Annotation of pkgsrc/doc/pkgsrc.html, revision 1.126
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
1664: medium you are using), and the ones that have vulnerabilities and
1665: therefore are considered insecure to install without thinking
1666: before.</p>
1667: <p>To install packages directly from an FTP or HTTP server, run
1668: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1669: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1670: <pre class="screen">
1671: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1672: <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>
1673: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1674: </pre>
1675: <p>Instead of URLs, you can also use local paths, for example if
1676: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1677: repository. If you want to install packages from multiple sources,
1678: you can separate them by a semicolon in
1679: <code class="varname">PKG_PATH</code>.</p>
1680: <p>After these preparations, installing a package is very
1681: easy:</p>
1682: <pre class="screen">
1683: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1684: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1685: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1686: </pre>
1.75 rillig 1687: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1688: package in question will be installed, too, assuming they are
1689: present where you install from.</p>
1.109 rillig 1690: <p>As mentioned above, packages for which vulnerabilities get
1691: known are not stored in the <code class="filename">All</code> subdirectory.
1692: They don't get deleted since that could be very frustrating if many
1693: other packages depend on it. Instead, they are moved to the
1694: <code class="filename">vulnerable</code> subdirectory. So you may need to add
1695: this directory to the <code class="varname">PKG_PATH</code> variable.
1.125 wiz 1696: However, you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.114 jmcneill 1697: regularly, especially after installing new packages, and verify
1698: that the vulnerabilities are acceptable for your configuration.</p>
1.75 rillig 1699: <p>After you've installed packages, be sure to have
1.88 wiz 1700: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1701: <code class="varname">PATH</code> so you can actually start the just
1702: installed program.</p>
1.75 rillig 1703: </div>
1704: <div class="sect2" lang="en">
1705: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1706: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1707: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1708: installed from source code or from a binary package. The
1.110 hubertf 1709: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1710: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88 wiz 1711: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1712: name can be given with or without version number. Wildcards can
1713: also be used to deinstall a set of packages, for example
1714: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1715: so that the shell does not expand them before
1716: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1717: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1718: removes all the packages that require the package in question
1719: and then removes the package itself. For example:
1.82 rillig 1720:
1.88 wiz 1721: </p>
1.82 rillig 1722: <pre class="screen">
1.88 wiz 1723: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1724: </pre>
1.82 rillig 1725: <p>
1726:
1.88 wiz 1727: will remove jpeg and all the packages that used it; this allows
1728: upgrading the jpeg package.</p>
1.82 rillig 1729: </div>
1730: <div class="sect2" lang="en">
1731: <div class="titlepage"><div><div><h3 class="title">
1732: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1733: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88 wiz 1734: installed packages or binary package files.</p>
1.82 rillig 1735: </div>
1736: <div class="sect2" lang="en">
1737: <div class="titlepage"><div><div><h3 class="title">
1738: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1739: <p>
1.88 wiz 1740: The NetBSD Security-Officer and Packages Groups maintain a list of
1741: known security vulnerabilities to packages which are (or have been)
1742: included in pkgsrc. The list is available from the NetBSD
1.110 hubertf 1743: 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 1744: </p>
1.82 rillig 1745: <p>
1.125 wiz 1746: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 1747: this list can be downloaded
1748: automatically, and a security audit of all packages installed on a system
1749: can take place.
1750: </p>
1.82 rillig 1751: <p>
1.125 wiz 1752: There are two components to auditing. The first
1753: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1754: is for downloading
1.88 wiz 1755: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1756: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1757: installed packages are vulnerable. If a package is vulnerable, you
1758: will see output similar to the following:
1759: </p>
1.82 rillig 1760: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 1761: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1762: <p>
1.125 wiz 1763: You may wish to have the
1.110 hubertf 1764: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1765: file downloaded daily so that
1766: it remains current. This may be done by adding an appropriate entry
1767: 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
1768: </p>
1769: <pre class="screen">
1770: # download vulnerabilities file
1771: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1772: </pre>
1773: <p>
1774: will update the vulnerability list every day at 3AM. You may wish to do
1775: this more often than once a day.
1776:
1777: In addition, you may wish to run the package audit from the daily
1778: security script. This may be accomplished by adding the following
1779: line to <code class="filename">/etc/security.local</code>:
1780: </p>
1781: <pre class="screen">
1782: /usr/sbin/pkg_admin audit
1783: </pre>
1784: <p>
1.88 wiz 1785: </p>
1.82 rillig 1786: </div>
1787: <div class="sect2" lang="en">
1788: <div class="titlepage"><div><div><h3 class="title">
1789: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1790: <p>
1.112 weinem 1791: 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 1792: <span class="command"><strong>lintpkgsrc</strong></span> with the “<span class="quote">-i</span>”
1.88 wiz 1793: argument to check if your packages are up-to-date, e.g.
1794: </p>
1795: <pre class="screen">
1796: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1797: ...
1.88 wiz 1798: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1799: </pre>
1.110 hubertf 1800: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88 wiz 1801: package on your system and rebuild any dependencies.
1802: </p>
1.82 rillig 1803: </div>
1804: <div class="sect2" lang="en">
1805: <div class="titlepage"><div><div><h3 class="title">
1806: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110 hubertf 1807: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1808: administrative functions on the package system.</p>
1.82 rillig 1809: </div>
1810: <div class="sect2" lang="en">
1811: <div class="titlepage"><div><div><h3 class="title">
1812: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75 rillig 1813: <p>Please pay very careful attention to the warnings
1.110 hubertf 1814: 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 1815: inherent dangers of installing binary packages which you did
1816: not create yourself, and the security holes that can be
1817: introduced onto your system by indiscriminate adding of such
1818: files.</p>
1.75 rillig 1819: <p>The same warning of course applies to every package you
1.88 wiz 1820: install from source when you haven't completely read and
1821: understood the source code of the package, the compiler that
1822: is used to build the package and all the other tools that are
1823: involved.</p>
1.75 rillig 1824: </div>
1825: </div>
1826: <div class="sect1" lang="en">
1827: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1828: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 1829: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1830: directory now contains a set of packages, organized into
1831: categories. You can browse the online index of packages, or run
1.110 hubertf 1832: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1833: directory to build local <code class="filename">README.html</code> files for
1.91 rillig 1834: 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 1835: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1836: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1837: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1838: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1839: different <code class="varname">LOCALBASE</code> definitions on the same
1840: system (inside a chroot is an exception). </p>
1841: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1842: 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 1843: instructions how to create your own packages.</p>
1.75 rillig 1844: <div class="sect2" lang="en">
1845: <div class="titlepage"><div><div><h3 class="title">
1846: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 1847: <p>To build packages from source, you need a working C
1.88 wiz 1848: compiler. On NetBSD, you need to install the
1849: “<span class="quote">comp</span>” and the “<span class="quote">text</span>” distribution
1850: sets. If you want to build X11-related packages, the
1851: “<span class="quote">xbase</span>” and “<span class="quote">xcomp</span>” distribution
1852: sets are required, too.</p>
1.75 rillig 1853: </div>
1854: <div class="sect2" lang="en">
1855: <div class="titlepage"><div><div><h3 class="title">
1856: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1857: <p>The first step for building a package is downloading the
1.88 wiz 1858: distfiles (i.e. the unmodified source). If they have not yet been
1859: downloaded, pkgsrc will fetch them automatically.</p>
1860: <p>If you have all files that you need in the
1861: <code class="filename">distfiles</code> directory,
1862: you don't need to connect. If the distfiles are on CD-ROM, you can
1863: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1864: </p>
1.82 rillig 1865: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1866: <p>
1.110 hubertf 1867: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1868: <p>By default a list of distribution sites will be randomly
1869: intermixed to prevent huge load on servers which holding popular
1870: packages (for example, SourceForge.net mirrors). Thus, every
1871: time when you need to fetch yet another distfile all the mirrors
1872: will be tried in new (random) order. You can turn this feature
1873: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1874: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1875: <p>You can overwrite some of the major distribution sites to
1876: fit to sites that are close to your own. By setting one or two
1877: variables you can modify the order in which the master sites are
1878: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1879: delimited list of domain suffixes.
1880: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1881: contains a whitespace delimited list of regular expressions. It
1882: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1883: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1884: some examples. This may save some of your bandwidth and
1885: time.</p>
1.75 rillig 1886: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1887: if you want to keep the settings, by editing the
1.110 hubertf 1888: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1889: and adding the definitions there.</p>
1.82 rillig 1890: <p>
1.88 wiz 1891: If a package depends on many other packages (such as
1.93 rillig 1892: <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 1893: alternate between periods of
1894: downloading source, and compiling. To ensure you have all the source
1895: downloaded initially you can run the command:
1896: </p>
1.82 rillig 1897: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1898: <p>
1.88 wiz 1899: which will output and run a set of shell commands to fetch the
1900: necessary files into the <code class="filename">distfiles</code> directory. You can
1901: also choose to download the files manually.
1902: </p>
1.75 rillig 1903: </div>
1904: <div class="sect2" lang="en">
1905: <div class="titlepage"><div><div><h3 class="title">
1906: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1907: <p>
1.88 wiz 1908: Once the software has downloaded, any patches will be applied, then it
1909: will be compiled for you. This may take some time depending on your
1910: computer, and how many other packages the software depends on and their
1911: compile time.
1912: </p>
1.75 rillig 1913: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1914: <h3 class="title">Note</h3>
1915: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1916: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.88 wiz 1917: “<span class="quote">make</span>” in the examples in this guide.</p>
1.75 rillig 1918: </div>
1.87 wiz 1919: <p>For example, type</p>
1.88 wiz 1920: <pre class="screen">
1921: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1922: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1923: </pre>
1.75 rillig 1924: <p>at the shell prompt to build the various components of the
1.88 wiz 1925: package.</p>
1.82 rillig 1926: <p>The next stage is to actually install the newly compiled
1.88 wiz 1927: program onto your system. Do this by entering:
1.82 rillig 1928:
1.88 wiz 1929: </p>
1.82 rillig 1930: <pre class="screen">
1.88 wiz 1931: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1932: </pre>
1.82 rillig 1933: <p>
1934:
1.88 wiz 1935: while you are still in the directory for whatever package you
1936: are installing.</p>
1.82 rillig 1937: <p>Installing the package on your system may require you to
1.88 wiz 1938: be root. However, pkgsrc has a
1939: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1940: to only become root for the actual installation step.</p>
1.82 rillig 1941: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 1942: You can now enter:
1.82 rillig 1943:
1.88 wiz 1944: </p>
1.82 rillig 1945: <pre class="screen">
1.88 wiz 1946: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1947: </pre>
1.82 rillig 1948: <p>
1949:
1.88 wiz 1950: to remove the compiled files in the work directory, as you shouldn't need
1951: them any more. If other packages were also added to your system
1952: (dependencies) to allow your program to compile, you can tidy these up
1953: also with the command:</p>
1.82 rillig 1954: <pre class="screen">
1.88 wiz 1955: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1956: </pre>
1.75 rillig 1957: <p>Taking the figlet utility as an example, we can install it on our
1.110 hubertf 1958: 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 1959: <p>The program is installed under the default root of the
1960: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1961: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1962: variable in your environment, and it will use that value as the
1963: root of your packages tree. So, to use
1964: <code class="filename">/usr/local</code>, set
1965: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1966: Please note that you should use a directory which is dedicated to
1967: packages and not shared with other programs (i.e., do not try and
1968: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1969: to add any of your own files or directories (such as
1970: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1971: <code class="filename">pkgsrc/</code>) below the
1972: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1973: conflicts between programs and other files installed by the
1974: package system and whatever else may have been installed
1975: there.</p>
1.110 hubertf 1976: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 1977: alter some configuration options at build time. Have a look at
1978: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1979: of what will be set there by default. Environment variables such
1980: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 1981: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 1982: set them each time you want to use pkgsrc.</p>
1983: <p>Occasionally, people want to “<span class="quote">look under the
1984: covers</span>” to see what is going on when a package is building
1985: or being installed. This may be for debugging purposes, or out of
1986: simple curiosity. A number of utility values have been added to
1987: help with this.</p>
1.75 rillig 1988: <div class="orderedlist"><ol type="1">
1989: <li>
1.110 hubertf 1990: <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 1991: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1992: information will be displayed. For example,</p>
1.75 rillig 1993: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 1994: <p>will show all the commands that are invoked, up to and
1995: including the “<span class="quote">patch</span>” stage.</p>
1.75 rillig 1996: </li>
1997: <li>
1.110 hubertf 1998: <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 1999: definition, then the <code class="varname">VARNAME</code> definition
2000: should be used, in conjunction with the show-var
1.110 hubertf 2001: 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 2002: variable <code class="varname">LOCALBASE</code>:</p>
2003: <pre class="screen">
2004: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 2005: /usr/pkg
2006: <code class="prompt">%</code>
1.88 wiz 2007: </pre>
1.75 rillig 2008: </li>
2009: </ol></div>
2010: <p>If you want to install a binary package that you've either
1.88 wiz 2011: created yourself (see next section), that you put into
2012: pkgsrc/packages manually or that is located on a remote FTP
2013: server, you can use the "bin-install" target. This target will
1.110 hubertf 2014: 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>,
2015: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 2016: sites searched is kept in the variable
2017: <code class="varname">BINPKG_SITES</code>, which defaults to
1.110 hubertf 2018: 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 2019: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2020: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2021: details.</p>
2022: <p>A final word of warning: If you set up a system that has a
2023: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2024: set that before any packages are installed, as you cannot use
2025: several directories for the same purpose. Doing so will result in
2026: pkgsrc not being able to properly detect your installed packages,
2027: and fail miserably. Note also that precompiled binary packages are
2028: usually built with the default <code class="varname">LOCALBASE</code> of
2029: <code class="filename">/usr/pkg</code>, and that you should
2030: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2031: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 2032: </div>
2033: </div>
2034: </div>
2035: <div class="chapter" lang="en">
2036: <div class="titlepage"><div><div><h2 class="title">
2037: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2038: <div class="toc">
2039: <p><b>Table of Contents</b></p>
2040: <dl>
2041: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2042: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 2043: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 2044: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2045: <dd><dl>
1.103 wiz 2046: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.123 snj 2047: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (CFLAGS)</a></span></dt>
2048: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (LDFLAGS)</a></span></dt>
1.88 wiz 2049: </dl></dd>
1.103 wiz 2050: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2051: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 2052: </dl>
2053: </div>
1.104 rillig 2054: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 2055: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2056: that file depends on the installation. On NetBSD, when you use
1.110 hubertf 2057: <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 2058: <code class="filename">/etc/</code>. In all other cases the default location is
2059: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2060: bootstrap program to install the binary packages.</p>
2061: <p>During the bootstrap, an example configuration file is created. To
2062: use that, you have to create the directory
2063: <code class="filename">${PREFIX}/etc</code> and copy the example file
2064: there.</p>
2065: <p>The format of the configuration file is that of the usual
2066: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2067: is done by setting variables in this file. Note that you can define all
2068: kinds of variables, and no special error checking (for example for
2069: spelling mistakes) takes place, so you have to try it out to see if it
2070: works.</p>
1.75 rillig 2071: <div class="sect1" lang="en">
2072: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2073: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2074: <p>In this section, you can find some variables that apply to all
1.89 rillig 2075: pkgsrc packages. A complete list of the variables that can be
2076: configured by the user is available in
2077: <code class="filename">mk/defaults/mk.conf</code>, together with some
2078: comments that describe each variable's intent.</p>
1.75 rillig 2079: <div class="itemizedlist"><ul type="disc">
2080: <li><p><code class="varname">LOCALBASE</code>: Where
2081: packages will be installed. The default is
1.76 rillig 2082: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2083: with different <code class="varname">LOCALBASE</code>s!</p></li>
2084: <li><p><code class="varname">CROSSBASE</code>: Where
2085: “<span class="quote">cross</span>” category packages will be
2086: installed. The default is
1.76 rillig 2087: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.75 rillig 2088: <li><p><code class="varname">X11BASE</code>: Where
2089: X11 is installed on the system. The default is
1.76 rillig 2090: <code class="filename">/usr/X11R6</code>.</p></li>
1.75 rillig 2091: <li><p><code class="varname">DISTDIR</code>: Where to store the
2092: downloaded copies of the original source distributions used
2093: for building pkgsrc packages. The default is
1.76 rillig 2094: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.97 rillig 2095: <li><p><code class="varname">PKG_DBDIR</code>: Where the
2096: database about installed packages is stored. The default is
2097: <code class="filename">/var/db/pkg</code>.</p></li>
1.75 rillig 2098: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
2099: If set, override the packages'
2100: <code class="varname">MASTER_SITES</code> with this value.</p></li>
2101: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
2102: Backup location(s) for distribution files and patch files
2103: if not found locally or in
1.76 rillig 2104: <code class="filename">${MASTER_SITES}</code> or
2105: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2106: The defaults are
1.76 rillig 2107: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2108: and
1.76 rillig 2109: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.75 rillig 2110: <li><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 2111: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2112: <em class="replaceable"><code>arch</code></em> are replaced with OS
2113: release (“<span class="quote">2.0</span>”, etc.) and architecture
2114: (“<span class="quote">mipsel</span>”, etc.).</p></li>
1.82 rillig 2115: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125 wiz 2116: List of acceptable licenses. License names are case-sensitive.
2117: Whenever you try to build a package whose license is not in this
2118: list, you will get an error message. If the license condition is
2119: simple enough, the error message will include specific
2120: instructions on how to change this variable.</p></li>
1.75 rillig 2121: </ul></div>
2122: </div>
2123: <div class="sect1" lang="en">
2124: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2125: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2126: <p>XXX
2127: </p>
2128: <div class="itemizedlist"><ul type="disc">
2129: <li><p><code class="varname">PACKAGES</code>: The top level
2130: directory for the binary packages. The default is
1.76 rillig 2131: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.75 rillig 2132: <li><p><code class="varname">WRKOBJDIR</code>:
2133: The top level directory where, if defined, the separate
2134: working directories will get created, and symbolically
1.76 rillig 2135: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2136: This is useful for building packages on several
1.76 rillig 2137: architectures, then <code class="filename">${PKGSRCDIR}</code>
2138: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 2139: is local to every architecture. (It should be noted that
2140: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126 ! jakllsch 2141: — it is an internal definition which refers to the
1.75 rillig 2142: root of the pkgsrc tree. It is possible to have many
2143: pkgsrc tree instances.)</p></li>
2144: <li><p><code class="varname">LOCALPATCHES</code>:
2145: Directory for local patches that aren't part of pkgsrc.
1.110 hubertf 2146: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.93 rillig 2147: information.</p></li>
1.75 rillig 2148: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 2149: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 2150: BSD-style Makefile. If this is not set,
2151: <code class="varname">MAKECONF</code> is set to
1.76 rillig 2152: <code class="filename">/dev/null</code> to avoid picking up
2153: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.82 rillig 2154: <li><p><code class="varname">DEPENDS_TARGET</code>:
2155: By default, dependencies are only installed, and no binary
2156: package is created for them. You can set this variable to
2157: <code class="literal">package</code> to automatically create binary
2158: packages after installing dependencies.</p></li>
1.75 rillig 2159: </ul></div>
2160: </div>
2161: <div class="sect1" lang="en">
2162: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109 rillig 2163: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.103 wiz 2164: <p>A growing number of packages support installation into a
2165: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2166: to be built, before the actual filesystem is touched. DESTDIR
2167: support exists in two variations:</p>
2168: <div class="itemizedlist"><ul type="disc">
2169: <li><p>Basic DESTDIR support means that the package
2170: installation and packaging is still run as
2171: root.</p></li>
2172: <li><p>Full DESTDIR support can run the complete build,
2173: installation and packaging as normal user. Root privileges are
2174: only needed to add packages.</p></li>
2175: </ul></div>
1.123 snj 2176: <p>To use the DESTDIR support, set
2177: <code class="varname">USE_DESTDIR=yes</code> to get the full support for packages
2178: that support it and with fallback to basic support. </p>
1.103 wiz 2179: <p>DESTDIR support changes the behaviour of various targets
2180: slightly. To install a package after building it, use
2181: <code class="literal">package-install</code>. <code class="literal">package</code> and
2182: <code class="literal">install</code> don't do that any
2183: longer. <code class="literal">package-install</code> can be used as
2184: <code class="varname">DEPENDS_TARGET</code>. <code class="literal">bin-install</code>
2185: will ask for the root password to install the package and fail,
2186: <code class="literal">package-install</code> will ask again.</p>
2187: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2188: clean</code></strong> needs to be run as root.</p>
1.118 imil 2189: <p>Considering the <code class="filename">foo/bar</code> package,
2190: DESTDIR full support can be tested using the following commands
2191:
2192: </p>
2193: <pre class="programlisting">
2194: <code class="prompt">$</code> id
2195: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
2196: <code class="prompt">$</code> mkdir $HOME/packages
2197: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
2198: </pre>
2199: <p>
2200:
2201: Verify <code class="varname">DESTDIR</code> full support, no root privileges
2202: should be needed
2203:
2204: </p>
2205: <pre class="programlisting">
1.123 snj 2206: <code class="prompt">$</code> make USE_DESTDIR=yes install
1.118 imil 2207: </pre>
2208: <p>
2209:
2210: Create a package without root privileges
2211:
2212: </p>
2213: <pre class="programlisting">
1.123 snj 2214: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package
1.118 imil 2215: </pre>
2216: <p>
2217:
2218: For the following command, you must be able to gain root
2219: 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>
2220:
2221: </p>
2222: <pre class="programlisting">
1.123 snj 2223: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package-install
1.118 imil 2224: </pre>
2225: <p>
2226:
2227: Then, as a simple user
2228:
2229: </p>
2230: <pre class="programlisting">
2231: <code class="prompt">$</code> make clean
2232: </pre>
2233: <p>
2234:
2235: </p>
1.103 wiz 2236: </div>
2237: <div class="sect1" lang="en">
2238: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2239: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.78 rillig 2240: <div class="sect2" lang="en">
2241: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2242: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 2243: <p>By default, pkgsrc will use GCC to build packages. This may be
2244: overridden by setting the following variables in /etc/mk.conf:</p>
2245: <div class="variablelist"><dl>
2246: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2247: <dd>
2248: <p>This is a list of values specifying the chain of
2249: compilers to invoke when building packages. Valid values
2250: are:</p>
2251: <div class="itemizedlist"><ul type="disc">
2252: <li><p><code class="varname">distcc</code>:
2253: distributed C/C++ (chainable)</p></li>
2254: <li><p><code class="varname">ccache</code>:
2255: compiler cache (chainable)</p></li>
2256: <li><p><code class="varname">gcc</code>:
2257: GNU C/C++ Compiler</p></li>
2258: <li><p><code class="varname">mipspro</code>:
2259: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
2260: <li><p><code class="varname">mipspro</code>:
2261: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
2262: <li><p><code class="varname">sunpro</code>:
2263: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2264: </ul></div>
2265: <p>The default is
2266: “<span class="quote"><code class="varname">gcc</code></span>”. You can use
2267: <code class="varname">ccache</code> and/or
2268: <code class="varname">distcc</code> with an appropriate
2269: <code class="varname">PKGSRC_COMPILER</code> setting,
2270: e.g. “<span class="quote"><code class="varname">ccache gcc</code></span>”. This
1.94 dmcmahil 2271: variable should always be terminated with a value for
2272: a real compiler. Note that only one real compiler
2273: should be listed (e.g. “<span class="quote"><code class="varname">sunpro gcc</code></span>”
2274: is not allowed).</p>
1.89 rillig 2275: </dd>
2276: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2277: <dd><p>This specifies the minimum version of GCC to use
2278: when building packages. If the system GCC doesn't
2279: satisfy this requirement, then pkgsrc will build and
2280: install one of the GCC packages to use instead.</p></dd>
2281: </dl></div>
2282: </div>
2283: <div class="sect2" lang="en">
2284: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2285: <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 2286: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2287: please make sure to use the <code class="literal">+=</code> operator
2288: instead of the <code class="literal">=</code> operator:</p>
2289: <pre class="programlisting">
1.100 rillig 2290: CFLAGS+= -your -flags
1.78 rillig 2291: </pre>
2292: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.117 jnemeth 2293: “<span class="quote">+</span>”) may lead to problems with packages that
2294: need to add their own flags. You may want to take a look
2295: 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>
2296: package if you're interested in optimization for the current
2297: CPU. Setting <code class="varname">USE_CPUFLAGS</code> to yes in
2298: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> will cause pkgsrc to automatically use cpuflags.</p>
1.78 rillig 2299: </div>
1.88 wiz 2300: <div class="sect2" lang="en">
2301: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2302: <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 2303: <p>If you want to pass flags to the linker, both in the configure
2304: step and the build step, you can do this in two ways. Either set
2305: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2306: between the two is that <code class="varname">LIBS</code> will be appended to
2307: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2308: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2309: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2310: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2311: <code class="varname">CFLAGS</code>, if you do not wish to override these
2312: settings, use the <code class="literal">+=</code> operator:</p>
2313: <pre class="programlisting">
1.100 rillig 2314: LDFLAGS+= -your -linkerflags
1.88 wiz 2315: </pre>
2316: </div>
1.78 rillig 2317: </div>
2318: <div class="sect1" lang="en">
2319: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2320: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.75 rillig 2321: <p>XXX
2322: </p>
2323: <div class="itemizedlist"><ul type="disc">
2324: <li>
2325: <p><code class="varname">PKG_DEVELOPER</code>:
2326: Run some sanity checks that package developers want:
2327: </p>
2328: <div class="itemizedlist"><ul type="circle">
1.88 wiz 2329: <li><p>make sure patches apply with zero
2330: fuzz</p></li>
2331: <li><p>run check-shlibs to see that all
2332: binaries will find their shared libs.</p></li>
1.75 rillig 2333: </ul></div>
2334: <p>
1.87 wiz 2335: </p>
1.75 rillig 2336: </li>
1.88 wiz 2337: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
2338: of debugging output which is displayed whilst making and
2339: installing the package. The default value for this is 0,
2340: which will not display the commands as they are executed
2341: (normal, default, quiet operation); the value 1 will display
2342: all shell commands before their invocation, and the value 2
2343: will display both the shell commands before their invocation,
1.110 hubertf 2344: and their actual execution progress with <span class="command"><strong>set
1.88 wiz 2345: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2346: </ul></div>
2347: <p>
2348: </p>
2349: </div>
2350: <div class="sect1" lang="en">
2351: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2352: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 2353: <p>Some packages have build time options, usually to select
2354: between different dependencies, enable optional support for big
2355: dependencies or enable experimental features.</p>
1.75 rillig 2356: <p>To see which options, if any, a package supports, and which
1.110 hubertf 2357: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 2358: show-options</strong></span>, for example:</p>
1.75 rillig 2359: <pre class="programlisting">
2360: The following options are supported by this package:
2361: ssl Enable SSL support.
2362: Exactly one of the following gecko options is required:
2363: firefox Use firefox as gecko rendering engine.
2364: mozilla Use mozilla as gecko rendering engine.
2365: At most one of the following database options may be selected:
2366: mysql Enable support for MySQL database.
2367: pgsql Enable support for PostgreSQL database.
1.1 grant 2368:
1.75 rillig 2369: These options are enabled by default: firefox
2370: These options are currently enabled: mozilla ssl
1.1 grant 2371: </pre>
1.75 rillig 2372: <p>The following variables can be defined in
1.110 hubertf 2373: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 2374: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2375: which can be used to select or disable options for all packages
2376: that support them, and
2377: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2378: which can be used to select or disable options specifically for
2379: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
2380: these variables are selected, options preceded by “<span class="quote">-</span>”
2381: are disabled. A few examples:</p>
1.75 rillig 2382: <pre class="screen">
1.110 hubertf 2383: <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 2384: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2385: PKG_OPTIONS.kdebase= debug -sasl
2386: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2387: <p>It is important to note that options that were specifically
1.120 snj 2388: suggested by the package maintainer must be explicitly removed if
1.111 rillig 2389: you do not wish to include the option. If you are unsure you can view
2390: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 2391: <p>The following settings are consulted in the order given, and
2392: the last setting that selects or disables an option is
2393: used:</p>
1.75 rillig 2394: <div class="orderedlist"><ol type="1">
2395: <li><p>the default options as suggested by the package
1.88 wiz 2396: maintainer</p></li>
1.75 rillig 2397: <li><p>the options implied by the settings of legacy
1.88 wiz 2398: variables (see below)</p></li>
1.75 rillig 2399: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2400: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
2401: </ol></div>
2402: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2403: selected is used, all others are automatically disabled. If an
2404: option of the group is explicitly disabled, the previously
2405: selected option, if any, is used. It is an error if no option
2406: from a required group of options is selected, and building the
2407: package will fail.</p>
2408: <p>Before the options framework was introduced, build options
2409: were selected by setting a variable (often named
2410: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 2411: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2412: transition to the options framework for the user, these legacy
2413: variables are converted to the appropriate options setting
2414: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2415: automatically. A warning is issued to prompt the user to update
1.110 hubertf 2416: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2417: directly. Support for the legacy variables will be removed
2418: eventually.</p>
1.75 rillig 2419: </div>
2420: </div>
2421: <div class="chapter" lang="en">
2422: <div class="titlepage"><div><div><h2 class="title">
2423: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2424: <div class="toc">
2425: <p><b>Table of Contents</b></p>
2426: <dl>
2427: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2428: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2429: </dl>
2430: </div>
2431: <div class="sect1" lang="en">
2432: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2433: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2434: <p>Once you have built and installed a package, you can create
2435: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.110 hubertf 2436: 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 2437: the same package on a group of hosts and wasting CPU time. It also
2438: provides a simple means for others to install your package, should
2439: you distribute it.</p>
2440: <p>To create a binary package, change into the appropriate
1.110 hubertf 2441: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2442: package</strong></span>:</p>
2443: <pre class="screen">
2444: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2445: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2446: </pre>
2447: <p>This will build and install your package (if not already done),
2448: and then build a binary package from what was installed. You can
1.110 hubertf 2449: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 2450: it. Binary packages are created by default in
2451: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110 hubertf 2452: 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 2453: 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 2454: <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 2455: such a binary package.</p>
1.75 rillig 2456: </div>
2457: <div class="sect1" lang="en">
2458: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2459: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110 hubertf 2460: <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 2461: </div>
2462: </div>
2463: <div class="chapter" lang="en">
2464: <div class="titlepage"><div><div><h2 class="title">
2465: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2466: builds)</h2></div></div></div>
2467: <div class="toc">
2468: <p><b>Table of Contents</b></p>
2469: <dl>
2470: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
2471: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
2472: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
2473: <dd><dl>
2474: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
2475: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
2476: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
2477: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
2478: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
2479: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2480: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
2481: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
2482: </dl></dd>
2483: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116 rillig 2484: <dd><dl>
2485: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
2486: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
2487: </dl></dd>
1.106 rillig 2488: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2489: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
2490: </dl>
2491: </div>
2492: <p>When you have multiple machines that should run the same packages,
2493: it is wasted time if they all build their packages themselves from
2494: source. There are two ways of getting a set of binary packages: The old
2495: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
2496: system. This chapter describes how to set them up so that the packages
2497: are most likely to be usable later.</p>
2498: <div class="sect1" lang="en">
2499: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2500: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
2501: <p>Since a bulk build takes several days or even weeks to finish, you
2502: should think about the setup before you start everything. Pay attention
2503: to at least the following points:</p>
2504: <div class="itemizedlist"><ul type="disc">
2505: <li>
2506: <p>If you want to upload the binary packages to
2507: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
2508: packages:</p>
2509: <div class="itemizedlist"><ul type="circle">
2510: <li><p>To end up on ftp.NetBSD.org, the packages must be built
2511: by a NetBSD developer on a trusted machine (that is, where you and only
2512: you have root access).</p></li>
2513: <li><p>Packages on ftp.NetBSD.org should only be created from
1.124 snj 2514: the stable branches (like 2009Q1), so that users browsing the available
1.106 rillig 2515: collections can see at a glance how old the packages
2516: are.</p></li>
2517: <li><p>The packages must be built as root, since some packages
2518: require set-uid binaries at runtime, and creating those packages as
2519: unprivileged user doesn't work well at the moment.</p></li>
2520: </ul></div>
2521: </li>
2522: <li><p>Make sure that the bulk build cannot break anything in
2523: your system. Most bulk builds run as root, so they should be run at least
2524: in a chroot environment or something even more restrictive, depending on
2525: what the operating system provides. There have been numerous cases where
2526: certain packages tried to install files outside the
2527: <code class="filename">LOCALBASE</code> or wanted to edit some files in
2528: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
2529: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
2530: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
2531: that you don't need any package during the build.</p></li>
2532: </ul></div>
2533: </div>
2534: <div class="sect1" lang="en">
2535: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2536: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
2537: <p>A complete bulk build requires lots of disk space. Some of the
2538: disk space can be read-only, some other must be writable. Some can be on
2539: remote filesystems (such as NFS) and some should be local. Some can be
2540: temporary filesystems, others must survive a sudden reboot.</p>
2541: <div class="itemizedlist"><ul type="disc">
2542: <li><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
2543: <li><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
2544: <li><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2545: <li><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
2546: <li><p>5 GB for the log files (read-write, remote, permanent)</p></li>
2547: <li><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2548: </ul></div>
1.75 rillig 2549: </div>
2550: <div class="sect1" lang="en">
2551: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2552: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
1.116 rillig 2553: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2554: <h3 class="title">Note</h3>
2555: <p>There are two ways of doing a bulk build. The old-style
2556: one and the new-style “<span class="quote">pbulk</span>”. The latter is the recommended
2557: way.</p>
1.106 rillig 2558: </div>
1.75 rillig 2559: <div class="sect2" lang="en">
2560: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2561: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.75 rillig 2562: <div class="sect3" lang="en">
2563: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 2564: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.93 rillig 2565: </h4></div></div></div>
1.76 rillig 2566: <p>The <code class="filename">build.conf</code> file is the main
1.87 wiz 2567: configuration file for bulk builds. You can configure how your
2568: copy of pkgsrc is kept up to date, how the distfiles are
2569: downloaded, how the packages are built and how the report is
2570: generated. You can find an annotated example file in
2571: <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2572: it, copy <code class="filename">build.conf-example</code> to
2573: <code class="filename">build.conf</code> and edit it, following the
2574: comments in that file.</p>
1.75 rillig 2575: </div>
2576: <div class="sect3" lang="en">
2577: <div class="titlepage"><div><div><h4 class="title">
1.110 hubertf 2578: <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 2579: </h4></div></div></div>
1.110 hubertf 2580: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.87 wiz 2581: Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2582: details of the default settings. You will want to ensure that
2583: <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
1.125 wiz 2584: As used in this example, <code class="varname">SKIP_LICENSE_CHECK=yes</code>
1.104 rillig 2585: completely bypasses the license check.</p>
1.87 wiz 2586: <pre class="programlisting">
1.100 rillig 2587: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2588: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2589: BSDSRCDIR= /usr/src
2590: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2591: OBJHOSTNAME?= yes # use work.`hostname`
2592: FAILOVER_FETCH= yes # insist on the correct checksum
2593: PKG_DEVELOPER?= yes
1.125 wiz 2594: SKIP_LICENSE_CHECK= yes
1.100 rillig 2595: </pre>
1.75 rillig 2596: <p>Some options that are especially useful for bulk builds
2597: can be found at the top lines of the file
1.76 rillig 2598: <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75 rillig 2599: options of these are briefly described here.</p>
2600: <div class="itemizedlist"><ul type="disc">
2601: <li><p>If you are on a slow machine, you may want to
1.87 wiz 2602: set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
2603: “<span class="quote">no</span>”.</p></li>
1.75 rillig 2604: <li><p>If you are doing bulk builds from a read-only
1.87 wiz 2605: copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2606: to the directory where all log files are created. Otherwise the
2607: log files are created in the pkgsrc directory.</p></li>
1.75 rillig 2608: <li><p>Another important variable is
1.87 wiz 2609: <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2610: should be always available while building other
2611: packages.</p></li>
1.75 rillig 2612: </ul></div>
2613: <p>Some other options are scattered in the pkgsrc
2614: infrastructure:</p>
2615: <div class="itemizedlist"><ul type="disc">
2616: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
1.87 wiz 2617: should be set to <code class="literal">yes</code>. The purpose of the bulk
2618: builds is creating binary packages, no matter if they are
2619: vulnerable or not. When uploading the packages to a public
2620: server, the vulnerable packages will be put into a directory of
2621: their own. Leaving this variable unset would prevent the bulk
2622: build system from even trying to build them, so possible
2623: building errors would not show up.</p></li>
1.75 rillig 2624: <li><p><code class="varname">CHECK_FILES</code>
1.93 rillig 2625: (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.87 wiz 2626: “<span class="quote">yes</span>” to check that the installed set of files
2627: matches the <code class="filename">PLIST</code>.</p></li>
1.75 rillig 2628: <li><p><code class="varname">CHECK_INTERPRETER</code>
1.93 rillig 2629: (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.87 wiz 2630: “<span class="quote">yes</span>” to check that the installed
2631: “<span class="quote">#!</span>”-scripts will find their
2632: interpreter.</p></li>
1.91 rillig 2633: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
2634: set to “<span class="quote"><code class="literal">yes</code></span>” to run each
2635: package's self-test before installing it. Note that some
2636: packages make heavy use of “<span class="quote">good</span>” random
2637: numbers, so you need to assure that the machine on which you
2638: are doing the bulk builds is not completely idle. Otherwise
2639: some test programs will seem to hang, while they are just
2640: waiting for new random data to be
2641: available.</p></li>
1.75 rillig 2642: </ul></div>
2643: </div>
2644: <div class="sect3" lang="en">
2645: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 2646: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.93 rillig 2647: </h4></div></div></div>
1.75 rillig 2648: <p>It is possible to configure the bulk build to perform
1.87 wiz 2649: certain site-specific tasks at the end of the pre-build
2650: stage. If the file
2651: <code class="filename">pre-build.local</code> exists in
2652: <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.110 hubertf 2653: (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 2654: stage. An example use of
2655: <code class="filename">pre-build.local</code> is to have the line:</p>
1.75 rillig 2656: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87 wiz 2657: > misc/openoffice/$BROKENF</pre>
1.75 rillig 2658: <p>to prevent the system from trying to build a particular package
1.87 wiz 2659: which requires nearly 3 GB of disk space.</p>
1.75 rillig 2660: </div>
2661: </div>
2662: <div class="sect2" lang="en">
2663: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2664: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.76 rillig 2665: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87 wiz 2666: deleted at the start of bulk builds, make sure your login
2667: shell is placed somewhere else. Either drop it into
2668: <code class="filename">/usr/local/bin</code> (and adjust your login
2669: shell in the passwd file), or (re-)install it via
1.110 hubertf 2670: <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 2671: you can login after a reboot (remember that your current
2672: process won't die if the package is removed, you just can't
2673: start any new instances of the shell any more). Also, if you
2674: use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2675: version of ssh for some reason, be sure to install ssh before
2676: starting it from <code class="filename">rc.local</code>:</p>
2677: <pre class="programlisting">
1.100 rillig 2678: (cd /usr/pkgsrc/security/ssh && make bulk-install)
2679: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2680: /usr/pkg/etc/rc.d/sshd
2681: fi
2682: </pre>
1.75 rillig 2683: <p>Not doing so will result in you being not able to log in
1.87 wiz 2684: via ssh after the bulk build is finished or if the machine
2685: gets rebooted or crashes. You have been warned! :)</p>
1.75 rillig 2686: </div>
2687: <div class="sect2" lang="en">
2688: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2689: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.75 rillig 2690: <p>Make sure you don't need any of the packages still
1.87 wiz 2691: installed.</p>
1.75 rillig 2692: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2693: <h3 class="title">Warning</h3>
1.99 rillig 2694: <p>During the bulk build, <span class="emphasis"><em>all packages, their
2695: configuration files and some more files from
2696: <code class="filename">/var</code>, <code class="filename">/home</code> and
2697: possibly other locations will be removed! So don't run a bulk
2698: build with privileges that might harm your
2699: system.</em></span></p>
1.75 rillig 2700: </div>
2701: <p>Be sure to remove all other things that might
1.87 wiz 2702: interfere with builds, like some libs installed in
2703: <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2704: <pre class="screen">
2705: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2706: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2707: </pre>
1.75 rillig 2708: <p>If for some reason your last build didn't complete (power
1.87 wiz 2709: failure, system panic, ...), you can continue it by
2710: running:</p>
1.75 rillig 2711: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87 wiz 2712: <p>At the end of the bulk build, you will get a summary via mail,
2713: and find build logs in the directory specified by
2714: <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2715: file.</p>
1.75 rillig 2716: </div>
2717: <div class="sect2" lang="en">
2718: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2719: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.75 rillig 2720: <p>The bulk builds consist of three steps:</p>
2721: <div class="variablelist"><dl>
2722: <dt><span class="term">1. pre-build</span></dt>
1.87 wiz 2723: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2724: cleans out any broken distfiles, and removes all
2725: packages installed.</p></dd>
1.75 rillig 2726: <dt><span class="term">2. the bulk build</span></dt>
1.87 wiz 2727: <dd><p>This is basically “<span class="quote">make bulk-package</span>” with
2728: an optimised order in which packages will be
2729: built. Packages that don't require other packages will
2730: be built first, and packages with many dependencies will
2731: be built later.</p></dd>
1.75 rillig 2732: <dt><span class="term">3. post-build</span></dt>
1.87 wiz 2733: <dd><p>Generates a report that's placed in the directory
2734: specified in the <code class="filename">build.conf</code> file
2735: named <code class="filename">broken.html</code>, a short version
2736: of that report will also be mailed to the build's
2737: admin.</p></dd>
1.75 rillig 2738: </dl></div>
1.87 wiz 2739: <p>During the build, a list of broken packages will be compiled
2740: in <code class="filename">/usr/pkgsrc/.broken</code> (or
2741: <code class="filename">.../.broken.${MACHINE}</code> if
2742: <code class="varname">OBJMACHINE</code> is set), individual build logs
2743: of broken builds can be found in the package's
2744: directory. These files are used by the bulk-targets to mark
2745: broken builds to not waste time trying to rebuild them, and
2746: they can be used to debug these broken package builds
2747: later.</p>
1.75 rillig 2748: </div>
2749: <div class="sect2" lang="en">
2750: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2751: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.75 rillig 2752: <p>Currently, roughly the following requirements are valid for
1.87 wiz 2753: NetBSD 2.0/i386:</p>
1.75 rillig 2754: <div class="itemizedlist"><ul type="disc">
1.87 wiz 2755: <li><p>10 GB - distfiles (NFS ok)</p></li>
2756: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
2757: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
2758: </ul></div>
2759: <p>Note that all pkgs will be de-installed as soon as they are
2760: turned into a binary package, and that sources are removed,
2761: so there is no excessively huge demand to disk
2762: space. Afterwards, if the package is needed again, it will
1.110 hubertf 2763: 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 2764: there are no cycles wasted by recompiling.</p>
1.75 rillig 2765: </div>
2766: <div class="sect2" lang="en">
2767: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2768: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87 wiz 2769: <p>If you don't want all the packages nuked from a machine
2770: (rendering it useless for anything but pkg compiling), there
2771: is the possibility of doing the package bulk build inside a
2772: chroot environment.</p>
2773: <p>The first step is to set up a chroot sandbox,
2774: e.g. <code class="filename">/usr/sandbox</code>. This can be done by
2775: using null mounts, or manually.</p>
2776: <p>There is a shell script called
2777: <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
2778: up the sandbox environment using null mounts. It will also
2779: create a script called <code class="filename">sandbox</code> in the
2780: root of the sandbox environment, which will allow the null
1.110 hubertf 2781: mounts to be activated using the <span class="command"><strong>sandbox
1.87 wiz 2782: mount</strong></span> command and deactivated using the
1.110 hubertf 2783: <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.87 wiz 2784: <p>To set up a sandbox environment by hand, after extracting all
1.110 hubertf 2785: the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.87 wiz 2786: distribution DESTDIR=/usr/sandbox</strong></span> in
2787: <code class="filename">/usr/src/etc</code>, be sure the following items
2788: are present and properly configured:</p>
1.75 rillig 2789: <div class="procedure"><ol type="1">
2790: <li>
2791: <p>Kernel</p>
2792: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2793: </li>
2794: <li>
1.76 rillig 2795: <p><code class="filename">/dev/*</code></p>
1.75 rillig 2796: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2797: </li>
2798: <li>
1.91 rillig 2799: <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 2800: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2801: </li>
2802: <li>
2803: <p>Working(!) mail config (hostname, sendmail.cf):</p>
2804: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2805: </li>
2806: <li>
1.91 rillig 2807: <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 2808: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2809: </li>
2810: <li>
1.76 rillig 2811: <p><code class="filename">/usr/src</code> (system sources,
1.126 ! jakllsch 2812: 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 2813: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87 wiz 2814: <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75 rillig 2815: </li>
2816: <li>
1.76 rillig 2817: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75 rillig 2818: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2819: </li>
2820: <li>
1.76 rillig 2821: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75 rillig 2822: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
2823: </li>
2824: <li>
2825: <p>Checkout pkgsrc via cvs into
1.87 wiz 2826: <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
2827: <pre class="screen">
2828: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
2829: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
2830: </pre>
1.75 rillig 2831: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87 wiz 2832: you do development in, as this will likely cause problems!</p>
1.75 rillig 2833: </li>
2834: <li><p>Make
1.87 wiz 2835: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
2836: <code class="filename">.../distfiles</code> point somewhere
2837: appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.123 snj 2838: <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 2839: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75 rillig 2840: </ol></div>
2841: <p>When the chroot sandbox is set up, you can start
1.87 wiz 2842: the build with the following steps:</p>
2843: <pre class="screen">
2844: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2845: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
2846: </pre>
2847: <p>This will just jump inside the sandbox and start building. At
2848: the end of the build, mail will be sent with the results of
2849: the build. Created binary pkgs will be in
2850: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
2851: (wherever that points/mounts to/from).</p>
1.75 rillig 2852: </div>
2853: <div class="sect2" lang="en">
2854: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2855: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.87 wiz 2856: <p>In addition to building a complete set of all packages in
2857: pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
2858: may be used to build a subset of the packages contained in
2859: pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
1.110 hubertf 2860: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.75 rillig 2861: <div class="itemizedlist"><ul type="disc">
2862: <li><p>SITE_SPECIFIC_PKGS</p></li>
2863: <li><p>HOST_SPECIFIC_PKGS</p></li>
2864: <li><p>GROUP_SPECIFIC_PKGS</p></li>
2865: <li><p>USER_SPECIFIC_PKGS</p></li>
2866: </ul></div>
1.87 wiz 2867: <p>will define the set of packages which should be built.
2868: The bulk build code will also include any packages which are
2869: needed as dependencies for the explicitly listed packages.</p>
2870: <p>One use of this is to do a bulk build with
2871: <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
2872: periodically to have a complete set of the binary packages
2873: needed for your site available without the overhead of
2874: building extra packages that are not needed.</p>
1.75 rillig 2875: </div>
2876: <div class="sect2" lang="en">
2877: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2878: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87 wiz 2879: <p>This section describes how pkgsrc developers can upload binary
2880: pkgs built by bulk builds to ftp.NetBSD.org.</p>
2881: <p>If you would like to automatically create checksum files for the
2882: binary packages you intend to upload, remember to set
2883: <code class="varname">MKSUMS=yes</code> in your
2884: <code class="filename">mk/bulk/build.conf</code>.</p>
2885: <p>If you would like to PGP sign the checksum files (highly
2886: recommended!), remember to set
2887: <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
2888: <code class="filename">mk/bulk/build.conf</code>. This will prompt you for
2889: your GPG password to sign the files before uploading everything.</p>
2890: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
2891: set properly in your <code class="filename">mk/bulk/build.conf</code>
2892: file, i.e. adjust it to something like one of the following:</p>
1.126 ! jakllsch 2893: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-20xxQy/NetBSD-a.b.c/arch/upload </pre>
! 2894: <p>Please use appropriate values for "packages-20xxQy",
1.87 wiz 2895: "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
2896: is different from your local login, write your login directly
2897: into the variable, e.g. my local account is "feyrer", but for my
2898: login "hubertf", I use:</p>
1.126 ! jakllsch 2899: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-20xxQy/NetBSD-a.b.c/arch/upload</pre>
1.87 wiz 2900: <p>A separate <code class="filename">upload</code> directory is used
2901: here to allow "closing" the directory during upload. To do
2902: so, run the following command on ftp.NetBSD.org next:</p>
1.126 ! jakllsch 2903: <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 2904: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
2905: only appropriate for packages for the NetBSD operating
2906: system. Binary packages for other operating systems should go
2907: into <code class="filename">/pub/pkgsrc</code>.</p>
2908: <p>Before uploading the binary pkgs, ssh authentication needs
2909: to be set up. This example shows how to set up temporary keys
2910: for the root account <span class="emphasis"><em>inside the sandbox</em></span>
2911: (assuming that no keys should be present there usually):</p>
2912: <pre class="screen">
2913: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75 rillig 2914: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
2915: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87 wiz 2916: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
2917: </pre>
2918: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
2919: append it to your <code class="filename">~/.ssh/authorized_keys</code>
2920: file on ftp.NetBSD.org. You can remove the key after the
2921: upload is done!</p>
2922: <p>Next, test if your ssh connection really works:</p>
1.75 rillig 2923: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87 wiz 2924: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
2925: <p>Now after all this works, you can exit the sandbox and start
2926: the upload:</p>
2927: <pre class="screen">
2928: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75 rillig 2929: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87 wiz 2930: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
2931: </pre>
1.110 hubertf 2932: <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
2933: <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 2934: upload. The upload script will take care of not uploading
2935: restricted packages and putting vulnerable packages into the
2936: <code class="filename">vulnerable</code> subdirectory.</p>
2937: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75 rillig 2938: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87 wiz 2939: Gdd:x! </pre>
2940: <p>Use whatever is needed to remove the key you've entered
2941: before! Last, move the uploaded packages out of the
2942: <code class="filename">upload</code> directory to have them accessible
2943: to everyone:</p>
2944: <pre class="screen">
1.126 ! jakllsch 2945: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-20xxQy/NetBSD-a.b.c/arch</code></strong>
1.75 rillig 2946: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
2947: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87 wiz 2948: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
2949: </pre>
1.75 rillig 2950: </div>
2951: </div>
2952: <div class="sect1" lang="en">
2953: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2954: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
1.116 rillig 2955: <p>Running a pbulk-style bulk build works roughly as follows:</p>
2956: <div class="itemizedlist"><ul type="disc">
2957: <li><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2958: <li><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
2959: </ul></div>
2960: <div class="sect2" lang="en">
2961: <div class="titlepage"><div><div><h3 class="title">
2962: <a name="bulk.pbulk.prepare"></a>7.4.1. Preparation</h3></div></div></div>
1.117 jnemeth 2963: <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 2964: <pre class="screen">
2965: $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2966: $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
2967: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
2968: </pre>
2969: <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>
2970: <div class="itemizedlist"><ul type="disc">
2971: <li><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
2972: <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>
2973: <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>
2974: <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 2975: <li><p><code class="literal"><code class="varname">SKIP_LICENSE_CHECK</code>=yes</code>, to bypass the license checks.</p></li>
1.116 rillig 2976: </ul></div>
2977: <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
2978: <pre class="screen">
2979: $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
2980: $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
2981: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
2982: </pre>
2983: <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>
2984: </div>
1.106 rillig 2985: <div class="sect2" lang="en">
2986: <div class="titlepage"><div><div><h3 class="title">
1.116 rillig 2987: <a name="bulk.pbulk.conf"></a>7.4.2. Configuration</h3></div></div></div>
1.114 jmcneill 2988: <p>TODO; see pkgsrc/doc/HOWTO-pbulk for more information.</p>
1.116 rillig 2989: <p>TODO: continue writing</p>
1.106 rillig 2990: </div>
2991: </div>
2992: <div class="sect1" lang="en">
2993: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2994: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 2995: <p>After your pkgsrc bulk-build has completed, you may wish to
2996: create a CD-ROM set of the resulting binary packages to assist
2997: in installing packages on other machines. The
1.91 rillig 2998: <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 2999: a simple tool for creating the ISO 9660 images.
1.110 hubertf 3000: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 3001: way that keeps all the dependencies for a given package on the same
3002: CD as that package.</p>
1.75 rillig 3003: <div class="sect2" lang="en">
3004: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3005: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.87 wiz 3006: <p>Complete documentation for cdpack is found in the cdpack(1)
3007: man page. The following short example assumes that the binary
3008: packages are left in
3009: <code class="filename">/usr/pkgsrc/packages/All</code> and that
3010: sufficient disk space exists in <code class="filename">/u2</code> to
3011: hold the ISO 9660 images.</p>
3012: <pre class="screen">
3013: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 3014: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 3015: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
3016: </pre>
3017: <p>If you wish to include a common set of files
3018: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
3019: etc.) on each CD in the collection, then you need to create a
3020: directory which contains these files. e.g.</p>
3021: <pre class="screen">
3022: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 3023: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
3024: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
3025: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
3026: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
3027: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 3028: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
3029: </pre>
1.75 rillig 3030: <p>Now create the images:</p>
3031: <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 3032: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 3033: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
3034: in their root directories.</p>
1.75 rillig 3035: </div>
3036: </div>
3037: </div>
3038: <div class="chapter" lang="en">
3039: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3040: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 3041: <div class="toc">
3042: <p><b>Table of Contents</b></p>
3043: <dl>
1.123 snj 3044: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in ${LOCALBASE}</a></span></dt>
3045: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in ${VARBASE}</a></span></dt>
1.90 rillig 3046: </dl>
3047: </div>
3048: <p>The files that are installed by pkgsrc are organized in a way that
3049: is similar to what you find in the <code class="filename">/usr</code> directory
3050: of the base system. But some details are different. This is because
3051: pkgsrc initially came from FreeBSD and had adopted its file system
3052: hierarchy. Later it was largely influenced by NetBSD. But no matter
3053: which operating system you are using pkgsrc with, you can expect the
3054: same layout for pkgsrc.</p>
1.91 rillig 3055: <p>There are mainly four root directories for pkgsrc, which are all
3056: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
3057: When pkgsrc has been installed as root, the default locations
3058: are:</p>
3059: <pre class="programlisting">
1.100 rillig 3060: LOCALBASE= /usr/pkg
3061: PKG_SYSCONFBASE= /usr/pkg/etc
3062: VARBASE= /var
3063: PKG_DBDIR= /var/db/pkg
1.91 rillig 3064: </pre>
3065: <p>In unprivileged mode (when pkgsrc has been installed as any other
3066: user), the default locations are:</p>
3067: <pre class="programlisting">
1.100 rillig 3068: LOCALBASE= ${HOME}/pkg
3069: PKG_SYSCONFBASE= ${HOME}/pkg/etc
3070: VARBASE= ${HOME}/pkg/var
3071: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
1.91 rillig 3072: </pre>
3073: <p>What these four directories are for, and what they look like is
3074: explained below.</p>
1.90 rillig 3075: <div class="itemizedlist"><ul type="disc">
3076: <li><p><code class="varname">LOCALBASE</code> corresponds to the
3077: <code class="filename">/usr</code> directory in the base system. It is the
3078: “<span class="quote">main</span>” directory where the files are installed and contains
3079: the well-known subdirectories like <code class="filename">bin</code>,
3080: <code class="filename">include</code>, <code class="filename">lib</code>,
3081: <code class="filename">share</code> and
3082: <code class="filename">sbin</code>.</p></li>
3083: <li><p><code class="varname">VARBASE</code> corresponds to
3084: <code class="filename">/var</code> in the base system. Some programs (especially
3085: games, network daemons) need write access to it during normal
3086: operation.</p></li>
3087: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
3088: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 hubertf 3089: 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 3090: itself.</p></li>
3091: </ul></div>
3092: <div class="sect1" lang="en">
3093: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3094: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 3095: </h2></div></div></div>
1.90 rillig 3096: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 3097: in <code class="filename">${LOCALBASE}</code>.</p>
1.90 rillig 3098: <div class="variablelist"><dl>
3099: <dt><span class="term"><code class="filename">bin</code></span></dt>
3100: <dd><p>Contains executable programs that are intended to be
3101: directly used by the end user.</p></dd>
3102: <dt><span class="term"><code class="filename">emul</code></span></dt>
3103: <dd><p>Contains files for the emulation layers of various other
3104: operating systems, especially for
3105: NetBSD.</p></dd>
3106: <dt><span class="term"><code class="filename">etc</code> (the usual location of
3107: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3108: <dd><p>Contains
3109: the configuration files.</p></dd>
3110: <dt><span class="term"><code class="filename">include</code></span></dt>
3111: <dd><p>Contains headers for the C and C++ programming
3112: languages.</p></dd>
3113: <dt><span class="term"><code class="filename">info</code></span></dt>
3114: <dd><p>Contains GNU info files of various
3115: packages.</p></dd>
3116: <dt><span class="term"><code class="filename">lib</code></span></dt>
3117: <dd><p>Contains shared and static
3118: libraries.</p></dd>
3119: <dt><span class="term"><code class="filename">libdata</code></span></dt>
3120: <dd><p>Contains data files that don't change after
3121: installation. Other data files belong into
3122: <code class="filename">${VARBASE}</code>.</p></dd>
3123: <dt><span class="term"><code class="filename">libexec</code></span></dt>
3124: <dd><p>Contains programs that are not intended to be used by
3125: end users, such as helper programs or network
3126: daemons.</p></dd>
3127: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3128: <dd><p>Contains programs that are intended to be executed as
3129: CGI scripts by a web server.</p></dd>
3130: <dt><span class="term"><code class="filename">man</code> (the usual value of
3131: <code class="filename">${PKGMANDIR}</code>)</span></dt>
3132: <dd><p>Contains brief
3133: documentation in form of manual pages.</p></dd>
3134: <dt><span class="term"><code class="filename">sbin</code></span></dt>
3135: <dd><p>Contains programs that are intended to be used only by
3136: the super-user.</p></dd>
3137: <dt><span class="term"><code class="filename">share</code></span></dt>
3138: <dd><p>Contains platform-independent data files that don't
3139: change after installation.</p></dd>
3140: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3141: <dd><p>Contains documentation files provided by the
3142: packages.</p></dd>
3143: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3144: <dd><p>Contains example files provided by the packages. Among
3145: others, the original configuration files are saved here and copied to
3146: <code class="filename">${PKG_SYSCONFDIR}</code> during
3147: installation.</p></dd>
3148: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3149: <dd><p>Contains the original files for rc.d
3150: scripts.</p></dd>
3151: <dt><span class="term"><code class="filename">var</code> (the usual location of
3152: <code class="filename">${VARBASE}</code>)</span></dt>
3153: <dd><p>Contains files
3154: that may be modified after
3155: installation.</p></dd>
3156: </dl></div>
3157: </div>
3158: <div class="sect1" lang="en">
3159: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3160: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 3161: </h2></div></div></div>
1.90 rillig 3162: <div class="variablelist"><dl>
3163: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3164: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3165: <dd><p>Contains
3166: information about the currently installed
3167: packages.</p></dd>
3168: <dt><span class="term"><code class="filename">games</code></span></dt>
3169: <dd><p>Contains highscore
3170: files.</p></dd>
3171: <dt><span class="term"><code class="filename">log</code></span></dt>
3172: <dd><p>Contains log files.</p></dd>
3173: <dt><span class="term"><code class="filename">run</code></span></dt>
3174: <dd><p>Contains informational files about daemons that are
3175: currently running.</p></dd>
3176: </dl></div>
3177: </div>
3178: </div>
3179: <div class="chapter" lang="en">
3180: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3181: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 3182: <div class="toc">
3183: <p><b>Table of Contents</b></p>
3184: <dl>
1.106 rillig 3185: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
3186: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
3187: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
3188: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
3189: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
3190: <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>
3191: <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 3192: <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 3193: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.123 snj 3194: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does Don't know how to make
3195: /usr/share/tmac/tmac.andoc mean?</a></span></dt>
3196: <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 3197: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
3198: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
3199: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.123 snj 3200: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my CFLAGS?</a></span></dt>
1.106 rillig 3201: <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 3202: <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 3203: </dl>
3204: </div>
3205: <p>This section contains hints, tips & tricks on special things in
3206: pkgsrc that we didn't find a better place for in the previous chapters, and
3207: it contains items for both pkgsrc users and developers.</p>
3208: <div class="sect1" lang="en">
3209: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3210: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 3211: <p>The following mailing lists may be of interest to pkgsrc users:</p>
3212: <div class="itemizedlist"><ul type="disc">
1.110 hubertf 3213: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78 rillig 3214: This is a general purpose list for most issues regarding
3215: pkgsrc, regardless of platform, e.g. soliciting user help
3216: for pkgsrc configuration, unexpected build failures, using
3217: particular packages, upgrading pkgsrc installations,
3218: questions regarding the pkgsrc release branches, etc. General announcements or
3219: proposals for changes that impact the pkgsrc user community,
3220: e.g. major infrastructure changes, new features, package
3221: removals, etc., may also be posted.</p></li>
1.110 hubertf 3222: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75 rillig 3223: A list where the results of pkgsrc bulk builds are sent and
3224: discussed.</p></li>
1.110 hubertf 3225: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75 rillig 3226: This list is for those who are interested in getting a
3227: commit message for every change committed to pkgsrc. It is
3228: also available in digest form, meaning one daily message
3229: containing all commit messages for changes to the package
3230: source tree in that 24 hour period.</p></li>
3231: </ul></div>
3232: <p>To subscribe, do:</p>
3233: <pre class="programlisting">
1.100 rillig 3234: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 3235: </pre>
3236: <p>Archives for all these mailing lists are available from
1.110 hubertf 3237: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 3238: </div>
3239: <div class="sect1" lang="en">
3240: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3241: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75 rillig 3242: <p>Pkgviews is tightly integrated with buildlink. You can find a
3243: pkgviews User's guide in
1.76 rillig 3244: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75 rillig 3245: </div>
3246: <div class="sect1" lang="en">
3247: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3248: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 3249: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 3250: a number of useful utilities for both users and developers of pkgsrc. This
3251: section attempts only to make the reader aware of the utilities and when
3252: they might be useful, and not to duplicate the documentation that comes
3253: with each package.</p>
3254: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.91 rillig 3255: <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 3256: Symlinks for use by buildlink.</p></li></ul></div>
3257: <p>OS tool augmentation (automatically installed when needed):</p>
3258: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3259: <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 3260: Calculates various kinds of checksums (including SHA1).</p></li>
1.91 rillig 3261: <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 3262: Compatibility library for pkgsrc tools.</p></li>
1.91 rillig 3263: <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 3264: non-BSD systems due to lack of native mtree.</p></li>
1.91 rillig 3265: <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 3266: Up-to-date replacement for
1.76 rillig 3267: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 3268: systems where pkg_install is not present.</p></li>
3269: </ul></div>
3270: <p>Utilities used by pkgsrc (not automatically installed):</p>
3271: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3272: <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 3273: Create a binary package from an
1.110 hubertf 3274: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 3275: save the old package.</p></li>
1.91 rillig 3276: <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 3277: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3278: from multiple locations. It currently supports the following
3279: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.91 rillig 3280: <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 3281: packages someplace else (enabled by default).</p></li>
1.117 jnemeth 3282: <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
3283: the best compiler flags to optimise code for your current
3284: CPU and compiler. Setting <code class="varname">USE_CPUFLAGS</code> to
3285: yes in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> will cause pkgsrc to automatically use
3286: cpuflags. </p></li>
1.75 rillig 3287: </ul></div>
3288: <p>Utilities for keeping track of installed packages, being up to date,
3289: etc:</p>
3290: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3291: <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 3292: packages whose installed versions do not match the latest pkgsrc
3293: entries.</p></li>
1.91 rillig 3294: <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 3295: dependency graphs of packages, to aid in choosing a strategy for
3296: updating.</p></li>
1.91 rillig 3297: <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
3298: 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>
3299: <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 3300: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
3301: <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 3302: does various checks on the complete pkgsrc system.</p></li>
1.91 rillig 3303: <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 3304: packages you have installed.</p></li>
3305: </ul></div>
3306: <p>Utilities for people maintaining or creating individual packages:</p>
3307: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3308: <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 3309: making and maintaining patches for a package (includes pkgdiff,
3310: pkgvi, mkpatches, etc.).</p></li>
1.91 rillig 3311: <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>,
3312: <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 3313: converting to pkgsrc.</p></li>
1.91 rillig 3314: <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 3315: pkgsrc to a Solaris package.</p></li>
3316: </ul></div>
3317: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3318: utilities)</p>
3319: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3320: <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 3321: packages in a chrooted area.</p></li>
1.91 rillig 3322: <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 3323: kernel version for chrooted cross builds.</p></li>
3324: </ul></div>
3325: </div>
3326: <div class="sect1" lang="en">
3327: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3328: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75 rillig 3329: <p>If you want to use pkgsrc as non-root user, you can set some
3330: variables to make pkgsrc work under these conditions. At the very least,
3331: you need to set <code class="varname">UNPRIVILEGED</code> to “<span class="quote">yes</span>”; this
3332: will turn on unprivileged mode and set multiple related variables to allow
3333: installation of packages as non-root.</p>
3334: <p>In case the defaults are not enough, you may want to tune some other
3335: variables used. For example, if the automatic user/group detection leads
3336: to incorrect values (or not the ones you would like to use), you can change
3337: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3338: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3339: <p>As regards bootstrapping, please note that the
1.110 hubertf 3340: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.75 rillig 3341: given the “<span class="quote">--ignore-user-check</span>” flag, as it will choose and
1.76 rillig 3342: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93 rillig 3343: installation targets. These directories can be overridden by the
1.75 rillig 3344: “<span class="quote">--prefix</span>” flag provided by the script, as well as some others
3345: that allow finer tuning of the tree layout.</p>
3346: </div>
3347: <div class="sect1" lang="en">
3348: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3349: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 3350: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3351: enable this feature by adding the option
3352: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110 hubertf 3353: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 3354: distfile is found, pkgsrc will try to resume it.</p>
3355: <p>You can also
1.110 hubertf 3356: 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 3357: <code class="varname">FETCH_USING</code> variable. You can specify the program by
3358: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
3359: by using the value manual. A value of custom disables the system defaults
3360: and dependency tracking for the fetch program. In that case you have to
3361: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
3362: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
3363: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75 rillig 3364: <p>For example, if you want to use
1.117 jnemeth 3365: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 3366: like:</p>
3367: <pre class="programlisting">
1.117 jnemeth 3368: FETCH_USING= wget
1.1 grant 3369: </pre>
1.75 rillig 3370: </div>
3371: <div class="sect1" lang="en">
3372: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3373: <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 3374: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 3375: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 3376: you will have to add the following line into
1.110 hubertf 3377: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 3378: <pre class="programlisting">
1.103 wiz 3379: X11_TYPE=modular
1.1 grant 3380: </pre>
1.75 rillig 3381: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
3382: <h3 class="title">Note</h3>
1.103 wiz 3383: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3384: </p>
1.75 rillig 3385: </div>
3386: </div>
3387: <div class="sect1" lang="en">
3388: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3389: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 3390: <p>If you are sitting behind a firewall which does not allow direct
3391: connections to Internet hosts (i.e. non-NAT), you may specify the
3392: relevant proxy hosts. This is done using an environment variable in the
3393: form of a URL, e.g. in Amdahl, the machine
3394: “<span class="quote">orpheus.amdahl.com</span>” is one of the firewalls, and it uses
3395: port 80 as the proxy port number. So the proxy environment variables
3396: are:</p>
3397: <pre class="programlisting">
1.100 rillig 3398: ftp_proxy=ftp://orpheus.amdahl.com:80/
3399: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 3400: </pre>
1.75 rillig 3401: </div>
3402: <div class="sect1" lang="en">
3403: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 3404: <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 3405: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 3406: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 3407: the first available command from the following list:</p>
3408: <div class="itemizedlist"><ul type="disc">
1.76 rillig 3409: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3410: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 3411: </ul></div>
3412: <p>On a default NetBSD installation, this will be
1.76 rillig 3413: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 3414: connections first, and falls back to active connections if the server
3415: refuses to do passive. For the other tools, add the following to your
1.110 hubertf 3416: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 3417: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3418: <p>Having that option present will prevent
1.76 rillig 3419: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 3420: transfers.</p>
3421: </div>
3422: <div class="sect1" lang="en">
3423: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3424: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3425: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 3426: from work or university, where you can't run a <span class="command"><strong>make
3427: 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 3428: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 3429: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 3430: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3431: resulting list to your machine at work/school and use it there. If you
1.110 hubertf 3432: 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 3433: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3434: URL:</p>
3435: <p>At home:</p>
3436: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3437: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3438: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3439: <p>At work:</p>
3440: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3441: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3442: home.</p>
3443: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3444: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3445: machine architecture), you can do so by using the above-mentioned
1.110 hubertf 3446: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 3447: directly by running:</p>
1.75 rillig 3448: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3449: <p>If you even decide to ignore
3450: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3451: by running:</p>
3452: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3453: </div>
3454: <div class="sect1" lang="en">
3455: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3456: <a name="tmac.andoc-missing"></a>9.10. What does “<span class="quote">Don't know how to make
1.75 rillig 3457: /usr/share/tmac/tmac.andoc</span>” mean?</h2></div></div></div>
1.91 rillig 3458: <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 3459: package, you get the error from make that it doesn't know how to make
1.76 rillig 3460: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.75 rillig 3461: you don't have installed the “<span class="quote">text</span>” set (nroff, ...) from
3462: the NetBSD base distribution on your machine. It is recommended to do
3463: that to format man pages.</p>
1.91 rillig 3464: <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 3465: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 3466: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 3467: </div>
3468: <div class="sect1" lang="en">
3469: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3470: <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 3471: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3472: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3473: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3474: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3475: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3476: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 3477: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 3478: -r</strong></span>).</p>
3479: </div>
3480: <div class="sect1" lang="en">
3481: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3482: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 3483: <p>When installing packages as non-root user and using the just-in-time
1.110 hubertf 3484: <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 3485: password for each required package installed. To avoid this, the sudo
3486: package can be used, which does password caching over a limited time. To
3487: use it, install sudo (either as binary package or from
1.98 wiz 3488: <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 3489: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 3490: <span class="emphasis"><em>after</em></span> the definition of the
3491: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 3492: <pre class="programlisting">
1.100 rillig 3493: .if exists(${LOCALBASE}/bin/sudo)
3494: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3495: .endif
1.1 grant 3496: </pre>
1.75 rillig 3497: </div>
3498: <div class="sect1" lang="en">
3499: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3500: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3501: <p>As the system administrator, you can choose where configuration files
3502: are installed. The default settings make all these files go into
1.76 rillig 3503: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3504: be suboptimal depending on your expectations (e.g., a read-only,
3505: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3506: configuration of the provided packages).</p>
3507: <p>In order to change the defaults, you can modify the
3508: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110 hubertf 3509: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 3510: directory; some common examples include <code class="filename">/etc</code> or
3511: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3512: <p>Furthermore, you can change this value on a per-package basis by
3513: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3514: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3515: package you would like to modify, that is, the contents of
3516: <code class="varname">PKGBASE</code>.</p>
3517: <p>Note that after changing these settings, you must rebuild and
3518: reinstall any affected packages.</p>
3519: </div>
3520: <div class="sect1" lang="en">
3521: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3522: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75 rillig 3523: <p>Please be aware that there can often be bugs in third-party software,
3524: and some of these bugs can leave a machine vulnerable to exploitation by
3525: attackers. In an effort to lessen the exposure, the NetBSD packages team
3526: maintains a database of known-exploits to packages which have at one time
3527: been included in pkgsrc. The database can be downloaded automatically, and
3528: a security audit of all packages installed on a system can take place. To
1.114 jmcneill 3529: do this, refer to the following two tools (installed as part of the
3530: <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 3531: <div class="orderedlist"><ol type="1">
3532: <li>
1.122 reed 3533: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 3534: download a list of the security vulnerabilities information. This list
3535: is kept up to date by the NetBSD security officer and the NetBSD
3536: packages team, and is distributed from the NetBSD ftp server:</p>
1.110 hubertf 3537: <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 3538: </li>
1.122 reed 3539: <li><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
1.75 rillig 3540: current machine, checking each vulnerability which is known. If a
3541: vulnerable package is installed, it will be shown by output to stdout,
3542: including a description of the type of vulnerability, and a URL
3543: containing more information.</p></li>
3544: </ol></div>
1.114 jmcneill 3545: <p>Use of these tools is strongly recommended! After
3546: “<span class="quote">pkg_install</span>” is installed, please read
1.75 rillig 3547: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.114 jmcneill 3548: pkg_install</code></strong>.</p>
1.87 wiz 3549: <p>If this package is installed, pkgsrc builds will use it to
1.110 hubertf 3550: 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 3551: check.</p>
1.75 rillig 3552: </div>
3553: <div class="sect1" lang="en">
3554: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3555: <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 3556: <p>When you add your own preferences to the
3557: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 3558: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3559: environment variables to the <code class="filename">./configure</code>
1.110 hubertf 3560: 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 3561: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3562: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3563: package.</p>
3564: <p>Currently there is no solution to this problem. If you
3565: really need the package to use your <code class="varname">CFLAGS</code>
1.110 hubertf 3566: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 3567: directory and then inspect any <code class="filename">Makefile</code> and
3568: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3569: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
3570: these lines. But be aware that some “<span class="quote">smart</span>”
3571: programmers write so bad code that it only works for the
3572: specific combination of <code class="varname">CFLAGS</code> they have
3573: chosen.</p>
3574: </div>
1.80 rillig 3575: <div class="sect1" lang="en">
3576: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3577: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.80 rillig 3578: <div class="procedure"><ol type="1">
3579: <li><p>Make sure that your copy of pkgsrc is consistent. A
3580: case that occurs often is that people only update pkgsrc in
3581: parts, because of performance reasons. Since pkgsrc is one large
3582: system, not a collection of many small systems, there are
3583: sometimes changes that only work when the whole pkgsrc tree is
3584: updated.</p></li>
3585: <li><p>Make sure that you don't have any CVS conflicts.
3586: Search for “<span class="quote"><<<<<<</span>” or
3587: “<span class="quote">>>>>>></span>” in all your pkgsrc
3588: files.</p></li>
3589: <li><p>Make sure that you don't have old copies of the packages
1.110 hubertf 3590: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 3591: verify this.</p></li>
3592: <li><p>If the problem still exists, write a mail to the
3593: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3594: </ol></div>
3595: </div>
1.88 wiz 3596: <div class="sect1" lang="en">
3597: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3598: <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 3599: <p>You have modified a file from pkgsrc, and someone else has
3600: modified that same file afterwards in the CVS repository. Both changes
3601: are in the same region of the file, so when you updated pkgsrc, the
3602: <code class="literal">cvs</code> command marked the conflicting changes in the
3603: file. Because of these markers, the file is no longer a valid
3604: <code class="filename">Makefile</code>.</p>
3605: <p>Have a look at that file, and if you don't need your local changes
1.110 hubertf 3606: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 3607: -dP</strong></span> in that directory to download the current version.</p>
3608: </div>
1.75 rillig 3609: </div>
3610: </div>
3611: <div class="part" lang="en">
3612: <div class="titlepage"><div><div><h1 class="title">
3613: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.77 rillig 3614: <div class="partintro" lang="en">
3615: <div></div>
3616: <p>This part of the book deals with creating and
3617: modifying packages. It starts with a “<span class="quote">HOWTO</span>”-like
3618: guide on creating a new package. The remaining chapters are more
3619: like a reference manual for pkgsrc.</p>
1.75 rillig 3620: <div class="toc">
3621: <p><b>Table of Contents</b></p>
3622: <dl>
1.106 rillig 3623: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 3624: <dd><dl>
1.106 rillig 3625: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3626: <dd><dl>
1.106 rillig 3627: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3628: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118 imil 3629: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3630: </dl></dd>
1.106 rillig 3631: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3632: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
3633: </dl></dd>
3634: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3635: <dd><dl>
1.123 snj 3636: <dt><span class="sect1"><a href="#components.Makefile">11.1. Makefile</a></span></dt>
3637: <dt><span class="sect1"><a href="#components.distinfo">11.2. distinfo</a></span></dt>
1.106 rillig 3638: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3639: <dd><dl>
3640: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3641: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3642: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3643: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3644: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3645: </dl></dd>
3646: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3647: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3648: <dd><dl>
3649: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3650: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3651: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3652: </dl></dd>
1.123 snj 3653: <dt><span class="sect1"><a href="#work-dir">11.6. work*</a></span></dt>
3654: <dt><span class="sect1"><a href="#files-dir">11.7. files/*</a></span></dt>
1.106 rillig 3655: </dl></dd>
1.123 snj 3656: <dt><span class="chapter"><a href="#makefile">12. Programming in Makefiles</a></span></dt>
1.106 rillig 3657: <dd><dl>
3658: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.123 snj 3659: <dt><span class="sect1"><a href="#makefile.variables">12.2. Makefile variables</a></span></dt>
1.106 rillig 3660: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3661: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3662: <dd><dl>
3663: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3664: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3665: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3666: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3667: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3668: </dl></dd>
3669: </dl></dd>
3670: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3671: <dd><dl>
3672: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.123 snj 3673: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic PLIST generation</a></span></dt>
3674: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of make print-PLIST</a></span></dt>
1.106 rillig 3675: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3676: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.123 snj 3677: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with PLIST_SRC</a></span></dt>
1.106 rillig 3678: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
3679: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
3680: </dl></dd>
3681: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3682: <dd><dl>
3683: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.123 snj 3684: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing buildlink3.mk files</a></span></dt>
1.106 rillig 3685: <dd><dl>
3686: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.123 snj 3687: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files</a></span></dt>
1.106 rillig 3688: </dl></dd>
1.123 snj 3689: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing builtin.mk files</a></span></dt>
1.106 rillig 3690: <dd><dl>
1.123 snj 3691: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a builtin.mk file</a></span></dt>
1.106 rillig 3692: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3693: </dl></dd>
3694: </dl></dd>
3695: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3696: <dd><dl>
3697: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3698: <dd><dl>
3699: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3700: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3701: </dl></dd>
3702: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3703: <dd><dl>
1.123 snj 3704: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How PKG_SYSCONFDIR is set</a></span></dt>
1.106 rillig 3705: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3706: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3707: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3708: </dl></dd>
3709: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3710: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
3711: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3712: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3713: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3714: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3715: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
3716: </dl></dd>
3717: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3718: <dd><dl>
3719: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.123 snj 3720: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use bsd.options.mk</a></span></dt>
1.106 rillig 3721: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 3722: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 3723: </dl></dd>
3724: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3725: <dd><dl>
3726: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3727: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3728: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3729: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.123 snj 3730: <dt><span class="sect1"><a href="#build.fetch">17.5. The fetch phase</a></span></dt>
1.106 rillig 3731: <dd><dl>
3732: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3733: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3734: </dl></dd>
1.123 snj 3735: <dt><span class="sect1"><a href="#build.checksum">17.6. The checksum phase</a></span></dt>
3736: <dt><span class="sect1"><a href="#build.extract">17.7. The extract phase</a></span></dt>
3737: <dt><span class="sect1"><a href="#build.patch">17.8. The patch phase</a></span></dt>
3738: <dt><span class="sect1"><a href="#build.tools">17.9. The tools phase</a></span></dt>
3739: <dt><span class="sect1"><a href="#build.wrapper">17.10. The wrapper phase</a></span></dt>
3740: <dt><span class="sect1"><a href="#build.configure">17.11. The configure phase</a></span></dt>
3741: <dt><span class="sect1"><a href="#build.build">17.12. The build phase</a></span></dt>
3742: <dt><span class="sect1"><a href="#build.test">17.13. The test phase</a></span></dt>
3743: <dt><span class="sect1"><a href="#build.install">17.14. The install phase</a></span></dt>
3744: <dt><span class="sect1"><a href="#build.package">17.15. The package phase</a></span></dt>
1.106 rillig 3745: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3746: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3747: </dl></dd>
3748: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3749: <dd><dl>
3750: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3751: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3752: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3753: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3754: </dl></dd>
3755: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3756: <dd><dl>
3757: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3758: <dd><dl>
3759: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.123 snj 3760: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from ???</a></span></dt>
1.106 rillig 3761: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3762: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3763: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3764: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3765: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3766: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3767: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3768: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3769: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3770: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3771: </dl></dd>
1.123 snj 3772: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the fetch phase</a></span></dt>
1.106 rillig 3773: <dd><dl>
3774: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3775: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
3776: </dl></dd>
1.123 snj 3777: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the configure phase</a></span></dt>
1.106 rillig 3778: <dd><dl>
3779: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3780: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3781: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3782: </dl></dd>
3783: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3784: <dd><dl>
3785: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3786: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3787: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
3788: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
3789: </dl></dd>
1.123 snj 3790: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the build phase</a></span></dt>
1.106 rillig 3791: <dd><dl>
3792: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3793: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.123 snj 3794: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to ...</a></span></dt>
1.106 rillig 3795: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3796: </dl></dd>
1.123 snj 3797: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the install phase</a></span></dt>
1.106 rillig 3798: <dd><dl>
3799: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3800: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3801: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3802: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3803: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3804: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3805: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3806: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 3807: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 3808: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 3809: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3810: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3811: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3812: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3813: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3814: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3815: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3816: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 3817: emulation</a></span></dt>
1.106 rillig 3818: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3819: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 3820: </dl></dd>
1.106 rillig 3821: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3822: </dl></dd>
1.106 rillig 3823: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3824: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 3825: <dd><dl>
1.106 rillig 3826: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3827: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3828: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
3829: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
3830: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 3831: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
3832: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 3833: </dl></dd>
3834: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3835: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3836: <dd><dl>
3837: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3838: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3839: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3840: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 3841: </dl></dd>
1.75 rillig 3842: </dl>
3843: </div>
1.77 rillig 3844: </div>
3845: <div class="chapter" lang="en">
3846: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3847: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 3848: <div class="toc">
3849: <p><b>Table of Contents</b></p>
3850: <dl>
1.106 rillig 3851: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3852: <dd><dl>
1.106 rillig 3853: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3854: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118 imil 3855: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3856: </dl></dd>
1.106 rillig 3857: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3858: <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 3859: </dl>
3860: </div>
1.77 rillig 3861: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 3862: most likely have a URL from where you can download the source
3863: code. Starting with this URL, creating a package involves only a
3864: few steps.</p>
1.77 rillig 3865: <div class="procedure"><ol type="1">
1.91 rillig 3866: <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 3867: <li><p>Then, choose one of the top-level directories as the
1.91 rillig 3868: category in which you want to place your package. You can also create a
3869: directory of your own (maybe called <code class="filename">local</code>). In that
3870: category directory, create another directory for your package and change
3871: into it.</p></li>
1.110 hubertf 3872: <li><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91 rillig 3873: you for a URL. Enter the URL of the distribution file (in most cases a
3874: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3875: of your package are created automatically. The distribution file is
3876: extracted automatically to fill in some details in the
3877: <code class="filename">Makefile</code> that would otherwise have to be done
3878: manually.</p></li>
3879: <li>
3880: <p>Examine the extracted files to determine the dependencies of
3881: your package. Ideally, this is mentioned in some
3882: <code class="filename">README</code> file, but things may differ. For each of
3883: these dependencies, look where it exists in pkgsrc, and if there is a
3884: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3885: line to your package <code class="filename">Makefile</code> which includes that
3886: file just before the last line. If the
3887: <code class="filename">buildlink3.mk</code> file does not exist, add a
3888: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3889: version of the dependency and where it can be found in pkgsrc. This line
3890: should be placed in the third paragraph. If the dependency is only
3891: needed for building the package, but not when using it, use
3892: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3893: Your package may then look like this:</p>
1.77 rillig 3894: <pre class="programlisting">
1.100 rillig 3895: [...]
1.77 rillig 3896:
1.100 rillig 3897: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
3898: DEPENDS+= screen-[0-9]*:../../misc/screen
3899: DEPENDS+= screen>=4.0:../../misc/screen
1.77 rillig 3900:
1.100 rillig 3901: [...]
1.77 rillig 3902:
1.100 rillig 3903: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3904: .include "../../devel/glib2/buildlink3.mk"
3905: .include "../../mk/bsd.pkg.mk"
1.77 rillig 3906: </pre>
3907: </li>
1.110 hubertf 3908: <li><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.91 rillig 3909: to be done to make your package a “<span class="quote">good</span>” one. If you don't
1.110 hubertf 3910: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3911: --explain</strong></span> or <span class="command"><strong>pkglint
1.91 rillig 3912: -e</strong></span>, which outputs additional
3913: explanations.</p></li>
3914: <li><p>In many cases the package is not yet ready to build. You can
1.110 hubertf 3915: 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 3916: over there, you can hopefully continue here.</p></li>
1.110 hubertf 3917: <li><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91 rillig 3918: directory from the extracted files. Besides these files, a lot of cache
3919: files and other system information has been saved in the working
3920: directory, which may become wrong after you edited the
3921: <code class="filename">Makefile</code>.</p></li>
1.110 hubertf 3922: <li><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
3923: 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 3924: <li><p>When the package builds fine, the next step is to install
1.110 hubertf 3925: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91 rillig 3926: everything works.</p></li>
3927: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
3928: contains a list of the files that are installed by the package, is
1.110 hubertf 3929: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91 rillig 3930: >PLIST</strong></span> to generate a probably correct list. Check
3931: the file using your preferred text editor to see if the list of
3932: files looks plausible.</p></li>
1.110 hubertf 3933: <li><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91 rillig 3934: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.110 hubertf 3935: <li><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91 rillig 3936: has been registered in the database of installed files, but with an
1.110 hubertf 3937: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3938: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91 rillig 3939: registered with the list of files from
3940: <code class="filename">PLIST</code>.</p></li>
1.110 hubertf 3941: <li><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91 rillig 3942: package from the set of installed files.</p></li>
1.77 rillig 3943: </ol></div>
1.91 rillig 3944: <div class="sect1" lang="en">
3945: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3946: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.91 rillig 3947: <div class="sect2" lang="en">
3948: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3949: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91 rillig 3950: <p>Simple Perl modules are handled automatically by
1.110 hubertf 3951: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91 rillig 3952: </div>
3953: <div class="sect2" lang="en">
3954: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3955: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.91 rillig 3956: <p>KDE applications should always include
3957: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
3958: settings that are typical of KDE packages.</p>
3959: </div>
1.118 imil 3960: <div class="sect2" lang="en">
3961: <div class="titlepage"><div><div><h3 class="title">
3962: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3963: <p>Python modules and programs packages are easily created using a
3964: set of predefined variables.</p>
3965: <p>Most Python packages use either “<span class="quote">distutils</span>” or
3966: easy-setup (“<span class="quote">eggs</span>”).
3967: If the software uses “<span class="quote">distutils</span>”, set the
3968: <code class="varname">PYDISTUTILSPKG</code> variable to “<span class="quote">yes</span>” so
3969: pkgsrc will make use of this framework.
3970: “<span class="quote">distutils</span>” uses a script called <code class="filename">setup.py</code>,
3971: if the “<span class="quote">distutils</span>” driver is not called
3972: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3973: to the name of the script.</p>
3974: <p>
3975: If the default Python versions are not supported by the software, set the
3976: <code class="varname">PYTHON_VERSIONS_ACCEPTED</code> variable to the Python versions
3977: the software is known to work with, from the most recent to the older
3978: one, e.g.
3979: </p>
3980: <pre class="programlisting">
1.126 ! jakllsch 3981: PYTHON_VERSIONS_ACCEPTED= 25 24
1.118 imil 3982: </pre>
3983: <p>
3984: If the packaged software is a Python module, include
3985: “<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>”.
3986: In this case, the package directory should be called
3987: “<span class="quote">py-software</span>” and <code class="varname">PKGNAME</code> should be set to
3988: “<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”, e.g.
3989: </p>
3990: <pre class="programlisting">
3991: DISTNAME= foopymodule-1.2.10
3992: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3993: </pre>
3994: <p>If it is an application, also include
3995: “<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”
3996: before “<span class="quote">extension.mk</span>”.</p>
3997: <p>If the packaged software, either it is an application or a module, is
3998: egg-aware, you only need to include
3999: “<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”.</p>
4000: <p>In order to correctly set the path to the Python interpreter, use the
4001: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
4002: that must be corrected. For example :
4003: </p>
4004: <pre class="programlisting">
4005: REPLACE_PYTHON= ${WRKSRC}/*.py
4006: </pre>
4007: </div>
1.91 rillig 4008: </div>
4009: <div class="sect1" lang="en">
4010: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4011: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.91 rillig 4012: <div class="sect2" lang="en">
4013: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4014: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.91 rillig 4015: <div class="sect3" lang="en">
4016: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 4017: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91 rillig 4018: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
4019: that the “<span class="quote">nvu</span>” package has not yet been imported into
4020: pkgsrc. As the description says it has to do with the web, the obvious
4021: choice for the category is “<span class="quote">www</span>”.</p>
4022: <pre class="programlisting">
1.100 rillig 4023: <code class="prompt">$</code> mkdir www/nvu
4024: <code class="prompt">$</code> cd www/nvu
1.91 rillig 4025: </pre>
4026: <p>The web site says that the sources are available as a tar file, so
1.110 hubertf 4027: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91 rillig 4028: <pre class="programlisting">
1.100 rillig 4029: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91 rillig 4030: </pre>
4031: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
4032: below the <code class="varname">DISTNAME</code> line, as the package name should
4033: not have the word “<span class="quote">sources</span>” in it. I also filled in the
4034: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
4035: <code class="varname">COMMENT</code> fields. Then the package
4036: <code class="filename">Makefile</code> looked like that:</p>
4037: <pre class="programlisting">
1.100 rillig 4038: # $NetBSD$
4039: #
1.91 rillig 4040:
1.100 rillig 4041: DISTNAME= nvu-1.0-sources
4042: PKGNAME= nvu-1.0
4043: CATEGORIES= www
4044: MASTER_SITES= http://cvs.nvu.com/download/
4045: EXTRACT_SUFX= .tar.bz2
4046:
4047: MAINTAINER= rillig@NetBSD.org
4048: HOMEPAGE= http://cvs.nvu.com/
4049: COMMENT= Web Authoring System
1.91 rillig 4050:
1.100 rillig 4051: # url2pkg-marker (please do not remove this line.)
4052: .include "../../mk/bsd.pkg.mk"
1.91 rillig 4053: </pre>
4054: <p>Then, I quit the editor and watched pkgsrc downloading a large
4055: source archive:</p>
4056: <pre class="programlisting">
1.100 rillig 4057: url2pkg> Running "make makesum" ...
4058: => Required installed package digest>=20010302: digest-20060826 found
4059: => Fetching nvu-1.0-sources.tar.bz2
4060: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4061: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
4062: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4063: url2pkg> Running "make extract" ...
4064: => Required installed package digest>=20010302: digest-20060826 found
4065: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4066: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4067: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4068: ===> Installing dependencies for nvu-1.0
4069: ===> Overriding tools for nvu-1.0
4070: ===> Extracting for nvu-1.0
4071: url2pkg> Adjusting the Makefile.
1.91 rillig 4072:
1.100 rillig 4073: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91 rillig 4074:
1.100 rillig 4075: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91 rillig 4076: </pre>
4077: </div>
4078: <div class="sect3" lang="en">
4079: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 4080: <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 4081: <p>Now that the package has been extracted, let's see what's inside
4082: it. The package has a <code class="filename">README.txt</code>, but that only
4083: says something about mozilla, so it's probably useless for seeing what
4084: dependencies this package has. But since there is a GNU configure script
4085: in the package, let's hope that it will complain about everything it
4086: needs.</p>
4087: <pre class="programlisting">
1.100 rillig 4088: <code class="prompt">$</code> bmake
4089: => Required installed package digest>=20010302: digest-20060826 found
4090: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4091: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4092: ===> Patching for nvu-1.0
4093: ===> Creating toolchain wrappers for nvu-1.0
4094: ===> Configuring for nvu-1.0
4095: [...]
4096: configure: error: Perl 5.004 or higher is required.
4097: [...]
4098: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4099: [...]
1.91 rillig 4100: </pre>
4101: <p>That worked quite well. So I opened the package Makefile in my
4102: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
4103: just appended “<span class="quote">perl</span>” to it. Since the dependencies of the
4104: package have changed now, and since a perl wrapper is automatically
4105: installed in the “<span class="quote">tools</span>” phase, I need to build the package
4106: from scratch.</p>
4107: <pre class="programlisting">
1.100 rillig 4108: <code class="prompt">$</code> bmake clean
4109: ===> Cleaning for nvu-1.0
4110: <code class="prompt">$</code> bmake
4111: [...]
4112: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4113: GNU Make. You will not be able to build Mozilla without GNU Make.
4114: [...]
1.91 rillig 4115: </pre>
4116: <p>So I added “<span class="quote">gmake</span>” to the
4117: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4118: <pre class="programlisting">
1.100 rillig 4119: [...]
4120: checking for GTK - version >= 1.2.0... no
4121: *** Could not run GTK test program, checking why...
4122: [...]
1.91 rillig 4123: </pre>
4124: <p>Now to the other dependencies. The first question is: Where is the
4125: GTK package hidden in pkgsrc?</p>
4126: <pre class="programlisting">
1.100 rillig 4127: <code class="prompt">$</code> echo ../../*/gtk*
4128: [many packages ...]
4129: <code class="prompt">$</code> echo ../../*/gtk
4130: ../../x11/gtk
4131: <code class="prompt">$</code> echo ../../*/gtk2
4132: ../../x11/gtk2
4133: <code class="prompt">$</code> echo ../../*/gtk2/bui*
4134: ../../x11/gtk2/buildlink3.mk
1.91 rillig 4135: </pre>
4136: <p>The first try was definitely too broad. The second one had exactly
4137: one result, which is very good. But there is one pitfall with GNOME
4138: packages. Before GNOME 2 had been released, there were already many
4139: GNOME 1 packages in pkgsrc. To be able to continue to use these
4140: packages, the GNOME 2 packages were imported as separate packages, and
4141: their names usually have a “<span class="quote">2</span>” appended. So I checked
4142: whether this was the case here, and indeed it was.</p>
4143: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4144: file, adding the dependency is very easy. I just inserted an
4145: <code class="literal">.include</code> line before the last line of the package
4146: <code class="filename">Makefile</code>, so that it now looks like this:</p>
4147: <pre class="programlisting">
1.100 rillig 4148: [...]
4149: .include "../../x11/gtk2/buildlink3.mk"
4150: .include "../../mk/bsd.pkg.mk
1.91 rillig 4151: </pre>
1.110 hubertf 4152: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.91 rillig 4153: was:</p>
4154: <pre class="programlisting">
1.100 rillig 4155: [...]
4156: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4157: checking for GTK - version >= 1.2.0... no
4158: *** Could not run GTK test program, checking why...
4159: *** The test program failed to compile or link. See the file config.log for the
4160: *** exact error that occured. This usually means GTK was incorrectly installed
4161: *** or that you have moved GTK since it was installed. In the latter case, you
4162: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4163: configure: error: Test for GTK failed.
4164: [...]
1.91 rillig 4165: </pre>
4166: <p>In this particular case, the assumption that “<span class="quote">every package
4167: prefers GNOME 2</span>” had been wrong. The first of the lines above
4168: told me that this package really wanted to have the GNOME 1 version of
4169: GTK. If the package had looked for GTK2, it would have looked for
1.110 hubertf 4170: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91 rillig 4171: So I changed the <code class="literal">x11/gtk2</code> to
4172: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4173: and tried again.</p>
4174: <pre class="programlisting">
1.100 rillig 4175: [...]
4176: 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
4177: In file included from xpidl.c:42:
4178: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4179: In file included from xpidl.c:42:
4180: xpidl.h:132: error: parse error before "IDL_ns"
4181: [...]
1.91 rillig 4182: </pre>
4183: <p>The package still does not find all of its dependencies. Now the
4184: question is: Which package provides the
4185: <code class="filename">libIDL/IDL.h</code> header file?</p>
4186: <pre class="programlisting">
1.100 rillig 4187: <code class="prompt">$</code> echo ../../*/*idl*
4188: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4189: <code class="prompt">$</code> echo ../../*/*IDL*
4190: ../../net/libIDL
1.91 rillig 4191: </pre>
4192: <p>Let's take the one from the second try. So I included the
4193: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4194: again. But the error didn't change. After digging through some of the
4195: code, I concluded that the build process of the package was broken and
4196: couldn't have ever worked, but since the Mozilla source tree is quite
4197: large, I didn't want to fix it. So I added the following to the package
4198: <code class="filename">Makefile</code> and tried again:</p>
4199: <pre class="programlisting">
1.100 rillig 4200: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4201: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
1.91 rillig 4202: </pre>
4203: <p>The latter line is needed because the package expects the library
4204: <code class="filename">libIDL.so</code>, but only
4205: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4206: wrapper to rewrite that on the fly.</p>
4207: <p>The next problem was related to a recent change of the FreeType
4208: 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>
4209: which patch files were relevant for this issue and copied them to the
4210: <code class="filename">patches</code> directory. Then I retried, fixed the
4211: patches so that they applied cleanly and retried again. This time,
4212: everything worked.</p>
4213: </div>
4214: <div class="sect3" lang="en">
4215: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 4216: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91 rillig 4217: <pre class="programlisting">
1.100 rillig 4218: <code class="prompt">$</code> bmake CHECK_FILES=no install
4219: [...]
4220: <code class="prompt">$</code> bmake print-PLIST >PLIST
4221: <code class="prompt">$</code> bmake deinstall
4222: <code class="prompt">$</code> bmake install
1.91 rillig 4223: </pre>
4224: </div>
4225: </div>
4226: </div>
1.77 rillig 4227: </div>
1.75 rillig 4228: <div class="chapter" lang="en">
4229: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4230: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 4231: <div class="toc">
4232: <p><b>Table of Contents</b></p>
4233: <dl>
1.123 snj 4234: <dt><span class="sect1"><a href="#components.Makefile">11.1. Makefile</a></span></dt>
4235: <dt><span class="sect1"><a href="#components.distinfo">11.2. distinfo</a></span></dt>
1.106 rillig 4236: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
4237: <dd><dl>
4238: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
4239: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
4240: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
4241: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
4242: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
4243: </dl></dd>
4244: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
4245: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
4246: <dd><dl>
4247: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
4248: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
4249: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 4250: </dl></dd>
1.123 snj 4251: <dt><span class="sect1"><a href="#work-dir">11.6. work*</a></span></dt>
4252: <dt><span class="sect1"><a href="#files-dir">11.7. files/*</a></span></dt>
1.75 rillig 4253: </dl>
4254: </div>
1.87 wiz 4255: <p>Whenever you're preparing a package, there are a number of
4256: files involved which are described in the following
4257: sections.</p>
1.75 rillig 4258: <div class="sect1" lang="en">
4259: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4260: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93 rillig 4261: </h2></div></div></div>
1.75 rillig 4262: <p>Building, installation and creation of a binary package are all
1.87 wiz 4263: controlled by the package's <code class="filename">Makefile</code>.
4264: The <code class="filename">Makefile</code> describes various things about
4265: a package, for example from where to get it, how to configure,
4266: build, and install it.</p>
1.76 rillig 4267: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 4268: sections that describe the package.</p>
1.75 rillig 4269: <p>In the first section there are the following variables, which
1.87 wiz 4270: should appear exactly in the order given here. The order and
4271: grouping of the variables is mostly historical and has no further
4272: meaning.</p>
1.75 rillig 4273: <div class="itemizedlist"><ul type="disc">
4274: <li><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 4275: distribution file to be downloaded from the package's
4276: website.</p></li>
1.75 rillig 4277: <li><p><code class="varname">PKGNAME</code> is the name of the
1.87 wiz 4278: package, as used by pkgsrc. You only need to provide it if
4279: <code class="varname">DISTNAME</code> (which is the default) is not a good
4280: name for the package in pkgsrc. Usually it is the pkgsrc
4281: directory name together with the version number. It must match the
4282: regular expression
4283: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4284: starts with a letter or digit, and contains only letters, digits,
4285: dashes, underscores, dots and plus signs.</p></li>
4286: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
4287: the package file to create if the <code class="varname">PKGNAME</code>
4288: isn't unique on a SVR4 system. The default is
4289: <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91 rillig 4290: <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 4291: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4292: does not produce an unique package name on a SVR4 system.
4293: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4294: characters.</p></li>
1.75 rillig 4295: <li>
4296: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 4297: which the package fits in. You can choose any of the top-level
4298: directories of pkgsrc for it.</p>
1.75 rillig 4299: <p>Currently the following values are available for
1.87 wiz 4300: <code class="varname">CATEGORIES</code>. If more than
4301: one is used, they need to be separated by spaces:</p>
1.75 rillig 4302: <pre class="programlisting">
1.100 rillig 4303: archivers cross geography meta-pkgs security
4304: audio databases graphics misc shells
4305: benchmarks devel ham multimedia sysutils
4306: biology editors inputmethod net textproc
4307: cad emulators lang news time
4308: chat finance mail parallel wm
4309: comms fonts math pkgtools www
4310: converters games mbone print x11
4311: </pre>
1.75 rillig 4312: </li>
1.81 rillig 4313: <li><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 4314: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4315: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4316: and <code class="varname">DISTFILES</code> are discussed in detail in
1.123 snj 4317: <a class="xref" href="#build.fetch" title="17.5. The fetch phase">Section 17.5, “The fetch phase”</a>.</p></li>
1.75 rillig 4318: </ul></div>
4319: <p>The second section contains information about separately
1.87 wiz 4320: downloaded patches, if any.
4321: </p>
1.75 rillig 4322: <div class="itemizedlist"><ul type="disc">
4323: <li><p><code class="varname">PATCHFILES:</code>
1.87 wiz 4324: Name(s) of additional files that contain distribution patches.
4325: There is no default. pkgsrc will look for them at
4326: <code class="varname">PATCH_SITES</code>.
4327: They will automatically be uncompressed before patching if
4328: the names end with <code class="filename">.gz</code> or
4329: <code class="filename">.Z</code>.</p></li>
1.75 rillig 4330: <li><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 4331: Primary location(s) for distribution patch files (see
4332: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75 rillig 4333: </ul></div>
4334: <p>The third section contains the following variables.
1.87 wiz 4335: </p>
1.75 rillig 4336: <div class="itemizedlist"><ul type="disc">
1.114 jmcneill 4337: <li><p><code class="varname">MAINTAINER</code> is the email
4338: address of the person who feels responsible for this package,
4339: and who is most likely to look at problems or questions regarding
4340: 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>.
4341: Other developers may contact the <code class="varname">MAINTAINER</code>
4342: before making changes to the package, but are not required to
4343: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4344: to yourself. If you really can't maintain the package for future
4345: updates, set it to
1.110 hubertf 4346: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.114 jmcneill 4347: <li><p><code class="varname">OWNER</code> should be used instead
4348: of <code class="varname">MAINTAINER</code> when you do not want other
4349: developers to update or change the package without contacting
4350: you first. A package Makefile should contain one of
4351: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4352: not both. </p></li>
1.75 rillig 4353: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 4354: find more information about the package.</p></li>
1.75 rillig 4355: <li><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 4356: description of the package (should not include the package
4357: name).</p></li>
1.75 rillig 4358: </ul></div>
4359: <p>Other variables that affect the build:
1.87 wiz 4360: </p>
1.75 rillig 4361: <div class="itemizedlist"><ul type="disc"><li>
4362: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 4363: interesting distribution files of the package are found. The
4364: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4365: works for most packages.</p>
1.75 rillig 4366: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 4367: (most GNU software does, for instance), but extracts itself in
4368: the current directory, you should set
4369: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4370: <p>If a package doesn't create a subdirectory with the
4371: name of <code class="varname">DISTNAME</code> but some different name,
4372: set <code class="varname">WRKSRC</code> to point to the proper name in
4373: <code class="filename">${WRKDIR}</code>, for example
4374: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91 rillig 4375: <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 4376: <p>The name of the working directory created by pkgsrc is
1.87 wiz 4377: taken from the <code class="varname">WRKDIR_BASENAME</code>
4378: variable. By default, its value is
4379: <code class="filename">work</code>. If you want to use the same
4380: pkgsrc tree for building different kinds of binary packages,
4381: you can change the variable according to your needs. Two
4382: other variables handle common cases of setting
4383: <code class="varname">WRKDIR_BASENAME</code> individually. If
4384: <code class="varname">OBJHOSTNAME</code> is defined in
1.110 hubertf 4385: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87 wiz 4386: the host's name is attached to the directory name. If
4387: <code class="varname">OBJMACHINE</code> is defined, the platform name
4388: is attached, which might look like
4389: <code class="filename">work.i386</code> or
4390: <code class="filename">work.sparc</code>.</p>
1.75 rillig 4391: </li></ul></div>
4392: <p>Please pay attention to the following gotchas:</p>
4393: <div class="itemizedlist"><ul type="disc">
1.87 wiz 4394: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 4395: installed in compressed form by the package. For packages using
4396: BSD-style makefiles which honor MANZ, there is
4397: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.76 rillig 4398: <li><p>Replace <code class="filename">/usr/local</code> with
1.88 wiz 4399: “<span class="quote">${PREFIX}</span>” in all files (see patches,
4400: below).</p></li>
1.110 hubertf 4401: <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 4402: </ul></div>
4403: </div>
4404: <div class="sect1" lang="en">
4405: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4406: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93 rillig 4407: </h2></div></div></div>
1.76 rillig 4408: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4409: digest, or checksum, of each distfile needed for the package. This
4410: ensures that the distfiles retrieved from the Internet have not been
4411: corrupted during transfer or altered by a malign force to introduce
4412: a security hole. Due to recent rumor about weaknesses of digest
4413: algorithms, all distfiles are protected using both SHA1 and RMD160
4414: message digests, as well as the file size.</p>
1.76 rillig 4415: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4416: checksums for all the patches found in the
1.110 hubertf 4417: <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 4418: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110 hubertf 4419: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87 wiz 4420: command.</p>
1.75 rillig 4421: <p>Some packages have different sets of distfiles depending on
1.91 rillig 4422: 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 4423: <code class="filename">distinfo</code> file and care should be taken when
4424: upgrading such a package to ensure distfile information is not
4425: lost.</p>
1.75 rillig 4426: </div>
4427: <div class="sect1" lang="en">
4428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4429: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93 rillig 4430: <p>Many packages still don't work out-of-the box on the various
4431: platforms that are supported by pkgsrc. Therefore, a number of custom
4432: patch files are needed to make the package work. These patch files are
4433: found in the <code class="filename">patches/</code> directory.</p>
4434: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4435: applied to the files in <code class="varname">WRKSRC</code> directory after
1.110 hubertf 4436: 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 4437: order</a>, so <code class="filename">patch-aa</code> is applied before
1.87 wiz 4438: <code class="filename">patch-ab</code>, etc.</p>
1.93 rillig 4439: <div class="sect2" lang="en">
4440: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4441: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 4442: <p>The <code class="filename">patch-*</code> files should be in
1.110 hubertf 4443: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 4444: problems. (To force patches to apply with fuzz you can set
4445: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 4446: should contain only changes for a single file, and no file should be
1.93 rillig 4447: patched by more than one patch file. This helps to keep future
4448: modifications simple.</p>
4449: <p>Each patch file is structured as follows: In the first line,
4450: there is the RCS Id of the patch itself. The second line should be
4451: empty for aesthetic reasons. After that, there should be a comment for
4452: each change that the patch does. There are a number of standard
4453: cases:</p>
4454: <div class="itemizedlist"><ul type="disc">
4455: <li><p>Patches that replace the <code class="literal">==</code>
1.110 hubertf 4456: 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 4457: are so common that they don't need a comment at all.</p></li>
1.93 rillig 4458: <li><p>Patches for commonly known vulnerabilities should
4459: mention the vulnerability ID (CAN, CVE).</p></li>
4460: <li><p>Patches that change source code should mention the
4461: platform and other environment (for example, the compiler) that the
4462: patch is needed for.</p></li>
4463: </ul></div>
4464: <p>In all other cases, the patch should be commented so that any
4465: developer who knows the code of the application can make some use of
4466: the patch. Special care should be taken for the upstream developers,
4467: since we generally want that they accept our patches, so we have less
4468: work in the future.</p>
4469: </div>
4470: <div class="sect2" lang="en">
4471: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4472: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93 rillig 4473: <p>One important thing to mention is to pay attention that no RCS
4474: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 4475: later checked into the NetBSD CVS tree. Use the
1.110 hubertf 4476: <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 4477: problems.</p>
1.87 wiz 4478: <p>For even more automation, we recommend using
1.110 hubertf 4479: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87 wiz 4480: whole set of patches. You just have to backup files before you
4481: edit them to <code class="filename">filename.orig</code>, e.g. with
1.110 hubertf 4482: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4483: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87 wiz 4484: you upgrade a package this way, you can easily compare the new
4485: set of patches with the previously existing one with
1.110 hubertf 4486: <span class="command"><strong>patchdiff</strong></span>. Copy the patches you want to use
1.87 wiz 4487: or update from the <code class="filename">work/.newpatches</code>
4488: directory to <code class="filename">patches/</code>.</p>
4489: <p>When you have finished a package, remember to generate
1.110 hubertf 4490: the checksums for the patch files by using the <span class="command"><strong>make
1.123 snj 4491: makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="11.2. distinfo">Section 11.2, “distinfo”</a>.</p>
1.87 wiz 4492: <p>When adding a patch that corrects a problem in the
4493: distfile (rather than e.g. enforcing pkgsrc's view of where
4494: man pages should go), send the patch as a bug report to the
4495: maintainer. This benefits non-pkgsrc users of the package,
4496: and usually makes it possible to remove the patch in future
4497: version.</p>
1.101 rillig 4498: <p>The file names of the patch files are usually of the form
4499: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.93 rillig 4500: </div>
4501: <div class="sect2" lang="en">
4502: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4503: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 4504: <p>If you want to share patches between multiple packages
4505: in pkgsrc, e.g. because they use the same distfiles, set
4506: <code class="varname">PATCHDIR</code> to the path where the patch files
4507: can be found, e.g.:</p>
4508: <pre class="programlisting">
1.100 rillig 4509: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 4510: </pre>
1.75 rillig 4511: <p>Patch files that are distributed by the author or other
1.87 wiz 4512: maintainers can be listed in
4513: <code class="varname">PATCHFILES</code>.</p>
4514: <p>If it is desired to store any patches that should not be
4515: committed into pkgsrc, they can be kept outside the pkgsrc
4516: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4517: directory tree there is expected to have the same
4518: “<span class="quote">category/package</span>” structure as pkgsrc, and
4519: patches are expected to be stored inside these dirs (also
4520: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4521: example, if you want to keep a private patch for
4522: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4523: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4524: files in the named directory are expected to be patch files,
4525: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4526: applied</em></span>.</p>
1.93 rillig 4527: </div>
1.85 jmmv 4528: <div class="sect2" lang="en">
4529: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4530: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 4531: <p>When fixing a portability issue in the code do not use
4532: preprocessor magic to check for the current operating system nor
4533: platform. Doing so hurts portability to other platforms because
4534: the OS-specific details are not abstracted appropriately.</p>
4535: <p>The general rule to follow is: instead of checking for the
4536: operating system the application is being built on, check for the
4537: specific <span class="emphasis"><em>features</em></span> you need. For example,
4538: instead of assuming that kqueue is available under NetBSD and
4539: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126 ! jakllsch 4540: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4541: yes, this generally involves patching the
1.110 hubertf 4542: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.85 jmmv 4543: that prevents some OSes from adopting interfaces from other OSes
4544: (e.g. Linux implementing kqueue), something that the above checks
4545: cannot take into account.</p>
4546: <p>Of course, checking for features generally involves more
4547: work on the developer's side, but the resulting changes are
1.87 wiz 4548: cleaner and there are chances they will work on many other
1.85 jmmv 4549: platforms. Not to mention that there are higher chances of being
4550: later integrated into the mainstream sources. Remember:
4551: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4552: <p>Some typical examples:</p>
4553: <div class="table">
1.106 rillig 4554: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.91 rillig 4555: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4556: <colgroup>
4557: <col>
4558: <col>
4559: <col>
4560: </colgroup>
4561: <thead><tr>
4562: <th>Where</th>
4563: <th>Incorrect</th>
4564: <th>Correct</th>
4565: </tr></thead>
4566: <tbody>
4567: <tr>
4568: <td>configure script</td>
4569: <td>
1.100 rillig 4570: <pre class="programlisting">
4571: case ${target_os} in
4572: netbsd*) have_kvm=yes ;;
4573: *) have_kvm=no ;;
4574: esac
4575: </pre>
1.85 jmmv 4576: </td>
4577: <td>
1.100 rillig 4578: <pre class="programlisting">
4579: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4580: </pre>
1.85 jmmv 4581: </td>
4582: </tr>
4583: <tr>
4584: <td>C source file</td>
4585: <td>
1.100 rillig 4586: <pre class="programlisting">
4587: #if defined(__NetBSD__)
4588: # include <sys/event.h>
4589: #endif
4590: </pre>
1.85 jmmv 4591: </td>
4592: <td>
1.100 rillig 4593: <pre class="programlisting">
4594: #if defined(HAVE_SYS_EVENT_H)
4595: # include <sys/event.h>
4596: #endif
4597: </pre>
1.85 jmmv 4598: </td>
4599: </tr>
4600: <tr>
4601: <td>C source file</td>
4602: <td>
1.100 rillig 4603: <pre class="programlisting">
4604: int
4605: monitor_file(...)
4606: {
4607: #if defined(__NetBSD__)
4608: int fd = kqueue();
4609: ...
4610: #else
4611: ...
4612: #endif
4613: }
4614: </pre>
1.85 jmmv 4615: </td>
4616: <td>
1.100 rillig 4617: <pre class="programlisting">
4618: int
4619: monitor_file(...)
4620: {
4621: #if defined(HAVE_KQUEUE)
4622: int fd = kqueue();
4623: ...
4624: #else
4625: ...
4626: #endif
4627: }
4628: </pre>
1.85 jmmv 4629: </td>
4630: </tr>
4631: </tbody>
1.91 rillig 4632: </table></div>
1.85 jmmv 4633: </div>
1.91 rillig 4634: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110 hubertf 4635: 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
4636: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85 jmmv 4637: 2</a>). It summarizes multiple details on how to make
4638: software easier to package; all the suggestions in it were
4639: collected from our experience in pkgsrc work, so they are possibly
4640: helpful when creating patches too.</p>
4641: </div>
4642: <div class="sect2" lang="en">
4643: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4644: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 4645: <p>Always, always, <span class="strong"><strong>always</strong></span>
4646: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4647: improvements you do to a package to the mainstream developers.
4648: This is the only way to get their attention on portability issues
4649: and to ensure that future versions can be built out-of-the box on
4650: NetBSD. Furthermore, any user that gets newer distfiles will get
4651: the fixes straight from the packaged code.</p>
1.93 rillig 4652: <p>This generally involves cleaning up the patches
4653: (because sometimes the patches that are
1.85 jmmv 4654: added to pkgsrc are quick hacks), filling bug reports in the
4655: appropriate trackers for the projects and working with the
4656: mainstream authors to accept your changes. It is
4657: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4658: the packages in pkgsrc are kept simple and thus further changes
4659: can be done without much hassle.</p>
4660: <p>Support the idea of free software!</p>
4661: </div>
1.75 rillig 4662: </div>
4663: <div class="sect1" lang="en">
4664: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4665: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.75 rillig 4666: <div class="variablelist"><dl>
1.76 rillig 4667: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4668: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4669: any credits where they are due. Please bear in mind that others do not
4670: share your sense of humour (or spelling idiosyncrasies), and that others
4671: will read everything that you write here.</p></dd>
1.76 rillig 4672: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4673: <dd><p>This file governs the files that are installed on your
4674: system: all the binaries, manual pages, etc. There are other
4675: directives which may be entered in this file, to control the
4676: creation and deletion of directories, and the location of
1.110 hubertf 4677: 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 4678: information.</p></dd>
1.75 rillig 4679: </dl></div>
4680: </div>
4681: <div class="sect1" lang="en">
4682: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4683: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.78 rillig 4684: <div class="sect2" lang="en">
4685: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4686: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.75 rillig 4687: <div class="variablelist"><dl>
1.76 rillig 4688: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.110 hubertf 4689: <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 4690: First time after package extraction and before files are
4691: moved in place, the second time after the files to install
4692: are moved in place. This can be used to do any custom
4693: procedures not possible with @exec commands in
1.110 hubertf 4694: <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
4695: <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 4696: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4697: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4698: this script's responsibility to clean up any additional messy details
4699: around the package's installation, since all pkg_delete knows is how to
4700: delete the files created in the original distribution.
1.110 hubertf 4701: 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>
4702: 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 4703: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4704: <dd>
4705: <p>This file is displayed after installation of the package.
1.87 wiz 4706: Useful for things like legal notices on almost-free
4707: software and hints for updating config files after
4708: installing modules for apache, PHP etc.
4709: Please note that you can modify variables in it easily by using
4710: <code class="varname">MESSAGE_SUBST</code> in the package's
4711: <code class="filename">Makefile</code>:</p>
1.75 rillig 4712: <pre class="programlisting">
1.100 rillig 4713: MESSAGE_SUBST+= SOMEVAR="somevalue"
4714: </pre>
1.75 rillig 4715: <p>replaces "${SOMEVAR}" with “<span class="quote">somevalue</span>” in
1.87 wiz 4716: <code class="filename">MESSAGE</code>. By default, substitution is
4717: performed for <code class="varname">PKGNAME</code>,
4718: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4719: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4720: <code class="varname">X11BASE</code>,
4721: <code class="varname">PKG_SYSCONFDIR</code>,
4722: <code class="varname">ROOT_GROUP</code>, and
1.117 jnemeth 4723: <code class="varname">ROOT_USER</code>.</p>
1.87 wiz 4724: <p>You can display a different or additional files by
4725: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4726: default is <code class="filename">MESSAGE</code>, if the file
4727: exists.</p>
1.75 rillig 4728: </dd>
1.78 rillig 4729: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4730: <dd><p>FIXME: There is no documentation on the
4731: alternatives framework.</p></dd>
4732: </dl></div>
4733: </div>
4734: <div class="sect2" lang="en">
4735: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4736: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.78 rillig 4737: <div class="variablelist"><dl>
4738: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4739: <dd><p>This file contains arbitrary things that could
4740: also go into a <code class="filename">Makefile</code>, but its purpose is
4741: to be used by more than one package. This file should only be
4742: used when the packages that will use the file are known in
4743: advance. For other purposes it is often better to write a
4744: <code class="filename">*.mk</code> file and give it a good name that
4745: describes what it does.</p></dd>
4746: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4747: <dd><p>This file contains the dependency information
1.110 hubertf 4748: 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 4749: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4750: <dd><p>This file contains workarounds for compiler bugs
4751: and similar things. It is included automatically by the pkgsrc
4752: infrastructure, so you don't need an extra
4753: <code class="literal">.include</code> line for
4754: it.</p></dd>
4755: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4756: <dd><p>This file contains the code for the
1.110 hubertf 4757: 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 4758: selected by the user. If a package has only one or two options,
4759: it is equally acceptable to put the code directly into the
4760: <code class="filename">Makefile</code>.</p></dd>
4761: </dl></div>
4762: </div>
4763: <div class="sect2" lang="en">
4764: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4765: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.78 rillig 4766: <div class="variablelist"><dl>
4767: <dt><span class="term"><code class="filename">README*</code></span></dt>
4768: <dd><p>These files do not take place in the creation of
4769: a package and thus are purely informative to the package
4770: developer.</p></dd>
4771: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4772: <dd><p>This file contains things that need to be done
4773: to make the package even
4774: better.</p></dd>
1.75 rillig 4775: </dl></div>
4776: </div>
1.78 rillig 4777: </div>
1.75 rillig 4778: <div class="sect1" lang="en">
4779: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4780: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93 rillig 4781: </h2></div></div></div>
1.110 hubertf 4782: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87 wiz 4783: unpacked into the directory denoted by
4784: <code class="varname">WRKDIR</code>. It can be removed by running
1.110 hubertf 4785: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87 wiz 4786: directory is also used to keep various timestamp files.
4787: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4788: The default is <code class="filename">${.CURDIR}/work</code>
4789: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4790: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4791: </div>
4792: <div class="sect1" lang="en">
4793: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4794: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93 rillig 4795: </h2></div></div></div>
1.75 rillig 4796: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4797: to configuration or building, you could place these files here and use
1.110 hubertf 4798: a <span class="command"><strong>${CP}</strong></span> command in the
1.87 wiz 4799: “<span class="quote">pre-configure</span>” target to achieve
4800: this. Alternatively, you could simply diff the file against
4801: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4802: the creation of this file.</p>
4803: <p>If you want to share files in this way with other
4804: packages, set the <code class="varname">FILESDIR</code> variable to point
4805: to the other package's <code class="filename">files</code> directory,
4806: e.g.:</p>
4807: <pre class="programlisting">
1.100 rillig 4808: FILESDIR=${.CURDIR}/../xemacs/files
4809: </pre>
1.75 rillig 4810: </div>
4811: </div>
4812: <div class="chapter" lang="en">
4813: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4814: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4815: <div class="toc">
4816: <p><b>Table of Contents</b></p>
4817: <dl>
1.106 rillig 4818: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.123 snj 4819: <dt><span class="sect1"><a href="#makefile.variables">12.2. Makefile variables</a></span></dt>
1.106 rillig 4820: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4821: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4822: <dd><dl>
4823: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4824: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4825: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4826: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4827: <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 4828: </dl></dd>
4829: </dl>
4830: </div>
1.76 rillig 4831: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4832: each of which forms a well-defined part of the pkgsrc system. Using
1.110 hubertf 4833: 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 4834: like pkgsrc requires some discipline to keep the code correct and
4835: understandable.</p>
1.76 rillig 4836: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4837: programming are variables (which are actually macros) and shell
4838: commands. Among these shell commands may even be more complex ones
1.110 hubertf 4839: 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 4840: as intended it is necessary to quote all variables correctly when they
4841: are used.</p>
4842: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4843: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4844: with them.</p>
4845: <div class="sect1" lang="en">
4846: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4847: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.97 rillig 4848: <div class="itemizedlist"><ul type="disc"><li>
4849: <p>When you are creating a file as a
4850: target of a rule, always write the data to a temporary file first
4851: and finally rename that file. Otherwise there might occur an error
4852: in the middle of generating the file, and when the user runs
1.110 hubertf 4853: <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 4854: regenerated properly. Example:</p>
4855: <pre class="programlisting">
1.100 rillig 4856: wrong:
4857: @echo "line 1" > ${.TARGET}
4858: @echo "line 2" >> ${.TARGET}
4859: @false
4860:
4861: correct:
4862: @echo "line 1" > ${.TARGET}.tmp
4863: @echo "line 2" >> ${.TARGET}.tmp
4864: @false
4865: @mv ${.TARGET}.tmp ${.TARGET}
1.97 rillig 4866: </pre>
1.110 hubertf 4867: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97 rillig 4868: <code class="filename">wrong</code> will exist, although there was an error
1.110 hubertf 4869: message in the first run. On the other hand, running <span class="command"><strong>make
1.97 rillig 4870: correct</strong></span> gives an error message twice, as expected.</p>
1.110 hubertf 4871: <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 4872: <code class="literal">${.TARGET}</code> in case of error, but this only
4873: happens when it is interrupted, for example by pressing
4874: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.110 hubertf 4875: 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 4876: </li></ul></div>
4877: </div>
4878: <div class="sect1" lang="en">
4879: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4880: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4881: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4882: can be processed using the five operators ``='', ``+='', ``?='',
1.110 hubertf 4883: ``:='', 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 4884: page.</p>
4885: <p>When a variable's value is parsed from a
1.76 rillig 4886: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4887: backslash character ``\'' are handled specially. If a backslash is
4888: followed by a newline, any whitespace immediately in front of the
4889: backslash, the backslash, the newline, and any whitespace
4890: immediately behind the newline are replaced with a single space. A
4891: backslash character and an immediately following hash character are
4892: replaced with a single hash character. Otherwise, the backslash is
4893: passed as is. In a variable assignment, any hash character that is
4894: not preceded by a backslash starts a comment that continues upto the
4895: end of the logical line.</p>
4896: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4897: the only way to create a variable consisting of a single backslash
4898: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4899: <p>So far for defining variables. The other thing you can do with
4900: variables is evaluating them. A variable is evaluated when it is
4901: part of the right side of the ``:='' or the ``!='' operator, or
4902: directly before executing a shell command which the variable is part
1.110 hubertf 4903: 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 4904: is, variables are not evaluated until there's no other way. The
4905: ``modifiers'' mentioned in the man page also evaluate the
4906: variable.</p>
4907: <p>Some of the modifiers split the string into words and then
4908: operate on the words, others operate on the string as a whole. When
4909: a string is split into words, it is split as you would expect
1.110 hubertf 4910: 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 4911: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.75 rillig 4912: loop does not follow the shell quoting rules but splits at sequences
4913: of whitespace.</p>
4914: <p>There are several types of variables that should be handled
4915: differently. Strings and two types of lists.</p>
4916: <div class="itemizedlist"><ul type="disc">
4917: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
4918: characters. Nevertheless, you should restrict yourself to only
4919: using printable characters. Examples are
4920: <code class="varname">PREFIX</code> and
4921: <code class="varname">COMMENT</code>.</p></li>
4922: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
4923: are never exported to any shell command. Their elements are
4924: separated by whitespace. Therefore, the elements themselves cannot
4925: have embedded whitespace. Any other characters are allowed.
1.110 hubertf 4926: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75 rillig 4927: Examples are <code class="varname">DEPENDS</code> and
4928: <code class="varname">BUILD_DEPENDS</code>.</p></li>
4929: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
4930: may be exported to a shell command. Their elements can contain any
4931: characters, including whitespace. That's why they cannot be used
1.110 hubertf 4932: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75 rillig 4933: <code class="varname">DISTFILES</code> and
4934: <code class="varname">MASTER_SITES</code>.</p></li>
4935: </ul></div>
4936: <div class="sect2" lang="en">
4937: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4938: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.75 rillig 4939: <div class="itemizedlist"><ul type="disc">
4940: <li><p>All variable names starting with an underscore
4941: are reserved for use by the pkgsrc infrastructure. They shall
4942: not be used by package
1.76 rillig 4943: <code class="filename">Makefile</code>s.</p></li>
1.110 hubertf 4944: <li><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75 rillig 4945: lowercase variable names for the iteration
4946: variables.</p></li>
4947: <li><p>All list variables should have a ``plural''
4948: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4949: <code class="varname">DISTFILES</code>.</p></li>
4950: </ul></div>
4951: </div>
4952: </div>
4953: <div class="sect1" lang="en">
4954: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4955: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75 rillig 4956: <p>This section presents you with some code snippets you should
4957: use in your own code. If you don't find anything appropriate here,
4958: you should test your code and add it here.</p>
4959: <div class="sect2" lang="en">
4960: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4961: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75 rillig 4962: <pre class="programlisting">
1.100 rillig 4963: STRING= foo * bar `date`
4964: INT_LIST= # empty
4965: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4966: EXT_LIST= # empty
4967: ANOTHER_EXT_LIST= a=b c=d
4968:
4969: INT_LIST+= ${STRING} # 1
4970: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4971: EXT_LIST+= ${STRING:Q} # 3
4972: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 4973: </pre>
1.75 rillig 4974: <p>When you add a string to an external list (example 3), it
4975: must be quoted. In all other cases, you must not add a quoting
4976: level. You must not merge internal and external lists, unless you
4977: are sure that all entries are correctly interpreted in both
4978: lists.</p>
4979: </div>
4980: <div class="sect2" lang="en">
4981: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4982: <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 4983: <pre class="programlisting">
1.100 rillig 4984: EXT_LIST= # empty
4985: .for i in ${INT_LIST}
4986: EXT_LIST+= ${i:Q}""
4987: .endfor
1.1 grant 4988: </pre>
1.75 rillig 4989: <p>This code converts the internal list
4990: <code class="varname">INT_LIST</code> into the external list
4991: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4992: are unquoted they must be quoted here. The reason for appending
4993: <code class="varname">""</code> is explained below.</p>
4994: </div>
4995: <div class="sect2" lang="en">
4996: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4997: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 4998: <p>Sometimes you may want to print an arbitrary string. There
4999: are many ways to get it wrong and only few that can handle every
5000: nastiness.</p>
1.75 rillig 5001: <pre class="programlisting">
1.100 rillig 5002: STRING= foo bar < > * `date` $$HOME ' "
5003: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 5004:
1.100 rillig 5005: all:
5006: echo ${STRING} # 1
5007: echo "${STRING}" # 2
5008: echo "${STRING:Q}" # 3
5009: echo ${STRING:Q} # 4
5010: echo x${STRING:Q} | sed 1s,.,, # 5
5011: printf "%s\\n" ${STRING:Q}"" # 6
5012: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 5013: </pre>
1.75 rillig 5014: <p>Example 1 leads to a syntax error in the shell, as the
5015: characters are just copied.</p>
5016: <p>Example 2 leads to a syntax error too, and if you leave out
5017: the last " character from <code class="varname">${STRING}</code>,
1.110 hubertf 5018: <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 5019: variable would be evaluated, too.</p>
5020: <p>Example 3 outputs each space character preceded by a
5021: backslash (or not), depending on the implementation of the
1.110 hubertf 5022: <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 5023: <p>Example 4 handles correctly every string that does not start
5024: with a dash. In that case, the result depends on the
1.110 hubertf 5025: 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 5026: guarantee that your input does not start with a dash, this form is
5027: appropriate.</p>
5028: <p>Example 5 handles even the case of a leading dash
5029: correctly.</p>
1.79 rillig 5030: <p>Example 6 also works with every string and is the
5031: light-weight solution, since it does not involve a pipe, which has
5032: its own problems.</p>
1.75 rillig 5033: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
5034: because the quoting has already been done when adding elements to
5035: the list.</p>
5036: <p>As internal lists shall not be passed to the shell, there is
5037: no example for it.</p>
5038: </div>
5039: <div class="sect2" lang="en">
5040: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5041: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75 rillig 5042: <p>There are many possible sources of wrongly quoted variables.
5043: This section lists some of the commonly known ones.</p>
5044: <div class="itemizedlist"><ul type="disc">
5045: <li>
5046: <p>Whenever you use the value of a list, think
5047: about what happens to leading or trailing whitespace. If the
5048: list is a well-formed shell expression, you can apply the
5049: <code class="varname">:M*</code> modifier to strip leading and trailing
5050: whitespace from each word. The <code class="varname">:M</code> operator
5051: first splits its argument according to the rules of the shell,
5052: and then creates a new list consisting of all words that match
5053: the shell glob expression <code class="varname">*</code>, that is: all.
5054: One class of situations where this is needed is when adding a
5055: variable like <code class="varname">CPPFLAGS</code> to
5056: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
5057: invokes other configure scripts, it strips the leading and
5058: trailing whitespace from the variable and then passes it to the
5059: other configure scripts. But these configure scripts expect the
5060: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
5061: the parent <code class="varname">CPPFLAGS</code>. That's why we better
5062: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
5063: here is how we do it:</p>
5064: <pre class="programlisting">
1.100 rillig 5065: CPPFLAGS= # empty
5066: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
5067: CPPFLAGS+= ${MY_CPPFLAGS}
5068:
5069: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
5070:
5071: all:
5072: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5073: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 5074: </pre>
1.75 rillig 5075: </li>
5076: <li><p>The example above contains one bug: The
5077: <code class="varname">${PREFIX}</code> is a properly quoted shell
5078: expression, but there is the C compiler after it, which also
5079: expects a properly quoted string (this time in C syntax). The
5080: version above is therefore only correct if
5081: <code class="varname">${PREFIX}</code> does not have embedded backslashes
5082: or double quotes. If you want to allow these, you have to add
5083: another layer of quoting to each variable that is used as a C
5084: string literal. You cannot use the <code class="varname">:Q</code>
5085: operator for it, as this operator only works for the
5086: shell.</p></li>
5087: <li>
5088: <p>Whenever a variable can be empty, the
5089: <code class="varname">:Q</code> operator can have surprising results. Here
5090: are two completely different cases which can be solved with the
5091: same trick.</p>
5092: <pre class="programlisting">
1.100 rillig 5093: EMPTY= # empty
5094: empty_test:
5095: for i in a ${EMPTY:Q} c; do \
5096: echo "$$i"; \
5097: done
5098:
5099: for_test:
5100: .for i in a:\ a:\test.txt
5101: echo ${i:Q}
5102: echo "foo"
5103: .endfor
1.1 grant 5104: </pre>
1.75 rillig 5105: <p>The first example will only print two of the three lines
5106: we might have expected. This is because
5107: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5108: the shell cannot see. The workaround is to write
5109: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5110: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5111: -f ${FNAME:Q}</code> (both of these are wrong).</p>
5112: <p>The second example will only print three lines instead of
5113: four. The first line looks like <code class="varname">a:\ echo foo</code>.
5114: This is because the backslash of the value
5115: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.110 hubertf 5116: <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
5117: <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 5118: <code class="varname">${i:Q}""</code>.</p>
5119: </li>
5120: </ul></div>
5121: </div>
5122: <div class="sect2" lang="en">
5123: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5124: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 5125: <p>The pkgsrc bmake program does not handle the following
5126: assignment correctly. In case <code class="varname">_othervar_</code>
5127: contains a ``-'' character, one of the closing braces is included
5128: in <code class="varname">${VAR}</code> after this code executes.</p>
5129: <pre class="programlisting">
1.100 rillig 5130: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 5131: </pre>
1.75 rillig 5132: <p>For a more complex code snippet and a workaround, see the
1.91 rillig 5133: 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 5134: <code class="varname">bug1</code>.</p>
5135: </div>
5136: </div>
5137: </div>
5138: <div class="chapter" lang="en">
5139: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5140: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75 rillig 5141: <div class="toc">
5142: <p><b>Table of Contents</b></p>
5143: <dl>
1.106 rillig 5144: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.123 snj 5145: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic PLIST generation</a></span></dt>
5146: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of make print-PLIST</a></span></dt>
1.106 rillig 5147: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
5148: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.123 snj 5149: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with PLIST_SRC</a></span></dt>
1.106 rillig 5150: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
5151: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.75 rillig 5152: </dl>
5153: </div>
1.87 wiz 5154: <p>The <code class="filename">PLIST</code> file contains a package's
5155: “<span class="quote">packing list</span>”, i.e. a list of files that belong to
5156: the package (relative to the <code class="filename">${PREFIX}</code>
5157: directory it's been installed in) plus some additional statements
1.110 hubertf 5158: - 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 5159: This chapter addresses some issues that need attention when
5160: dealing with the <code class="filename">PLIST</code> file (or files, see
5161: below!).</p>
1.75 rillig 5162: <div class="sect1" lang="en">
5163: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5164: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87 wiz 5165: <p>Be sure to add a RCS ID line as the first thing in any
5166: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 5167: <pre class="programlisting">
1.100 rillig 5168: @comment $NetBSD$
1.87 wiz 5169: </pre>
1.75 rillig 5170: </div>
5171: <div class="sect1" lang="en">
5172: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5173: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110 hubertf 5174: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87 wiz 5175: to output a PLIST that matches any new files since the package
1.110 hubertf 5176: 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 5177: more information on this target.</p>
1.75 rillig 5178: </div>
5179: <div class="sect1" lang="en">
5180: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 5181: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93 rillig 5182: </h2></div></div></div>
1.87 wiz 5183: <p>If you have used any of the *-dirs packages, as explained in
1.110 hubertf 5184: <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
5185: <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.87 wiz 5186: <code class="varname">@comment</code>s instead of real
5187: <code class="varname">@dirrm</code> lines. You can also do this for
5188: specific directories and files, so that the results of that
5189: command are very close to reality. This helps <span class="emphasis"><em>a
5190: lot</em></span> during the update of packages.</p>
5191: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5192: of AWK patterns and actions that are used to filter the output of
5193: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5194: scripting you like to it, but be careful with quoting.</p>
5195: <p>For example, to get all files inside the
5196: <code class="filename">libdata/foo</code> directory removed from the
5197: resulting PLIST:</p>
5198: <pre class="programlisting">
1.100 rillig 5199: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.87 wiz 5200: </pre>
5201: <p>And to get all the <code class="varname">@dirrm</code> lines referring
5202: to a specific (shared) directory converted to
5203: <code class="varname">@comment</code>s:</p>
1.75 rillig 5204: <pre class="programlisting">
1.100 rillig 5205: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87 wiz 5206: </pre>
1.75 rillig 5207: </div>
5208: <div class="sect1" lang="en">
5209: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5210: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 5211: <p>A number of variables are substituted automatically in
5212: PLISTs when a package is installed on a system. This includes the
5213: following variables:</p>
1.75 rillig 5214: <div class="variablelist"><dl>
5215: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5216: <dd>
5217: <p>Some packages like emacs and perl embed information
1.87 wiz 5218: about which architecture they were built on into the
5219: pathnames where they install their files. To handle this
5220: case, PLIST will be preprocessed before actually used, and
5221: the symbol
5222: “<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>” will be
1.110 hubertf 5223: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87 wiz 5224: same is done if the string
5225: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5226: PLIST somewhere - use this on packages that have GNU
5227: autoconf-created configure scripts.</p>
1.75 rillig 5228: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
5229: <h3 class="title">Legacy note</h3>
5230: <p>There used to be a symbol
1.87 wiz 5231: “<span class="quote"><code class="varname">$ARCH</code></span>” that
1.110 hubertf 5232: was replaced by the output of <span class="command"><strong>uname
1.87 wiz 5233: -m</strong></span>, but that's no longer supported and has
5234: been removed.</p>
1.75 rillig 5235: </div>
5236: </dd>
5237: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5238: <dd>
5239: <p>Some packages want to embed the OS name and version
1.87 wiz 5240: into some paths. To do this, use these variables in the
5241: <code class="filename">PLIST</code>:
5242: </p>
1.75 rillig 5243: <div class="itemizedlist"><ul type="disc">
1.110 hubertf 5244: <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 5245: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. “<span class="quote">solaris</span>”)</p></li>
1.110 hubertf 5246: <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 5247: </ul></div>
5248: </dd>
5249: </dl></div>
1.87 wiz 5250: <p>For a complete list of values which are replaced by
5251: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5252: search for <code class="varname">PLIST_SUBST</code>).</p>
5253: <p>If you want to change other variables not listed above, you
5254: can add variables and their expansions to this variable in the
1.110 hubertf 5255: 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 5256: <pre class="programlisting">
1.100 rillig 5257: PLIST_SUBST+= SOMEVAR="somevalue"
1.87 wiz 5258: </pre>
1.75 rillig 5259: <p>This replaces all occurrences of “<span class="quote">${SOMEVAR}</span>”
1.87 wiz 5260: in the <code class="filename">PLIST</code> with
5261: “<span class="quote">somevalue</span>”.</p>
1.120 snj 5262: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119 mishka 5263: the common case of conditionally including some
5264: <code class="filename">PLIST</code> entries. It can be done by adding
5265: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120 snj 5266: setting the corresponding <code class="varname">PLIST.foo</code> variable
5267: to <code class="literal">yes</code> if the entry should be included.
1.119 mishka 5268: This will substitute “<span class="quote"><code class="varname">${PLIST.foo}</code></span>”
5269: in the <code class="filename">PLIST</code> with either
5270: “<span class="quote"><code class="literal">""</code></span>” or
5271: “<span class="quote"><code class="literal">"@comment "</code></span>”.
5272: For example, in <code class="filename">Makefile</code>:</p>
5273: <pre class="programlisting">
5274: PLIST_VARS+= foo
5275: .if <em class="replaceable"><code>condition</code></em>
5276: PLIST.foo= yes
5277: .else
5278: </pre>
5279: <p>And then in <code class="filename">PLIST</code>:</p>
5280: <pre class="programlisting">
5281: @comment $NetBSD$
5282: bin/bar
5283: man/man1/bar.1
5284: ${PLIST.foo}bin/foo
5285: ${PLIST.foo}man/man1/foo.1
5286: ${PLIST.foo}share/bar/foo.data
5287: ${PLIST.foo}@dirrm share/bar
5288: </pre>
1.75 rillig 5289: </div>
5290: <div class="sect1" lang="en">
5291: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5292: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75 rillig 5293: <p>Man pages should be installed in compressed form if
1.87 wiz 5294: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5295: and uncompressed otherwise. To handle this in the
5296: <code class="filename">PLIST</code> file, the suffix “<span class="quote">.gz</span>” is
5297: appended/removed automatically for man pages according to
5298: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5299: or not, see above for details. This modification of the
5300: <code class="filename">PLIST</code> file is done on a copy of it, not
5301: <code class="filename">PLIST</code> itself.</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="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93 rillig 5306: </h2></div></div></div>
1.76 rillig 5307: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5308: in generating the binary package, set the variable
5309: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.110 hubertf 5310: 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 5311: important. The default for <code class="varname">PLIST_SRC</code> is
5312: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5313: </div>
5314: <div class="sect1" lang="en">
5315: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5316: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5317: <p>Some packages decide to install a different set of files based on
1.87 wiz 5318: the operating system being used. These differences can be
5319: automatically handled by using the following files:</p>
1.75 rillig 5320: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5321: <li><p><code class="filename">PLIST.common</code></p></li>
5322: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5323: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5324: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5325: <li><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5326: </ul></div>
5327: </div>
5328: <div class="sect1" lang="en">
5329: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5330: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.87 wiz 5331: <p>A “<span class="quote">shared directory</span>” is a directory where
5332: multiple (and unrelated) packages install files. These
1.125 wiz 5333: directories were problematic because you had to add special
5334: tricks in the PLIST to conditionally remove them, or have some
1.87 wiz 5335: centralized package handle them.</p>
1.125 wiz 5336: <p>In pkgsrc, it is now easy: Each package should create
5337: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
5338: will remove any directories left empty after uninstalling a
5339: package.</p>
5340: <p>If a package needs an empty directory to work, create
5341: the directory during installation as usual, and also add an
5342: entry to the PLIST:
5343: </p>
1.87 wiz 5344: <pre class="programlisting">
1.125 wiz 5345: @pkgdir path/to/empty/directory
1.87 wiz 5346: </pre>
1.125 wiz 5347: <p>
5348: </p>
1.75 rillig 5349: </div>
5350: </div>
5351: <div class="chapter" lang="en">
5352: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5353: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75 rillig 5354: <div class="toc">
5355: <p><b>Table of Contents</b></p>
5356: <dl>
1.106 rillig 5357: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.123 snj 5358: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing buildlink3.mk files</a></span></dt>
1.75 rillig 5359: <dd><dl>
1.106 rillig 5360: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.123 snj 5361: <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 5362: </dl></dd>
1.123 snj 5363: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing builtin.mk files</a></span></dt>
1.75 rillig 5364: <dd><dl>
1.123 snj 5365: <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 5366: <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 5367: </dl></dd>
5368: </dl>
5369: </div>
5370: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5371: are seen by a package's configure and build processes. This is implemented
5372: in a two step process:</p>
1.75 rillig 5373: <div class="orderedlist"><ol type="1">
5374: <li><p>Symlink headers and libraries for dependencies into
1.87 wiz 5375: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5376: of <code class="varname">WRKDIR</code>.</p></li>
1.75 rillig 5377: <li><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5378: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5379: <code class="option">-L${LOCALBASE}/lib</code> into references to
5380: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5381: native compiler on some operating systems look like GCC, so that
5382: packages that expect GCC won't require modifications to build with
5383: those native compilers.</p></li>
1.75 rillig 5384: </ol></div>
5385: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5386: package may be built consistently despite what other software may be
5387: installed. Please note that the normal system header and library paths,
5388: e.g. <code class="filename">/usr/include</code>,
5389: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5390: designed to insulate the package build from non-system-supplied
5391: software.</p>
1.75 rillig 5392: <div class="sect1" lang="en">
5393: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5394: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5395: <p>The process of converting packages to use the buildlink3
1.87 wiz 5396: framework (“<span class="quote">bl3ifying</span>”) is fairly straightforward.
5397: The things to keep in mind are:</p>
1.75 rillig 5398: <div class="orderedlist"><ol type="1">
1.87 wiz 5399: <li><p>Ensure that the build always calls the wrapper scripts
5400: instead of the actual toolchain. Some packages are tricky,
5401: and the only way to know for sure is the check
5402: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5403: wrappers are being invoked.</p></li>
5404: <li><p>Don't override <code class="varname">PREFIX</code> from within
5405: the package Makefile, e.g. Java VMs, standalone shells,
5406: etc., because the code to symlink files into
5407: <code class="filename">${BUILDLINK_DIR}</code> looks for files
5408: relative to “<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”.
5409: </p></li>
5410: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
5411: <code class="filename">buildlink3.mk</code> files that you list in a
5412: package's Makefile are added as dependencies for that package.
5413: </p></li>
1.75 rillig 5414: </ol></div>
1.87 wiz 5415: <p>If a dependency on a particular package is required for its libraries and
5416: headers, then we replace:</p>
1.75 rillig 5417: <pre class="programlisting">
1.100 rillig 5418: DEPENDS+= foo>=1.1.0:../../category/foo
5419: </pre>
1.75 rillig 5420: <p>with</p>
5421: <pre class="programlisting">
1.100 rillig 5422: .include "../../category/foo/buildlink3.mk"
5423: </pre>
1.75 rillig 5424: <p>The buildlink3.mk files usually define the required dependencies.
5425: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5426: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5427: <pre class="programlisting">
1.100 rillig 5428: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5429: .include "../../category/foo/buildlink3.mk"
5430: </pre>
1.76 rillig 5431: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5432: files in <code class="filename">pkgsrc/mk</code>
5433: that handle special package issues:</p>
1.75 rillig 5434: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5435: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5436: the native or a pkgsrc Berkeley DB implementation based on
5437: the values of <code class="varname">BDB_ACCEPTED</code> and
5438: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.76 rillig 5439: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5440: comes with neither Curses nor NCurses, this will take care
1.91 rillig 5441: 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 5442: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5443: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5444: adding a dependency on Heimdal or MIT-krb5 for packages that
5445: require a Kerberos 5 implementation.</p></li>
1.88 wiz 5446: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
5447: system-provided Motif installation or adds a dependency on
1.91 rillig 5448: <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 5449: <code class="varname">MOTIF_TYPE</code> to “<span class="quote">dt</span>”,
5450: “<span class="quote">lesstif</span>”, or “<span class="quote">openmotif</span>” to choose
5451: which Motif version will be used.</p></li>
1.76 rillig 5452: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5453: variables that may be used by packages that use the
5454: Open Sound System (OSS) API.</p></li>
1.76 rillig 5455: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.93 rillig 5456: either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
1.87 wiz 5457: the file for more information.</p></li>
1.76 rillig 5458: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5459: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91 rillig 5460: 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 5461: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5462: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5463: library.</p></li>
1.75 rillig 5464: </ul></div>
1.76 rillig 5465: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5466: files provide a more complete
5467: description of how to use them properly.</p>
1.75 rillig 5468: </div>
5469: <div class="sect1" lang="en">
5470: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5471: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107 rillig 5472: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87 wiz 5473: included by Makefiles to indicate the need to compile and link
5474: against header files and libraries provided by the package. A
5475: <code class="filename">buildlink3.mk</code> file should always provide
5476: enough information to add the correct type of dependency
5477: relationship and include any other
5478: <code class="filename">buildlink3.mk</code> files that it needs to find
5479: headers and libraries that it needs in turn.</p>
5480: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91 rillig 5481: 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 5482: package is highly recommended. For most packages, the following
5483: command will generate a good starting point for
5484: <code class="filename">buildlink3.mk</code> files:</p>
5485: <pre class="screen">
5486: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5487: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5488: </pre>
1.75 rillig 5489: <div class="sect2" lang="en">
5490: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5491: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5492: <p>The following real-life example
1.87 wiz 5493: <code class="filename">buildlink3.mk</code> is taken
5494: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5495: <pre class="programlisting">
1.120 snj 5496: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 grant 5497:
1.120 snj 5498: BUILDLINK_TREE+= tiff
1.1 grant 5499:
1.120 snj 5500: .if !defined(TIFF_BUILDLINK3_MK)
5501: TIFF_BUILDLINK3_MK:=
1.87 wiz 5502:
1.120 snj 5503: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5504: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5505: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.87 wiz 5506:
1.100 rillig 5507: .include "../../devel/zlib/buildlink3.mk"
5508: .include "../../graphics/jpeg/buildlink3.mk"
1.120 snj 5509: .endif # TIFF_BUILDLINK3_MK
1.87 wiz 5510:
1.120 snj 5511: BUILDLINK_TREE+= -tiff
1.100 rillig 5512: </pre>
1.87 wiz 5513: <p>The header and footer manipulate
1.120 snj 5514: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87 wiz 5515: <code class="filename">buildlink3.mk</code> files and is used to track
1.120 snj 5516: the dependency tree.</p>
5517: <p>The main section is protected from multiple inclusion
1.87 wiz 5518: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5519: added. Several important variables are set in the section:</p>
5520: <div class="itemizedlist"><ul type="disc">
5521: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5522: is the actual dependency recorded in the installed
5523: package; this should always be set using
1.110 hubertf 5524: <span class="command"><strong>+=</strong></span> to ensure that
1.87 wiz 5525: we're appending to any pre-existing list of values. This
5526: variable should be set to the first version of the
5527: package that had an API change.
5528: </p></li>
5529: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
5530: is the location of the <em class="replaceable"><code>pkg</code></em>
5531: pkgsrc directory.</p></li>
5532: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5533: (not shown above) controls whether we use
5534: <code class="varname">BUILD_DEPENDS</code> or
5535: <code class="varname">DEPENDS</code> to add the dependency on
5536: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5537: selected by setting
5538: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5539: to “<span class="quote">build</span>”. By default, the full dependency is
5540: used.</p></li>
5541: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5542: and
5543: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5544: (not shown above) are lists of subdirectories of
1.76 rillig 5545: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5546: to add to the header and library search paths. These
5547: default to “<span class="quote">include</span>” and “<span class="quote">lib</span>”
1.87 wiz 5548: respectively.</p></li>
5549: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5550: (not shown above) is the list of preprocessor flags to add
5551: to <code class="varname">CPPFLAGS</code>, which are passed on to the
5552: configure and build phases. The “<span class="quote">-I</span>” option
5553: should be avoided and instead be handled using
5554: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5555: above.</p></li>
1.75 rillig 5556: </ul></div>
1.87 wiz 5557: <p>The following variables are all optionally defined within
5558: this second section (protected against multiple inclusion) and
5559: control which package files are symlinked into
5560: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5561: transformed during the symlinking:</p>
1.75 rillig 5562: <div class="itemizedlist"><ul type="disc">
1.87 wiz 5563: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5564: (not shown above) is a shell glob pattern relative to
1.76 rillig 5565: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5566: to be symlinked into
1.76 rillig 5567: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5568: e.g. <code class="filename">include/*.h</code>.</p></li>
5569: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
5570: (not shown above) is a shell pipeline that
5571: outputs to stdout a list of files relative to
5572: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5573: The resulting files are to be symlinked
5574: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5575: this takes the <code class="filename">+CONTENTS</code> of a
5576: <em class="replaceable"><code>pkg</code></em> and filters it through
5577: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
5578: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5579: (not shown above) is a filter command that filters
1.76 rillig 5580: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5581: relative to
1.76 rillig 5582: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5583: on stdout. By default for overwrite packages,
5584: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5585: outputs the contents of the <code class="filename">include</code>
5586: and <code class="filename">lib</code> directories in the package
5587: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75 rillig 5588: it outputs any libtool archives in
1.87 wiz 5589: <code class="filename">lib</code> directories.</p></li>
1.95 tron 5590: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5591: (not shown above) is a list of sed arguments used to
5592: transform the name of the source filename into a
1.110 hubertf 5593: destination filename, e.g. <span class="command"><strong>-e
1.87 wiz 5594: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5595: </ul></div>
1.120 snj 5596: <p>This section can additionally include any
1.87 wiz 5597: <code class="filename">buildlink3.mk</code> needed for
5598: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5599: Including these <code class="filename">buildlink3.mk</code> files
5600: means that the headers and libraries for these
5601: dependencies are also symlinked into
5602: <code class="filename">${BUILDLINK_DIR}</code>
5603: whenever the <em class="replaceable"><code>pkg</code></em>
5604: <code class="filename">buildlink3.mk</code>
1.120 snj 5605: file is included. Dependencies are only added for directly
5606: include <code class="filename">buildlink3.mk</code> files.</p>
1.75 rillig 5607: </div>
5608: <div class="sect2" lang="en">
5609: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5610: <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 5611: <p>The situation that requires increasing the dependency listed in
1.75 rillig 5612: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5613: after a package update is when the API or interface to the
1.87 wiz 5614: header files change.</p>
5615: <p>In this case,
5616: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5617: should be adjusted to require at least the new package
5618: version. In some cases, the packages that depend on this new
5619: version may need their <code class="varname">PKGREVISION</code>s
5620: increased and, if they have <code class="filename">buildlink3.mk</code>
5621: files, their
5622: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5623: adjusted, too. This is needed so pkgsrc will require the
5624: correct package dependency and not settle for an older one
5625: when building the source.</p>
5626: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5627: should be increased when the binary interface or sonames
5628: (major number of the library version) of any installed
5629: shared libraries change. This is needed so that binary
5630: packages made using it will require the correct package
5631: dependency and not settle for an older one which will not
1.87 wiz 5632: contain the necessary shared libraries.</p>
1.110 hubertf 5633: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.75 rillig 5634: more information about dependencies on other packages,
5635: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5636: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5637: <p>Please take careful consideration before adjusting
5638: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5639: or
5640: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5641: as we don't want to cause unneeded package deletions and
5642: rebuilds. In many cases, new versions of packages work just
5643: fine with older dependencies.</p>
5644: <p>Also it is not needed to set
1.75 rillig 5645: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5646: when it is identical to
1.87 wiz 5647: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5648: </div>
5649: </div>
5650: <div class="sect1" lang="en">
5651: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5652: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5653: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5654: coincide with headers and libraries present in the base system.
1.76 rillig 5655: Aside from a <code class="filename">buildlink3.mk</code> file, these
5656: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5657: file that includes the necessary checks to decide whether using
5658: the built-in software or the pkgsrc software is
1.87 wiz 5659: appropriate.</p>
5660: <p>The only requirements of a builtin.mk file for
5661: <em class="replaceable"><code>pkg</code></em> are:</p>
1.75 rillig 5662: <div class="orderedlist"><ol type="1">
1.87 wiz 5663: <li><p>It should set
5664: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5665: to either “<span class="quote">yes</span>” or “<span class="quote">no</span>”
5666: after it is included.</p></li>
5667: <li><p>It should <span class="emphasis"><em>not</em></span> override any
5668: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5669: which is already set before the
5670: <code class="filename">builtin.mk</code> file is included.</p></li>
5671: <li><p>It should be written to allow multiple inclusion. This
5672: is <span class="emphasis"><em>very</em></span> important and takes careful
5673: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5674: </ol></div>
5675: <div class="sect2" lang="en">
5676: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5677: <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 5678: <p>The following is the recommended template for builtin.mk
1.87 wiz 5679: files:</p>
1.75 rillig 5680: <pre class="programlisting">
1.100 rillig 5681: .if !defined(IS_BUILTIN.foo)
5682: #
5683: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5684: # genuinely exists in the system or not.
5685: #
5686: IS_BUILTIN.foo?= no
5687:
5688: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5689: # version can be determined.
5690: #
5691: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5692: BUILTIN_PKG.foo?= foo-1.0
5693: . endif
5694: .endif # IS_BUILTIN.foo
5695:
5696: .if !defined(USE_BUILTIN.foo)
5697: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5698: . if defined(BUILTIN_PKG.foo)
5699: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5700: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5701: USE_BUILTIN.foo!= \
5702: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5703: && ${ECHO} "yes" || ${ECHO} "no"
5704: . endif
5705: . endfor
5706: . endif
5707: .endif # USE_BUILTIN.foo
5708:
5709: CHECK_BUILTIN.foo?= no
5710: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5711: #
5712: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5713: # "yes" or "no".
5714: #
5715: .endif # CHECK_BUILTIN.foo
5716: </pre>
1.87 wiz 5717: <p>The first section sets
5718: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5719: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5720: in the base system. This should not be a base system software
5721: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
5722: it should only be “<span class="quote">yes</span>” if the actual package is
5723: included as part of the base system. This variable is only
5724: used internally within the <code class="filename">builtin.mk</code>
5725: file.</p>
5726: <p>The second section sets
5727: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5728: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5729: system if it exists (if
5730: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5731: is “<span class="quote">yes</span>”). This variable is only used internally
5732: within the <code class="filename">builtin.mk</code> file.</p>
5733: <p>The third section sets
5734: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5735: and is <span class="emphasis"><em>required</em></span> in all
5736: <code class="filename">builtin.mk</code> files. The code in this
5737: section must make the determination whether the built-in
5738: software is adequate to satisfy the dependencies listed in
5739: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5740: This is typically done by comparing
5741: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5742: against each of the dependencies in
5743: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5744: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5745: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5746: end of the <code class="filename">builtin.mk</code> file. Note that
5747: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5748: may be “<span class="quote">yes</span>” even if
5749: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5750: is “<span class="quote">no</span>” because we may make the determination
5751: that the built-in version of the software is similar enough to
5752: be used as a replacement.</p>
5753: <p>The last section is guarded by
5754: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5755: and includes code that uses the value of
5756: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5757: set in the previous section. This typically includes, e.g.,
5758: adding additional dependency restrictions and listing additional
5759: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5760: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5761: </div>
5762: <div class="sect2" lang="en">
5763: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5764: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5765: <p>When building packages, it's possible to choose whether to set
5766: a global preference for using either the built-in (native)
5767: version or the pkgsrc version of software to satisfy a
5768: dependency. This is controlled by setting
5769: <code class="varname">PREFER_PKGSRC</code> and
5770: <code class="varname">PREFER_NATIVE</code>. These variables take values
5771: of either “<span class="quote">yes</span>”, “<span class="quote">no</span>”, or a list of
5772: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5773: use the pkgsrc versions of software, while
5774: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5775: built-in versions. Preferences are determined by the most
5776: specific instance of the package in either
5777: <code class="varname">PREFER_PKGSRC</code> or
5778: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5779: in neither or in both variables, then
5780: <code class="varname">PREFER_PKGSRC</code> has precedence over
5781: <code class="varname">PREFER_NATIVE</code>. For example, to require
5782: using pkgsrc versions of software for all but the most basic
5783: bits on a NetBSD system, you can set:</p>
5784: <pre class="programlisting">
1.100 rillig 5785: PREFER_PKGSRC= yes
5786: PREFER_NATIVE= getopt skey tcp_wrappers
5787: </pre>
1.87 wiz 5788: <p>A package <span class="emphasis"><em>must</em></span> have a
5789: <code class="filename">builtin.mk</code>
5790: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5791: otherwise it is simply ignored in that list.</p>
1.75 rillig 5792: </div>
5793: </div>
5794: </div>
5795: <div class="chapter" lang="en">
5796: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5797: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75 rillig 5798: <div class="toc">
5799: <p><b>Table of Contents</b></p>
5800: <dl>
1.106 rillig 5801: <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 5802: <dd><dl>
1.106 rillig 5803: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5804: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75 rillig 5805: </dl></dd>
1.106 rillig 5806: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75 rillig 5807: <dd><dl>
1.123 snj 5808: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How PKG_SYSCONFDIR is set</a></span></dt>
1.106 rillig 5809: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5810: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5811: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5812: </dl></dd>
5813: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5814: <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>
5815: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5816: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5817: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5818: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5819: <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 5820: </dl>
5821: </div>
5822: <p>This chapter describes the framework known as
5823: <code class="literal">pkginstall</code>, whose key features are:</p>
5824: <div class="itemizedlist"><ul type="disc">
5825: <li><p>Generic installation and manipulation of directories and files
5826: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
5827: <li><p>Automatic handling of configuration files during installation,
5828: provided that packages are correctly designed.</p></li>
5829: <li><p>Generation and installation of system startup scripts.</p></li>
5830: <li><p>Registration of system users and groups.</p></li>
5831: <li><p>Registration of system shells.</p></li>
5832: <li><p>Automatic updating of fonts databases.</p></li>
5833: </ul></div>
5834: <p>The following sections inspect each of the above points in detail.</p>
5835: <p>You may be thinking that many of the things described here could be
5836: easily done with simple code in the package's post-installation target
5837: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5838: as the code in them is only executed when building from source. Machines
5839: using binary packages could not benefit from it at all (as the code itself
5840: could be unavailable). Therefore, the only way to achieve any of the items
5841: described above is by means of the installation scripts, which are
5842: automatically generated by pkginstall.</p>
5843: <div class="sect1" lang="en">
5844: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5845: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5846: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5847: of files and directories that belong to a package. The names used in it
1.76 rillig 5848: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5849: which means that it cannot register files outside this directory (absolute
5850: path names are not allowed). Despite this restriction, some packages need
5851: to install files outside this location; e.g., under
1.76 rillig 5852: <code class="filename">${VARBASE}</code> or
1.87 wiz 5853: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5854: is to create such files during installation time by using
5855: installation scripts.</p>
5856: <p>The generic installation scripts are shell scripts that can
5857: contain arbitrary code. The list of scripts to execute is taken from
5858: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5859: <code class="filename">INSTALL</code>. A similar variable exists for package
5860: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5861: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5862: commands, so they have the potential to create and manage files
5863: anywhere in the file system.</p>
5864: <p>Using these general installation files is not recommended, but
5865: may be needed in some special cases. One reason for avoiding them is
5866: that the user has to trust the packager that there is no unwanted or
5867: simply erroneous code included in the installation script. Also,
5868: previously there were many similar scripts for the same functionality,
5869: and fixing a common error involved finding and changing all of
5870: them.</p>
5871: <p>The pkginstall framework offers another, standardized way. It
5872: provides generic scripts to abstract the manipulation of such files
5873: and directories based on variables set in the package's
5874: <code class="filename">Makefile</code>. The rest of this section describes
5875: these variables.</p>
1.75 rillig 5876: <div class="sect2" lang="en">
5877: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5878: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5879: <p>The following variables can be set to request the creation of
5880: directories anywhere in the file system:</p>
5881: <div class="itemizedlist"><ul type="disc">
5882: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
5883: contain a list of directories that should be created and should attempt
5884: to be destroyed by the installation scripts. The difference between
5885: the two is that the latter prompts the administrator to remove any
5886: directories that may be left after deinstallation (because they were
5887: not empty), while the former does not.</p></li>
5888: <li>
5889: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5890: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5891: which directories should be created and should attempt to be destroyed
5892: by the installation scripts. Each tuple holds the following values,
5893: separated by spaces: the directory name, its owner, its group and its
5894: numerical mode. For example:</p>
5895: <pre class="programlisting">
1.100 rillig 5896: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5897: </pre>
1.75 rillig 5898: <p>The difference between the two is exactly the same as their
5899: non-<code class="varname">PERMS</code> counterparts.</p>
5900: </li>
5901: </ul></div>
5902: </div>
5903: <div class="sect2" lang="en">
5904: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5905: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5906: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5907: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5908: To overcome this problem, the only solution is to extract the file in the
5909: known place (i.e., inside the installation prefix) and copy it to the
5910: appropriate location during installation (done by the installation scripts
5911: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5912: file</em></span> in the following paragraphs, which describe the variables
5913: that can be used to automatically and consistently handle files outside the
5914: installation prefix:</p>
5915: <div class="itemizedlist"><ul type="disc">
5916: <li>
5917: <p><code class="varname">CONF_FILES</code> and
5918: <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
5919: During installation time, the master file is copied to the target one
5920: if and only if the latter does not exist. Upon deinstallation, the
5921: target file is removed provided that it was not modified by the
5922: installation.</p>
5923: <p>The difference between the two is that the latter prompts the
5924: administrator to remove any files that may be left after
5925: deinstallation (because they were not empty), while the former does
5926: not.</p>
5927: </li>
5928: <li>
5929: <p><code class="varname">CONF_FILES_PERMS</code> and
5930: <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
5931: files as well as their target locations. For each of them, it also
5932: specifies their owner, their group and their numeric permissions, in
5933: this order. For example:</p>
5934: <pre class="programlisting">
1.100 rillig 5935: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5936: </pre>
1.75 rillig 5937: <p>The difference between the two is exactly the same as their
5938: non-<code class="varname">PERMS</code> counterparts.</p>
5939: </li>
5940: </ul></div>
5941: </div>
5942: </div>
5943: <div class="sect1" lang="en">
5944: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5945: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75 rillig 5946: <p>Configuration files are special in the sense that they are installed
5947: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5948: need special treatment during installation (most of which is automated by
5949: pkginstall). The main concept you must bear in mind is that files marked
5950: as configuration files are automatically copied to the right place (somewhere
5951: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5952: and only if</em></span> they didn't exist before. Similarly, they will not
5953: be removed if they have local modifications. This ensures that
5954: administrators never lose any custom changes they may have made.</p>
5955: <div class="sect2" lang="en">
5956: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5957: <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 5958: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5959: specifies where configuration files shall be installed. Its contents are
5960: set based upon the following variables:</p>
5961: <div class="itemizedlist"><ul type="disc">
5962: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5963: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5964: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5965: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5966: Packages must not use it directly.</p></li>
5967: <li>
5968: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5969: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5970: for the package being built shall be installed. The definition of this
5971: variable only makes sense in the package's
1.76 rillig 5972: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5973: <p>As an example, consider the Apache package,
1.91 rillig 5974: <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 5975: configuration files under the
1.76 rillig 5976: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5977: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5978: Makefile.</p>
5979: </li>
5980: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
5981: variable that holds this package's configuration directory (if
5982: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5983: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5984: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
5985: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
5986: directory where the configuration files for the package identified by
5987: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5988: </ul></div>
5989: <p>Based on the above variables, pkginstall determines the value of
5990: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5991: variable that can be used within a package to refer to its configuration
5992: directory. The algorithm used to set its value is basically the
5993: following:</p>
5994: <div class="orderedlist"><ol type="1">
5995: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
5996: its value is used.</p></li>
5997: <li><p>If the previous variable is not defined but
5998: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 5999: <code class="filename">Makefile</code>, the resulting value is
6000: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.75 rillig 6001: <li><p>Otherwise, it is set to
1.76 rillig 6002: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 6003: </ol></div>
1.76 rillig 6004: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117 jnemeth 6005: 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
6006: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
6007: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75 rillig 6008: </div>
6009: <div class="sect2" lang="en">
6010: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6011: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 6012: <p>Given that pkgsrc (and users!) expect configuration files to be in a
6013: known place, you need to teach each package where it shall install its
6014: files. In some cases you will have to patch the package Makefiles to
6015: achieve it. If you are lucky, though, it may be as easy as passing an
6016: extra flag to the configuration script; this is the case of GNU Autoconf-
6017: generated files:</p>
6018: <pre class="programlisting">
1.100 rillig 6019: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 6020: </pre>
1.75 rillig 6021: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
6022: for</em></span> its configuration files, not where they will be originally
6023: installed (although the difference is never explicit,
6024: unfortunately).</p>
6025: </div>
6026: <div class="sect2" lang="en">
6027: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6028: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75 rillig 6029: <p>As said before, pkginstall automatically handles configuration files.
6030: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 6031: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 6032: directly</strong></span>. Bad news is that many software installation scripts
6033: will, out of the box, mess with the contents of that directory. So what is
6034: the correct procedure to fix this issue?</p>
6035: <p>You must teach the package (usually by manually patching it) to
6036: install any configuration files under the examples hierarchy,
1.76 rillig 6037: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
6038: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 6039: has the original copies available.</p>
6040: <p>Once the required configuration files are in place (i.e., under the
6041: examples hierarchy), the pkginstall framework can use them as master copies
6042: during the package installation to update what is in
1.76 rillig 6043: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 6044: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110 hubertf 6045: 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 6046: about their syntax and their purpose. Here is an example, taken from the
1.91 rillig 6047: <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 6048: <pre class="programlisting">
1.100 rillig 6049: EGDIR= ${PREFIX}/share/doc/mutt/samples
6050: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 6051: </pre>
1.75 rillig 6052: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
6053: package and has no meaning outside it.</p>
6054: </div>
6055: <div class="sect2" lang="en">
6056: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6057: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 6058: <p>The automatic copying of config files can be toggled by setting the
6059: environment variable <code class="varname">PKG_CONFIG</code> prior to package
6060: installation.</p>
6061: </div>
6062: </div>
6063: <div class="sect1" lang="en">
6064: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6065: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75 rillig 6066: <p>System startup scripts are special files because they must be
6067: installed in a place known by the underlying OS, usually outside the
1.110 hubertf 6068: 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 6069: can be used. However, pkginstall provides a special mechanism to handle
6070: these files.</p>
6071: <p>In order to provide system startup scripts, the package has
6072: to:</p>
6073: <div class="orderedlist"><ol type="1">
1.76 rillig 6074: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 6075: the <code class="literal">.sh</code> suffix appended. Considering the
1.91 rillig 6076: <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 6077: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.75 rillig 6078: <li>
6079: <p>Tell pkginstall to handle it, appending the name of the script,
6080: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6081: Continuing the previous example:</p>
6082: <pre class="programlisting">
1.100 rillig 6083: RCD_SCRIPTS+= cupsd
1.1 grant 6084: </pre>
1.75 rillig 6085: </li>
6086: </ol></div>
6087: <p>Once this is done, pkginstall will do the following steps for each
6088: script in an automated fashion:</p>
6089: <div class="orderedlist"><ol type="1">
6090: <li><p>Process the file found in the files directory applying all the
1.76 rillig 6091: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 6092: variable.</p></li>
6093: <li><p>Copy the script from the files directory to the examples
1.76 rillig 6094: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 6095: that this master file must be explicitly registered in the
1.76 rillig 6096: <code class="filename">PLIST</code>.</p></li>
1.75 rillig 6097: <li><p>Add code to the installation scripts to copy the startup script
6098: from the examples hierarchy into the system-wide startup scripts
6099: directory.</p></li>
6100: </ol></div>
6101: <div class="sect2" lang="en">
6102: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6103: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 6104: <p>The automatic copying of config files can be toggled by setting the
6105: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6106: installation. Note that the scripts will be always copied inside the
1.76 rillig 6107: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 6108: matter what the value of this variable is.</p>
6109: </div>
6110: </div>
6111: <div class="sect1" lang="en">
6112: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6113: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75 rillig 6114: <p>If a package needs to create special users and/or groups during
6115: installation, it can do so by using the pkginstall framework.</p>
6116: <p>Users can be created by adding entries to the
6117: <code class="varname">PKG_USERS</code> variable. Each entry has the following
6118: syntax:</p>
6119: <pre class="programlisting">
1.100 rillig 6120: user:group
1.1 grant 6121: </pre>
1.87 wiz 6122: <p>Further specification of user details may be done by setting
6123: per-user variables.
6124: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6125: numeric UID for the user.
6126: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6127: user's description or comment.
6128: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6129: user's home directory, and defaults to
6130: <code class="filename">/nonexistent</code> if not specified.
6131: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 6132: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 6133: not specified.</p>
1.75 rillig 6134: <p>Similarly, groups can be created by adding entries to the
6135: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6136: <pre class="programlisting">
1.100 rillig 6137: group
1.1 grant 6138: </pre>
1.93 rillig 6139: <p>The numeric GID of the group may be set by defining
1.75 rillig 6140: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6141: <p>If a package needs to create the users and groups at an earlier
6142: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6143: either <code class="literal">configure</code> or <code class="literal">build</code> to
6144: indicate the phase before which the users and groups are created. In
6145: this case, the numeric UIDs and GIDs of the created users and groups
6146: are automatically hardcoded into the final installation scripts.</p>
6147: </div>
6148: <div class="sect1" lang="en">
6149: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6150: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75 rillig 6151: <p>Packages that install system shells should register them in the shell
1.76 rillig 6152: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 6153: administrator. This must be done from the installation scripts to keep
6154: binary packages working on any system. pkginstall provides an easy way to
6155: accomplish this task.</p>
6156: <p>When a package provides a shell interpreter, it has to set the
6157: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
6158: add some hooks to the installation scripts to handle it. Consider the
1.91 rillig 6159: 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 6160: <pre class="programlisting">
1.100 rillig 6161: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 6162: </pre>
1.75 rillig 6163: <div class="sect2" lang="en">
6164: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6165: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 6166: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 6167: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 6168: environment variable to <code class="literal">NO</code>.</p>
6169: </div>
6170: </div>
6171: <div class="sect1" lang="en">
6172: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6173: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75 rillig 6174: <p>Packages that install X11 fonts should update the database files
6175: that index the fonts within each fonts directory. This can easily be
6176: accomplished within the pkginstall framework.</p>
6177: <p>When a package installs X11 fonts, it must list the directories in
6178: which fonts are installed in the
6179: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
6180: where <em class="replaceable"><code>type</code></em> can be one of “<span class="quote">ttf</span>”,
6181: “<span class="quote">type1</span>” or “<span class="quote">x11</span>”. This will add hooks to the
6182: installation scripts to run the appropriate commands to update the fonts
6183: database files within each of those directories. For convenience, if the
6184: directory path is relative, it is taken to be relative to the package's
1.91 rillig 6185: 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 6186: <pre class="programlisting">
1.100 rillig 6187: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1 grant 6188: </pre>
1.75 rillig 6189: <div class="sect2" lang="en">
6190: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6191: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 6192: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 6193: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 6194: environment variable to <code class="literal">NO</code>.</p>
6195: </div>
6196: </div>
6197: </div>
6198: <div class="chapter" lang="en">
6199: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6200: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75 rillig 6201: <div class="toc">
6202: <p><b>Table of Contents</b></p>
6203: <dl>
1.106 rillig 6204: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.123 snj 6205: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use bsd.options.mk</a></span></dt>
1.106 rillig 6206: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 6207: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75 rillig 6208: </dl>
6209: </div>
6210: <p>Many packages have the ability to be built to support different
1.76 rillig 6211: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 6212: in pkgsrc that provides generic handling of those options that
6213: determine different ways in which the packages can be built. It's
6214: possible for the user to specify exactly which sets of options will be
6215: built into a package or to allow a set of global default options
6216: apply.</p>
1.107 rillig 6217: <p>There are two broad classes of behaviors that one might want to
6218: control via options. One is whether some particular feature is
6219: enabled in a program that will be built anyway, often by including or
6220: not including a dependency on some other package. The other is
6221: whether or not an additional program will be built as part of the
6222: package. Generally, it is better to make a split package for such
6223: additional programs instead of using options, because it enables
6224: binary packages to be built which can then be added separately. For
6225: example, the foo package might have minimal dependencies (those
6226: packages without which foo doesn't make sense), and then the foo-gfoo
6227: package might include the GTK frontend program gfoo. This is better
6228: than including a gtk option to foo that adds gfoo, because either that
6229: option is default, in which case binary users can't get foo without
6230: gfoo, or not default, in which case they can't get gfoo. With split
6231: packages, they can install foo without having GTK, and later decide to
6232: install gfoo (pulling in GTK at that time). This is an advantage to
6233: source users too, avoiding the need for rebuilds.</p>
6234: <p>Plugins with widely varying dependencies should usually be split
6235: instead of options.</p>
6236: <p>It is often more work to maintain split packages, especially if
6237: the upstream package does not support this. The decision of split
6238: vs. option should be made based on the likelihood that users will want
6239: or object to the various pieces, the size of the dependencies that are
6240: included, and the amount of work.</p>
6241: <p>A further consideration is licensing. Non-free parts, or parts
6242: that depend on non-free dependencies (especially plugins) should
6243: almost always be split if feasible.</p>
1.75 rillig 6244: <div class="sect1" lang="en">
6245: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6246: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75 rillig 6247: <p>Global default options are listed in
6248: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6249: that should be built into every package if that option is supported.
1.110 hubertf 6250: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 6251: </div>
6252: <div class="sect1" lang="en">
6253: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6254: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93 rillig 6255: </h2></div></div></div>
1.75 rillig 6256: <p>The following example shows how
1.76 rillig 6257: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6258: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6259: <code class="filename">Makefile</code>, or in a file,
6260: e.g. <code class="filename">options.mk</code>, that is included by the
6261: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6262: <pre class="programlisting">
1.100 rillig 6263: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6264: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6265: PKG_OPTIONS_OPTIONAL_GROUPS= database
6266: PKG_OPTIONS_GROUP.database= mysql pgsql
6267: PKG_SUGGESTED_OPTIONS= wibble-foo
6268: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6269: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6270:
6271: .include "../../mk/bsd.prefs.mk"
6272:
6273: # this package was previously named wibble2
6274: .if defined(PKG_OPTIONS.wibble2)
6275: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6276: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6277: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6278: .endif
6279:
6280: .include "../../mk/bsd.options.mk"
6281:
6282: # Package-specific option-handling
6283:
6284: ###
6285: ### FOO support
6286: ###
6287: .if !empty(PKG_OPTIONS:Mwibble-foo)
6288: CONFIGURE_ARGS+= --enable-foo
6289: .endif
6290:
6291: ###
6292: ### LDAP support
6293: ###
6294: .if !empty(PKG_OPTIONS:Mldap)
6295: . include "../../databases/openldap-client/buildlink3.mk"
6296: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6297: .endif
6298:
6299: ###
6300: ### database support
6301: ###
6302: .if !empty(PKG_OPTIONS:Mmysql)
6303: . include "../../mk/mysql.buildlink3.mk"
6304: .endif
6305: .if !empty(PKG_OPTIONS:Mpgsql)
6306: . include "../../mk/pgsql.buildlink3.mk"
6307: .endif
1.75 rillig 6308: </pre>
6309: <p>The first section contains the information about which build
6310: options are supported by the package, and any default options settings
6311: if needed.</p>
6312: <div class="orderedlist"><ol type="1">
6313: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.110 hubertf 6314: <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 6315: options. It should be set to
1.78 rillig 6316: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6317: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6318: at the point where the options are processed.</p></li>
1.75 rillig 6319: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6320: build options supported by the package.</p></li>
6321: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6322: list of names of groups of mutually exclusive options. The options in
6323: each group are listed in
6324: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6325: The most specific setting of any option from the group takes
6326: precedence over all other options in the group. Options from the
6327: groups will be automatically added to
6328: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6329: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6330: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6331: packages will fail if no option from the group is
6332: selected.</p></li>
6333: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6334: of names of sets of options. At least one option from each set must
6335: be selected. The options in each set are listed in
6336: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6337: Options from the sets will be automatically added to
6338: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6339: fail if no option from the set is selected.</p></li>
6340: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6341: build options which are enabled by default.</p></li>
6342: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6343: of
6344: “<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”
1.110 hubertf 6345: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75 rillig 6346: their option counterparts. Pairs should be added with
6347: “<span class="quote">+=</span>” to keep the listing of global legacy variables. A
6348: warning will be issued if the user uses a legacy
6349: variable.</p></li>
6350: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6351: of
6352: “<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”
6353: pairs that map options that have been renamed to their new
6354: counterparts. Pairs should be added with “<span class="quote">+=</span>” to keep
6355: the listing of global legacy options. A warning will be issued if
6356: the user uses a legacy option.</p></li>
6357: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6358: options implied by deprecated variables used. This can be used for
6359: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6360: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6361: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6362: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6363: a list of warnings about deprecated variables or options used, and
6364: what to use instead.</p></li>
6365: </ol></div>
6366: <p>A package should never modify
6367: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6368: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6369: To suggest a default set of options, use
6370: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6371: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6372: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6373: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6374: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6375: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6376: happen with platform-specific options if none of them is supported on
6377: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6378: empty list and the package is otherwise treated as not using the
6379: options framework.</p>
1.76 rillig 6380: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6381: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6382: build options, properly filtered to remove unsupported and duplicate
6383: options.</p>
6384: <p>The remaining sections contain the logic that is specific to
6385: each option. The correct way to check for an option is to check
6386: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6387: <pre class="programlisting">
1.100 rillig 6388: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75 rillig 6389: </pre>
6390: </div>
6391: <div class="sect1" lang="en">
6392: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6393: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75 rillig 6394: <p>Options that enable similar features in different packages (like
6395: optional support for a library) should use a common name in all
6396: packages that support it (like the name of the library). If another
6397: package already has an option with the same meaning, use the same
6398: name.</p>
6399: <p>Options that enable features specific to one package, where it's
6400: unlikely that another (unrelated) package has the same (or a similar)
6401: optional feature, should use a name prefixed with
6402: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6403: <p>If a group of related packages share an optional feature
6404: specific to that group, prefix it with the name of the
6405: “<span class="quote">main</span>” package
6406: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6407: <p>For new options, add a line to
1.76 rillig 6408: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6409: fields, separated by tab. The first field is the option name, the
6410: second its description. The description should be a whole sentence
6411: (starting with an uppercase letter and ending with a period) that
6412: describes what enabling the option does. E. g. “<span class="quote">Enable ispell
6413: support.</span>” The file is sorted by option names.</p>
6414: </div>
1.107 rillig 6415: <div class="sect1" lang="en">
6416: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6417: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110 hubertf 6418: <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 6419: different dependencies based on the options with which the package was
6420: built. For querying these options, the file
6421: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6422: typical example looks like this:</p>
6423: <pre class="programlisting">
6424: pkgbase := libpurple
6425: .include "../../mk/pkg-build-options.mk"
6426:
6427: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6428: ...
6429: .endif
6430: </pre>
6431: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6432: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6433: options of the libpurple package, which can then be queried like
6434: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6435: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6436: details.</p>
6437: </div>
1.75 rillig 6438: </div>
6439: <div class="chapter" lang="en">
6440: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6441: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75 rillig 6442: <div class="toc">
6443: <p><b>Table of Contents</b></p>
6444: <dl>
1.106 rillig 6445: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6446: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6447: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6448: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.123 snj 6449: <dt><span class="sect1"><a href="#build.fetch">17.5. The fetch phase</a></span></dt>
1.106 rillig 6450: <dd><dl>
6451: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6452: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6453: </dl></dd>
1.123 snj 6454: <dt><span class="sect1"><a href="#build.checksum">17.6. The checksum phase</a></span></dt>
6455: <dt><span class="sect1"><a href="#build.extract">17.7. The extract phase</a></span></dt>
6456: <dt><span class="sect1"><a href="#build.patch">17.8. The patch phase</a></span></dt>
6457: <dt><span class="sect1"><a href="#build.tools">17.9. The tools phase</a></span></dt>
6458: <dt><span class="sect1"><a href="#build.wrapper">17.10. The wrapper phase</a></span></dt>
6459: <dt><span class="sect1"><a href="#build.configure">17.11. The configure phase</a></span></dt>
6460: <dt><span class="sect1"><a href="#build.build">17.12. The build phase</a></span></dt>
6461: <dt><span class="sect1"><a href="#build.test">17.13. The test phase</a></span></dt>
6462: <dt><span class="sect1"><a href="#build.install">17.14. The install phase</a></span></dt>
6463: <dt><span class="sect1"><a href="#build.package">17.15. The package phase</a></span></dt>
1.106 rillig 6464: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6465: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75 rillig 6466: </dl>
6467: </div>
6468: <div class="sect1" lang="en">
6469: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6470: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75 rillig 6471: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6472: built. Building a package is separated into different
6473: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6474: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120 snj 6475: described in the following sections. Each phase is split into
1.87 wiz 6476: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6477: containing phase, prefixed by one of <code class="varname">pre-</code>,
6478: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6479: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6480: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 6481: <p>Never override the regular targets (like
6482: <code class="varname">fetch</code>), if you have to, override the
6483: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 6484: <p>The basic steps for building a program are always the same. First
1.87 wiz 6485: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6486: the local system and then extracted. After any pkgsrc-specific patches
6487: to compile properly are applied, the software can be configured, then
6488: built (usually by compiling), and finally the generated binaries, etc.
6489: can be put into place on the system.</p>
1.97 rillig 6490: <p>To get more details about what is happening at each step,
6491: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6492: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6493: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 6494: </div>
6495: <div class="sect1" lang="en">
6496: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6497: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75 rillig 6498: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6499: the next section, here's a brief discussion on where programs are
6500: installed, and which variables influence this.</p>
1.75 rillig 6501: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6502: where all files of the final program shall be installed. It is
6503: usually set to <code class="varname">LOCALBASE</code>
6504: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6505: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6506: <code class="varname">PREFIX</code> needs to be put
6507: into the various places in the program's source where paths to
1.110 hubertf 6508: 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 6509: <p>When choosing which of these variables to use,
1.87 wiz 6510: follow the following rules:</p>
1.75 rillig 6511: <div class="itemizedlist"><ul type="disc">
1.88 wiz 6512: <li><p><code class="varname">PREFIX</code> always points to the location
6513: where the current pkg will be installed. When referring to a
6514: pkg's own installation path, use
6515: “<span class="quote">${PREFIX}</span>”.</p></li>
6516: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
6517: are installed. If you need to construct a -I or -L argument
6518: to the compiler to find includes and libraries installed by
6519: another non-X11 pkg, use “<span class="quote">${LOCALBASE}</span>”. The name
1.87 wiz 6520: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6521: installed all packages in <code class="filename">/usr/local</code>. As
6522: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6523: administrator, this variable is a misnomer.</p></li>
1.88 wiz 6524: <li><p><code class="varname">X11BASE</code> is where the actual X11
6525: distribution (from xsrc, etc.) is installed. When looking for
6526: <span class="emphasis"><em>standard</em></span> X11 includes (not those
6527: installed by a package), use “<span class="quote">${X11BASE}</span>”.</p></li>
6528: <li>
6529: <p>X11-based packages are special in that they may be
6530: installed in either <code class="varname">X11BASE</code> or
6531: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6532: <p>Usually, X11 packages should be installed under
1.88 wiz 6533: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6534: will need to include
6535: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6536: request the presence of X11 and to get the right compilation
6537: flags.</p>
1.75 rillig 6538: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6539: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6540: files. These packages are special and they must be placed under
6541: <code class="varname">X11BASE</code>. To accomplish this, set either
6542: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6543: your package.</p>
1.75 rillig 6544: <p>Some notes: If you need
1.87 wiz 6545: to find includes or libraries installed by a pkg that has
6546: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6547: its pkg <code class="filename">Makefile</code>, you need to look in
6548: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6549: <code class="filename">${LOCALBASE}</code>. To force installation of
6550: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91 rillig 6551: <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 6552: is enabled by default.</p>
1.75 rillig 6553: </li>
1.88 wiz 6554: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
6555: the installed location of an X11
6556: package. <code class="varname">X11PREFIX</code> will be set to
6557: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6558: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6559: installed.</p></li>
6560: <li>
6561: <p>If xpkgwedge is installed, it is possible to have some
6562: packages installed in <code class="varname">X11BASE</code> and some in
6563: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6564: installed package, the <code class="varname">EVAL_PREFIX</code>
6565: definition can be used. It takes pairs in the format
1.110 hubertf 6566: “<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 6567: variable <code class="varname">DIRNAME</code> will be set to the prefix
6568: of the installed package <package>, or
6569: “<span class="quote">${X11PREFIX}</span>” if the package is not
6570: installed.</p>
1.75 rillig 6571: <p>This is best illustrated by example.</p>
6572: <p>The following lines are taken from
1.87 wiz 6573: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6574: <pre class="programlisting">
1.100 rillig 6575: EVAL_PREFIX+= GTKDIR=gtk+
6576: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6577: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6578: CONFIGURE_ARGS+= --enable-multibyte
6579: </pre>
1.88 wiz 6580: <p>Specific defaults can be defined for the packages
6581: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6582: definition of the form:</p>
1.75 rillig 6583: <pre class="programlisting">
1.100 rillig 6584: GTKDIR_DEFAULT= ${LOCALBASE}
6585: </pre>
1.75 rillig 6586: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6587: to the first definition in
6588: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6589: </li>
1.76 rillig 6590: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.110 hubertf 6591: 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 6592: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6593: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6594: </ul></div>
6595: </div>
6596: <div class="sect1" lang="en">
6597: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6598: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114 jmcneill 6599: <p>When building a package, various directories are used to store
1.87 wiz 6600: source files, temporary files, pkgsrc-internal files, and so on. These
6601: directories are explained here.</p>
1.75 rillig 6602: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6603: are two common base directories for these relative directories:
6604: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6605: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6606: inside the package itself.</p>
1.75 rillig 6607: <div class="variablelist"><dl>
6608: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6609: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6610: root directory. Generally, you don't need
6611: it.</p></dd>
1.97 rillig 6612: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6613: <dd><p>This is an absolute pathname that points to the
6614: current package.</p></dd>
1.75 rillig 6615: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6616: <dd><p>This is a pathname relative to
1.87 wiz 6617: <code class="varname">PKGSRCDIR</code> that points to the current
6618: package.</p></dd>
1.75 rillig 6619: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6620: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 6621: where all work takes place. The distfiles are extracted to this
1.87 wiz 6622: directory. It also contains temporary directories and log files used by
6623: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6624: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6625: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6626: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6627: where the distfiles are extracted. It is usually a direct subdirectory
6628: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6629: that isn't hidden. This variable may be changed by a package
6630: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6631: </dl></div>
1.114 jmcneill 6632: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6633: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116 rillig 6634: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114 jmcneill 6635: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6636: If users would like to have their pkgsrc trees behave in a
6637: read-only manner, then the value of
6638: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6639: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 6640: </div>
6641: <div class="sect1" lang="en">
6642: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6643: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110 hubertf 6644: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87 wiz 6645: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6646: phase. This will automatically run all phases that are required for this
6647: phase. The default phase is <code class="varname">build</code>, that is, when you
1.110 hubertf 6648: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87 wiz 6649: the package will be built, but not installed.</p>
1.75 rillig 6650: </div>
6651: <div class="sect1" lang="en">
6652: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6653: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6654: <p>The first step in building a package is to fetch the
1.88 wiz 6655: distribution files (distfiles) from the sites that are providing
6656: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6657: phase.</p>
1.81 rillig 6658: <div class="sect2" lang="en">
6659: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6660: <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 6661: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6662: defines all URLs from where the distfile, whose name is
6663: derived from the <code class="varname">DISTNAME</code> variable, is
6664: fetched. The more complicated cases are described
6665: below.</p>
6666: <p>The variable <code class="varname">DISTFILES</code> specifies
6667: the list of distfiles that have to be fetched. Its value
6668: defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6669: so that most packages don't need to define it at all.
6670: <code class="varname">EXTRACT_SUFX</code> is
6671: <code class="literal">.tar.gz</code> by default, but can be changed
6672: freely. Note that if your package requires additional
6673: distfiles to the default one, you cannot just append the
6674: additional filenames using the <code class="literal">+=</code>
6675: operator, but you have write for example:</p>
1.81 rillig 6676: <pre class="programlisting">
1.100 rillig 6677: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6678: </pre>
1.88 wiz 6679: <p>Each distfile is fetched from a list of sites, usually
6680: <code class="varname">MASTER_SITES</code>. If the package has multiple
6681: <code class="varname">DISTFILES</code> or multiple
6682: <code class="varname">PATCHFILES</code> from different sites, you can
6683: set
6684: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6685: to the list of URLs where the file
6686: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6687: (including the suffix) can be found.</p>
6688: <pre class="programlisting">
1.100 rillig 6689: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6690: DISTFILES+= foo-file.tar.gz
6691: SITES.foo-file.tar.gz= \
6692: http://www.somewhere.com/somehow/ \
6693: http://www.somewhereelse.com/mirror/somehow/
6694: </pre>
1.81 rillig 6695: <p>When actually fetching the distfiles, each item from
1.88 wiz 6696: <code class="varname">MASTER_SITES</code> or
6697: <code class="varname">SITES.*</code> gets the name of each distfile
6698: appended to it, without an intermediate slash. Therefore,
6699: all site values have to end with a slash or other separator
6700: character. This allows for example to set
6701: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6702: that gets the name of the distfile as a parameter. In this
6703: case, the definition would look like:</p>
1.81 rillig 6704: <pre class="programlisting">
1.100 rillig 6705: MASTER_SITES= http://www.example.com/download.cgi?file=
6706: </pre>
1.125 wiz 6707: <p> The exception to this rule are URLs starting with a dash.
6708: In that case the URL is taken as is, fetched and the result stored
6709: under the name of the distfile.</p>
1.81 rillig 6710: <p>There are some predefined values for
1.88 wiz 6711: <code class="varname">MASTER_SITES</code>, which can be used in
6712: packages. The names of the variables should speak for
6713: themselves.</p>
6714: <pre class="programlisting">
1.100 rillig 6715: ${MASTER_SITE_APACHE}
6716: ${MASTER_SITE_BACKUP}
6717: ${MASTER_SITE_CYGWIN}
6718: ${MASTER_SITE_DEBIAN}
6719: ${MASTER_SITE_FREEBSD}
6720: ${MASTER_SITE_FREEBSD_LOCAL}
6721: ${MASTER_SITE_GENTOO}
6722: ${MASTER_SITE_GNOME}
6723: ${MASTER_SITE_GNU}
6724: ${MASTER_SITE_GNUSTEP}
6725: ${MASTER_SITE_IFARCHIVE}
6726: ${MASTER_SITE_KDE}
6727: ${MASTER_SITE_MOZILLA}
6728: ${MASTER_SITE_MYSQL}
6729: ${MASTER_SITE_OPENOFFICE}
6730: ${MASTER_SITE_PERL_CPAN}
6731: ${MASTER_SITE_PGSQL}
6732: ${MASTER_SITE_R_CRAN}
6733: ${MASTER_SITE_SOURCEFORGE}
6734: ${MASTER_SITE_SOURCEFORGE_JP}
6735: ${MASTER_SITE_SUNSITE}
6736: ${MASTER_SITE_SUSE}
6737: ${MASTER_SITE_TEX_CTAN}
6738: ${MASTER_SITE_XCONTRIB}
6739: ${MASTER_SITE_XEMACS}
6740: </pre>
1.88 wiz 6741: <p>Some explanations for the less self-explaining ones:
6742: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.110 hubertf 6743: 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
6744: 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 6745: <p>If you choose one of these predefined sites, you may
6746: want to specify a subdirectory of that site. Since these
6747: macros may expand to more than one actual site, you
6748: <span class="emphasis"><em>must</em></span> use the following construct to
6749: specify a subdirectory:</p>
1.81 rillig 6750: <pre class="programlisting">
1.100 rillig 6751: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6752: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6753: </pre>
1.81 rillig 6754: <p>Note the trailing slash after the subdirectory
1.88 wiz 6755: name.</p>
1.81 rillig 6756: </div>
6757: <div class="sect2" lang="en">
6758: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6759: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6760: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6761: all the distfiles exist in a local directory
1.93 rillig 6762: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 6763: user). If the files do not exist, they are fetched using
6764: commands of the form</p>
1.75 rillig 6765: <pre class="programlisting">
1.100 rillig 6766: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6767: </pre>
1.88 wiz 6768: <p>where <code class="literal">${site}</code> varies through
6769: several possibilities in turn: first,
6770: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6771: sites specified in either <code class="varname">SITES.file</code> if
6772: defined, else <code class="varname">MASTER_SITES</code> or
6773: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6774: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6775: all except the first and the last can be optionally sorted
6776: by the user, via setting either
6777: <code class="varname">MASTER_SORT_RANDOM</code>, and
6778: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6779: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117 jnemeth 6780: <p> The specific command and arguments used depend on the
6781: <code class="varname">FETCH_USING</code> parameter. The example above is
6782: for <code class="literal">FETCH_USING=custom</code>.</p>
1.97 rillig 6783: <p>The distfiles mirror run by the NetBSD Foundation uses the
6784: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6785: distfiles, if they are freely distributable. Packages setting
6786: <code class="varname">NO_SRC_ON_FTP</code> (usually to
6787: “<span class="quote">${RESTRICTED}</span>”) will not have their distfiles
6788: mirrored.</p>
1.81 rillig 6789: </div>
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.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6794: <p>After the distfile(s) are fetched, their checksum is
6795: generated and compared with the checksums stored in the
6796: distinfo file. If the checksums don't match, the build is
6797: aborted. This is to ensure the same distfile is used for
6798: building, and that the distfile wasn't changed, e.g. by some
6799: malign force, deliberately changed distfiles on the master
6800: distribution site or network lossage.</p>
1.75 rillig 6801: </div>
6802: <div class="sect1" lang="en">
6803: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6804: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6805: <p>When the distfiles are present on the local system, they
1.88 wiz 6806: need to be extracted, as they usually come in the form of some
6807: compressed archive format.</p>
1.75 rillig 6808: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6809: extracted. If you only need some of them, you can set the
6810: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6811: files.</p>
6812: <p>Extracting the files is usually done by a little
1.93 rillig 6813: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6814: already knows how to extract various archive formats, so most
6815: likely you will not need to change anything here. But if you
6816: need, the following variables may help you:</p>
1.75 rillig 6817: <div class="variablelist"><dl>
6818: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6819: <dd><p>Use these variables to override the default
1.88 wiz 6820: options for an extract command, which are defined in
1.93 rillig 6821: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6822: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6823: <dd><p>This variable can be set to
1.114 jmcneill 6824: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6825: (which is the default value), <code class="literal">pax</code>, or an
1.88 wiz 6826: absolute pathname pointing to the command with which tar
1.114 jmcneill 6827: archives should be extracted. It is preferred to choose bsdtar over gtar
6828: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 6829: </dl></div>
1.88 wiz 6830: <p>If the <code class="filename">extract</code> program doesn't
6831: serve your needs, you can also override the
6832: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6833: command used for extracting the files. This command is
6834: executed in the <code class="filename">${WRKSRC}</code>
6835: directory. During execution of this command, the shell
6836: variable <code class="varname">extract_file</code> holds the absolute
6837: pathname of the file that is going to be extracted.</p>
1.75 rillig 6838: <p>And if that still does not suffice, you can override the
1.88 wiz 6839: <code class="varname">do-extract</code> target in the package
6840: Makefile.</p>
1.75 rillig 6841: </div>
6842: <div class="sect1" lang="en">
6843: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6844: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6845: <p>After extraction, all the patches named by the
1.88 wiz 6846: <code class="varname">PATCHFILES</code>, those present in the patches
6847: subdirectory of the package as well as in
6848: $LOCALPATCHES/$PKGPATH (e.g.
6849: <code class="filename">/usr/local/patches/graphics/png</code>) are
6850: applied. Patchfiles ending in <code class="filename">.Z</code> or
6851: <code class="filename">.gz</code> are uncompressed before they are
6852: applied, files ending in <code class="filename">.orig</code> or
6853: <code class="filename">.rej</code> are ignored. Any special options to
1.110 hubertf 6854: <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
6855: <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>
6856: <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 6857: it fail if the patches apply with some lines of fuzz. Please
6858: fix (regen) the patches so that they apply cleanly. The
6859: rationale behind this is that patches that don't apply cleanly
6860: may end up being applied in the wrong place, and cause severe
6861: harm there.</p>
1.75 rillig 6862: </div>
6863: <div class="sect1" lang="en">
6864: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6865: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110 hubertf 6866: <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 6867: </p>
1.75 rillig 6868: </div>
6869: <div class="sect1" lang="en">
6870: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6871: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6872: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6873: linkers. The following variables can be used to tweak the
6874: wrappers.</p>
1.75 rillig 6875: <div class="variablelist"><dl>
6876: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6877: <dd><p>The command used to print progress
1.88 wiz 6878: messages. Does nothing by default. Set to
6879: <code class="literal">${ECHO}</code> to see the progress
6880: messages.</p></dd>
1.75 rillig 6881: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6882: <dd><p>This variable can be set to
1.88 wiz 6883: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6884: depending on whether you want additional information in the
6885: wrapper log file.</p></dd>
1.75 rillig 6886: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6887: <dd><p>This variable can be set to
1.88 wiz 6888: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6889: on whether the wrapper should use its cache, which will
6890: improve the speed. The default value is
6891: <code class="literal">yes</code>, but is forced to
6892: <code class="literal">no</code> if the platform does not support
6893: it.</p></dd>
1.75 rillig 6894: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6895: <dd><p>A list of reordering commands. A reordering
6896: command has the form
6897: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6898: It ensures that that
6899: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6900: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6901: </p></dd>
1.75 rillig 6902: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6903: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6904: investigate further]</p></dd>
1.75 rillig 6905: </dl></div>
6906: </div>
6907: <div class="sect1" lang="en">
6908: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6909: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6910: <p>Most pieces of software need information on the header
6911: files, system calls, and library routines which are available
6912: on the platform they run on. The process of determining this
6913: information is known as configuration, and is usually
6914: automated. In most cases, a script is supplied with the
6915: distfiles, and its invocation results in generation of header
6916: files, Makefiles, etc.</p>
6917: <p>If the package contains a configure script, this can be
6918: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
6919: “<span class="quote">yes</span>”. If the configure script is a GNU autoconf
6920: script, you should set <code class="varname">GNU_CONFIGURE</code> to
6921: “<span class="quote">yes</span>” instead. What happens in the
6922: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6923: <pre class="programlisting">
1.100 rillig 6924: .for d in ${CONFIGURE_DIRS}
6925: cd ${WRKSRC} \
6926: && cd ${d} \
6927: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6928: .endfor
6929: </pre>
1.88 wiz 6930: <p><code class="varname">CONFIGURE_DIRS</code> (default:
6931: “<span class="quote">.</span>”) is a list of pathnames relative to
6932: <code class="varname">WRKSRC</code>. In each of these directories, the
6933: configure script is run with the environment
6934: <code class="varname">CONFIGURE_ENV</code> and arguments
6935: <code class="varname">CONFIGURE_ARGS</code>. The variables
6936: <code class="varname">CONFIGURE_ENV</code>,
6937: <code class="varname">CONFIGURE_SCRIPT</code> (default:
6938: “<span class="quote">./configure</span>”) and
6939: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6940: package.</p>
6941: <p>If the program uses an <code class="filename">Imakefile</code>
6942: for configuration, the appropriate steps can be invoked by
6943: setting <code class="varname">USE_IMAKE</code> to
6944: “<span class="quote">yes</span>”. (If you only want the package installed in
6945: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97 rillig 6946: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6947: xmkmf's environment by adding them to the
6948: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111 rillig 6949: <p>If the program uses <code class="filename">cmake</code>
6950: for configuration, the appropriate steps can be invoked by
6951: setting <code class="varname">USE_CMAKE</code> to “<span class="quote">yes</span>”.
6952: You can add variables to cmake's environment by adding them to the
6953: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6954: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6955: The top directory argument is given by the
6956: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
6957: “<span class="quote">.</span>” (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97 rillig 6958: <p>If there is no configure step at all, set
6959: <code class="varname">NO_CONFIGURE</code> to “<span class="quote">yes</span>”.</p>
1.75 rillig 6960: </div>
6961: <div class="sect1" lang="en">
6962: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6963: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6964: <p>For building a package, a rough equivalent of the
6965: following code is executed.</p>
1.75 rillig 6966: <pre class="programlisting">
1.100 rillig 6967: .for d in ${BUILD_DIRS}
6968: cd ${WRKSRC} \
6969: && cd ${d} \
6970: && env ${MAKE_ENV} \
6971: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6972: -f ${MAKE_FILE} \
6973: ${BUILD_TARGET}
6974: .endfor
6975: </pre>
1.88 wiz 6976: <p><code class="varname">BUILD_DIRS</code> (default:
6977: “<span class="quote">.</span>”) is a list of pathnames relative to
6978: <code class="varname">WRKSRC</code>. In each of these directories,
6979: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6980: <code class="varname">MAKE_ENV</code> and arguments
6981: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6982: <code class="varname">MAKE_ENV</code>,
6983: <code class="varname">BUILD_MAKE_FLAGS</code>,
6984: <code class="varname">MAKE_FILE</code> and
6985: <code class="varname">BUILD_TARGET</code> may all be changed by the
6986: package.</p>
1.75 rillig 6987: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.88 wiz 6988: “<span class="quote">gmake</span>” if <code class="varname">USE_TOOLS</code> contains
6989: “<span class="quote">gmake</span>”, “<span class="quote">make</span>” otherwise. The
6990: default value of <code class="varname">MAKE_FILE</code> is
6991: “<span class="quote">Makefile</span>”, and <code class="varname">BUILD_TARGET</code>
6992: defaults to “<span class="quote">all</span>”.</p>
1.97 rillig 6993: <p>If there is no build step at all, set
6994: <code class="varname">NO_BUILD</code> to “<span class="quote">yes</span>”.</p>
1.75 rillig 6995: </div>
6996: <div class="sect1" lang="en">
6997: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6998: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6999: <p>[TODO]</p>
7000: </div>
7001: <div class="sect1" lang="en">
7002: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7003: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 7004: <p>Once the build stage has completed, the final step is to
1.88 wiz 7005: install the software in public directories, so users can
7006: access the programs and files.</p>
1.75 rillig 7007: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 7008: equivalent of the following code is executed. Additionally,
7009: before and after this code, much magic is performed to do
7010: consistency checks, registering the package, and so on.</p>
7011: <pre class="programlisting">
1.100 rillig 7012: .for d in ${INSTALL_DIRS}
7013: cd ${WRKSRC} \
7014: && cd ${d} \
7015: && env ${MAKE_ENV} \
7016: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
7017: -f ${MAKE_FILE} \
7018: ${INSTALL_TARGET}
7019: .endfor
7020: </pre>
1.75 rillig 7021: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 7022: <span class="emphasis"><em>build</em></span> phase.
7023: <code class="varname">INSTALL_DIRS</code> defaults to
7024: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
7025: is “<span class="quote">install</span>” by default, plus
7026: “<span class="quote">install.man</span>” if <code class="varname">USE_IMAKE</code> is
7027: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
7028: defined.</p>
1.75 rillig 7029: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 7030: variables are useful. They are all variations of the
1.110 hubertf 7031: <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 7032: permissions preset. <code class="varname">INSTALL</code> is the plain
7033: install command. The specialized variants, together with their
7034: intended use, are:</p>
1.75 rillig 7035: <div class="variablelist"><dl>
7036: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 7037: <dd><p>directories that contain
7038: binaries</p></dd>
1.75 rillig 7039: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 7040: <dd><p>directories that contain
7041: scripts</p></dd>
1.75 rillig 7042: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 7043: <dd><p>directories that contain shared and static
7044: libraries</p></dd>
1.75 rillig 7045: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 7046: <dd><p>directories that contain data
7047: files</p></dd>
1.75 rillig 7048: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 7049: <dd><p>directories that contain man
7050: pages</p></dd>
1.75 rillig 7051: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 7052: <dd><p>binaries that can be stripped from debugging
7053: symbols</p></dd>
1.75 rillig 7054: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 7055: <dd><p>binaries that cannot be
7056: stripped</p></dd>
1.75 rillig 7057: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 7058: <dd><p>game
7059: binaries</p></dd>
1.75 rillig 7060: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 7061: <dd><p>shared and static
7062: libraries</p></dd>
1.75 rillig 7063: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
7064: <dd><p>data files</p></dd>
7065: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 7066: <dd><p>data files for
7067: games</p></dd>
1.75 rillig 7068: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
7069: <dd><p>man pages</p></dd>
7070: </dl></div>
7071: <p>Some other variables are:</p>
7072: <div class="variablelist"><dl>
7073: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
7074: <dd><p>A list of directories relative to
1.88 wiz 7075: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 wiz 7076: beginning of the <span class="emphasis"><em>install</em></span> phase.
7077: The package is supposed to create all needed directories itself
7078: before installing files to it and list all other directories here.
7079: </p></dd>
1.75 rillig 7080: </dl></div>
1.97 rillig 7081: <p>In the rare cases that a package shouldn't install anything,
7082: set <code class="varname">NO_INSTALL</code> to “<span class="quote">yes</span>”. This is
7083: mostly relevant for packages in the <code class="filename">regress</code>
7084: category.</p>
1.75 rillig 7085: </div>
7086: <div class="sect1" lang="en">
7087: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7088: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 7089: <p>Once the install stage has completed, a binary package of
7090: the installed files can be built. These binary packages can be
7091: used for quick installation without previous compilation, e.g. by
1.110 hubertf 7092: the <span class="command"><strong>make bin-install</strong></span> or by using
7093: <span class="command"><strong>pkg_add</strong></span>.</p>
1.88 wiz 7094: <p>By default, the binary packages are created in
7095: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
7096: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
7097: one for each category in the <code class="varname">CATEGORIES</code>
7098: variable. <code class="varname">PACKAGES</code> defaults to
7099: <code class="filename">pkgsrc/packages</code>.</p>
7100: </div>
7101: <div class="sect1" lang="en">
7102: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7103: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88 wiz 7104: <p>Once you're finished with a package, you can clean the work
1.110 hubertf 7105: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.88 wiz 7106: to clean the work directories of all dependencies too, use
1.110 hubertf 7107: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 7108: </div>
7109: <div class="sect1" lang="en">
7110: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7111: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.75 rillig 7112: <div class="variablelist"><dl>
7113: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 7114: <dd><p>For any of the main targets described in the
7115: previous section, two auxiliary targets exist with
1.87 wiz 7116: “<span class="quote">pre-</span>” and “<span class="quote">post-</span>” used as a
7117: prefix for the main target's name. These targets are
1.88 wiz 7118: invoked before and after the main target is called,
7119: allowing extra configuration or installation steps be
7120: performed from a package's Makefile, for example, which
7121: a program's configure script or install target
7122: omitted.</p></dd>
1.75 rillig 7123: <dt><span class="term">do-*</span></dt>
1.88 wiz 7124: <dd><p>Should one of the main targets do the wrong thing,
7125: and should there be no variable to fix this, you can
7126: redefine it with the do-* target. (Note that redefining
7127: the target itself instead of the do-* target is a bad
7128: idea, as the pre-* and post-* targets won't be called
7129: anymore, etc.) You will not usually need to do
7130: this.</p></dd>
1.75 rillig 7131: <dt><span class="term">reinstall</span></dt>
1.88 wiz 7132: <dd>
1.110 hubertf 7133: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88 wiz 7134: you noticed some file was not installed properly, you
7135: can repeat the installation with this target, which will
7136: ignore the “<span class="quote">already installed</span>” flag.</p>
7137: <p>This is the default value of
7138: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110 hubertf 7139: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88 wiz 7140: package</strong></span>, where the defaults are
7141: “<span class="quote">package</span>” and “<span class="quote">update</span>”,
7142: respectively.</p>
7143: </dd>
1.75 rillig 7144: <dt><span class="term">deinstall</span></dt>
7145: <dd>
1.110 hubertf 7146: <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 7147: current directory, effectively de-installing the
7148: package. The following variables can be used to tune the
7149: behaviour:</p>
1.75 rillig 7150: <div class="variablelist"><dl>
7151: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.110 hubertf 7152: <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 7153: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 7154: <dd><p>Remove all packages that require (depend on)
7155: the given package. This can be used to remove any
7156: packages that may have been pulled in by a given
1.110 hubertf 7157: package, e.g. if <span class="command"><strong>make deinstall
1.87 wiz 7158: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 7159: <code class="filename">pkgsrc/x11/kde</code>, this is
7160: likely to remove whole KDE. Works by adding
1.110 hubertf 7161: “<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 7162: command line.</p></dd>
1.75 rillig 7163: </dl></div>
7164: </dd>
1.88 wiz 7165: <dt><span class="term">bin-install</span></dt>
7166: <dd><p>Install a binary package from local disk and via FTP
7167: from a list of sites (see the
7168: <code class="varname">BINPKG_SITES</code> variable), and do a
1.110 hubertf 7169: <span class="command"><strong>make package</strong></span> if no binary package is
1.88 wiz 7170: available anywhere. The arguments given to
1.110 hubertf 7171: <span class="command"><strong>pkg_add</strong></span> can be set via
1.88 wiz 7172: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7173: operation, etc.</p></dd>
1.75 rillig 7174: <dt><span class="term">update</span></dt>
7175: <dd>
1.88 wiz 7176: <p>This target causes the current package to be
7177: updated to the latest version. The package and all
7178: depending packages first get de-installed, then current
7179: versions of the corresponding packages get compiled and
7180: installed. This is similar to manually noting which
7181: packages are currently installed, then performing a
1.110 hubertf 7182: series of <span class="command"><strong>make deinstall</strong></span> and
7183: <span class="command"><strong>make install</strong></span> (or whatever
1.88 wiz 7184: <code class="varname">UPDATE_TARGET</code> is set to) for these
7185: packages.</p>
7186: <p>You can use the “<span class="quote">update</span>” target to
1.110 hubertf 7187: resume package updating in case a previous <span class="command"><strong>make
1.88 wiz 7188: update</strong></span> was interrupted for some reason.
7189: However, in this case, make sure you don't call
1.110 hubertf 7190: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88 wiz 7191: list of dependent packages in <code class="varname">WRKDIR</code>.
7192: Otherwise, you lose the ability to automatically update
7193: the current package along with the dependent packages
7194: you have installed.</p>
1.110 hubertf 7195: <p>Resuming an interrupted <span class="command"><strong>make
1.88 wiz 7196: update</strong></span> will only work as long as the package
7197: tree remains unchanged. If the source code for one of
7198: the packages to be updated has been changed, resuming
1.110 hubertf 7199: <span class="command"><strong>make update</strong></span> will most certainly
1.88 wiz 7200: fail!</p>
7201: <p>The following variables can be used either on the
1.110 hubertf 7202: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7203: alter the behaviour of <span class="command"><strong>make
1.88 wiz 7204: update</strong></span>:</p>
1.75 rillig 7205: <div class="variablelist"><dl>
7206: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7207: <dd><p>Install target to recursively use for the
7208: updated package and the dependent packages.
7209: Defaults to <code class="varname">DEPENDS_TARGET</code> if
7210: set, “<span class="quote">install</span>” otherwise for
1.110 hubertf 7211: <span class="command"><strong>make update</strong></span>. Other good
1.88 wiz 7212: targets are “<span class="quote">package</span>” or
7213: “<span class="quote">bin-install</span>”. Do not set this to
7214: “<span class="quote">update</span>” or you will get stuck in an
7215: endless loop!</p></dd>
1.75 rillig 7216: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7217: <dd><p>Don't clean up after updating. Useful if
7218: you want to leave the work sources of the updated
7219: packages around for inspection or other purposes.
7220: Be sure you eventually clean up the source tree
7221: (see the “<span class="quote">clean-update</span>” target below)
7222: or you may run into troubles with old source code
7223: still lying around on your next
1.110 hubertf 7224: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88 wiz 7225: update</strong></span>.</p></dd>
1.75 rillig 7226: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7227: <dd><p>Deinstall each package before installing
7228: (making <code class="varname">DEPENDS_TARGET</code>). This
7229: may be necessary if the
7230: “<span class="quote">clean-update</span>” target (see below) was
1.110 hubertf 7231: called after interrupting a running <span class="command"><strong>make
1.88 wiz 7232: update</strong></span>.</p></dd>
1.75 rillig 7233: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7234: <dd><p>Allows you to disable recursion and hardcode
7235: the target for packages. The default is
7236: “<span class="quote">update</span>” for the update target,
7237: facilitating a recursive update of prerequisite
7238: packages. Only set
7239: <code class="varname">DEPENDS_TARGET</code> if you want to
7240: disable recursive updates. Use
7241: <code class="varname">UPDATE_TARGET</code> instead to just
7242: set a specific target for each package to be
1.110 hubertf 7243: installed during <span class="command"><strong>make update</strong></span>
1.88 wiz 7244: (see above).</p></dd>
1.75 rillig 7245: </dl></div>
7246: </dd>
7247: <dt><span class="term">clean-update</span></dt>
7248: <dd>
1.88 wiz 7249: <p>Clean the source tree for all packages that would
1.110 hubertf 7250: get updated if <span class="command"><strong>make update</strong></span> was called
1.88 wiz 7251: from the current directory. This target should not be
7252: used if the current package (or any of its depending
7253: packages) have already been de-installed (e.g., after
1.110 hubertf 7254: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88 wiz 7255: some packages you intended to update. As a rule of
7256: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110 hubertf 7257: the first time you run <span class="command"><strong>make update</strong></span>
1.88 wiz 7258: and only if you have a dirty package tree (e.g., if you
7259: used <code class="varname">NOCLEAN</code>).</p>
7260: <p>If you are unsure about whether your tree is
1.110 hubertf 7261: clean, you can either perform a <span class="command"><strong>make
1.88 wiz 7262: clean</strong></span> at the top of the tree, or use the
7263: following sequence of commands from the directory of the
7264: package you want to update (<span class="emphasis"><em>before</em></span>
1.110 hubertf 7265: running <span class="command"><strong>make update</strong></span> for the first
1.88 wiz 7266: time, otherwise you lose all the packages you wanted to
7267: update!):</p>
1.87 wiz 7268: <pre class="screen">
7269: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7270: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7271: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7272: </pre>
1.88 wiz 7273: <p>The following variables can be used either on the
1.110 hubertf 7274: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7275: <span class="command"><strong>make clean-update</strong></span>:</p>
1.75 rillig 7276: <div class="variablelist"><dl>
7277: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110 hubertf 7278: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88 wiz 7279: reconstruct the list of directories to update for
1.110 hubertf 7280: this package. Only use this if <span class="command"><strong>make
1.88 wiz 7281: update</strong></span> successfully installed all
7282: packages you wanted to update. Normally, this is
1.110 hubertf 7283: done automatically on <span class="command"><strong>make
1.88 wiz 7284: update</strong></span>, but may have been suppressed by
7285: the <code class="varname">NOCLEAN</code> variable (see
7286: above).</p></dd>
1.75 rillig 7287: </dl></div>
7288: </dd>
1.88 wiz 7289: <dt><span class="term">replace</span></dt>
7290: <dd>
7291: <p>Update the installation of the current package. This
7292: differs from update in that it does not replace dependent
1.93 rillig 7293: 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 7294: target to work.</p>
7295: <p><span class="emphasis"><em>Be careful when using this
7296: target!</em></span> There are no guarantees that dependent
7297: packages will still work, in particular they will most
1.110 hubertf 7298: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88 wiz 7299: library package whose shared library major version changed
7300: between your installed version and the new one. For this
7301: reason, this target is not officially supported and only
7302: recommended for advanced users.</p>
7303: </dd>
1.75 rillig 7304: <dt><span class="term">info</span></dt>
1.110 hubertf 7305: <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 7306: package. You can use this to check which version of a
7307: package is installed.</p></dd>
7308: <dt><span class="term">index</span></dt>
7309: <dd>
7310: <p>This is a top-level command, i.e. it should be used in
7311: the <code class="filename">pkgsrc</code> directory. It creates a
7312: database of all packages in the local pkgsrc tree, including
7313: dependencies, comment, maintainer, and some other useful
7314: information. Individual entries are created by running
1.110 hubertf 7315: <span class="command"><strong>make describe</strong></span> in the packages'
1.88 wiz 7316: directories. This index file is saved as
7317: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.110 hubertf 7318: verbose format by running <span class="command"><strong>make
1.88 wiz 7319: print-index</strong></span>. You can search in it with
1.110 hubertf 7320: <span class="command"><strong>make search
1.88 wiz 7321: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7322: extract a list of all packages that depend on a particular
1.110 hubertf 7323: one by running <span class="command"><strong>make show-deps
1.88 wiz 7324: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7325: <p>Running this command takes a very long time, some
7326: hours even on fast machines!</p>
7327: </dd>
1.75 rillig 7328: <dt><span class="term">readme</span></dt>
1.88 wiz 7329: <dd>
7330: <p>This target generates a
7331: <code class="filename">README.html</code> file, which can be
1.91 rillig 7332: 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 7333: contain references to any packages which are in the
7334: <code class="varname">PACKAGES</code> directory on the local
7335: host. The generated files can be made to refer to URLs
7336: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7337: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7338: wanted to generate <code class="filename">README.html</code>
7339: files which pointed to binary packages on the local
7340: machine, in the directory
7341: <code class="filename">/usr/packages</code>, set
7342: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7343: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7344: <code class="varname">${PACKAGES}</code> directory and its
7345: subdirectories will be searched for all the binary
7346: packages.</p>
7347: <p>The target can be run at the toplevel or in category
7348: directories, in which case it descends recursively.</p>
7349: </dd>
1.75 rillig 7350: <dt><span class="term">readme-all</span></dt>
1.88 wiz 7351: <dd><p>This is a top-level command, run it in
7352: <code class="filename">pkgsrc</code>. Use this target to create a
7353: file <code class="filename">README-all.html</code> which contains a
7354: list of all packages currently available in the NetBSD
7355: Packages Collection, together with the category they belong
7356: to and a short description. This file is compiled from the
7357: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110 hubertf 7358: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88 wiz 7359: readme</strong></span>.</p></dd>
1.75 rillig 7360: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 7361: <dd><p>This is very much the same as the
7362: “<span class="quote">readme</span>” target (see above), but is to be
7363: used when generating a pkgsrc tree to be written to a
7364: CD-ROM. This target also produces
7365: <code class="filename">README.html</code> files, and can be made
7366: to refer to URLs based on
7367: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 7368: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 7369: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 7370: <dd><p>This target shows which distfiles and patchfiles
7371: are needed to build the package
7372: (<code class="varname">ALLFILES</code>, which contains all
7373: <code class="varname">DISTFILES</code> and
1.87 wiz 7374: <code class="varname">PATCHFILES</code>, but not
7375: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 7376: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 7377: <dd><p>This target shows nothing if the package is not
7378: installed. If a version of this package is installed,
7379: but is not the version provided in this version of
7380: pkgsrc, then a warning message is displayed. This target
7381: can be used to show which of your installed packages are
7382: downlevel, and so the old versions can be deleted, and
7383: the current ones added.</p></dd>
1.75 rillig 7384: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 7385: <dd><p>This target shows the directory in the pkgsrc
7386: hierarchy from which the package can be built and
7387: installed. This may not be the same directory as the one
7388: from which the package was installed. This target is
7389: intended to be used by people who may wish to upgrade
7390: many packages on a single host, and can be invoked from
7391: the top-level pkgsrc Makefile by using the
1.87 wiz 7392: “<span class="quote">show-host-specific-pkgs</span>” target.</p></dd>
1.75 rillig 7393: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 7394: <dd><p>This target shows which installed packages match
7395: the current package's <code class="varname">DEPENDS</code>. Useful
7396: if out of date dependencies are causing build
7397: problems.</p></dd>
1.75 rillig 7398: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 7399: <dd><p>After a package is installed, check all its
7400: binaries and (on ELF platforms) shared libraries to see
7401: if they find the shared libs they need. Run by default
1.110 hubertf 7402: 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 7403: <dt><span class="term">print-PLIST</span></dt>
7404: <dd>
7405: <p>After a “<span class="quote">make install</span>” from a new or
1.88 wiz 7406: upgraded pkg, this prints out an attempt to generate a
1.110 hubertf 7407: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88 wiz 7408: -newer work/.extract_done</strong></span>. An attempt is made
7409: to care for shared libs etc., but it is
1.87 wiz 7410: <span class="emphasis"><em>strongly</em></span> recommended to review the
7411: result before putting it into
7412: <code class="filename">PLIST</code>. On upgrades, it's useful to
7413: diff the output of this command against an already
7414: existing <code class="filename">PLIST</code> file.</p>
1.110 hubertf 7415: <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 7416: other methods that don't update file access times, be
7417: sure to add these files manually to your
1.87 wiz 7418: <code class="filename">PLIST</code>, as the “<span class="quote">find
7419: -newer</span>” command used by this target won't catch
7420: them!</p>
1.123 snj 7421: <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 7422: information on this target.</p>
1.75 rillig 7423: </dd>
7424: <dt><span class="term">bulk-package</span></dt>
7425: <dd>
1.88 wiz 7426: <p>Used to do bulk builds. If an appropriate binary
7427: package already exists, no action is taken. If not, this
7428: target will compile, install and package it (and its
7429: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.110 hubertf 7430: properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, “Configuration”</a>).
1.88 wiz 7431: After creating the binary package, the sources, the
7432: just-installed package and its required packages are
7433: removed, preserving free disk space.</p>
7434: <p><span class="emphasis"><em>Beware that this target may deinstall
7435: all packages installed on a system!</em></span></p>
1.75 rillig 7436: </dd>
7437: <dt><span class="term">bulk-install</span></dt>
7438: <dd>
1.88 wiz 7439: <p>Used during bulk-installs to install required
7440: packages. If an up-to-date binary package is available,
1.110 hubertf 7441: 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,
7442: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87 wiz 7443: but the installed binary won't be removed.</p>
1.88 wiz 7444: <p>A binary package is considered
7445: “<span class="quote">up-to-date</span>” to be installed via
1.110 hubertf 7446: <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 7447: <div class="itemizedlist"><ul type="disc">
7448: <li><p>None of the package's files
7449: (<code class="filename">Makefile</code>, ...) were modified
7450: since it was built.</p></li>
7451: <li><p>None of the package's required (binary)
7452: packages were modified since it was built.</p></li>
1.75 rillig 7453: </ul></div>
1.88 wiz 7454: <p><span class="emphasis"><em>Beware that this target may deinstall
7455: all packages installed on a system!</em></span></p>
1.75 rillig 7456: </dd>
7457: </dl></div>
7458: </div>
7459: </div>
7460: <div class="chapter" lang="en">
7461: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7462: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75 rillig 7463: <div class="toc">
7464: <p><b>Table of Contents</b></p>
7465: <dl>
1.106 rillig 7466: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7467: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7468: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7469: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75 rillig 7470: </dl>
7471: </div>
1.87 wiz 7472: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7473: by pkgsrc and also for individual packages to define what commands
7474: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7475: or for later run-time of an installed packaged (such as
7476: <code class="varname">DEPENDS</code>).
7477: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7478: package will not be used.</p>
7479: <p>When building a package, the replacement tools are
1.75 rillig 7480: made available in a directory (as symlinks or wrapper scripts)
7481: that is early in the executable search path. Just like the buildlink
1.87 wiz 7482: system, this helps with consistent builds.</p>
7483: <p>A tool may be needed to help build a specific package. For example,
7484: perl, GNU make (gmake) or yacc may be needed.</p>
7485: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7486: tool may be inefficient for building a package with pkgsrc.
7487: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7488: yacc) or a better sed.</p>
7489: <p>The tools used by a package can be listed by running
1.110 hubertf 7490: <span class="command"><strong>make show-tools</strong></span>.</p>
1.75 rillig 7491: <div class="sect1" lang="en">
7492: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7493: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7494: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7495: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110 hubertf 7496: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7497: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75 rillig 7498: These can be seen by running:
1.110 hubertf 7499: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87 wiz 7500: <p>If a package needs a specific program to build
1.75 rillig 7501: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7502: to define the tools needed.</p>
1.75 rillig 7503: </div>
7504: <div class="sect1" lang="en">
7505: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7506: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.87 wiz 7507: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75 rillig 7508: and not the native version for a build dependency.
7509: And the :run means that it is used for a
7510: run-time dependencies also (and becomes a DEPENDS).
7511: The default is a build dependency which can be set with
7512: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7513: and pkg-config:build.)</p>
1.75 rillig 7514: <pre class="programlisting">
7515: USE_TOOLS+= mktemp:pkgsrc
7516: USE_TOOLS+= gmake perl:run pkg-config
7517: </pre>
1.87 wiz 7518: <p>When using the tools framework, a
1.75 rillig 7519: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7520: which contains the full path to the appropriate tool. For example,
7521: <code class="varname">TOOLS_PATH.bash</code> could be “<span class="quote">/bin/bash</span>”
1.87 wiz 7522: on Linux systems.</p>
7523: <p>If you always need a pkgsrc version of the
1.75 rillig 7524: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7525: </p>
7526: </div>
7527: <div class="sect1" lang="en">
7528: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7529: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7530: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7531: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7532: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7533: the name of the common tools. For example:</p>
7534: <pre class="programlisting">
7535: .if exists(/usr/bin/bzcat)
7536: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7537: .elif exists(/usr/bin/bzip2)
7538: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7539: .endif
1.69 rillig 7540:
1.75 rillig 7541: TOOLS_PLATFORM.true?= true # shell builtin
7542: </pre>
7543: </div>
1.97 rillig 7544: <div class="sect1" lang="en">
7545: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7546: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.97 rillig 7547: <div class="qandaset">
7548: <dl>
1.106 rillig 7549: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97 rillig 7550: </dt>
1.106 rillig 7551: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97 rillig 7552: tools?</a>
7553: </dt>
1.106 rillig 7554: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97 rillig 7555: package is using while being built? I want to know whether it
7556: uses sed or not.</a>
7557: </dt>
7558: </dl>
7559: <table border="0" summary="Q and A Set">
7560: <col align="left" width="1%">
7561: <tbody>
7562: <tr class="question">
7563: <td align="left" valign="top">
1.126 ! jakllsch 7564: <a name="tools.new"></a><a name="id52055318"></a><p><b>18.4.1.</b></p>
1.97 rillig 7565: </td>
7566: <td align="left" valign="top"><p>How do I add a new tool?</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.listall"></a><a name="id52055326"></a><p><b>18.4.2.</b></p>
1.97 rillig 7575: </td>
7576: <td align="left" valign="top"><p>How do I get a list of all available
7577: tools?</p></td>
7578: </tr>
7579: <tr class="answer">
7580: <td align="left" valign="top"></td>
7581: <td align="left" valign="top"><p>TODO</p></td>
7582: </tr>
7583: <tr class="question">
7584: <td align="left" valign="top">
1.126 ! jakllsch 7585: <a name="tools.used"></a><a name="id52055335"></a><p><b>18.4.3.</b></p>
1.97 rillig 7586: </td>
7587: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7588: package is using while being built? I want to know whether it
7589: uses sed or not.</p></td>
7590: </tr>
7591: <tr class="answer">
7592: <td align="left" valign="top"></td>
7593: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7594: to do it.)</p></td>
7595: </tr>
7596: </tbody>
7597: </table>
7598: </div>
7599: </div>
1.75 rillig 7600: </div>
7601: <div class="chapter" lang="en">
7602: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7603: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75 rillig 7604: <div class="toc">
7605: <p><b>Table of Contents</b></p>
7606: <dl>
1.106 rillig 7607: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75 rillig 7608: <dd><dl>
1.106 rillig 7609: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.123 snj 7610: <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 7611: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7612: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7613: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7614: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7615: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7616: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7617: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7618: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7619: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7620: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7621: </dl></dd>
1.123 snj 7622: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the fetch phase</a></span></dt>
1.106 rillig 7623: <dd><dl>
7624: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7625: <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>
7626: </dl></dd>
1.123 snj 7627: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the configure phase</a></span></dt>
1.106 rillig 7628: <dd><dl>
7629: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7630: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7631: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7632: </dl></dd>
7633: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7634: <dd><dl>
7635: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7636: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7637: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
7638: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
7639: </dl></dd>
1.123 snj 7640: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the build phase</a></span></dt>
1.106 rillig 7641: <dd><dl>
7642: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7643: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.123 snj 7644: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to ...</a></span></dt>
1.106 rillig 7645: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7646: </dl></dd>
1.123 snj 7647: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the install phase</a></span></dt>
1.106 rillig 7648: <dd><dl>
7649: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7650: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7651: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7652: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7653: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7654: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7655: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7656: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 7657: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 7658: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 7659: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7660: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7661: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7662: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7663: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7664: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7665: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7666: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 7667: emulation</a></span></dt>
1.106 rillig 7668: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7669: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75 rillig 7670: </dl></dd>
1.106 rillig 7671: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7672: </dl>
7673: </div>
7674: <div class="sect1" lang="en">
7675: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7676: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.75 rillig 7677: <div class="sect2" lang="en">
7678: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7679: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7680: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7681: different platforms. As a result, it is important to ensure,
7682: where possible, that packages in pkgsrc are portable. This
7683: chapter mentions some particular details you should pay
7684: attention to while working on pkgsrc.</p>
1.78 rillig 7685: </div>
7686: <div class="sect2" lang="en">
7687: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 7688: <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 7689: </h3></div></div></div>
1.78 rillig 7690: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7691: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7692: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7693: want to use those variables in the preprocessor directives of
1.110 hubertf 7694: <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 7695: <code class="literal">.for</code>), you need to include the file
7696: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7697: loads the user preferences.</p>
1.78 rillig 7698: <p>But note that some variables may not be completely defined
1.87 wiz 7699: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7700: included, as they may contain references to variables that are
7701: not yet defined. In shell commands this is no problem, since
7702: variables are actually macros, which are only expanded when they
7703: are used. But in the preprocessor directives mentioned above and
7704: in dependency lines (of the form <code class="literal">target:
7705: dependencies</code>) the variables are expanded at load
7706: time.</p>
1.78 rillig 7707: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
7708: <h3 class="title">Note</h3>
7709: <p>Currently there is no exhaustive list of all
1.87 wiz 7710: variables that tells you whether they can be used at load time
7711: or only at run time, but it is in preparation.</p>
1.78 rillig 7712: </div>
7713: </div>
7714: <div class="sect2" lang="en">
7715: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7716: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.88 wiz 7717: <p>Occasionally, packages require interaction from the user,
7718: and this can be in a number of ways:</p>
1.78 rillig 7719: <div class="itemizedlist"><ul type="disc">
1.79 rillig 7720: <li><p>When fetching the distfiles, some packages require user
1.87 wiz 7721: interaction such as entering username/password or accepting a
7722: license on a web page.</p></li>
1.88 wiz 7723: <li><p>When extracting the distfiles, some packages may ask for
7724: passwords.</p></li>
1.78 rillig 7725: <li><p>help to configure the package before it is built</p></li>
7726: <li><p>help during the build process</p></li>
7727: <li><p>help during the installation of a package</p></li>
7728: </ul></div>
1.88 wiz 7729: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7730: provided to notify the pkgsrc mechanism of an interactive stage
7731: which will be needed, and this should be set in the package's
7732: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7733: <pre class="programlisting">
1.100 rillig 7734: INTERACTIVE_STAGE= build
1.87 wiz 7735: </pre>
1.78 rillig 7736: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7737: <pre class="programlisting">
1.100 rillig 7738: INTERACTIVE_STAGE= configure install
1.87 wiz 7739: </pre>
1.88 wiz 7740: <p>The user can then decide to skip this package by setting the
7741: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7742: </div>
7743: <div class="sect2" lang="en">
7744: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7745: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.98 wiz 7746: <p>Authors of software can choose the licence under which
7747: software can be copied. This is due to copyright law, and reasons
7748: for license choices are outside the scope of pkgsrc. The pkgsrc
7749: system recognizes that there are a number of licenses which some
7750: users may find objectionable or difficult or impossible to comply
7751: with. The Free Software Foundation has declared some licenses
7752: "Free", and the Open Source Initiative has a definition of "Open
7753: Source". The pkgsrc system, as a policy choice, does not label
7754: packages which have licenses that are Free or Open Source.
7755: However, packages without a license meeting either of those tests
7756: are labeled with a license tag denoting the license. Note that a
7757: package with no license to copy trivially does not meet either the
7758: Free or Open Source test.</p>
7759: <p>For packages which are not Free or Open Source, pkgsrc will
7760: not build the package unless the user has indicated to pkgsrc that
7761: packages with that particular license may be built. Note that
7762: this documentation avoids the term "accepted the license". The
7763: pkgsrc system is merely providing a mechanism to avoid
1.99 rillig 7764: accidentally building a package with a non-free license;
1.98 wiz 7765: judgement and responsibility remain with the user. (Installation
7766: of binary packages are not currently subject to this mechanism;
7767: this is a bug.)</p>
7768: <p>One might want to only install packages with a BSD license,
1.121 jnemeth 7769: or the GPL, and not the other. The free licenses are added to the
7770: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The
7771: user can override the default by setting the
7772: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7773: of "+=". The licenses accepted by default are:
7774: </p>
7775: <pre class="programlisting">
7776: public-domain
7777: gnu-gpl-v2 gnu-lgpl-v2
7778: gnu-gpl-v3 gnu-lgpl-v3
7779: original-bsd modified-bsd
7780: x11
7781: apache-2.0
7782: cddl-1.0
7783: open-font-license
7784: </pre>
7785: <p>
7786: </p>
1.78 rillig 7787: <p>The license tag mechanism is intended to address
1.87 wiz 7788: copyright-related issues surrounding building, installing and
7789: using a package, and not to address redistribution issues (see
7790: <code class="varname">RESTRICTED</code> and
1.121 jnemeth 7791: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7792: Packages with redistribution restrictions should set these
7793: tags.</p>
1.98 wiz 7794: <p>Denoting that a package may be copied according to a
7795: particular license is done by placing the license in
1.87 wiz 7796: <code class="filename">pkgsrc/licenses</code> and setting the
7797: <code class="varname">LICENSE</code> variable to a string identifying the
1.91 rillig 7798: 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 7799: <pre class="programlisting">
1.100 rillig 7800: LICENSE= xv-license
1.87 wiz 7801: </pre>
7802: <p>When trying to build, the user will get a notice that the
1.98 wiz 7803: package is covered by a license which has not been placed in the
7804: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7805: <pre class="programlisting">
1.100 rillig 7806: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7807: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7808: ===> To view the license, enter "/usr/bin/make show-license".
7809: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7810: ===> ACCEPTABLE_LICENSES+=xv-license
7811: *** Error code 1
1.87 wiz 7812: </pre>
1.110 hubertf 7813: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 7814: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 7815: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7816: convey to pkgsrc that it should not in the future fail because of
7817: that license:</p>
1.78 rillig 7818: <pre class="programlisting">
1.100 rillig 7819: ACCEPTABLE_LICENSES+=xv-license
1.87 wiz 7820: </pre>
1.98 wiz 7821: <p>When adding a package with a new license, the license text
7822: should be added to <code class="filename">pkgsrc/licenses</code> for
7823: displaying. A list of known licenses can be seen in this
1.91 rillig 7824: directory.</p>
1.98 wiz 7825: <p>When the license changes (in a way other than formatting),
7826: please make sure that the new license has a different name (e.g.,
7827: append the version number if it exists, or the date). Just
7828: because a user told pkgsrc to build programs under a previous
7829: version of a license does not mean that pkgsrc should build
1.99 rillig 7830: programs under the new licenses. The higher-level point is that
1.98 wiz 7831: pkgsrc does not evaluate licenses for reasonableness; the only
7832: test is a mechanistic test of whether a particular text has been
7833: approved by either of two bodies.</p>
1.78 rillig 7834: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98 wiz 7835: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7836: is deprecated because it does not crisply refer to a particular
7837: license text. Another problem with such usage is that it does not
7838: enable a user to tell pkgsrc to proceed for a single package
7839: without also telling pkgsrc to proceed for all packages with that
7840: tag.</p>
1.75 rillig 7841: </div>
7842: <div class="sect2" lang="en">
7843: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7844: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 7845: <p>Some licenses restrict how software may be re-distributed.
1.98 wiz 7846: Because a license tag is required unless the package is Free or
7847: Open Source, all packages with restrictions should have license
7848: tags. By declaring the restrictions, package tools can
7849: automatically refrain from e.g. placing binary packages on FTP
7850: sites.</p>
7851: <p>There are four restrictions that may be encoded, which are
7852: the cross product of sources (distfiles) and binaries not being
7853: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7854: language in any license, and because non-Free licenses tend to be
7855: different from each other, pkgsrc adopts a definition of FTP and
7856: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7857: should not be made available over the Internet at no charge.
7858: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7859: made available on some kind of media, together with other source
7860: and binary packages, and which is sold for a distribution charge.
7861: </p>
7862: <p>In order to encode these restrictions, the package system
1.87 wiz 7863: defines five make variables that can be set to note these
7864: restrictions:</p>
1.75 rillig 7865: <div class="itemizedlist"><ul type="disc">
7866: <li>
7867: <p><code class="varname">RESTRICTED</code></p>
7868: <p>This variable should be set whenever a restriction
1.87 wiz 7869: exists (regardless of its kind). Set this variable to a
1.98 wiz 7870: string containing the reason for the restriction. It should
7871: be understood that those wanting to understand the restriction
7872: will have to read the license, and perhaps seek advice of
7873: counsel.</p>
1.75 rillig 7874: </li>
7875: <li>
7876: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7877: <p>Binaries may not be placed on CD-ROM containing other
7878: binary packages, for which a distribution charge may be made.
7879: In this case, set this variable to
7880: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7881: </li>
7882: <li>
7883: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7884: <p>Binaries may not made available on the Internet without
7885: charge. In this case, set this variable to
7886: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7887: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7888: </li>
7889: <li>
7890: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7891: <p>Distfiles may not be placed on CD-ROM, together with
7892: other distfiles, for which a fee may be charged. In this
7893: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7894: </p>
1.75 rillig 7895: </li>
7896: <li>
7897: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7898: <p>Distfiles may not made available via FTP at no charge.
7899: In this case, set this variable to
7900: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7901: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7902: </li>
7903: </ul></div>
7904: </div>
7905: <div class="sect2" lang="en">
7906: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7907: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 7908: <p>Your package may depend on some other package being present
1.88 wiz 7909: - and there are various ways of expressing this dependency.
7910: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7911: <code class="varname">DEPENDS</code> definitions, the
7912: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7913: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7914: to handle dependencies, and which uses the variables named above.
1.110 hubertf 7915: 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 7916: <p>The basic difference between the two variables is as
1.87 wiz 7917: follows: The <code class="varname">DEPENDS</code> definition registers
7918: that pre-requisite in the binary package so it will be pulled in
7919: when the binary package is later installed, whilst the
7920: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7921: dependency that is only needed for building the package.</p>
1.75 rillig 7922: <p>This means that if you only need a package present whilst
1.87 wiz 7923: you are building, it should be noted as a
7924: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7925: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7926: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7927: <pre class="programlisting">
1.100 rillig 7928: <pre-req-package-name>:../../<category>/<pre-req-package>
1.87 wiz 7929: </pre>
1.75 rillig 7930: <p>Please note that the “<span class="quote">pre-req-package-name</span>”
1.87 wiz 7931: may include any of the wildcard version numbers recognized by
1.110 hubertf 7932: <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 7933: <div class="orderedlist"><ol type="1">
7934: <li>
7935: <p>If your package needs another package's binaries or
1.87 wiz 7936: libraries to build or run, and if that package has a
7937: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7938: <pre class="programlisting">
1.100 rillig 7939: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 7940: </pre>
1.75 rillig 7941: </li>
7942: <li>
7943: <p>If your package needs to use another package to build
1.87 wiz 7944: itself and there is no <code class="filename">buildlink3.mk</code>
7945: file available, use the <code class="varname">BUILD_DEPENDS</code>
7946: definition:</p>
1.75 rillig 7947: <pre class="programlisting">
1.100 rillig 7948: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
1.87 wiz 7949: </pre>
1.75 rillig 7950: </li>
7951: <li>
7952: <p>If your package needs a library with which to link and
1.76 rillig 7953: again there is no <code class="filename">buildlink3.mk</code> file
1.87 wiz 7954: available, this is specified using the
7955: <code class="varname">DEPENDS</code> definition. For example:</p>
1.75 rillig 7956: <pre class="programlisting">
1.100 rillig 7957: DEPENDS+= xpm-3.4j:../../graphics/xpm
1.87 wiz 7958: </pre>
1.109 rillig 7959: <p>You can also use wildcards in package dependencies:</p>
1.75 rillig 7960: <pre class="programlisting">
1.100 rillig 7961: DEPENDS+= xpm-[0-9]*:../../graphics/xpm
1.87 wiz 7962: </pre>
1.75 rillig 7963: <p>Note that such wildcard dependencies are retained when
1.87 wiz 7964: creating binary packages. The dependency is checked when
7965: installing the binary package and any package which matches
7966: the pattern will be used. Wildcard dependencies should be
7967: used with care.</p>
1.75 rillig 7968: <p>The “<span class="quote">-[0-9]*</span>” should be used instead of
1.87 wiz 7969: “<span class="quote">-*</span>” to avoid potentially ambiguous matches
7970: such as “<span class="quote">tk-postgresql</span>” matching a
7971: “<span class="quote">tk-*</span>” <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7972: <p>Wildcards can also be used to specify that a package
1.87 wiz 7973: will only build against a certain minimum version of a
7974: pre-requisite:</p>
1.75 rillig 7975: <pre class="programlisting">
1.100 rillig 7976: DEPENDS+= tiff>=3.5.4:../../graphics/tiff
1.87 wiz 7977: </pre>
1.75 rillig 7978: <p>This means that the package will build against version
1.87 wiz 7979: 3.5.4 of the tiff library or newer. Such a dependency may
7980: be warranted if, for example, the API of the library has
7981: changed with version 3.5.4 and a package would not compile
7982: against an earlier version of tiff.</p>
1.75 rillig 7983: <p>Please note that such dependencies should only be
1.87 wiz 7984: updated if a package requires a newer pre-requisite, but
1.93 rillig 7985: not to denote recommendations such as
1.87 wiz 7986: ABI changes that do not prevent a package from building
7987: correctly. Such recommendations can be expressed using
7988: <code class="varname">ABI_DEPENDS</code>:</p>
1.75 rillig 7989: <pre class="programlisting">
1.100 rillig 7990: ABI_DEPENDS+= tiff>=3.6.1:../../graphics/tiff
1.87 wiz 7991: </pre>
1.75 rillig 7992: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87 wiz 7993: line, this denotes that while a package will build against
7994: tiff>=3.5.4, at least version 3.6.1 is recommended.
7995: <code class="varname">ABI_DEPENDS</code> entries will be turned into
7996: dependencies unless explicitly ignored (in which case a
7997: warning will be printed).</p>
1.75 rillig 7998: <p>To ignore these ABI dependency recommendations and just
1.87 wiz 7999: use the required <code class="varname">DEPENDS</code>, set
8000: <code class="varname">USE_ABI_DEPENDS=NO</code>. This may make
8001: it easier and faster to update packages built using pkgsrc,
8002: since older compatible dependencies can continue to be
8003: used. This is useful for people who watch their rebuilds
8004: very carefully; it is not very good as a general-purpose
8005: hammer. If you use it, you need to be mindful of possible
8006: ABI changes, including those from the underlying OS.</p>
1.75 rillig 8007: <p>Packages that are built with recommendations ignored
1.87 wiz 8008: may not be uploaded to ftp.NetBSD.org by developers and
8009: should not be used across different systems that may have
8010: different versions of binary packages installed.</p>
1.75 rillig 8011: <p>For security fixes, please update the package
1.110 hubertf 8012: 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 8013: information.</p>
1.75 rillig 8014: </li>
8015: <li>
8016: <p>If your package needs some executable to be able to run
1.87 wiz 8017: correctly and if there's no
8018: <code class="filename">buildlink3.mk</code> file, this is specified
8019: using the <code class="varname">DEPENDS</code> variable. The
1.91 rillig 8020: <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 8021: be able to execute the latex binary from the teTeX package
8022: when it runs, and that is specified:</p>
1.75 rillig 8023: <pre class="programlisting">
1.100 rillig 8024: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.87 wiz 8025: </pre>
1.75 rillig 8026: <p>The comment about wildcard dependencies from previous
1.87 wiz 8027: paragraph applies here, too.</p>
1.75 rillig 8028: </li>
8029: </ol></div>
8030: <p>If your package needs files from another package to build,
1.87 wiz 8031: add the relevant distribution files to
8032: <code class="varname">DISTFILES</code>, so they will be extracted
1.91 rillig 8033: 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 8034: (It relies on the jpeg sources being present in source form
8035: during the build.)</p>
1.75 rillig 8036: </div>
8037: <div class="sect2" lang="en">
8038: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8039: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 8040: <p>Your package may conflict with other packages a user might
1.87 wiz 8041: already have installed on his system, e.g. if your package
1.88 wiz 8042: installs the same set of files as another package in the pkgsrc
8043: tree.</p>
1.75 rillig 8044: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 8045: space-separated list of packages (including version string) your
8046: package conflicts with.</p>
1.91 rillig 8047: <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>
8048: 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 8049: install the same shared library, thus you set in
8050: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
8051: <pre class="programlisting">
1.100 rillig 8052: CONFLICTS= Xaw-Xpm-[0-9]*
1.87 wiz 8053: </pre>
8054: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75 rillig 8055: <pre class="programlisting">
1.100 rillig 8056: CONFLICTS= Xaw3d-[0-9]*
1.87 wiz 8057: </pre>
1.75 rillig 8058: <p>Packages will automatically conflict with other packages
1.87 wiz 8059: with the name prefix and a different version
8060: string. “<span class="quote">Xaw3d-1.5</span>” e.g. will automatically
8061: conflict with the older version “<span class="quote">Xaw3d-1.3</span>”.</p>
1.75 rillig 8062: </div>
8063: <div class="sect2" lang="en">
8064: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8065: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 8066: <p>There are several reasons why a package might be
1.88 wiz 8067: instructed to not build under certain circumstances. If the
1.87 wiz 8068: package builds and runs on most platforms, the exceptions
8069: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
8070: the package builds and runs on a small handful of platforms,
8071: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
8072: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
8073: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
8074: (OS-version-platform) that can use glob-style
8075: wildcards.</p>
1.88 wiz 8076: <p>Some packages are tightly bound to a specific version of an
1.91 rillig 8077: 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 8078: backwards compatible with other versions of the OS, and should be
8079: uploaded to a version specific directory on the FTP server. Mark
8080: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
8081: “<span class="quote">yes</span>”. This variable is not currently used by any of
8082: the package system internals, but may be used in the
8083: future.</p>
1.75 rillig 8084: <p>If the package should be skipped (for example, because it
1.87 wiz 8085: provides functionality already provided by the system), set
1.88 wiz 8086: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
8087: the package should fail because some preconditions are not met,
8088: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 8089: message.</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="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 8094: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 8095: installed, the <code class="varname">PKG_PRESERVE</code> definition should
8096: be set in the package Makefile. This will be carried into any
8097: binary package that is made from this pkgsrc entry. A
8098: “<span class="quote">preserved</span>” package will
1.110 hubertf 8099: 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 8100: “<span class="quote">-f</span>” option is used.</p>
1.75 rillig 8101: </div>
8102: <div class="sect2" lang="en">
8103: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8104: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 8105: <p>When a vulnerability is found, this should be noted in
1.87 wiz 8106: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.110 hubertf 8107: and after committing that file, use <span class="command"><strong>make upload</strong></span>
1.87 wiz 8108: in the same directory to update the file on ftp.NetBSD.org.</p>
1.75 rillig 8109: <p>After fixing the vulnerability by a patch, its
1.87 wiz 8110: <code class="varname">PKGREVISION</code> should be increased (this
8111: is of course not necessary if the problem is fixed by using
8112: a newer release of the software).</p>
1.75 rillig 8113: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 8114: branch, be sure to submit a pullup request!</p>
1.75 rillig 8115: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 8116: semi-automatically by a weekly cron job.</p>
1.75 rillig 8117: </div>
8118: <div class="sect2" lang="en">
8119: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8120: <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 8121: <p>When making fixes to an existing package it can be useful
1.87 wiz 8122: to change the version number in <code class="varname">PKGNAME</code>. To
8123: avoid conflicting with future versions by the original author, a
8124: “<span class="quote">nb1</span>”, “<span class="quote">nb2</span>”, ... suffix can be used
8125: on package versions by setting <code class="varname">PKGREVISION=1</code>
8126: (2, ...). The “<span class="quote">nb</span>” is treated like a
8127: “<span class="quote">.</span>” by the package tools. e.g.</p>
8128: <pre class="programlisting">
1.100 rillig 8129: DISTNAME= foo-17.42
8130: PKGREVISION= 9
1.87 wiz 8131: </pre>
1.75 rillig 8132: <p>will result in a <code class="varname">PKGNAME</code> of
1.87 wiz 8133: “<span class="quote">foo-17.42nb9</span>”. If you want to use the original
8134: value of <code class="varname">PKGNAME</code> without the “<span class="quote">nbX</span>”
8135: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8136: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 8137: <p>When a new release of the package is released, the
1.87 wiz 8138: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8139: minor release of the above package, things should be like:</p>
1.75 rillig 8140: <pre class="programlisting">
1.100 rillig 8141: DISTNAME= foo-17.43
1.87 wiz 8142: </pre>
8143: <p><code class="varname">PKGREVISION</code> should be incremented for any
8144: non-trivial change in the resulting binary package. Without a
8145: <code class="varname">PKGREVISION</code> bump, someone with the previous
8146: version installed has no way of knowing that their package is out
8147: of date. Thus, changes without increasing
8148: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8149: trivial that no reasonable person would want to upgrade", and this
8150: is the rough test for when increasing
8151: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8152: changes that do not merit increasing
8153: <code class="varname">PKGREVISION</code> are:</p>
1.100 rillig 8154: <div class="itemizedlist"><ul type="disc">
1.114 jmcneill 8155: <li><p>Changing <code class="varname">HOMEPAGE</code>,
8156: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100 rillig 8157: or comments in Makefile.</p></li>
8158: <li><p>
8159: Changing build variables if the resulting binary package is the same.</p></li>
8160: <li><p>
8161: Changing <code class="filename">DESCR</code>.</p></li>
8162: <li><p>
8163: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8164: </ul></div>
1.87 wiz 8165: <p>Examples of changes that do merit an increase to
8166: <code class="varname">PKGREVISION</code> include:</p>
1.100 rillig 8167: <div class="itemizedlist"><ul type="disc">
8168: <li><p>
8169: Security fixes</p></li>
8170: <li><p>
8171: Changes or additions to a patch file</p></li>
8172: <li><p>
8173: Changes to the <code class="filename">PLIST</code></p></li>
1.112 weinem 8174: <li><p>A dependency is changed or renamed.</p></li>
1.100 rillig 8175: </ul></div>
1.78 rillig 8176: <p>PKGREVISION must also be incremented when dependencies have ABI
8177: changes.</p>
1.75 rillig 8178: </div>
1.79 rillig 8179: <div class="sect2" lang="en">
8180: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8181: <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 8182: <p>When you want to replace the same text in multiple files
1.87 wiz 8183: or when the replacement text varies, patches alone cannot help.
8184: This is where the SUBST framework comes in. It provides an
8185: easy-to-use interface for replacing text in files.
8186: Example:</p>
8187: <pre class="programlisting">
1.100 rillig 8188: SUBST_CLASSES+= fix-paths
8189: SUBST_STAGE.fix-paths= pre-configure
8190: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8191: SUBST_FILES.fix-paths= src/*.c
8192: SUBST_FILES.fix-paths+= scripts/*.sh
8193: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8194: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.87 wiz 8195: </pre>
1.79 rillig 8196: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 8197: that are used to identify the different SUBST blocks that are
8198: defined. The SUBST framework is heavily used by pkgsrc, so it is
8199: important to always use the <code class="literal">+=</code> operator with
8200: this variable. Otherwise some substitutions may be
8201: skipped.</p>
1.79 rillig 8202: <p>The remaining variables of each SUBST block are
1.87 wiz 8203: parameterized with the identifier from the first line
8204: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8205: parameters to a function call.</p>
1.79 rillig 8206: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 8207: which the replacement will take place. All combinations of
8208: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8209: <code class="literal">post-</code> together with a phase name are
8210: possible, though only few are actually used. Most commonly used
8211: are <code class="literal">post-patch</code> and
8212: <code class="literal">pre-configure</code>. Of these two,
8213: <code class="literal">pre-configure</code> should be preferred because
1.110 hubertf 8214: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87 wiz 8215: have the state after applying the patches but before making any
8216: other changes. This is especially useful when you are debugging
8217: a package in order to create new patches for it. Similarly,
8218: <code class="literal">post-build</code> is preferred over
8219: <code class="literal">pre-install</code>, because the install phase should
8220: generally be kept as simple as possible. When you use
8221: <code class="literal">post-build</code>, you have the same files in the
8222: working directory that will be installed later, so you can check
8223: if the substitution has succeeded.</p>
1.79 rillig 8224: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 8225: that is printed just before the substitution is done.</p>
1.79 rillig 8226: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 8227: globbing patterns that specifies the files in which the
8228: substitution will take place. The patterns are interpreted
8229: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 8230: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.110 hubertf 8231: <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 8232: command should be prefixed with <code class="literal">-e</code>, so that
8233: all SUBST blocks look uniform.</p>
1.79 rillig 8234: <p>There are some more variables, but they are so seldomly
1.87 wiz 8235: used that they are only documented in the
8236: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 8237: </div>
1.75 rillig 8238: </div>
8239: <div class="sect1" lang="en">
8240: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8241: <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 8242: <div class="sect2" lang="en">
8243: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8244: <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 8245: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8246: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8247: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8248: with the name of each file to download as an argument, expecting
8249: it to output the URL of the directory from which to download
1.91 rillig 8250: 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 8251: example of this usage.</p>
1.75 rillig 8252: <p>If the download can't be automated, because the user must
1.87 wiz 8253: submit personal information to apply for a password, or must pay
8254: for the source, or whatever, you can set
8255: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8256: displayed to the user before aborting the build. Example:</p>
8257: <pre class="programlisting">
1.100 rillig 8258: FETCH_MESSAGE= "Please download the files"
8259: FETCH_MESSAGE+= " "${DISTFILES:Q}
8260: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87 wiz 8261: </pre>
1.75 rillig 8262: </div>
8263: <div class="sect2" lang="en">
8264: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8265: <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 8266: <p>Sometimes authors of a software package make some
1.87 wiz 8267: modifications after the software was released, and they put up a
8268: new distfile without changing the package's version number. If a
8269: package is already in pkgsrc at that time, the checksum will
8270: no longer match. The contents of the new distfile should be
8271: compared against the old one before changing anything, to make
8272: sure the distfile was really updated on purpose, and that
8273: no trojan horse or so crept in.
1.97 rillig 8274: Please mention that the distfiles were compared and what was found
8275: in your commit message.
1.87 wiz 8276: Then, the correct way to work around this is to
8277: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8278: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8279: <code class="varname">DISTFILES</code> and
1.93 rillig 8280: <code class="varname">PATCHFILES</code> for this package will be put in that
1.97 rillig 8281: subdirectory of the local distfiles directory.
1.110 hubertf 8282: (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 8283: In case this
1.87 wiz 8284: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8285: including the <code class="filename">nbX</code> suffix) or a date stamp
8286: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
8287: Do not forget regenerating the <code class="filename">distinfo</code> file
8288: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8289: path in the filenames.
1.97 rillig 8290: Also increase the PKGREVISION if the installed package is different.
1.87 wiz 8291: Furthermore, a mail to the package's authors seems appropriate
8292: telling them that changing distfiles after releases without
8293: changing the file names is not good practice.</p>
1.75 rillig 8294: </div>
8295: </div>
8296: <div class="sect1" lang="en">
8297: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8298: <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 8299: <div class="sect2" lang="en">
8300: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8301: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8302: <p>pkgsrc supports many different machines, with different
1.87 wiz 8303: object formats like a.out and ELF, and varying abilities to do
8304: shared library and dynamic loading at all. To accompany this,
8305: varying commands and options have to be passed to the
8306: compiler, linker, etc. to get the Right Thing, which can be
8307: pretty annoying especially if you don't have all the machines
8308: at your hand to test things. The
1.91 rillig 8309: <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 8310: can help here, as it just “<span class="quote">knows</span>” how to build
8311: both static and dynamic libraries from a set of source files,
8312: thus being platform-independent.</p>
8313: <p>Here's how to use libtool in a package in seven simple
8314: steps:</p>
1.75 rillig 8315: <div class="orderedlist"><ol type="1">
8316: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8317: Makefile.</p></li>
1.75 rillig 8318: <li><p>For library objects, use “<span class="quote">${LIBTOOL} --mode=compile
1.87 wiz 8319: ${CC}</span>” in place of “<span class="quote">${CC}</span>”. You could even
8320: add it to the definition of <code class="varname">CC</code>, if only
8321: libraries are being built in a given Makefile. This one command
8322: will build both PIC and non-PIC library objects, so you need not
8323: have separate shared and non-shared library rules.</p></li>
1.75 rillig 8324: <li>
8325: <p>For the linking of the library, remove any
1.87 wiz 8326: “<span class="quote">ar</span>”, “<span class="quote">ranlib</span>”, and “<span class="quote">ld
8327: -Bshareable</span>” commands, and instead use:</p>
1.75 rillig 8328: <pre class="programlisting">
1.100 rillig 8329: ${LIBTOOL} --mode=link \
8330: ${CC} -o ${.TARGET:.a=.la} \
8331: ${OBJS:.o=.lo} \
8332: -rpath ${PREFIX}/lib \
8333: -version-info major:minor
1.87 wiz 8334: </pre>
1.75 rillig 8335: <p>Note that the library is changed to have a
1.87 wiz 8336: <code class="filename">.la</code> extension, and the objects are
8337: changed to have a <code class="filename">.lo</code>
8338: extension. Change <code class="varname">OBJS</code> as
8339: necessary. This automatically creates all of the
8340: <code class="filename">.a</code>,
8341: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8342: necessary) in the build directory. Be sure to include
8343: “<span class="quote">-version-info</span>”, especially when major and
8344: minor are zero, as libtool will otherwise strip off the
8345: shared library version.</p>
1.75 rillig 8346: <p>From the libtool manual:</p>
8347: <pre class="programlisting">
1.100 rillig 8348: So, libtool library versions are described by three integers:
1.69 rillig 8349:
1.100 rillig 8350: CURRENT
8351: The most recent interface number that this library implements.
1.69 rillig 8352:
1.100 rillig 8353: REVISION
8354: The implementation number of the CURRENT interface.
1.69 rillig 8355:
1.100 rillig 8356: AGE
8357: The difference between the newest and oldest interfaces that
8358: this library implements. In other words, the library implements
8359: all the interface numbers in the range from number `CURRENT -
8360: AGE' to `CURRENT'.
1.1 grant 8361:
1.100 rillig 8362: If two libraries have identical CURRENT and AGE numbers, then the
8363: dynamic linker chooses the library with the greater REVISION number.
1.87 wiz 8364: </pre>
1.75 rillig 8365: <p>The “<span class="quote">-release</span>” option will produce
1.87 wiz 8366: different results for a.out and ELF (excluding symlinks)
8367: in only one case. An ELF library of the form
8368: “<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8369: will have a symlink of
8370: “<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8371: on an a.out platform. This is handled
8372: automatically.</p>
1.75 rillig 8373: <p>The “<span class="quote">-rpath argument</span>” is the install
1.87 wiz 8374: directory of the library being built.</p>
1.76 rillig 8375: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8376: <code class="filename">.la</code> file, the other files will be
8377: added automatically.</p>
1.75 rillig 8378: </li>
8379: <li>
1.76 rillig 8380: <p>When linking shared object (<code class="filename">.so</code>)
1.110 hubertf 8381: 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 8382: shared libraries, use “<span class="quote">-module
8383: -avoid-version</span>” to prevent them getting version
8384: tacked on.</p>
1.76 rillig 8385: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8386: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8387: </li>
8388: <li>
8389: <p>When linking programs that depend on these libraries
1.87 wiz 8390: <span class="emphasis"><em>before</em></span> they are installed, preface
1.110 hubertf 8391: 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 8392: --mode=link</span>”, and it will find the correct
8393: libraries (static or shared), but please be aware that
8394: libtool will not allow you to specify a relative path in
8395: -L (such as “<span class="quote">-L../somelib</span>”), because it
8396: expects you to change that argument to be the
8397: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8398: <pre class="programlisting">
1.100 rillig 8399: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87 wiz 8400: </pre>
1.75 rillig 8401: <p>should be changed to:</p>
8402: <pre class="programlisting">
1.100 rillig 8403: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87 wiz 8404: </pre>
1.75 rillig 8405: <p>and it will do the right thing with the libraries.</p>
8406: </li>
8407: <li>
1.110 hubertf 8408: <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>
8409: 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 8410: --mode=install</span>”, and change the library name to
8411: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8412: <pre class="programlisting">
1.126 ! jakllsch 8413: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87 wiz 8414: </pre>
1.76 rillig 8415: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8416: shared library, any needed symlinks, and run
1.110 hubertf 8417: <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 8418: </li>
1.76 rillig 8419: <li><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8420: the <code class="filename">.la</code>
8421: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8422: </ol></div>
8423: </div>
8424: <div class="sect2" lang="en">
8425: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8426: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8427: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8428: package Makefile. This will override the package's own libtool
8429: in most cases. For older libtool using packages, libtool is
8430: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8431: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8432: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8433: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8434: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
8435: default, it is set to “<span class="quote">libtool */libtool
8436: */*/libtool</span>”. If this does not match the location of the
8437: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8438: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8439: libraries built and installed, then use
8440: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8441: <p>If your package makes use of the platform-independent library
1.87 wiz 8442: for loading dynamic shared objects, that comes with libtool
8443: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8444: <p>Some packages use libtool incorrectly so that the package
8445: may not work or build in some circumstances. Some of the more
8446: common errors are:</p>
1.75 rillig 8447: <div class="itemizedlist"><ul type="disc">
8448: <li>
8449: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8450: executable or library. This in itself isn't a problem if one of two things
8451: has been done:</p>
1.75 rillig 8452: <div class="orderedlist"><ol type="1">
8453: <li><p>The shared object is named correctly, i.e.
1.87 wiz 8454: <code class="filename">libfoo.la</code>, not
8455: <code class="filename">foo.la</code></p></li>
1.75 rillig 8456: <li><p>The -dlopen option is used when linking an executable.</p></li>
8457: </ol></div>
8458: </li>
8459: <li><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8460: The function lt_dlinit() should be called and the macro
8461: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8462: executables.</p></li>
1.75 rillig 8463: </ul></div>
8464: </div>
8465: <div class="sect2" lang="en">
8466: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8467: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8468: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8469: to regenerate the configure script and Makefile.in makefile
8470: templates, then they should be executed in a pre-configure
8471: target.</p>
1.75 rillig 8472: <p>For packages that need only autoconf:</p>
8473: <pre class="programlisting">
1.100 rillig 8474: AUTOCONF_REQD= 2.50 # if default version is not good enough
8475: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8476: ...
1.1 grant 8477:
1.100 rillig 8478: pre-configure:
8479: cd ${WRKSRC} && autoconf
1.1 grant 8480:
1.100 rillig 8481: ...
1.87 wiz 8482: </pre>
1.75 rillig 8483: <p>and for packages that need automake and autoconf:</p>
8484: <pre class="programlisting">
1.100 rillig 8485: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8486: USE_TOOLS+= automake # use "automake14" for automake-1.4
8487: ...
8488:
8489: pre-configure:
8490: set -e; cd ${WRKSRC}; \
8491: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8492:
1.100 rillig 8493: ...
1.87 wiz 8494: </pre>
1.75 rillig 8495: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8496: require GNU Make.</p>
1.75 rillig 8497: <p>There are times when the configure process makes
1.87 wiz 8498: additional changes to the generated files, which then causes
8499: the build process to try to re-execute the automake sequence.
8500: This is prevented by touching various files in the configure
8501: stage. If this causes problems with your package you can set
8502: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8503: Makefile.</p>
1.75 rillig 8504: </div>
8505: </div>
8506: <div class="sect1" lang="en">
8507: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8508: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.87 wiz 8509: <div class="sect2" lang="en">
8510: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8511: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8512: <p>Compilers for the C, C++, and Fortran languages comes with
8513: the NetBSD base system. By default, pkgsrc assumes that a package
8514: is written in C and will hide all other compilers (via the wrapper
1.110 hubertf 8515: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8516: <p>To declare which language's compiler a package needs, set
8517: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
8518: currently are “<span class="quote">c</span>”, “<span class="quote">c++</span>”, and
8519: “<span class="quote">fortran</span>” (and any combination). The default is
8520: “<span class="quote">c</span>”. Packages using GNU configure scripts, even if
8521: written in C++, usually need a C compiler for the configure
8522: phase.</p>
8523: </div>
8524: <div class="sect2" lang="en">
8525: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8526: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87 wiz 8527: <p>If a program is written in Java, use the Java framework in
8528: pkgsrc. The package must include
8529: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8530: provides the following variables:</p>
8531: <div class="itemizedlist"><ul type="disc">
8532: <li><p><code class="varname">USE_JAVA</code> defines if a build
8533: dependency on the JDK is added. If
8534: <code class="varname">USE_JAVA</code> is set to “<span class="quote">run</span>”, then
8535: there is only a runtime dependency on the JDK. The default is
8536: “<span class="quote">yes</span>”, which also adds a build dependency on the
8537: JDK.</p></li>
8538: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
8539: a package needs a Java2 implementation. The supported values
8540: are “<span class="quote">yes</span>”, “<span class="quote">1.4</span>”, and
8541: “<span class="quote">1.5</span>”. “<span class="quote">yes</span>” accepts any Java2
8542: implementation, “<span class="quote">1.4</span>” insists on versions 1.4 or
8543: above, and “<span class="quote">1.5</span>” only accepts versions 1.5 or
8544: above. This variable is not set by default.</p></li>
8545: </ul></div>
8546: </div>
8547: <div class="sect2" lang="en">
8548: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8549: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8550: <p>If your package contains interpreted perl scripts, add
8551: “<span class="quote">perl</span>” to the <code class="varname">USE_TOOLS</code> variable
8552: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8553: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8554: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8555: that you want adjusted. Every occurrence of
8556: <code class="filename">*/bin/perl</code> will be replaced with the full
8557: path to the perl executable.</p>
8558: <p>If a particular version of perl is needed, set the
8559: <code class="varname">PERL5_REQD</code> variable to the version number. The
8560: default is “<span class="quote">5.0</span>”.</p>
1.110 hubertf 8561: <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 8562: about handling perl modules.</p>
8563: </div>
8564: <div class="sect2" lang="en">
8565: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8566: <a name="other-programming-languages"></a>19.4.4. Other programming languages</h3></div></div></div>
1.87 wiz 8567: <p>Currently, there is no special handling for other languages
8568: in pkgsrc. If a compiler package provides a
8569: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8570: just add a (build) dependency on the appropriate compiler
8571: package.</p>
8572: </div>
8573: </div>
8574: <div class="sect1" lang="en">
8575: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8576: <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 8577: <p>The most common failures when building a package are that
8578: some platforms do not provide certain header files, functions or
8579: libraries, or they provide the functions in a library that the
8580: original package author didn't know. To work around this, you
8581: can rewrite the source code in most cases so that it does not
8582: use the missing functions or provides a replacement function.</p>
8583: <div class="sect2" lang="en">
8584: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8585: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8586: <p>If a package already comes with a GNU configure script, the
8587: preferred way to fix the build failure is to change the
8588: configure script, not the code. In the other cases, you can
8589: utilize the C preprocessor, which defines certain macros
8590: depending on the operating system and hardware architecture it
8591: compiles for. These macros can be queried using for example
8592: <code class="varname">#if defined(__i386)</code>. Almost every operating
8593: system, hardware architecture and compiler has its own macro.
8594: For example, if the macros <code class="varname">__GNUC__</code>,
8595: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8596: are all defined, you know that you are using NetBSD on an i386
8597: compatible CPU, and your compiler is GCC.</p>
8598: <p>The list of the following macros for hardware and
8599: operating system depends on the compiler that is used. For
8600: example, if you want to conditionally compile code on Solaris,
8601: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8602: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.75 rillig 8603: <div class="sect3" lang="en">
8604: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8605: <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 8606: <p>To distinguish between 4.4 BSD-derived systems and the
8607: rest of the world, you should use the following code.</p>
8608: <pre class="programlisting">
1.100 rillig 8609: #include <sys/param.h>
8610: #if (defined(BSD) && BSD >= 199306)
8611: /* BSD-specific code goes here */
8612: #else
8613: /* non-BSD-specific code goes here */
8614: #endif
1.75 rillig 8615: </pre>
1.77 rillig 8616: <p>If this distinction is not fine enough, you can also test
8617: for the following macros.</p>
1.75 rillig 8618: <pre class="programlisting">
1.100 rillig 8619: FreeBSD __FreeBSD__
8620: DragonFly __DragonFly__
8621: Interix __INTERIX
8622: IRIX __sgi (TODO: get a definite source for this)
8623: Linux linux, __linux, __linux__
8624: NetBSD __NetBSD__
8625: OpenBSD __OpenBSD__
8626: Solaris sun, __sun
1.75 rillig 8627: </pre>
8628: </div>
8629: <div class="sect3" lang="en">
8630: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8631: <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 8632: <pre class="programlisting">
1.100 rillig 8633: i386 i386, __i386, __i386__
8634: MIPS __mips
8635: SPARC sparc, __sparc
1.75 rillig 8636: </pre>
8637: </div>
8638: <div class="sect3" lang="en">
8639: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8640: <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 8641: <pre class="programlisting">
1.100 rillig 8642: GCC __GNUC__ (major version), __GNUC_MINOR__
8643: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8644: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8645: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8646: </pre>
8647: </div>
8648: </div>
1.78 rillig 8649: <div class="sect2" lang="en">
8650: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8651: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8652: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8653: combinations of compiler version and architecture and almost
8654: always relation to optimisation being enabled. Common symptoms
8655: are gcc internal errors or never finishing compiling a
1.78 rillig 8656: file.</p>
8657: <p>Typically, a workaround involves testing the
8658: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8659: optimisation for that combination of file,
8660: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87 wiz 8661: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78 rillig 8662: number of examples.</p>
8663: </div>
8664: <div class="sect2" lang="en">
8665: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8666: <a name="undefined-reference"></a>19.5.3. Undefined reference to “<span class="quote">...</span>”</h3></div></div></div>
1.92 rillig 8667: <p>This error message often means that a package did not
1.78 rillig 8668: link to a shared library it needs. The following functions are
8669: known to cause this error message over and over.</p>
8670: <div class="informaltable">
8671: <a name="undefined-reference-functions"></a><table border="1">
8672: <colgroup>
8673: <col>
8674: <col>
8675: <col>
8676: </colgroup>
8677: <thead><tr>
8678: <th>Function</th>
8679: <th>Library</th>
8680: <th>Affected platforms</th>
8681: </tr></thead>
8682: <tbody>
8683: <tr>
8684: <td>accept, bind, connect</td>
8685: <td>-lsocket</td>
8686: <td>Solaris</td>
8687: </tr>
8688: <tr>
8689: <td>crypt</td>
8690: <td>-lcrypt</td>
8691: <td>DragonFly, NetBSD</td>
8692: </tr>
8693: <tr>
8694: <td>dlopen, dlsym</td>
8695: <td>-ldl</td>
8696: <td>Linux</td>
8697: </tr>
8698: <tr>
8699: <td>gethost*</td>
8700: <td>-lnsl</td>
8701: <td>Solaris</td>
8702: </tr>
8703: <tr>
8704: <td>inet_aton</td>
8705: <td>-lresolv</td>
8706: <td>Solaris</td>
8707: </tr>
8708: <tr>
8709: <td>nanosleep, sem_*, timer_*</td>
8710: <td>-lrt</td>
8711: <td>Solaris</td>
8712: </tr>
8713: <tr>
8714: <td>openpty</td>
8715: <td>-lutil</td>
8716: <td>Linux</td>
8717: </tr>
8718: </tbody>
8719: </table>
8720: </div>
8721: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8722: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8723: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110 hubertf 8724: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87 wiz 8725: bmake</strong></span>.</p>
1.92 rillig 8726: <div class="sect3" lang="en">
8727: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8728: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92 rillig 8729: <p>When you are using the SunPro compiler, there is another
8730: possibility. That compiler cannot handle the following code:</p>
8731: <pre class="programlisting">
1.100 rillig 8732: extern int extern_func(int);
1.93 rillig 8733:
1.100 rillig 8734: static inline int
8735: inline_func(int x)
8736: {
1.92 rillig 8737: return extern_func(x);
1.100 rillig 8738: }
1.93 rillig 8739:
1.100 rillig 8740: int main(void)
8741: {
1.92 rillig 8742: return 0;
1.100 rillig 8743: }
1.92 rillig 8744: </pre>
8745: <p>It generates the code for <code class="function">inline_func</code> even if
8746: that function is never used. This code then refers to
8747: <code class="function">extern_func</code>, which can usually not be resolved. To
8748: solve this problem you can try to tell the package to disable inlining
8749: of functions.</p>
8750: </div>
1.87 wiz 8751: </div>
8752: <div class="sect2" lang="en">
8753: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8754: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8755: <p>Sometimes packages fail to build because the compiler runs
8756: into an operating system specific soft limit. With the
8757: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8758: to unlimit the resources. Currently, the allowed values are
8759: “<span class="quote">datasize</span>” and “<span class="quote">stacksize</span>” (or both).
8760: Setting this variable is similar to running the shell builtin
1.110 hubertf 8761: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 8762: segment size or maximum stack size of a process, respectively, to
8763: their hard limits.</p>
1.78 rillig 8764: </div>
1.75 rillig 8765: </div>
8766: <div class="sect1" lang="en">
8767: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8768: <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 8769: <div class="sect2" lang="en">
8770: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8771: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 8772: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 8773: with some operating systems cannot create more than one
8774: directory at a time. As such, you should call
8775: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8776: <pre class="programlisting">
1.100 rillig 8777: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8778: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87 wiz 8779: </pre>
1.78 rillig 8780: <p>You can also just append “<span class="quote"><code class="literal">dir1
1.87 wiz 8781: dir2</code></span>” to the
8782: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8783: automatically do the right thing.</p>
1.75 rillig 8784: </div>
8785: <div class="sect2" lang="en">
8786: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8787: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8788: <p>In general, documentation should be installed into
1.87 wiz 8789: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8790: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8791: includes the version number of the package).</p>
1.84 wiz 8792: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8793: directory where HTML documentation is installed with the
8794: “<span class="quote">--with-html-dir</span>” option. Sometimes using this flag
8795: is needed because otherwise the documentation ends up in
8796: <code class="filename">${PREFIX}/share/doc/html</code> or other
8797: places.</p>
8798: <p>An exception to the above is that library API documentation
1.91 rillig 8799: 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 8800: browsers (devhelp) should be left at their default location, which
8801: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8802: documentation can be recognized from files ending in
8803: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8804: (It is also acceptable to install such files in
8805: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8806: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8807: <code class="filename">.devhelp*</code> file must be directly in that
8808: directory then, no additional subdirectory level is allowed in
8809: this case. This is usually achieved by using
8810: “<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”.
8811: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8812: though.)</p>
1.75 rillig 8813: </div>
8814: <div class="sect2" lang="en">
8815: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8816: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8817: <p>Certain packages, most of them in the games category, install
1.87 wiz 8818: a score file that allows all users on the system to record their
8819: highscores. In order for this to work, the binaries need to be
8820: installed setgid and the score files owned by the appropriate
8821: group and/or owner (traditionally the "games" user/group). The
8822: following variables, documented in more detail in
8823: <code class="filename">mk/defaults/mk.conf</code>, control this
8824: behaviour: <code class="varname">SETGIDGAME</code>,
8825: <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
8826: <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75 rillig 8827: <p>Note that per default, setgid installation of games is
1.87 wiz 8828: disabled; setting <code class="varname">SETGIDGAME=YES</code> will set all
8829: the other variables accordingly.</p>
1.114 jmcneill 8830: <p>A package should therefore never hard code file ownership or
1.87 wiz 8831: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8832: <code class="varname">INSTALL_GAME_DATA</code> to set these
8833: correctly.</p>
1.75 rillig 8834: </div>
8835: <div class="sect2" lang="en">
8836: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8837: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 8838: <p><code class="varname">DESTDIR</code> support means that a package
8839: installs into a staging directory, not the final location of the
8840: files. Then a binary package is created which can be used for
8841: installation as usual. There are two ways: Either the package must
8842: install as root (“<span class="quote">destdir</span>”) or the package can
8843: install as non-root user (“<span class="quote">user-destdir</span>”).</p>
8844: <div class="itemizedlist"><ul type="disc">
8845: <li><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
8846: set to “<span class="quote">destdir</span>” or “<span class="quote">user-destdir</span>”. If
8847: bsd.prefs.mk is included in the Makefile,
8848: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8849: the inclusion.</p></li>
1.103 wiz 8850: <li><p>All installation operations have to be prefixed with
8851: <code class="filename">${DESTDIR}</code>.</p></li>
8852: <li><p>automake gets this DESTDIR mostly right
8853: automatically. Many manual rules and pre/post-install often are
8854: incorrect; fix them.</p></li>
8855: <li><p>If files are installed with special owner/group
1.118 imil 8856: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.103 wiz 8857: <li><p>In general, packages should support
8858: <code class="varname">UNPRIVILEGED</code> to be able to use
8859: DESTDIR.</p></li>
8860: </ul></div>
8861: </div>
8862: <div class="sect2" lang="en">
8863: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8864: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8865: <p>Your package may also contain scripts with hardcoded paths to
8866: other interpreters besides (or as well as) perl. To correct the
8867: full pathname to the script interpreter, you need to set the
8868: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 8869: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 8870: <pre class="programlisting">
1.100 rillig 8871: REPLACE_INTERPRETER+= tcl
8872: REPLACE.tcl.old= .*/bin/tclsh
8873: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8874: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8875: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87 wiz 8876: </pre>
1.75 rillig 8877: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8878: <h3 class="title">Note</h3>
8879: <p>Before March 2006, these variables were called
1.87 wiz 8880: <code class="varname">_REPLACE.*</code> and
8881: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8882: </div>
8883: </div>
8884: <div class="sect2" lang="en">
8885: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8886: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8887: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8888: the Makefile fragment
8889: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 8890: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 8891: configuration for such modules as well as various hooks to tune
8892: this configuration. See comments in this file for
8893: details.</p>
1.75 rillig 8894: <p>Perl5 modules will install into different places depending
1.87 wiz 8895: on the version of perl used during the build process. To
8896: address this, pkgsrc will append lines to the
8897: <code class="filename">PLIST</code> corresponding to the files listed in
8898: the installed <code class="filename">.packlist</code> file generated by
8899: most perl5 modules. This is invoked by defining
8900: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
8901: paths to packlist files, e.g.:</p>
1.75 rillig 8902: <pre class="programlisting">
1.100 rillig 8903: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
1.87 wiz 8904: </pre>
1.75 rillig 8905: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87 wiz 8906: <code class="varname">PERL5_SITEARCH</code>, and
8907: <code class="varname">PERL5_ARCHLIB</code> represent the three locations
8908: in which perl5 modules may be installed, and may be used by
8909: perl5 packages that don't have a packlist. These three
8910: variables are also substituted for in the
8911: <code class="filename">PLIST</code>.</p>
1.75 rillig 8912: </div>
8913: <div class="sect2" lang="en">
8914: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8915: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 8916: <p>Some packages install info files or use the
1.87 wiz 8917: “<span class="quote">makeinfo</span>” or “<span class="quote">install-info</span>”
8918: commands. <code class="varname">INFO_FILES</code> should be defined in
8919: the package Makefile so that <code class="filename">INSTALL</code> and
8920: <code class="filename">DEINSTALL</code> scripts will be generated to
8921: handle registration of the info files in the Info directory
8922: file. The “<span class="quote">install-info</span>” command used for the info
8923: files registration is either provided by the system, or by a
8924: special purpose package automatically added as dependency if
8925: needed.</p>
1.75 rillig 8926: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8927: <code class="filename">${PREFIX}</code> where info files are primarily
8928: located. <code class="varname">PKGINFODIR</code> defaults to
8929: “<span class="quote">info</span>” and can be overridden by the user.</p>
1.75 rillig 8930: <p>The info files for the package should be listed in the
1.87 wiz 8931: package <code class="filename">PLIST</code>; however any split info files
8932: need not be listed.</p>
1.75 rillig 8933: <p>A package which needs the “<span class="quote">makeinfo</span>” command
1.87 wiz 8934: at build time must add “<span class="quote">makeinfo</span>” to
8935: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
8936: version of the “<span class="quote">makeinfo</span>” command is needed it
8937: should be noted with the <code class="varname">TEXINFO_REQD</code>
8938: variable in the package <code class="filename">Makefile</code>. By
8939: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 8940: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 8941: does not match the required minimum, a build dependency on the
1.91 rillig 8942: <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 8943: be added automatically.</p>
1.75 rillig 8944: <p>The build and installation process of the software provided
1.87 wiz 8945: by the package should not use the
1.110 hubertf 8946: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 8947: info files is the task of the package
8948: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 8949: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 8950: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 8951: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8952: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 8953: in <code class="varname">PATH</code>.</p>
1.110 hubertf 8954: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 8955: no effect except the logging of a message. The script overriding
1.110 hubertf 8956: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 8957: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 8958: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8959: </div>
8960: <div class="sect2" lang="en">
8961: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8962: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 8963: <p>All packages that install manual pages should install them
1.87 wiz 8964: into the same directory, so that there is one common place to look
8965: for them. In pkgsrc, this place is
8966: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8967: should be used in packages. The default for
8968: <code class="varname">PKGMANDIR</code> is
8969: “<span class="quote"><code class="filename">man</code></span>”. Another often-used value
8970: is “<span class="quote"><code class="filename">share/man</code></span>”.</p>
1.75 rillig 8971: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8972: <h3 class="title">Note</h3>
1.87 wiz 8973: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8974: is far from complete.</p>
1.75 rillig 8975: </div>
1.81 rillig 8976: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8977: <code class="filename">man/</code> as the top level directory for the man
8978: page file entries, and the pkgsrc framework will convert as
8979: needed. In all other places, the correct
8980: <code class="varname">PKGMANDIR</code> must be used.</p>
8981: <p>Packages that are
8982: configured with <code class="varname">GNU_CONFIGURE</code> set as
8983: “<span class="quote">yes</span>”, by default will use the
8984: <code class="filename">./configure</code>
8985: --mandir switch to set where the man pages should be installed.
8986: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8987: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8988: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8989: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
8990: to “<span class="quote">no</span>”.
8991: Or if the <code class="filename">./configure</code> script uses
8992: a non-standard use of --mandir, you can set
8993: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110 hubertf 8994: <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 8995: information on installation of compressed manual pages.</p>
1.75 rillig 8996: </div>
8997: <div class="sect2" lang="en">
8998: <div class="titlepage"><div><div><h3 class="title">
1.107 rillig 8999: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87 wiz 9000: <p>If a package installs <code class="filename">.schemas</code> or
1.107 rillig 9001: <code class="filename">.entries</code> files, used by GConf,
1.87 wiz 9002: you need to take some extra steps to make sure they get registered
9003: in the database:</p>
1.75 rillig 9004: <div class="orderedlist"><ol type="1">
1.107 rillig 9005: <li><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87 wiz 9006: instead of its <code class="filename">buildlink3.mk</code> file. This
1.107 rillig 9007: takes care of rebuilding the GConf database at installation and
1.87 wiz 9008: deinstallation time, and tells the package where to install
1.107 rillig 9009: GConf data files using some standard configure arguments. It
1.87 wiz 9010: also disallows any access to the database directly from the
9011: package.</p></li>
1.75 rillig 9012: <li><p>Ensure that the package installs its
1.87 wiz 9013: <code class="filename">.schemas</code> files under
9014: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
9015: installed under <code class="filename">${PREFIX}/etc</code>, you will
9016: need to manually patch the package.</p></li>
1.75 rillig 9017: <li><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 9018: directory, as they will be handled automatically. See
1.110 hubertf 9019: <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 9020: <li><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87 wiz 9021: your <code class="filename">Makefile</code> with a list of all
9022: <code class="filename">.schemas</code> files installed by the package, if
9023: any. Names must not contain any directories in them.</p></li>
1.107 rillig 9024: <li><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87 wiz 9025: your <code class="filename">Makefile</code> with a
9026: list of all <code class="filename">.entries</code> files installed by the
9027: package, if any. Names must not contain any directories in
9028: them.</p></li>
1.75 rillig 9029: </ol></div>
9030: </div>
9031: <div class="sect2" lang="en">
9032: <div class="titlepage"><div><div><h3 class="title">
1.119 mishka 9033: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87 wiz 9034: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119 mishka 9035: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87 wiz 9036: get registered in the database:</p>
1.75 rillig 9037: <div class="orderedlist"><ol type="1">
9038: <li><p>Include
1.119 mishka 9039: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
9040: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.87 wiz 9041: takes care of rebuilding the scrollkeeper database at
9042: installation and deinstallation time, and disallows any access
9043: to it directly from the package.</p></li>
1.75 rillig 9044: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 9045: <code class="filename">libdata/scrollkeeper</code> directory, as they
9046: will be handled automatically.</p></li>
1.76 rillig 9047: <li><p>Remove the <code class="filename">share/omf</code> directory from
1.119 mishka 9048: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
9049: print-PLIST</strong></span> does this automatically.)</p></li>
1.75 rillig 9050: </ol></div>
9051: </div>
9052: <div class="sect2" lang="en">
9053: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9054: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 9055: <p>If a package installs font files, you will need to rebuild
1.87 wiz 9056: the fonts database in the directory where they get installed at
9057: installation and deinstallation time. This can be automatically
9058: done by using the pkginstall framework.</p>
1.75 rillig 9059: <p>You can list the directories where fonts are installed in the
1.87 wiz 9060: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9061: variables, where <em class="replaceable"><code>type</code></em> can be one of
9062: “<span class="quote">ttf</span>”, “<span class="quote">type1</span>” or “<span class="quote">x11</span>”.
9063: Also make sure that the database file
9064: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 9065: <p>Note that you should not create new directories for fonts;
1.87 wiz 9066: instead use the standard ones to avoid that the user needs to
9067: manually configure his X server to find them.</p>
1.75 rillig 9068: </div>
9069: <div class="sect2" lang="en">
9070: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9071: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 9072: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 9073: take some extra steps to get them registered in the GTK2 database
9074: properly:</p>
1.75 rillig 9075: <div class="orderedlist"><ol type="1">
9076: <li><p>Include
1.87 wiz 9077: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9078: <code class="filename">buildlink3.mk</code> file. This takes care of
9079: rebuilding the database at installation and deinstallation time.</p></li>
9080: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
9081: your package installs GTK2 immodules.</p></li>
9082: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
9083: GTK2 loaders.</p></li>
1.75 rillig 9084: <li>
1.87 wiz 9085: <p>Patch the package to not touch any of the GTK2
9086: databases directly. These are:</p>
1.75 rillig 9087: <div class="itemizedlist"><ul type="disc">
1.76 rillig 9088: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9089: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 9090: </ul></div>
9091: </li>
1.87 wiz 9092: <li><p>Check the <code class="filename">PLIST</code> and remove
9093: any entries under the <code class="filename">libdata/gtk-2.0</code>
9094: directory, as they will be handled automatically.</p></li>
1.75 rillig 9095: </ol></div>
9096: </div>
9097: <div class="sect2" lang="en">
9098: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9099: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 9100: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 9101: registered in system-wide catalogs (like DTDs, sub-catalogs,
9102: etc.), you need to take some extra steps:</p>
1.75 rillig 9103: <div class="orderedlist"><ol type="1">
9104: <li><p>Include
1.87 wiz 9105: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9106: your <code class="filename">Makefile</code>, which takes care of
9107: registering those files in system-wide catalogs at
9108: installation and deinstallation time.</p></li>
1.75 rillig 9109: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9110: any SGML catalogs installed by the package.</p></li>
1.75 rillig 9111: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9112: any XML catalogs installed by the package.</p></li>
1.75 rillig 9113: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9114: to be added to the SGML catalog. These come in groups of
9115: three strings; see xmlcatmgr(1) for more information
9116: (specifically, arguments recognized by the 'add' action).
9117: Note that you will normally not use this variable.</p></li>
1.75 rillig 9118: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9119: to be added to the XML catalog. These come in groups of three
9120: strings; see xmlcatmgr(1) for more information (specifically,
9121: arguments recognized by the 'add' action). Note that you will
9122: normally not use this variable.</p></li>
1.75 rillig 9123: </ol></div>
9124: </div>
9125: <div class="sect2" lang="en">
9126: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9127: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9128: <p>If a package provides extensions to the MIME database by
1.87 wiz 9129: installing <code class="filename">.xml</code> files inside
9130: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9131: need to take some extra steps to ensure that the database is kept
9132: consistent with respect to these new files:</p>
1.75 rillig 9133: <div class="orderedlist"><ol type="1">
9134: <li><p>Include
1.87 wiz 9135: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9136: (avoid using the <code class="filename">buildlink3.mk</code> file from
9137: this same directory, which is reserved for inclusion from
9138: other <code class="filename">buildlink3.mk</code> files). It takes
9139: care of rebuilding the MIME database at installation and
9140: deinstallation time, and disallows any access to it directly
9141: from the package.</p></li>
1.75 rillig 9142: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 9143: <code class="filename">share/mime</code> directory,
9144: <span class="emphasis"><em>except</em></span> for files saved under
9145: <code class="filename">share/mime/packages</code>. The former are
9146: handled automatically by
9147: the update-mime-database program, but the latter are
9148: package-dependent and must be removed by the package that
9149: installed them in the first place.</p></li>
1.76 rillig 9150: <li><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9151: from the PLIST. They will be handled by the shared-mime-info
9152: package.</p></li>
1.75 rillig 9153: </ol></div>
9154: </div>
9155: <div class="sect2" lang="en">
9156: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9157: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93 rillig 9158: <p>If a package uses intltool during its build, add
9159: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9160: which forces it to use the intltool package provided by pkgsrc,
9161: instead of the one bundled with the distribution file.</p>
1.75 rillig 9162: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9163: latest available version; this way, the package benefits of any
9164: bug fixes that may have appeared since it was released.</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="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9169: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9170: the startup directory by default, but you can enable it, by adding
9171: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 9172: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9173: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9174: it will automatically remove the scripts when the package is
9175: deinstalled.</p>
1.75 rillig 9176: </div>
9177: <div class="sect2" lang="en">
9178: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9179: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9180: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9181: the <code class="filename">ls-R</code> database of the tree needs to be
9182: updated.</p>
1.75 rillig 9183: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9184: <h3 class="title">Note</h3>
1.125 wiz 9185: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 9186: packages should install files
1.125 wiz 9187: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9188: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 9189: </div>
9190: <div class="orderedlist"><ol type="1">
9191: <li><p>Include
1.125 wiz 9192: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 9193: takes care of rebuilding the <code class="filename">ls-R</code>
9194: database at installation and deinstallation time.</p></li>
1.75 rillig 9195: <li>
9196: <p>If your package installs files into a texmf
1.87 wiz 9197: tree other than the one
1.125 wiz 9198: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9199: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 9200: trees that need database update.</p>
1.75 rillig 9201: <p>If your package also installs font map files that need
1.110 hubertf 9202: to be registered using <span class="command"><strong>updmap</strong></span>,
1.125 wiz 9203: include <code class="filename">../../print/texlive-tetex/map.mk</code> and
9204: set <code class="varname">TEX_MAP_FILES</code> and/or
9205: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 9206: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9207: be run automatically at installation/deinstallation to
9208: enable/disable font map files for TeX output
9209: drivers.</p>
1.75 rillig 9210: </li>
1.76 rillig 9211: <li><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9212: databases are included in <code class="filename">PLIST</code>, as
9213: they will be removed only by the teTeX-bin package.</p></li>
1.75 rillig 9214: </ol></div>
9215: </div>
1.85 jmmv 9216: <div class="sect2" lang="en">
9217: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9218: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87 wiz 9219: emulation</h3></div></div></div>
9220: <p>There are some packages that provide libraries and
9221: executables for running binaries from a one operating system
9222: on a different one (if the latter supports it). One example
9223: is running Linux binaries on NetBSD.</p>
1.91 rillig 9224: <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 9225: helps in extracting and packaging Linux rpm packages.</p>
9226: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9227: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9228: if all libraries for each installed executable can be found by
9229: the dynamic linker. Since the standard dynamic linker is run,
9230: this fails for emulation packages, because the libraries used
9231: by the emulation are not in the standard directories.</p>
9232: </div>
9233: <div class="sect2" lang="en">
9234: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9235: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 9236: <p>If a package installs images under the
1.87 wiz 9237: <code class="filename">share/icons/hicolor</code> and/or updates the
9238: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9239: database, you need to take some extra steps to make sure that the
9240: shared theme directory is handled appropriately and that the cache
9241: database is rebuilt:</p>
1.85 jmmv 9242: <div class="orderedlist"><ol type="1">
9243: <li><p>Include
1.87 wiz 9244: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9245: <li><p>Check the <code class="filename">PLIST</code> and remove the
9246: entry that refers to the theme cache.</p></li>
1.85 jmmv 9247: <li><p>Ensure that the PLIST does not remove the shared icon
9248: directories from the <code class="filename">share/icons/hicolor</code>
9249: hierarchy because they will be handled automatically.</p></li>
9250: </ol></div>
9251: <p>The best way to verify that the PLIST is correct with
9252: respect to the last two points is to regenerate it using
1.110 hubertf 9253: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85 jmmv 9254: </div>
9255: <div class="sect2" lang="en">
9256: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9257: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 9258: <p>If a package installs <code class="filename">.desktop</code> files
9259: under <code class="filename">share/applications</code> and these include
9260: MIME information, you need to take extra steps to ensure that they
9261: are registered into the MIME database:</p>
9262: <div class="orderedlist"><ol type="1">
9263: <li><p>Include
9264: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9265: <li><p>Check the PLIST and remove the entry that refers to the
9266: <code class="filename">share/applications/mimeinfo.cache</code> file.
9267: It will be handled automatically.</p></li>
9268: </ol></div>
9269: <p>The best way to verify that the PLIST is correct with
1.110 hubertf 9270: respect to the last point is to regenerate it using <span class="command"><strong>make
1.85 jmmv 9271: print-PLIST</strong></span>.</p>
1.75 rillig 9272: </div>
9273: </div>
1.87 wiz 9274: <div class="sect1" lang="en">
9275: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9276: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 9277: <p>In some cases one does not have the time to solve a problem
1.125 wiz 9278: immediately. In this case, one can plainly mark a package as broken. For
9279: this, one just sets the variable <code class="varname">BROKEN</code> to the
9280: reason why the package is broken (similar to the
9281: <code class="varname">RESTRICTED</code> variable). A user trying to build
9282: the package will immediately be shown this message, and the build
9283: will not be even tried.</p>
9284: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87 wiz 9285: intervals.</p>
9286: </div>
1.75 rillig 9287: </div>
9288: <div class="chapter" lang="en">
9289: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9290: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88 wiz 9291: <p>To check out all the gotchas when building a package, here are
9292: the steps that I do in order to get a package working. Please note
9293: this is basically the same as what was explained in the previous
9294: sections, only with some debugging aids.</p>
1.75 rillig 9295: <div class="itemizedlist"><ul type="disc">
1.110 hubertf 9296: <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 9297: <li>
1.91 rillig 9298: <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 9299: create a directory for a new package, change into it, then run
1.110 hubertf 9300: <span class="command"><strong>url2pkg</strong></span>:</p>
1.75 rillig 9301: <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>
9302: <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>
9303: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9304: </li>
1.76 rillig 9305: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9306: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.110 hubertf 9307: <li><p>Run <span class="command"><strong>make configure</strong></span></p></li>
1.75 rillig 9308: <li><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 9309: configure step to the package's
9310: <code class="filename">Makefile</code>.</p></li>
1.75 rillig 9311: <li>
9312: <p>Make the package compile, doing multiple rounds of</p>
9313: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9314: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9315: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9316: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9317: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9318: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9319: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9320: <p>Doing this step as non-root user will ensure that no files
9321: are modified that shouldn't be, especially during the build
1.110 hubertf 9322: phase. <span class="command"><strong>mkpatches</strong></span>,
9323: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.91 rillig 9324: 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 9325: package.</p>
1.75 rillig 9326: </li>
1.88 wiz 9327: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.123 snj 9328: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “Makefile”</a>.</p></li>
1.75 rillig 9329: <li>
1.76 rillig 9330: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9331: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9332: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9333: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9334: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9335: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9336: <p>You usually need to be <code class="username">root</code> to do
9337: this. Look if there are any files left:</p>
1.75 rillig 9338: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9339: <p>If this reveals any files that are missing in
1.88 wiz 9340: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9341: </li>
9342: <li>
1.88 wiz 9343: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9344: package again and make a binary package:</p>
1.75 rillig 9345: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9346: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9347: </li>
9348: <li>
9349: <p>Delete the installed package:</p>
1.88 wiz 9350: <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 9351: </li>
9352: <li>
1.110 hubertf 9353: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88 wiz 9354: command, which shouldn't find anything now:</p>
1.75 rillig 9355: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9356: </li>
9357: <li>
9358: <p>Reinstall the binary package:</p>
1.93 rillig 9359: <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 9360: </li>
1.88 wiz 9361: <li><p>Play with it. Make sure everything works.</p></li>
1.75 rillig 9362: <li>
1.110 hubertf 9363: <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 9364: reports:</p>
1.75 rillig 9365: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9366: </li>
1.110 hubertf 9367: <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 9368: </ul></div>
9369: </div>
9370: <div class="chapter" lang="en">
9371: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9372: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75 rillig 9373: <div class="toc">
9374: <p><b>Table of Contents</b></p>
9375: <dl>
1.106 rillig 9376: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9377: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9378: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
9379: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
9380: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 9381: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9382: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9383: </dl>
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-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9388: <p>Our policy is that we accept binaries only from pkgsrc
9389: developers to guarantee that the packages don't contain any
9390: trojan horses etc. This is not to annoy anyone but rather to
9391: protect our users! You're still free to put up your home-made
9392: binary packages and tell the world where to get them. NetBSD
9393: developers doing bulk builds and wanting to upload them please
1.110 hubertf 9394: 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 9395: </div>
9396: <div class="sect1" lang="en">
9397: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9398: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9399: <p>First, check that your package is complete, compiles and
1.110 hubertf 9400: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
9401: 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 9402: archive that contains all files that make up the package.
1.87 wiz 9403: Finally, send this package to the pkgsrc bug tracking system,
1.110 hubertf 9404: 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 9405: that, go to the web page
1.110 hubertf 9406: <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 9407: which contains some instructions and a link to a form where you
9408: can submit packages. The
9409: <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
9410: also available as a substitute for either of the above two tools.
9411: </p>
1.87 wiz 9412: <p>In the form of the problem report, the category should be
9413: “<span class="quote">pkg</span>”, the synopsis should include the package name
9414: and version number, and the description field should contain a
9415: short description of your package (contents of the COMMENT
9416: variable or DESCR file are OK). The uuencoded package data should
9417: go into the “<span class="quote">fix</span>” field.</p>
1.75 rillig 9418: <p>If you want to submit several packages, please send a
9419: separate PR for each one, it's easier for us to track things
9420: that way.</p>
9421: <p>Alternatively, you can also import new packages into
9422: pkgsrc-wip (“<span class="quote">pkgsrc work-in-progress</span>”); see the
1.110 hubertf 9423: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.75 rillig 9424: for details.</p>
9425: </div>
9426: <div class="sect1" lang="en">
9427: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9428: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9429: <p>Please note all package additions, updates, moves, and
1.93 rillig 9430: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9431: important to keep this file up to date and conforming to the
9432: existing format, because it will be used by scripts to
1.110 hubertf 9433: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 9434: sites. Additionally, check the
1.76 rillig 9435: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9436: for the package you updated or removed, in case it was mentioned
9437: there.</p>
9438: <p>When the <code class="varname">PKGREVISION</code> of a package is
9439: bumped, the change should appear in
1.93 rillig 9440: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9441: related or otherwise relevant. Mass bumps that result from a
9442: dependency being updated should not be mentioned. In all other
9443: cases it's the developer's decision.</p>
9444: <p>There is a make target that helps in creating proper
1.110 hubertf 9445: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 9446: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9447: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9448: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9449: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 9450: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9451: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 9452: For new packages, or package moves or removals, set the
9453: <code class="varname">CTYPE</code> variable on the command line to "Added",
9454: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 9455: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 9456: not the same as your NetBSD login name. The target also automatically
9457: removes possibly existing entries for the package in the
9458: <code class="filename">TODO</code> file. Don't forget to commit
9459: the changes, e.g. by using <span class="command"><strong>make changes-entry-commit</strong></span>!
1.126 ! jakllsch 9460: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 9461: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9462: makes the cvs commands use the main repository.
9463: </p>
1.75 rillig 9464: </div>
9465: <div class="sect1" lang="en">
9466: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9467: <a name="committing-importing"></a>21.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87 wiz 9468: <p>This section is only of interest for pkgsrc developers with write
1.75 rillig 9469: access to the pkgsrc repository. Please remember that cvs
9470: imports files relative to the current working directory, and that
9471: the pathname that you
1.110 hubertf 9472: give the <span class="command"><strong>cvs import</strong></span> command is so that it knows where
1.75 rillig 9473: to place the files in the repository. Newly created packages should be
9474: imported with a vendor tag of “<span class="quote">TNF</span>” and a release tag of
1.87 wiz 9475: “<span class="quote">pkgsrc-base</span>”, e.g:</p>
1.75 rillig 9476: <pre class="programlisting">
1.100 rillig 9477: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
9478: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
1.75 rillig 9479: </pre>
1.87 wiz 9480: <p>Remember to move the directory from which you imported out of
1.75 rillig 9481: the way, or cvs will complain the next time you “<span class="quote">cvs
9482: update</span>” your source tree. Also don't forget to add the new
1.87 wiz 9483: package to the category's <code class="filename">Makefile</code>.</p>
9484: <p>The commit message of the initial import should include part of the
1.76 rillig 9485: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9486: what the package is/does.</p>
9487: <p>For new packages, “<span class="quote">cvs import</span>” is preferred to “<span class="quote">cvs
1.75 rillig 9488: add</span>” because the former gets everything with a single command,
1.87 wiz 9489: and provides a consistent tag.</p>
1.75 rillig 9490: </div>
9491: <div class="sect1" lang="en">
9492: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9493: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9494: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9495: changes between old and new versions into the commit log when updating
1.87 wiz 9496: a package. There are various reasons for this:</p>
1.75 rillig 9497: <div class="itemizedlist"><ul type="disc">
1.87 wiz 9498: <li><p>A URL is volatile, and can change over time. It may go away completely
9499: or its information may be overwritten by newer information.</p></li>
9500: <li><p>Having the change information between old and new versions in our CVS
9501: repository is very useful for people who use either cvs or anoncvs.</p></li>
9502: <li><p>Having the change information between old and new versions in our CVS
1.75 rillig 9503: repository is very useful for people who read the pkgsrc-changes mailing
9504: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9505: the package.</p></li>
1.75 rillig 9506: </ul></div>
1.87 wiz 9507: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9508: has been released, it should not automatically be upgraded in the CVS
9509: repository. We prefer to be conservative in the packages that are
9510: included in pkgsrc - development or beta packages are not really the
9511: best thing for most places in which pkgsrc is used. Please use your
9512: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9513: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9514: </div>
9515: <div class="sect1" lang="en">
9516: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.122 reed 9517: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9518: <p>Renaming packages is not recommended.</p>
9519: <p>When renaming packages, be sure to fix any references to old name
9520: in other Makefiles, options, buildlink files, etc.</p>
9521: <p>Also When renaming a package, please define
9522: <code class="varname">SUPERSEDES</code> to the package name and dewey version
9523: pattern(s) of the previous package name.
9524: This may be repeated for multiple renames.
9525: The new package would be an exact replacement.
9526: </p>
9527: <p>Note that “<span class="quote">successor</span>” in the
9528: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9529: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9530: not be an exact replacement but is a suggestion for the replaced
9531: functionality.</p>
9532: </div>
9533: <div class="sect1" lang="en">
9534: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9535: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9536: <p>It is preferred that packages are not renamed or moved, but if needed
9537: please follow these steps.
9538: </p>
1.75 rillig 9539: <div class="orderedlist"><ol type="1">
9540: <li><p>Make a copy of the directory somewhere else.</p></li>
9541: <li>
9542: <p>Remove all CVS dirs.</p>
1.87 wiz 9543: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9544: <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 9545: <p>and use that for further work.</p>
1.75 rillig 9546: </li>
9547: <li><p>Fix <code class="varname">CATEGORIES</code> and any
9548: <code class="varname">DEPENDS</code> paths that just did “<span class="quote">../package</span>”
9549: instead of “<span class="quote">../../category/package</span>”.</p></li>
1.122 reed 9550: <li><p>In the modified package's Makefile, consider setting
9551: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9552: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9553: for doing an update using pkgsrc building; for example, it can
9554: 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>
9555: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9556: new <code class="varname">PKGPATH</code> for that moved package. Note that
9557: it may have multiple matches, so the tool should also check on the
9558: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9559: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9560: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.110 hubertf 9561: <li><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 9562: place.</p></li>
9563: <li>
9564: <p>Check if any package depends on it:
9565: </p>
9566: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9567: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9568: </li>
9569: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
1.110 hubertf 9570: <li><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.76 rillig 9571: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9572: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
1.75 rillig 9573: <li>
9574: <p>Commit the changed and removed files:</p>
9575: <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 9576: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9577: </li>
9578: </ol></div>
9579: </div>
9580: </div>
9581: <div class="chapter" lang="en">
9582: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9583: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9584: <p>This section contains the answers to questions that may
9585: arise when you are writing a package. If you don't find your
9586: question answered here, first have a look in the other chapters,
9587: and if you still don't have the answer, ask on the
9588: <code class="literal">pkgsrc-users</code> mailing list.</p>
9589: <div class="qandaset">
9590: <dl>
1.106 rillig 9591: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9592: MAKEFLAGS, .MAKEFLAGS and
9593: MAKE_FLAGS?</a>
9594: </dt>
1.106 rillig 9595: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9596: MAKE, GMAKE and
9597: MAKE_PROGRAM?</a>
9598: </dt>
1.106 rillig 9599: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9600: CC, PKG_CC and
9601: PKGSRC_COMPILER?</a>
9602: </dt>
1.106 rillig 9603: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9604: BUILDLINK_LDFLAGS,
9605: BUILDLINK_LDADD and
9606: BUILDLINK_LIBS?</a>
9607: </dt>
1.106 rillig 9608: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9609: VARNAME=BUILDLINK_PREFIX.foo
9610: say it's empty?</a>
9611: </dt>
1.106 rillig 9612: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9613: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9614: don't understand the := inside
9615: it.</a>
9616: </dt>
1.106 rillig 9617: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9618: developers?</a>
9619: </dt>
1.106 rillig 9620: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9621: documentation?</a>
9622: </dt>
1.106 rillig 9623: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.92 rillig 9624: do?</a>
9625: </dt>
1.75 rillig 9626: </dl>
9627: <table border="0" summary="Q and A Set">
9628: <col align="left" width="1%">
9629: <tbody>
9630: <tr class="question">
9631: <td align="left" valign="top">
1.126 ! jakllsch 9632: <a name="devfaq.makeflags"></a><a name="id52060368"></a><p><b>22.1.</b></p>
1.75 rillig 9633: </td>
9634: <td align="left" valign="top"><p>What is the difference between
9635: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9636: <code class="varname">MAKE_FLAGS</code>?</p></td>
9637: </tr>
9638: <tr class="answer">
1.91 rillig 9639: <td align="left" valign="top"></td>
1.75 rillig 9640: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.110 hubertf 9641: 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 9642: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9643: the <code class="varname">MAKE_PROGRAM</code> when building the
9644: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9645: </tr>
9646: <tr class="question">
9647: <td align="left" valign="top">
1.126 ! jakllsch 9648: <a name="devfaq.make"></a><a name="id52060403"></a><p><b>22.2.</b></p>
1.75 rillig 9649: </td>
9650: <td align="left" valign="top"><p>What is the difference between
9651: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9652: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9653: </tr>
9654: <tr class="answer">
1.91 rillig 9655: <td align="left" valign="top"></td>
1.75 rillig 9656: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.110 hubertf 9657: <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 9658: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9659: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9660: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9661: Make program that is used for building the
9662: package.</p></td>
9663: </tr>
9664: <tr class="question">
9665: <td align="left" valign="top">
1.126 ! jakllsch 9666: <a name="devfaq.cc"></a><a name="id52060441"></a><p><b>22.3.</b></p>
1.75 rillig 9667: </td>
9668: <td align="left" valign="top"><p>What is the difference between
9669: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9670: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9671: </tr>
9672: <tr class="answer">
1.91 rillig 9673: <td align="left" valign="top"></td>
1.75 rillig 9674: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9675: compiler, which can be configured by the pkgsrc user.
9676: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9677: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9678: path to a compiler, but the type of compiler that should be
1.76 rillig 9679: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9680: information about the latter variable.</p></td>
9681: </tr>
9682: <tr class="question">
9683: <td align="left" valign="top">
1.126 ! jakllsch 9684: <a name="devfaq.bl3flags"></a><a name="id52060476"></a><p><b>22.4.</b></p>
1.75 rillig 9685: </td>
9686: <td align="left" valign="top"><p>What is the difference between
9687: <code class="varname">BUILDLINK_LDFLAGS</code>,
9688: <code class="varname">BUILDLINK_LDADD</code> and
9689: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9690: </tr>
9691: <tr class="answer">
1.91 rillig 9692: <td align="left" valign="top"></td>
1.75 rillig 9693: <td align="left" valign="top"><p>[FIXME]</p></td>
9694: </tr>
9695: <tr class="question">
9696: <td align="left" valign="top">
1.126 ! jakllsch 9697: <a name="devfaq.bl3prefix"></a><a name="id52060494"></a><p><b>22.5.</b></p>
1.75 rillig 9698: </td>
1.110 hubertf 9699: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 9700: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9701: say it's empty?</p></td>
9702: </tr>
9703: <tr class="answer">
1.91 rillig 9704: <td align="left" valign="top"></td>
1.75 rillig 9705: <td align="left" valign="top"><p>For optimization reasons, some variables are only
9706: available in the “<span class="quote">wrapper</span>” phase and later. To
9707: “<span class="quote">simulate</span>” the wrapper phase, append
1.110 hubertf 9708: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 9709: command.</p></td>
9710: </tr>
1.78 rillig 9711: <tr class="question">
9712: <td align="left" valign="top">
1.126 ! jakllsch 9713: <a name="devfaq.master_sites"></a><a name="id52060521"></a><p><b>22.6.</b></p>
1.78 rillig 9714: </td>
9715: <td align="left" valign="top"><p>What does
9716: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9717: don't understand the <code class="literal">:=</code> inside
9718: it.</p></td>
9719: </tr>
9720: <tr class="answer">
1.91 rillig 9721: <td align="left" valign="top"></td>
1.78 rillig 9722: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9723: assignment operator, like you might expect at first sight.
9724: Instead, it is a degenerate form of
9725: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.110 hubertf 9726: 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 9727: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9728: case of <code class="varname">MASTER_SITE_*</code>,
9729: <em class="replaceable"><code>old_string</code></em> is the empty string and
9730: <em class="replaceable"><code>new_string</code></em> is
9731: <code class="literal">package/</code>. That's where the
9732: <code class="literal">:</code> and the <code class="literal">=</code> fall
9733: together.</p></td>
9734: </tr>
9735: <tr class="question">
9736: <td align="left" valign="top">
1.126 ! jakllsch 9737: <a name="devfaq.mailinglists"></a><a name="id52060587"></a><p><b>22.7.</b></p>
1.78 rillig 9738: </td>
9739: <td align="left" valign="top"><p>Which mailing lists are there for package
9740: developers?</p></td>
9741: </tr>
9742: <tr class="answer">
1.91 rillig 9743: <td align="left" valign="top"></td>
1.78 rillig 9744: <td align="left" valign="top"><div class="variablelist"><dl>
1.110 hubertf 9745: <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 9746: <dd><p>This is a list for technical discussions related
9747: to pkgsrc development, e.g. soliciting feedback for changes to
9748: pkgsrc infrastructure, proposed new features, questions related
9749: to porting pkgsrc to a new platform, advice for maintaining a
9750: package, patches that affect many packages, help requests moved
9751: from pkgsrc-users when an infrastructure bug is found,
9752: etc.</p></dd>
1.110 hubertf 9753: <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 9754: <dd><p>All bug reports in category "pkg" sent with
1.110 hubertf 9755: <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 9756: directly; use one of the other mailing
9757: lists.</p></dd>
9758: </dl></div></td>
9759: </tr>
1.80 rillig 9760: <tr class="question">
9761: <td align="left" valign="top">
1.126 ! jakllsch 9762: <a name="devfaq.documentation"></a><a name="id52060621"></a><p><b>22.8.</b></p>
1.80 rillig 9763: </td>
9764: <td align="left" valign="top"><p>Where is the pkgsrc
9765: documentation?</p></td>
9766: </tr>
9767: <tr class="answer">
1.91 rillig 9768: <td align="left" valign="top"></td>
1.80 rillig 9769: <td align="left" valign="top">
9770: <p>There are many places where you can find
9771: documentation about pkgsrc:</p>
9772: <div class="itemizedlist"><ul type="disc">
9773: <li><p>The pkgsrc guide (this document) is a collection
9774: of chapters that explain large parts of pkgsrc, but some
9775: chapters tend to be outdated. Which ones they are is hard to
9776: say.</p></li>
1.110 hubertf 9777: <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 9778: about certain features, announcements of new parts of the pkgsrc
9779: infrastructure and sometimes even announcements that a certain
9780: feature has been marked as obsolete. The benefit here is that
9781: each message has a date appended to it.</p></li>
9782: <li><p>Many of the files in the
9783: <code class="filename">mk/</code> directory start with a comment that
9784: describes the purpose of the file and how it can be used by the
1.92 rillig 9785: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 9786: documentation is to run <span class="command"><strong>bmake
1.92 rillig 9787: help</strong></span>.</p></li>
1.80 rillig 9788: <li><p>The CVS log messages are a rich source of
9789: information, but they tend to be highly abbreviated, especially
9790: for actions that occur often. Some contain a detailed
9791: description of what has changed, but they are geared towards the
9792: other pkgsrc developers, not towards an average pkgsrc user.
9793: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9794: don't know what has been before, these messages may not be worth
9795: too much to you.</p></li>
9796: <li><p>Some parts of pkgsrc are only “<span class="quote">implicitly
9797: documented</span>”, that is the documentation exists only in the
9798: mind of the developer who wrote the code. To get this
1.110 hubertf 9799: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 9800: to see who has written it and ask on the
9801: <code class="literal">tech-pkg</code> mailing list, so that others can
9802: find your questions later (see above). To be sure that the
9803: developer in charge reads the mail, you may CC him or
9804: her.</p></li>
9805: </ul></div>
9806: </td>
9807: </tr>
1.92 rillig 9808: <tr class="question">
9809: <td align="left" valign="top">
1.126 ! jakllsch 9810: <a name="devfaq.too-much-time"></a><a name="id52060812"></a><p><b>22.9.</b></p>
1.92 rillig 9811: </td>
9812: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9813: do?</p></td>
9814: </tr>
9815: <tr class="answer">
9816: <td align="left" valign="top"></td>
9817: <td align="left" valign="top">
1.93 rillig 9818: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9819: anyway.</p>
9820: <div class="itemizedlist"><ul type="disc">
1.110 hubertf 9821: <li><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.92 rillig 9822: <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
9823: will tell you about newer versions of installed packages that are
9824: available, but not yet updated in pkgsrc.</p></li>
9825: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126 ! jakllsch 9826: — it contains a list of suggested new packages and a list of
1.92 rillig 9827: cleanups and enhancements for pkgsrc that would be nice to
9828: have.</p></li>
9829: <li><p>Review packages for which review was requested on
1.110 hubertf 9830: the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.92 rillig 9831: mailing list.</p></li>
9832: </ul></div>
9833: </td>
9834: </tr>
1.75 rillig 9835: </tbody>
9836: </table>
9837: </div>
9838: </div>
1.85 jmmv 9839: <div class="chapter" lang="en">
9840: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9841: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9842: <div class="toc">
9843: <p><b>Table of Contents</b></p>
9844: <dl>
1.106 rillig 9845: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9846: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9847: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9848: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 9849: </dl>
9850: </div>
1.110 hubertf 9851: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85 jmmv 9852: site</a>:</p>
9853: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9854: environment, an intuitive and attractive desktop for users, and the
9855: GNOME development platform, an extensive framework for building
9856: applications that integrate into the rest of the desktop.</p></blockquote></div>
9857: <p>pkgsrc provides a seamless way to automatically build and install
9858: a complete GNOME environment <span class="emphasis"><em>under many different
9859: platforms</em></span>. We can say with confidence that pkgsrc is one of
9860: the most advanced build and packaging systems for GNOME due to its
9861: included technologies buildlink3, the wrappers and tools framework and
9862: automatic configuration file management. Lots of efforts are put into
9863: achieving a completely clean deinstallation of installed software
9864: components.</p>
1.110 hubertf 9865: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85 jmmv 9866: the above also means that great efforts are put into making GNOME work
1.110 hubertf 9867: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85 jmmv 9868: pkgsrc as its preferred packaging system, contributing lots of
9869: portability fixes to make GNOME build and install under it.</p>
9870: <p>This chapter is aimed at pkgsrc developers and other people
9871: interested in helping our GNOME porting and packaging efforts. It
9872: provides instructions on how to manage the existing packages and some
9873: important information regarding their internals.</p>
9874: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9875: <h3 class="title">We need your help!</h3>
9876: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9877: and GNOME and are willing to learn new exciting stuff, please jump
1.110 hubertf 9878: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85 jmmv 9879: work</a> list! There is still a long way to go to get a
9880: fully-functional GNOME desktop under NetBSD and we need your help to
9881: achieve it!</p>
9882: </div>
9883: <div class="sect1" lang="en">
9884: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9885: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85 jmmv 9886: <p>pkgsrc includes three GNOME-related meta packages:</p>
9887: <div class="itemizedlist"><ul type="disc">
1.91 rillig 9888: <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 9889: the core GNOME desktop environment. It only includes the necessary
9890: bits to get it to boot correctly, although it may lack important
9891: functionality for daily operation. The idea behind this package is
9892: to let end users build their own configurations on top of this one,
9893: first installing this meta package to achieve a functional setup and
9894: then adding individual applications.</p></li>
1.91 rillig 9895: <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 9896: complete installation of the GNOME platform and desktop as defined
9897: by the GNOME project; this is based on the components distributed in
9898: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9899: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9900: official FTP server. Developer-only tools found in those
9901: directories are not installed unless required by some other
9902: component to work properly. Similarly, packages from the bindings
9903: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9904: in unless required as a dependency for an end-user component. This
1.91 rillig 9905: 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>
9906: <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 9907: Installs all the tools required to build a GNOME component when
9908: fetched from the CVS repository. These are required to let the
1.110 hubertf 9909: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85 jmmv 9910: </ul></div>
9911: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9912: sorted in a way that eases updates: a package may depend on other
9913: packages listed before it but not on any listed after it. It is very
9914: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9915: change it to alphabetical sorting!</em></span></p>
9916: </div>
9917: <div class="sect1" lang="en">
9918: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9919: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9920: <p>Almost all GNOME applications are written in C and use a common
9921: set of tools as their build system. Things get different with the new
9922: bindings to other languages (such as Python), but the following will
9923: give you a general idea on the minimum required tools:</p>
9924: <div class="itemizedlist"><ul type="disc">
9925: <li>
9926: <p>Almost all GNOME applications use the GNU Autotools as their
9927: build system. As a general rule you will need to tell this to your
9928: package:</p>
1.100 rillig 9929: <pre class="programlisting">
9930: GNU_CONFIGURE=yes
1.85 jmmv 9931: USE_LIBTOOL=yes
1.100 rillig 9932: USE_TOOLS+=gmake
9933: </pre>
1.85 jmmv 9934: </li>
9935: <li>
9936: <p>If the package uses pkg-config to detect dependencies, add this
9937: tool to the list of required utilities:</p>
9938: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91 rillig 9939: <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 9940: the end of the build process to ensure that you did not miss to
9941: specify any dependency in your package and that the version
9942: requirements are all correct.</p>
9943: </li>
1.93 rillig 9944: <li><p>If the package uses intltool, be sure to add
9945: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9946: to handle dependencies and to force the package to use the latest
9947: available version.</p></li>
9948: <li>
9949: <p>If the package uses gtk-doc (a documentation generation
9950: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9951: tool is rather big and the distfile should come with pregenerated
9952: documentation anyway; if it does not, it is a bug that you ought to
9953: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9954: the default):</p>
9955: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9956: <p>The default location of installed HTML files
9957: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9958: and should not be changed unless the package insists on installing
9959: them somewhere else. Otherwise programs as
1.110 hubertf 9960: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.89 rillig 9961: do that with an entry similar to:</p>
9962: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 9963: </li>
9964: </ul></div>
9965: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9966: files under the installation prefix to maintain databases. In this
9967: context, shared means that those exact same directories and files are
9968: used among several different packages, leading to conflicts in the
9969: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9970: handle the most common cases, so you have to forget about using
9971: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9972: omitting shared files from them. If you find yourself doing those,
9973: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9974: <p>The following table lists the common situations that result in
9975: using shared directories or files. For each of them, the appropriate
9976: solution is given. After applying the solution be sure to
9977: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110 hubertf 9978: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85 jmmv 9979: <div class="table">
1.106 rillig 9980: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.91 rillig 9981: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9982: <colgroup>
9983: <col>
9984: <col>
9985: </colgroup>
9986: <thead><tr>
9987: <th>If the package...</th>
9988: <th>Then...</th>
9989: </tr></thead>
9990: <tbody>
9991: <tr>
9992: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119 mishka 9993: <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 9994: </tr>
9995: <tr>
9996: <td>Installs icons under the
9997: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9998: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110 hubertf 9999: <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 10000: </tr>
10001: <tr>
10002: <td>Installs files under
10003: <code class="filename">share/mime/packages</code>.</td>
1.110 hubertf 10004: <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 10005: </tr>
10006: <tr>
10007: <td>Installs <code class="filename">.desktop</code> files under
10008: <code class="filename">share/applications</code> and these include MIME
10009: information.</td>
1.110 hubertf 10010: <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 10011: </tr>
10012: </tbody>
1.91 rillig 10013: </table></div>
1.85 jmmv 10014: </div>
1.91 rillig 10015: <br class="table-break">
1.85 jmmv 10016: </div>
10017: <div class="sect1" lang="en">
10018: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10019: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 10020: <p>When seeing GNOME as a whole, there are two kinds of
10021: updates:</p>
10022: <div class="variablelist"><dl>
10023: <dt><span class="term">Major update</span></dt>
10024: <dd>
10025: <p>Given that there is still a very long way for GNOME 3 (if it
10026: ever appears), we consider a major update one that goes from a
10027: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
10028: where <code class="literal">Y</code> is even and greater than
10029: <code class="literal">X</code>. These are hard to achieve because they
10030: introduce lots of changes in the components' code and almost all
10031: GNOME distfiles are updated to newer versions. Some of them can
10032: even break API and ABI compatibility with the previous major
10033: version series. As a result, the update needs to be done all at
10034: once to minimize breakage.</p>
10035: <p>A major update typically consists of around 80 package
10036: updates and the addition of some new ones.</p>
10037: </dd>
10038: <dt><span class="term">Minor update</span></dt>
10039: <dd>
10040: <p>We consider a minor update one that goes from a
10041: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
10042: one where <code class="literal">Y</code> is greater than
10043: <code class="literal">X</code>. These are easy to achieve because they do
10044: not update all GNOME components, can be done in an incremental way
10045: and do not break API nor ABI compatibility.</p>
10046: <p>A minor update typically consists of around 50 package
10047: updates, although the numbers here may vary a lot.</p>
10048: </dd>
10049: </dl></div>
10050: <p>In order to update the GNOME components in pkgsrc to a new stable
10051: release (either major or minor), the following steps should be
10052: followed:</p>
10053: <div class="orderedlist"><ol type="1">
10054: <li>
10055: <p>Get a list of all the tarballs that form the new release by
10056: using the following commands. These will leave the full list of the
1.120 snj 10057: components' distfiles into the <code class="filename">list.txt</code>
1.85 jmmv 10058: file:</p>
1.88 wiz 10059: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 10060: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
10061: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 10062: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 10063: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
10064: awk '{ print $9 }' >>list.txt</code></strong></pre>
10065: </li>
10066: <li><p>Open each meta package's <code class="filename">Makefile</code> and
10067: bump their version to the release you are updating them to. The
10068: three meta packages should be always consistent with versioning.
10069: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
10070: in them.</p></li>
10071: <li>
10072: <p>For each meta package, update all its
10073: <code class="varname">DEPENDS</code> lines to match the latest versions as
10074: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
10075: newer version (even if found in the FTP) because the meta packages
10076: are supposed to list the exact versions that form a specific GNOME
10077: release. Exceptions are permitted here if a newer version solves a
10078: serious issue in the overall desktop experience; these typically
10079: come in the form of a revision bump in pkgsrc, not in newer versions
10080: from the developers.</p>
10081: <p>Packages not listed in the <code class="filename">list.txt</code> file
10082: should be updated to the latest version available (if found in
10083: pkgsrc). This is the case, for example, of the dependencies on the
1.91 rillig 10084: 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 10085: </li>
10086: <li>
10087: <p>Generate a patch from the modified meta packages and extract the
10088: list of "new" lines. This will provide you an outline on what
10089: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 10090: <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 10091: </li>
10092: <li><p>For major desktop updates it is recommended to zap all your
10093: installed packages and start over from scratch at this point.</p></li>
10094: <li><p>Now comes the longest step by far: iterate over the contents
10095: of <code class="filename">todo.txt</code> and update the packages listed in
10096: it in order. For major desktop updates none of these should be
1.93 rillig 10097: committed until the entire set is completed because there are chances
1.85 jmmv 10098: of breaking not-yet-updated packages.</p></li>
10099: <li><p>Once the packages are up to date and working, commit them to
10100: the tree one by one with appropriate log messages. At the end,
10101: commit the three meta package updates and all the corresponding
10102: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10103: <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>
10104: </ol></div>
10105: </div>
10106: <div class="sect1" lang="en">
10107: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10108: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 10109: <p>GNOME is a very big component in pkgsrc which approaches 100
10110: packages. Please, it is very important that you always, always,
10111: <span class="strong"><strong>always</strong></span> feed back any portability
1.110 hubertf 10112: 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 10113: their attention on portability issues and to ensure that future versions
10114: can be built out-of-the box on NetBSD. The less custom patches in
10115: pkgsrc, the easier further updates are. Those developers in charge of
10116: issuing major GNOME updates will be grateful if you do that.</p>
1.110 hubertf 10117: <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 10118: Bugzilla</a>. Not all components use these to track bugs, but most
10119: of them do. Do not be short on your reports: always provide detailed
10120: explanations of the current failure, how it can be improved to achieve
10121: maximum portability and, if at all possible, provide a patch against CVS
10122: head. The more verbose you are, the higher chances of your patch being
10123: accepted.</p>
10124: <p>Also, please avoid using preprocessor magic to fix portability
10125: issues. While the FreeBSD GNOME people are doing a great job in porting
10126: GNOME to their operating system, the official GNOME sources are now
10127: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10128: and similar macros. This hurts portability. Please see our patching
1.110 hubertf 10129: 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 10130: details.</p>
10131: </div>
10132: </div>
1.75 rillig 10133: </div>
10134: <div class="part" lang="en">
10135: <div class="titlepage"><div><div><h1 class="title">
10136: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
10137: <div class="partintro" lang="en">
10138: <div></div>
10139: <p>This part of the guide deals with everything
10140: from the infrastructure that is behind the interfaces described
10141: in the developer's guide. A casual package maintainer should not
10142: need anything from this part.</p>
10143: <div class="toc">
10144: <p><b>Table of Contents</b></p>
10145: <dl>
1.106 rillig 10146: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10147: <dd><dl>
1.106 rillig 10148: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10149: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10150: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75 rillig 10151: <dd><dl>
1.106 rillig 10152: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10153: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75 rillig 10154: </dl></dd>
1.106 rillig 10155: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10156: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10157: <dd><dl>
1.106 rillig 10158: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10159: <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 10160: </dl></dd>
1.106 rillig 10161: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10162: <dd><dl>
1.123 snj 10163: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in bsd.prefs.mk</a></span></dt>
10164: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in bsd.pkg.mk</a></span></dt>
1.75 rillig 10165: </dl></dd>
10166: </dl></dd>
1.106 rillig 10167: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 10168: <dd><dl>
1.106 rillig 10169: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10170: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10171: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10172: <dd><dl>
1.106 rillig 10173: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10174: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10175: </dl></dd>
10176: </dl></dd>
1.106 rillig 10177: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 10178: <dd><dl>
1.106 rillig 10179: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10180: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10181: </dl></dd>
10182: </dl>
10183: </div>
10184: </div>
10185: <div class="chapter" lang="en">
10186: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10187: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10188: <div class="toc">
10189: <p><b>Table of Contents</b></p>
10190: <dl>
1.106 rillig 10191: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10192: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10193: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 10194: <dd><dl>
1.106 rillig 10195: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10196: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 10197: </dl></dd>
1.106 rillig 10198: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10199: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10200: <dd><dl>
1.106 rillig 10201: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10202: <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 10203: </dl></dd>
1.106 rillig 10204: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10205: <dd><dl>
1.123 snj 10206: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in bsd.prefs.mk</a></span></dt>
10207: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in bsd.pkg.mk</a></span></dt>
1.75 rillig 10208: </dl></dd>
10209: </dl>
10210: </div>
10211: <p>The pkgsrc infrastructure consists of many small Makefile
10212: fragments. Each such fragment needs a properly specified
10213: interface. This chapter explains how such an interface looks
10214: like.</p>
10215: <div class="sect1" lang="en">
10216: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10217: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10218: <p>Whenever a variable is defined in the pkgsrc
10219: infrastructure, the location and the way of definition provide
10220: much information about the intended use of that variable.
10221: Additionally, more documentation may be found in a header
10222: comment or in this pkgsrc guide.</p>
10223: <p>A special file is
10224: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10225: variables that are intended to be user-defined. They are either
10226: defined using the <code class="literal">?=</code> operator or they are
10227: left undefined because defining them to anything would
10228: effectively mean “<span class="quote">yes</span>”. All these variables may be
10229: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10230: file.</p>
10231: <p>Outside this file, the following conventions apply:
10232: Variables that are defined using the <code class="literal">?=</code>
10233: operator may be overridden by a package.</p>
10234: <p>Variables that are defined using the <code class="literal">=</code>
10235: operator may be used read-only at run-time.</p>
10236: <p>Variables whose name starts with an underscore must not be
10237: accessed outside the pkgsrc infrastructure at all. They may
10238: change without further notice.</p>
10239: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
10240: <h3 class="title">Note</h3>
10241: <p>These conventions are currently not applied
10242: consistently to the complete pkgsrc
10243: infrastructure.</p>
10244: </div>
10245: </div>
10246: <div class="sect1" lang="en">
10247: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10248: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10249: <p>All variables that contain lists of things should default
10250: to being empty. Two examples that do not follow this rule are
10251: <code class="varname">USE_LANGUAGES</code> and
10252: <code class="varname">DISTFILES</code>. These variables cannot simply be
10253: modified using the <code class="literal">+=</code> operator in package
10254: <code class="filename">Makefile</code>s (or other files included by
10255: them), since there is no guarantee whether the variable is
10256: already set or not, and what its value is. In the case of
10257: <code class="varname">DISTFILES</code>, the packages “<span class="quote">know</span>”
10258: the default value and just define it as in the following
10259: example.</p>
10260: <pre class="programlisting">
1.100 rillig 10261: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10262: </pre>
10263: <p>Because of the selection of this default value, the same
10264: value appears in many package Makefiles. Similarly for
10265: <code class="varname">USE_LANGUAGES</code>, but in this case the default
10266: value (“<span class="quote"><code class="literal">c</code></span>”) is so short that it
10267: doesn't stand out. Nevertheless it is mentioned in many
10268: files.</p>
10269: </div>
10270: <div class="sect1" lang="en">
10271: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10272: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.75 rillig 10273: <div class="sect2" lang="en">
10274: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10275: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75 rillig 10276: <p>Variable evaluation takes place either at load time or at
10277: runtime, depending on the context in which they occur. The
10278: contexts where variables are evaluated at load time are:</p>
10279: <div class="itemizedlist"><ul type="disc">
10280: <li><p>The right hand side of the <code class="literal">:=</code>
10281: and <code class="literal">!=</code> operators,</p></li>
10282: <li><p>Make directives like <code class="literal">.if</code> or
10283: <code class="literal">.for</code>,</p></li>
10284: <li><p>Dependency lines.</p></li>
10285: </ul></div>
10286: <p>A special exception are references to the iteration
10287: variables of <code class="literal">.for</code> loops, which are expanded
10288: inline, no matter in which context they appear.</p>
10289: <p>As the values of variables may change during load time,
10290: care must be taken not to evaluate them by accident. Typical
10291: examples for variables that should not be evaluated at load time
10292: are <code class="varname">DEPENDS</code> and
10293: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10294: clear, here is an example:</p>
10295: <pre class="programlisting">
1.100 rillig 10296: CONFIGURE_ARGS= # none
10297: CFLAGS= -O
10298: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10299:
1.100 rillig 10300: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10301:
1.100 rillig 10302: CFLAGS+= -Wall
1.75 rillig 10303: </pre>
10304: <p>This code shows how the use of the <code class="literal">:=</code>
10305: operator can quickly lead to unexpected results. The first
10306: paragraph is fairly common code. The second paragraph evaluates
10307: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10308: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10309: <code class="literal">-Wall</code> is appended to the
10310: <code class="varname">CFLAGS</code>, but this addition will not appear in
10311: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10312: paragraphs from above typically occur in completely unrelated
10313: files.</p>
10314: </div>
10315: <div class="sect2" lang="en">
10316: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10317: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75 rillig 10318: <p>After all the files have been loaded, the values of the
10319: variables cannot be changed anymore. Variables that are used in
10320: the shell commands are expanded at this point.</p>
10321: </div>
10322: </div>
10323: <div class="sect1" lang="en">
10324: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10325: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10326: <p>There are many ways in which the definition and use of a
10327: variable can be restricted in order to detect bugs and
10328: violations of the (mostly unwritten) policies. See the
10329: <code class="literal">pkglint</code> developer's documentation for further
10330: details.</p>
10331: </div>
10332: <div class="sect1" lang="en">
10333: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10334: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10335: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10336: of the following classes. Cases where a file falls into more
10337: than one class should be avoided as it often leads to subtle
10338: bugs.</p>
10339: <div class="sect2" lang="en">
10340: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10341: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10342: <p>In a traditional imperative programming language some of
1.76 rillig 10343: the <code class="filename">.mk</code> files could be described as
1.126 ! jakllsch 10344: procedures. They take some input parameters and—after
! 10345: inclusion—provide a result in output parameters. Since all
1.76 rillig 10346: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10347: care must be taken not to use parameter names that have already
10348: another meaning. For example, <code class="varname">PKGNAME</code> is a
10349: bad choice for a parameter name.</p>
10350: <p>Procedures are completely evaluated at preprocessing time.
10351: That is, when calling a procedure all input parameters must be
10352: completely resolvable. For example,
10353: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10354: parameter since it is very likely that further text will be
10355: added after calling the procedure, which would effectively apply
10356: the procedure to only a part of the variable. Also, references
10357: to other variables wit will be modified after calling the
10358: procedure.</p>
10359: <p>A procedure can declare its output parameters either as
10360: suitable for use in preprocessing directives or as only
10361: available at runtime. The latter alternative is for variables
10362: that contain references to other runtime variables.</p>
10363: <p>Procedures shall be written such that it is possible to
10364: call the procedure more than once. That is, the file must not
10365: contain multiple-inclusion guards.</p>
10366: <p>Examples for procedures are
1.76 rillig 10367: <code class="filename">mk/bsd.options.mk</code> and
10368: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10369: that the parameters are evaluated at load time, they should be
10370: assigned using the <code class="literal">:=</code> operator, which should
10371: be used only for this purpose.</p>
10372: </div>
10373: <div class="sect2" lang="en">
10374: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10375: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10376: <p>Action files take some input parameters and may define
10377: runtime variables. They shall not define loadtime variables.
10378: There are action files that are included implicitly by the
10379: pkgsrc infrastructure, while other must be included
10380: explicitly.</p>
10381: <p>An example for action files is
1.76 rillig 10382: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10383: </div>
10384: </div>
1.81 rillig 10385: <div class="sect1" lang="en">
10386: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10387: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10388: <p>Package <code class="filename">Makefile</code>s usually consist of
10389: a set of variable definitions, and include the file
10390: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10391: Before that, they may also include various other
10392: <code class="filename">*.mk</code> files if they need to query the
10393: availability of certain features like the type of compiler or
10394: the X11 implementation. Due to the heavy use of preprocessor
10395: directives like <code class="literal">.if</code> and
10396: <code class="literal">.for</code>, the order in which the files are loaded
10397: matters.</p>
10398: <p>This section describes at which point the various files
10399: are loaded and gives reasons for that order.</p>
10400: <div class="sect2" lang="en">
10401: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10402: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10403: </h3></div></div></div>
10404: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10405: is to define some essential variables like
10406: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10407: <code class="varname">MACHINE_ARCH</code>.</p>
10408: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10409: 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 10410: After that, those variables
1.81 rillig 10411: that have not been overridden by the user are loaded from
10412: <code class="filename">mk/defaults/mk.conf</code>.</p>
10413: <p>After the user settings, the system settings and platform
10414: settings are loaded, which may override the user
10415: settings.</p>
10416: <p>Then, the tool definitions are loaded. The tool wrappers
10417: are not yet in effect. This only happens when building a
10418: package, so the proper variables must be used instead of the
10419: direct tool names.</p>
10420: <p>As the last steps, some essential variables from the
10421: wrapper and the package system flavor are loaded, as well as the
10422: variables that have been cached in earlier phases of a package
10423: build.</p>
10424: </div>
10425: <div class="sect2" lang="en">
10426: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10427: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10428: </h3></div></div></div>
1.81 rillig 10429: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10430: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10431: loaded, which fill default values for those variables that have
1.93 rillig 10432: not been defined by the package. These variables may later
1.81 rillig 10433: be used even in unrelated files.</p>
10434: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10435: provides the target <code class="literal">error-check</code> that is added
10436: as a special dependency to all other targets that use
10437: <code class="varname">DELAYED_ERROR_MSG</code> or
10438: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10439: <p>Then, the package-specific hacks from
10440: <code class="filename">hacks.mk</code> are included.</p>
10441: <p>Then, various other files follow. Most of them don't have
10442: any dependencies on what they need to have included before or
10443: after them, though some do.</p>
10444: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10445: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10446: restricts the use of these variables to all the files that have
10447: been included before. Appearances in later files will be
10448: silently ignored.</p>
10449: <p>Then, the files for the main targets are included, in the
10450: order of later execution, though the actual order should not
10451: matter.</p>
10452: <p>At last, some more files are included that don't set any
10453: interesting variables but rather just define make targets to be
10454: executed.</p>
10455: </div>
10456: </div>
1.75 rillig 10457: </div>
10458: <div class="chapter" lang="en">
10459: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10460: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75 rillig 10461: <div class="toc">
10462: <p><b>Table of Contents</b></p>
10463: <dl>
1.106 rillig 10464: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10465: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10466: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10467: <dd><dl>
1.106 rillig 10468: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10469: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10470: </dl></dd>
10471: </dl>
10472: </div>
10473: <p>The pkgsrc infrastructure consists of a large codebase,
10474: and there are many corners where every little bit of a file is
10475: well thought out, making pkgsrc likely to fail as soon as
10476: anything is changed near those parts. To prevent most changes
10477: from breaking anything, a suite of regression tests should go
10478: along with every important part of the pkgsrc infrastructure.
10479: This chapter describes how regression tests work in pkgsrc and
10480: how you can add new tests.</p>
10481: <div class="sect1" lang="en">
10482: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10483: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10484: <p></p>
10485: </div>
10486: <div class="sect1" lang="en">
10487: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10488: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.91 rillig 10489: <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 10490: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10491: can simply run that command, which will run all tests in the
1.76 rillig 10492: <code class="filename">regress</code> category.</p>
1.75 rillig 10493: </div>
10494: <div class="sect1" lang="en">
10495: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10496: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10497: <p>Every directory in the <code class="filename">regress</code>
10498: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10499: is considered a regression test. This file is a shell program
1.110 hubertf 10500: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10501: The following functions can be overridden to suit your
10502: needs.</p>
10503: <div class="sect2" lang="en">
10504: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10505: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10506: <p>These functions do not take any parameters. They are all
10507: called in “<span class="quote">set -e</span>” mode, so you should be careful
10508: to check the exitcodes of any commands you run in the
10509: test.</p>
10510: <div class="variablelist"><dl>
10511: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10512: <dd><p>This function prepares the environment for the
10513: test. By default it does nothing.</p></dd>
10514: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10515: <dd><p>This function runs the actual test. By default,
10516: it calls <code class="varname">TEST_MAKE</code> with the arguments
10517: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10518: error messages into the file
10519: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10520: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10521: <dd><p>This function is run after the test and is
10522: typically used to compare the actual output from the one that is
10523: expected. It can make use of the various helper functions from
10524: the next section.</p></dd>
10525: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10526: <dd><p>This function cleans everything up after the
10527: test has been run. By default it does nothing.</p></dd>
10528: </dl></div>
10529: </div>
10530: <div class="sect2" lang="en">
10531: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10532: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.75 rillig 10533: <div class="variablelist"><dl>
10534: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10535: <dd><p>This function compares the exitcode of the
1.110 hubertf 10536: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.75 rillig 10537: If they differ, the test will fail.</p></dd>
10538: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10539: <dd><p>This function checks for each of its parameters
1.110 hubertf 10540: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.75 rillig 10541: extended regular expression. If it does not, the test will
10542: fail.</p></dd>
10543: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10544: <dd><p>This function checks for each of its parameters
1.110 hubertf 10545: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10546: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10547: If any of the regular expressions matches, the test will
10548: fail.</p></dd>
10549: </dl></div>
10550: </div>
10551: </div>
10552: </div>
10553: <div class="chapter" lang="en">
10554: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10555: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10556: <div class="toc">
10557: <p><b>Table of Contents</b></p>
10558: <dl>
1.106 rillig 10559: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10560: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10561: </dl>
10562: </div>
10563: <p>The pkgsrc system has already been ported to many
10564: operating systems, hardware architectures and compilers. This
10565: chapter explains the necessary steps to make pkgsrc even more
10566: portable.</p>
10567: <div class="sect1" lang="en">
10568: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10569: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10570: <p>To port pkgsrc to a new operating system (called
10571: <code class="literal">MyOS</code> in this example), you need to touch the
10572: following files:</p>
10573: <div class="variablelist"><dl>
1.93 rillig 10574: <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 10575: <dd><p>This file contains some basic definitions, for
10576: example the name of the C
10577: compiler.</p></dd>
1.76 rillig 10578: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10579: <dd><p>Insert code that defines the variables
10580: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10581: <code class="varname">LOWER_OS_VERSION</code>,
10582: <code class="varname">LOWER_VENDOR</code>,
10583: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10584: <code class="varname">APPEND_ELF</code>, and the other variables that
10585: appear in this file.</p></dd>
1.93 rillig 10586: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10587: <dd><p>This file contains the platform-specific
10588: definitions that are used by pkgsrc. Start by copying one of the
10589: other files and edit it to your
10590: needs.</p></dd>
1.93 rillig 10591: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75 rillig 10592: <dd><p>This file contains a list of directories,
10593: together with their permission bits and ownership. These
10594: directories will be created automatically with every package
1.98 wiz 10595: that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
10596: be removed.</p></dd>
1.93 rillig 10597: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75 rillig 10598: <dd><p>Just copy one of the pre-existing x11.dist files
10599: to your
1.76 rillig 10600: <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10601: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75 rillig 10602: <dd><p>On some operating systems, the tools that are
10603: provided with the base system are not good enough for pkgsrc.
1.110 hubertf 10604: 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 10605: narrow limit on the line length they can process. Therefore
10606: pkgsrc brings its own tools, which can be enabled
10607: here.</p></dd>
1.93 rillig 10608: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10609: <dd><p>This file defines the paths to all the tools
10610: that are needed by one or the other package in pkgsrc, as well
10611: as by pkgsrc itself. Find out where these tools are on your
10612: platform and add them.</p></dd>
10613: </dl></div>
10614: <p>Now, you should be able to build some basic packages, like
1.91 rillig 10615: <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 10616: </div>
10617: <div class="sect1" lang="en">
10618: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10619: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10620: <p>TODO</p>
10621: </div>
10622: </div>
10623: </div>
10624: <div class="appendix" lang="en">
10625: <div class="titlepage"><div><div><h2 class="title">
10626: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
10627: <div class="toc">
10628: <p><b>Table of Contents</b></p>
10629: <dl>
10630: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10631: <dd><dl>
10632: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10633: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10634: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.123 snj 10635: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75 rillig 10636: </dl></dd>
10637: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10638: </dl>
10639: </div>
10640: <p>We checked to find a piece of software that wasn't in the packages
10641: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10642: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10643: present in the tree is beyond us, but it's useful for the purposes of
10644: this exercise.</p>
10645: <div class="sect1" lang="en">
10646: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10647: <a name="example-files"></a>A.1. files</h2></div></div></div>
10648: <div class="sect2" lang="en">
10649: <div class="titlepage"><div><div><h3 class="title">
10650: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10651: <pre class="programlisting">
1.100 rillig 10652: # $NetBSD$
10653: #
1.1 grant 10654:
1.100 rillig 10655: DISTNAME= bison-1.25
10656: CATEGORIES= devel
10657: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10658:
1.100 rillig 10659: MAINTAINER= thorpej@NetBSD.org
10660: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10661: COMMENT= GNU yacc clone
1.1 grant 10662:
1.100 rillig 10663: GNU_CONFIGURE= yes
10664: INFO_FILES= bison.info
1.1 grant 10665:
1.100 rillig 10666: .include "../../mk/bsd.pkg.mk"
1.1 grant 10667: </pre>
1.75 rillig 10668: </div>
10669: <div class="sect2" lang="en">
10670: <div class="titlepage"><div><div><h3 class="title">
10671: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10672: <pre class="programlisting">
1.100 rillig 10673: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.110 hubertf 10674: 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 10675: of the NetBSD source tree is beyond me.
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">
10680: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10681: <pre class="programlisting">
1.100 rillig 10682: @comment $NetBSD$
10683: bin/bison
10684: man/man1/bison.1.gz
10685: share/bison.simple
10686: share/bison.hairy
1.1 grant 10687: </pre>
1.75 rillig 10688: </div>
10689: <div class="sect2" lang="en">
10690: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 10691: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93 rillig 10692: </h3></div></div></div>
1.75 rillig 10693: <p>The NetBSD package system comes with
1.91 rillig 10694: <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 10695: which helps to check the contents of these
10696: files. After installation it is quite easy to use, just change to the
10697: directory of the package you wish to examine and execute
1.110 hubertf 10698: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10699: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10700: looks fine.</pre>
10701: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110 hubertf 10702: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75 rillig 10703: -Wall</strong></span> for a very thorough check.</p>
10704: </div>
10705: </div>
10706: <div class="sect1" lang="en">
10707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10708: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10709: <p>Create the directory where the package lives,
10710: plus any auxiliary directories:</p>
10711: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10712: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10713: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10714: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10715: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110 hubertf 10716: <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 10717: then continue with fetching the distfile:</p>
10718: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10719: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10720: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10721: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10722: ftp: Error retrieving file: 500 Internal error
10723:
10724: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10725: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10726: ftp: Error retrieving file: 500 Internal error
10727:
10728: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10729: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10730: Successfully retrieved file.</pre>
10731: <p>Generate the checksum of the distfile into
1.76 rillig 10732: <code class="filename">distinfo</code>:</p>
1.88 wiz 10733: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10734: <p>Now compile:</p>
10735: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10736: >> Checksum OK for bison-1.25.tar.gz.
10737: ===> Extracting for bison-1.25
10738: ===> Patching for bison-1.25
10739: ===> Ignoring empty patch directory
10740: ===> Configuring for bison-1.25
10741: creating cache ./config.cache
10742: checking for gcc... cc
10743: checking whether we are using GNU C... yes
10744: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10745: checking how to run the C preprocessor... cc -E
10746: checking for minix/config.h... no
10747: checking for POSIXized ISC... no
10748: checking whether cross-compiling... no
10749: checking for ANSI C header files... yes
10750: checking for string.h... yes
10751: checking for stdlib.h... yes
10752: checking for memory.h... yes
10753: checking for working const... yes
10754: checking for working alloca.h... no
10755: checking for alloca... yes
10756: checking for strerror... yes
10757: updating cache ./config.cache
10758: creating ./config.status
10759: creating Makefile
10760: ===> Building for bison-1.25
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 LR0.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 allocate.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 closure.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 conflicts.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 derives.c
1.68 rillig 10766: 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 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 getargs.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 gram.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 lalr.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 lex.c
10771: 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
10772: 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
10773: 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
10774: 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
10775: 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
10776: 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
10777: 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
10778: 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
10779: 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
10780: 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
10781: 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
10782: 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
10783: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10784: rm -f bison.s1
1.75 rillig 10785: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10786: <p>Everything seems OK, so install the files:</p>
10787: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10788: >> Checksum OK for bison-1.25.tar.gz.
10789: ===> Installing for bison-1.25
10790: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10791: rm -f /usr/pkg/bin/bison
10792: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10793: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10794: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10795: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10796: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10797: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10798: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10799: ===> Registering installation for bison-1.25</pre>
10800: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 10801: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 10802: binary package, do this now:</p>
10803: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10804: >> Checksum OK for bison-1.25.tar.gz.
10805: ===> Building package for bison-1.25
10806: Creating package bison-1.25.tgz
10807: Registering depends:.
1.75 rillig 10808: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10809: <p>Now that you don't need the source and object files
10810: any more, clean up:</p>
10811: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10812: ===> Cleaning for bison-1.25</pre>
10813: </div>
10814: </div>
10815: <div class="appendix" lang="en">
10816: <div class="titlepage"><div><div><h2 class="title">
10817: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
10818: <div class="toc">
10819: <p><b>Table of Contents</b></p>
10820: <dl>
10821: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10822: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10823: </dl>
10824: </div>
10825: <div class="sect1" lang="en">
10826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10827: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10828: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10829: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10830: => figlet221.tar.gz doesn't seem to exist on this system.
10831: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10832: => [172219 bytes]
10833: Connected to ftp.plig.net.
10834: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10835: 331 Guest login ok, send your complete e-mail address as password.
10836: 230-You are user #5 of 500 simultaneous users allowed.
10837: 230-
1.68 rillig 10838: 230- ___ _ _ _
10839: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10840: 230- | _| _| . |_| . | | | . |_| . | _| . |
10841: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10842: 230- |_| |_| |___| |___|
10843: 230-
10844: 230-** Welcome to ftp.plig.org **
10845: 230-
10846: 230-Please note that all transfers from this FTP site are logged. If you
10847: 230-do not like this, please disconnect now.
10848: 230-
1.120 snj 10849: 230-This archive is available via
1.1 grant 10850: 230-
10851: 230-HTTP: http://ftp.plig.org/
10852: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10853: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10854: 230-
10855: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10856: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10857: 230-
10858: 230-
10859: 230 Logged in anonymously.
10860: Remote system type is UNIX.
10861: Using binary mode to transfer files.
10862: 200 Type okay.
10863: 250 "/pub" is new cwd.
10864: 250-"/pub/figlet" is new cwd.
10865: 250-
10866: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10867: 250-
1.75 rillig 10868: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10869: 250-
10870: 250-The official FIGlet web page is:
1.75 rillig 10871: 250- http://www.figlet.org/
1.1 grant 10872: 250-
10873: 250-If you have questions, please mailto:info@figlet.org. If you want to
10874: 250-contribute a font or something else, you can email us.
1.68 rillig 10875: 250
1.1 grant 10876: 250 "/pub/figlet/program" is new cwd.
10877: 250 "/pub/figlet/program/unix" is new cwd.
10878: local: figlet221.tar.gz remote: figlet221.tar.gz
10879: 502 Unimplemented command.
10880: 227 Entering Passive Mode (195,40,6,41,246,104)
10881: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10882: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10883: 226 Transfer completed.
10884: 172219 bytes received in 00:02 (75.99 KB/s)
10885: 221 Goodbye.
10886: => Checksum OK for figlet221.tar.gz.
10887: ===> Extracting for figlet-2.2.1nb2
10888: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10889: ===> Patching for figlet-2.2.1nb2
10890: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10891: ===> Overriding tools for figlet-2.2.1nb2
10892: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10893: ===> Configuring for figlet-2.2.1nb2
10894: ===> Building for figlet-2.2.1nb2
10895: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10896: chmod a+x figlet
10897: gcc -O2 -o chkfont chkfont.c
10898: => Unwrapping files-to-be-installed.
1.14 xtraeme 10899: <code class="prompt">#</code>
1.75 rillig 10900: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10901: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10902: ===> Installing for figlet-2.2.1nb2
10903: install -d -o root -g wheel -m 755 /usr/pkg/bin
10904: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10905: mkdir -p /usr/pkg/share/figlet
10906: cp figlet /usr/pkg/bin
10907: cp chkfont /usr/pkg/bin
10908: chmod 555 figlist showfigfonts
10909: cp figlist /usr/pkg/bin
10910: cp showfigfonts /usr/pkg/bin
10911: cp fonts/*.flf /usr/pkg/share/figlet
10912: cp fonts/*.flc /usr/pkg/share/figlet
10913: cp figlet.6 /usr/pkg/man/man6
10914: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10915: <code class="prompt">#</code></pre>
10916: </div>
10917: <div class="sect1" lang="en">
10918: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10919: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10920: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10921: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10922: ===> Packaging figlet-2.2.1nb2
10923: ===> Building binary package for figlet-2.2.1nb2
10924: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10925: Using SrcDir value of /usr/pkg
1.68 rillig 10926: Registering depends:.
1.75 rillig 10927: <code class="prompt">#</code></pre>
10928: </div>
10929: </div>
10930: <div class="appendix" lang="en">
10931: <div class="titlepage"><div><div><h2 class="title">
1.76 rillig 10932: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
10933: <div class="toc">
10934: <p><b>Table of Contents</b></p>
10935: <dl>
1.126 ! jakllsch 10936: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. distfiles: The distributed source files</a></span></dt>
! 10937: <dt><span class="sect1"><a href="#ftp-misc">C.2. misc: Miscellaneous things</a></span></dt>
! 10938: <dt><span class="sect1"><a href="#ftp-packages">C.3. packages: Binary packages</a></span></dt>
! 10939: <dt><span class="sect1"><a href="#ftp-reports">C.4. reports: Bulk build reports</a></span></dt>
! 10940: <dt><span class="sect1"><a href="#ftp-source">C.5. current,
! 10941: pkgsrc-20xxQy:
1.76 rillig 10942: source packages</a></span></dt>
10943: </dl>
10944: </div>
10945: <p>As in other big projects, the directory layout of pkgsrc
10946: is quite complex for newbies. This chapter explains where you
10947: find things on the FTP server. The base directory on
1.110 hubertf 10948: <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 10949: On other servers it may be different, but inside this directory,
10950: everything should look the same, no matter on which server you
10951: are. This directory contains some subdirectories, which are
10952: explained below.</p>
1.76 rillig 10953: <div class="sect1" lang="en">
10954: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 ! jakllsch 10955: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76 rillig 10956: <p>The directory <code class="filename">distfiles</code> contains lots
10957: of archive files from all pkgsrc packages, which are mirrored
10958: here. The subdirectories are called after their package names
10959: and are used when the distributed files have names that don't
10960: explicitly contain a version number or are otherwise too generic
10961: (for example <code class="filename">release.tar.gz</code>).</p>
10962: </div>
10963: <div class="sect1" lang="en">
10964: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 ! jakllsch 10965: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76 rillig 10966: <p>This directory contains things that individual pkgsrc
10967: developers find worth publishing.</p>
10968: </div>
10969: <div class="sect1" lang="en">
10970: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 ! jakllsch 10971: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102 rillig 10972: <p>This directory contains binary packages for the various
10973: platforms that are supported by pkgsrc.
10974: 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>
10975: <div class="itemizedlist"><ul type="disc">
1.108 rillig 10976: <li><p><code class="varname">OPSYS</code> is the name of the
1.109 rillig 10977: operating system for which the packages have been built. The
1.110 hubertf 10978: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109 rillig 10979: command, so it may differ from the one you are used to
10980: hear.</p></li>
1.108 rillig 10981: <li><p><code class="varname">ARCH</code> is the hardware
10982: architecture of the platform for which the packages have been
1.110 hubertf 10983: built. It also includes the <code class="varname">ABI</code> (Application
10984: Binary Interface) for platforms that have several of
10985: them.</p></li>
1.108 rillig 10986: <li><p><code class="varname">OSVERSION</code> is the version of
10987: the operating system. For version numbers that change often (for
10988: example NetBSD-current), the often-changing part should be
10989: replaced with an <code class="literal">x</code>, for example
10990: <code class="literal">4.99.x</code>.</p></li>
10991: <li><p><code class="varname">TAG</code> is either
1.126 ! jakllsch 10992: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108 rillig 10993: for a stable branch, or <code class="literal">head</code> for packages
10994: built from the HEAD branch. The latter should only be used when
10995: the packages are updated on a regular basis. Otherwise the date
10996: from checking out pkgsrc should be appended, for example
10997: <code class="literal">head_20071015</code>.</p></li>
1.102 rillig 10998: </ul></div>
10999: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
11000: can quickly click through the directories on the
11001: server and find the best binary packages for their machines. Since they
11002: usually know the operating system and the hardware architecture, OPSYS
11003: and ARCH are placed first. After these choices, they can select the
11004: best combination of OSVERSION and TAG together, since it is usually the
11005: case that packages stay compatible between different version of the
11006: operating system.</p>
11007: <p>In each of these directories, there is a
11008: whole binary packages collection for a specific platform. It has a directory called
1.76 rillig 11009: <code class="filename">All</code> which contains all binary packages.
11010: Besides that, there are various category directories that
11011: contain symbolic links to the real binary packages.</p>
11012: </div>
11013: <div class="sect1" lang="en">
11014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 ! jakllsch 11015: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 11016: <p>Here are the reports from bulk builds, for those who want
11017: to fix packages that didn't build on some of the platforms. The
1.126 ! jakllsch 11018: 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 11019: </div>
11020: <div class="sect1" lang="en">
11021: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 ! jakllsch 11022: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
! 11023: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 11024: source packages</h2></div></div></div>
11025: <p>These directories contain the “<span class="quote">real</span>” pkgsrc,
11026: that is the files that define how to create binary packages from
11027: source archives.</p>
11028: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 11029: snapshot of the CVS repository, which is updated regularly. The
11030: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
11031: directory, ready to be downloaded as a whole.</p>
1.76 rillig 11032: <p>In the directories for the quarterly branches, there is an
11033: additional file called
1.126 ! jakllsch 11034: <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 11035: which contains the state of pkgsrc when it was branched.</p>
11036: </div>
1.75 rillig 11037: </div>
11038: <div class="appendix" lang="en">
11039: <div class="titlepage"><div><div><h2 class="title">
11040: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
11041: <div class="toc">
11042: <p><b>Table of Contents</b></p>
11043: <dl>
1.79 rillig 11044: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 11045: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
11046: </dl>
11047: </div>
1.79 rillig 11048: <p>This section contains information on editing the pkgsrc
11049: guide itself.</p>
1.75 rillig 11050: <div class="sect1" lang="en">
11051: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 11052: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
11053: <p>The pkgsrc guide's source code is stored in
11054: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
11055: are created from it:</p>
11056: <div class="itemizedlist"><ul type="disc">
11057: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
11058: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.110 hubertf 11059: <li><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
11060: <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 11061: The PDF version of the pkgsrc guide.</p></li>
1.110 hubertf 11062: <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 11063: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 11064: </ul></div>
11065: </div>
11066: <div class="sect1" lang="en">
11067: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11068: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 11069: <p>The procedure to edit the pkgsrc guide is:</p>
11070: <div class="procedure"><ol type="1">
11071: <li><p>Make sure you have the packages needed to
1.83 wiz 11072: regenerate the pkgsrc guide (and other XML-based NetBSD
1.91 rillig 11073: 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
11074: 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 11075: PostScript and PDF versions. You will need both packages
11076: installed, to make sure documentation is consistent across all
11077: formats.</p></li>
1.110 hubertf 11078: <li><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 11079: right directory. All further steps will take place
11080: here.</p></li>
11081: <li><p>Edit the XML file(s) in
11082: <code class="filename">files/</code>.</p></li>
1.110 hubertf 11083: <li><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 11084: guide for valid XML and to build the final output files. If you
11085: get any errors at this stage, you can just edit the files, as
11086: there are only symbolic links in the working directory, pointing
11087: to the files in <code class="filename">files/</code>.</p></li>
1.110 hubertf 11088: <li><p><span class="command"><strong>(cd files && cvs
1.79 rillig 11089: commit)</strong></span></p></li>
1.110 hubertf 11090: <li><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 11091: regenerate the output files with the proper RCS
11092: Ids.</p></li>
1.91 rillig 11093: <li>
1.110 hubertf 11094: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 11095: commit the files in both <code class="filename">pkgsrc/doc</code> and
11096: <code class="filename">htdocs</code>.</p>
11097: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11098: <h3 class="title">Note</h3>
11099: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 11100: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
11101: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 11102: directory.</p>
11103: </div>
11104: </li>
1.79 rillig 11105: </ol></div>
1.75 rillig 11106: </div>
11107: </div>
11108: </div></body>
1.1 grant 11109: </html>
CVSweb <webmaster@jp.NetBSD.org>