Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.6
1.1 dsieger 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
3: <head>
4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.2 rillig 6: <link rel="stylesheet" href="/global.css" type="text/css">
1.1 dsieger 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
9: </head>
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>
21: <div class="affiliation"><div class="address"><p><code class="email"><<a href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
27: <div class="affiliation"><div class="address"><p><code class="email"><<a href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.4 rillig 33: <div><p class="copyright">Copyright © 1994-2007 The NetBSD Foundation, Inc</p></div>
1.6 ! rillig 34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.26 2007/09/18 08:17:21 rillig Exp $</p></div>
1.1 dsieger 35: <div><div class="abstract">
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>
52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
64: <dd><dl>
65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
66: <dd><dl>
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>
69: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
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>
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>
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>
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>
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.4 rillig 116: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installion process</a></span></dt>
117: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 118: <dd><dl>
1.4 rillig 119: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
120: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
121: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 122: </dl></dd>
1.4 rillig 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.1 dsieger 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.6 ! 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.1 dsieger 133: <dd><dl>
1.6 ! 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>
! 148: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.1. Configuration</a></span></dt></dl></dd>
! 149: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
! 150: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
! 151: </dl></dd>
! 152: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
! 153: <dd><dl>
! 154: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
! 155: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
! 156: </dl></dd>
! 157: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
! 158: <dd><dl>
! 159: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
! 160: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
! 161: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
! 162: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
! 163: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
! 164: <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>
! 165: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
! 166: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
! 167: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
! 168: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does “<span class="quote">Don't know how to make
1.1 dsieger 169: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.6 ! rillig 170: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</a></span></dt>
! 171: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
! 172: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
! 173: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
! 174: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
! 175: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
! 176: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</a></span></dt>
1.1 dsieger 177: </dl></dd>
178: </dl></dd>
179: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
180: <dd><dl>
1.6 ! rillig 181: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 182: <dd><dl>
1.6 ! rillig 183: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 184: <dd><dl>
1.6 ! rillig 185: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
! 186: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.1 dsieger 187: </dl></dd>
1.6 ! rillig 188: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
! 189: <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>
! 190: </dl></dd>
! 191: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
! 192: <dd><dl>
! 193: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
! 194: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
! 195: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
! 196: <dd><dl>
! 197: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
! 198: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
! 199: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
! 200: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
! 201: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
! 202: </dl></dd>
! 203: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
! 204: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
! 205: <dd><dl>
! 206: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
! 207: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
! 208: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
! 209: </dl></dd>
! 210: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
! 211: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
! 212: </dl></dd>
! 213: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
! 214: <dd><dl>
! 215: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
! 216: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
! 217: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
! 218: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
! 219: <dd><dl>
! 220: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
! 221: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
! 222: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
! 223: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
! 224: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
! 225: </dl></dd>
! 226: </dl></dd>
! 227: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
! 228: <dd><dl>
! 229: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
! 230: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
! 231: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
! 232: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
! 233: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
! 234: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
! 235: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
! 236: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
! 237: </dl></dd>
! 238: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
! 239: <dd><dl>
! 240: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
! 241: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
! 242: <dd><dl>
! 243: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
! 244: <dt><span class="sect2"><a href="#updating-buildlink-depends">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</a></span></dt>
! 245: </dl></dd>
! 246: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
! 247: <dd><dl>
! 248: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
! 249: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
! 250: </dl></dd>
! 251: </dl></dd>
! 252: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
! 253: <dd><dl>
! 254: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
! 255: <dd><dl>
! 256: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
! 257: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
! 258: </dl></dd>
! 259: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
! 260: <dd><dl>
! 261: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
! 262: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
! 263: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
! 264: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
! 265: </dl></dd>
! 266: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
! 267: <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>
! 268: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
! 269: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
! 270: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
! 271: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
! 272: <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>
! 273: </dl></dd>
! 274: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
! 275: <dd><dl>
! 276: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
! 277: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
! 278: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
! 279: </dl></dd>
! 280: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
! 281: <dd><dl>
! 282: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
! 283: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
! 284: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
! 285: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
! 286: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
! 287: <dd><dl>
! 288: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
! 289: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
! 290: </dl></dd>
! 291: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
! 292: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
! 293: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
! 294: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
! 295: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
! 296: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
! 297: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
! 298: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
! 299: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
! 300: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
! 301: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
! 302: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
! 303: </dl></dd>
! 304: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
! 305: <dd><dl>
! 306: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
! 307: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
! 308: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
! 309: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
! 310: </dl></dd>
! 311: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
! 312: <dd><dl>
! 313: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
! 314: <dd><dl>
! 315: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
! 316: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
! 317: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
! 318: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
! 319: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
! 320: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
! 321: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
! 322: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
! 323: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
! 324: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
! 325: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
! 326: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
! 327: </dl></dd>
! 328: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
! 329: <dd><dl>
! 330: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
! 331: <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>
! 332: </dl></dd>
! 333: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
! 334: <dd><dl>
! 335: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
! 336: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
! 337: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
! 338: </dl></dd>
! 339: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
! 340: <dd><dl>
! 341: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
! 342: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
! 343: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
! 344: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
! 345: </dl></dd>
! 346: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
! 347: <dd><dl>
! 348: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
! 349: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
! 350: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
! 351: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
! 352: </dl></dd>
! 353: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
! 354: <dd><dl>
! 355: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
! 356: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
! 357: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
! 358: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
! 359: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
! 360: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
! 361: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
! 362: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
! 363: <dt><span class="sect2"><a href="#gconf2-data-files">19.6.9. Packages installing GConf2 data files</a></span></dt>
! 364: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
! 365: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
! 366: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
! 367: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
! 368: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
! 369: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
! 370: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
! 371: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
! 372: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 373: emulation</a></span></dt>
1.6 ! rillig 374: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
! 375: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 376: </dl></dd>
1.6 ! rillig 377: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 378: </dl></dd>
1.6 ! rillig 379: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
! 380: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 381: <dd><dl>
1.6 ! rillig 382: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
! 383: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
! 384: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
! 385: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
! 386: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
! 387: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
! 388: </dl></dd>
! 389: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
! 390: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
! 391: <dd><dl>
! 392: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
! 393: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
! 394: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
! 395: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 396: </dl></dd>
397: </dl></dd>
398: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
399: <dd><dl>
1.6 ! rillig 400: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 401: <dd><dl>
1.6 ! rillig 402: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
! 403: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
! 404: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 405: <dd><dl>
1.6 ! rillig 406: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
! 407: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 408: </dl></dd>
1.6 ! rillig 409: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
! 410: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 411: <dd><dl>
1.6 ! rillig 412: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
! 413: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 414: </dl></dd>
1.6 ! rillig 415: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 416: <dd><dl>
1.6 ! rillig 417: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
! 418: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 419: </dl></dd>
420: </dl></dd>
1.6 ! rillig 421: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 422: <dd><dl>
1.6 ! rillig 423: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
! 424: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
! 425: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 426: <dd><dl>
1.6 ! rillig 427: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
! 428: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 429: </dl></dd>
430: </dl></dd>
1.6 ! rillig 431: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1 dsieger 432: <dd><dl>
1.6 ! rillig 433: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
! 434: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 435: </dl></dd>
436: </dl></dd>
437: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
438: <dd><dl>
439: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
440: <dd><dl>
441: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
442: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
443: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
444: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span></a></span></dt>
445: </dl></dd>
446: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
447: </dl></dd>
448: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
449: <dd><dl>
450: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
451: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
452: </dl></dd>
453: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
454: <dd><dl>
455: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
456: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
457: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
458: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
1.3 rillig 459: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages</code>: Binary packages</a></span></dt>
1.1 dsieger 460: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
461: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
462: source packages</a></span></dt>
463: </dl></dd>
464: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
465: <dd><dl>
466: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
467: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
468: </dl></dd>
469: </dl>
470: </div>
471: <div class="list-of-tables">
472: <p><b>List of Tables</b></p>
473: <dl>
474: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
475: </dt>
476: <dt>3.1. <a href="#binary-kits">Binary kits and available packages</a>
477: </dt>
1.6 ! rillig 478: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 479: </dt>
1.6 ! rillig 480: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 481: </dt>
482: </dl>
483: </div>
484: <div class="chapter" lang="en">
485: <div class="titlepage"><div><div><h2 class="title">
486: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
487: <div class="toc">
488: <p><b>Table of Contents</b></p>
489: <dl>
490: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
491: <dd><dl>
492: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
493: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
494: </dl></dd>
495: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
496: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
497: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
498: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
499: </dl>
500: </div>
501: <div class="sect1" lang="en">
502: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
503: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
504: <p>There is a lot of software freely available for Unix-based
505: systems, which is usually available in form of the source code. Before
506: such software can be used, it needs to be configured to the local
507: system, compiled and installed, and this is exactly what The NetBSD
508: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
509: to handle binary packages, so that not every user has to build the
510: packages for himself, which is a time-costly task.</p>
511: <p>pkgsrc currently contains several thousand packages,
512: including:</p>
513: <div class="itemizedlist"><ul type="disc">
514: <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
515: web server</p></li>
516: <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
517: web browser</p></li>
518: <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
519: Desktop Environment</p></li>
520: <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
521: Desktop Environment</p></li>
522: </ul></div>
523: <p>...just to name a few.</p>
524: <p>pkgsrc has built-in support for handling varying dependencies,
525: such as pthreads and X11, and extended features such as IPv6 support on
526: a range of platforms.</p>
527: <div class="sect2" lang="en">
528: <div class="titlepage"><div><div><h3 class="title">
529: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
530: <p>
531: pkgsrc provides the following key features:
532: </p>
533: <div class="itemizedlist"><ul type="disc">
534: <li><p>Easy building of software from source as well as the creation
535: and installation of binary packages. The source and latest
536: patches are retrieved from a master or mirror download site, checksum
537: verified, then built on your system. Support for binary-only
538: distributions is available for both native platforms and NetBSD
539: emulated platforms.</p></li>
540: <li><p>All packages are installed in a consistent directory tree,
541: including binaries, libraries, man pages and other
542: documentation.</p></li>
543: <li><p>Package dependencies, including when performing package updates,
544: are handled automatically. The configuration files of various
545: packages are handled automatically during updates, so local changes
546: are preserved.</p></li>
547: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
548: consists of highly portable code. This allows the greatest speed of
549: development when porting to new a platform. This portability also
550: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
551: platforms</em></span>.</p></li>
552: <li><p>The installation prefix, acceptable software licenses,
553: international encryption requirements and build-time options for a
554: large number of packages are all set in a simple, central
555: configuration file.</p></li>
556: <li><p>The entire source (not including the distribution files) is
557: freely available under a BSD license, so you may extend and adapt
558: pkgsrc to your needs. Support for local packages and patches is
559: available right out of the box, so you can configure it specifically
560: for your environment.</p></li>
561: </ul></div>
562: <p>The following principles are basic to pkgsrc:</p>
563: <div class="itemizedlist"><ul type="disc">
564: <li><p>“<span class="quote">It should only work if it's right.</span>”
1.6 ! rillig 565: — That means, if a package contains bugs, it's better to find
1.1 dsieger 566: them and to complain about them rather than to just install the package
567: and hope that it works. There are numerous checks in pkgsrc that try to
568: 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
569: of shell scripts), and post-installation checks (installed files,
570: references to shared libraries, script interpreters).</p></li>
571: <li><p>“<span class="quote">If it works, it should work everywhere</span>”
1.6 ! rillig 572: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 573: pkgsrc has been ported to many operating systems. Care is taken that
574: packages behave the same on all platforms.</p></li>
575: </ul></div>
576: </div>
577: <div class="sect2" lang="en">
578: <div class="titlepage"><div><div><h3 class="title">
579: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
580: <p>pkgsrc consists of both a source distribution and a binary
581: distribution for these operating systems. After retrieving the required
582: source or binaries, you can be up and running with pkgsrc in just
583: minutes!</p>
584: <p>pkgsrc was derived from FreeBSD's ports system, and
585: initially developed for NetBSD only. Since then, pkgsrc has
586: grown a lot, and now supports the following platforms:</p>
587: <div class="table">
588: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
589: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
590: <colgroup>
591: <col>
592: <col>
593: </colgroup>
594: <thead><tr>
595: <th>Platform</th>
596: <th>Date Support Added</th>
597: </tr></thead>
598: <tbody>
599: <tr>
600: <td><a href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
601: <td align="center">Aug 1997</td>
602: </tr>
603: <tr>
604: <td><a href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
605: <td align="center">Mar 1999</td>
606: </tr>
607: <tr>
608: <td><a href="http://www.kernel.org/" target="_top">Linux</a></td>
609: <td align="center">Jun 1999</td>
610: </tr>
611: <tr>
612: <td>
613: <a href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
614: (<a href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
615: </td>
616: <td align="center">Oct 2001</td>
617: </tr>
618: <tr>
619: <td><a href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
620: <td align="center">Nov 2002</td>
621: </tr>
622: <tr>
623: <td><a href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
624: <td align="center">Nov 2002</td>
625: </tr>
626: <tr>
627: <td><a href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
628: <td align="center">Dec 2002</td>
629: </tr>
630: <tr>
631: <td>BSD/OS</td>
632: <td align="center">Dec 2003</td>
633: </tr>
634: <tr>
635: <td><a href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
636: <td align="center">Dec 2003</td>
637: </tr>
638: <tr>
639: <td>
640: <a href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
641: (Microsoft Windows Services for Unix)
642: </td>
643: <td align="center">Mar 2004</td>
644: </tr>
645: <tr>
646: <td><a href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
647: <td align="center">Oct 2004</td>
648: </tr>
649: <tr>
650: <td><a href="http://www.tru64.org/" target="_top">OSF/1</a></td>
651: <td align="center">Nov 2004</td>
652: </tr>
653: <tr>
654: <td><a href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
655: <td align="center">Apr 2007</td>
656: </tr>
657: </tbody>
658: </table></div>
659: </div>
660: <br class="table-break">
661: </div>
662: </div>
663: <div class="sect1" lang="en">
664: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
665: <a name="overview"></a>1.2. Overview</h2></div></div></div>
666: <p>This document is divided into three parts. The first,
667: <a href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
668: describes how one can use one of the packages in the Package
669: Collection, either by installing a precompiled binary package,
670: or by building one's own copy using the NetBSD package system.
671: The second part, <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
672: package so it can be easily built by other NetBSD users without
673: knowing about the package's building details. The third part,
674: <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
675: is intended for those who want to understand how pkgsrc is
676: implemented.</p>
677: <p>This document is available in various formats:
678: <span class="simplelist"><a href="index.html" target="_top">HTML</a>, <a href="pkgsrc.pdf" target="_top">PDF</a>, <a href="pkgsrc.ps" target="_top">PS</a>, <a href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
679: </div>
680: <div class="sect1" lang="en">
681: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
682: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
683: <p>There has been a lot of talk about “<span class="quote">ports</span>”,
684: “<span class="quote">packages</span>”, etc. so far. Here is a description of all the
685: terminology used within this document.</p>
686: <div class="variablelist"><dl>
687: <dt><span class="term">Package</span></dt>
688: <dd><p>A set of files and building instructions
689: that describe what's necessary
690: to build a certain piece of software using
691: pkgsrc. Packages are traditionally stored under
692: <code class="filename">/usr/pkgsrc</code>.</p></dd>
693: <dt><span class="term">The NetBSD package system</span></dt>
694: <dd><p>This is the former name of “<span class="quote">pkgsrc</span>”. It
695: is part of the NetBSD operating system and can be bootstrapped
696: to run on non-NetBSD operating systems as well. It handles
697: building (compiling), installing, and removing of
698: packages.</p></dd>
699: <dt><span class="term">Distfile</span></dt>
700: <dd><p>This term describes the file or files that are
701: provided by the author of the piece of software to
702: distribute his work. All the changes necessary to build on
703: NetBSD are reflected in the corresponding package. Usually
704: the distfile is in the form of a compressed tar-archive,
705: but other types are possible, too. Distfiles are usually
706: stored below
707: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
708: <dt><span class="term">Port</span></dt>
709: <dd><p>This is the term used by FreeBSD and OpenBSD people
710: for what we call a package.
711: In NetBSD terminology, “<span class="quote">port</span>” refers to a different
712: architecture.</p></dd>
713: <dt><span class="term">Precompiled/binary package</span></dt>
714: <dd>
715: <p>A set of binaries built with pkgsrc from a distfile
716: and stuffed together in a single <code class="filename">.tgz</code>
717: file so it can be installed on machines of the same
718: machine architecture without the need to
719: recompile. Packages are usually generated in
720: <code class="filename">/usr/pkgsrc/packages</code>; there is also
721: an archive on <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
722: <p>Sometimes, this is referred to by the term “<span class="quote">package</span>” too,
723: especially in the context of precompiled packages.</p>
724: </dd>
725: <dt><span class="term">Program</span></dt>
726: <dd><p>The piece of software to be installed which will be
727: constructed from all the files in the distfile by the
728: actions defined in the corresponding package.</p></dd>
729: </dl></div>
730: <div class="sect2" lang="en">
731: <div class="titlepage"><div><div><h3 class="title">
732: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
733: <div class="variablelist"><dl>
734: <dt><span class="term">pkgsrc users</span></dt>
735: <dd>
736: <p>The
737: pkgsrc users are people who use the packages provided by pkgsrc.
738: Typically they are system administrators. The people using the
739: software that is inside the packages (maybe called “<span class="quote">end
740: users</span>”) are not covered by the pkgsrc guide.</p>
741: <p>There are two kinds of pkgsrc users: Some only want to
742: install pre-built binary packages. Others build the pkgsrc
743: packages from source, either for installing them directly or for
744: building binary packages themselves. For pkgsrc users <a href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
745: documentation.</p>
746: </dd>
747: <dt><span class="term">package maintainers</span></dt>
748: <dd><p>A
749: package maintainer creates packages as described in <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
750: <dt><span class="term">infrastructure developers</span></dt>
751: <dd><p>These people are involved in all those files
752: that live in the <code class="filename">mk/</code> directory and below.
753: Only these people should need to read through <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
754: too.</p></dd>
755: </dl></div>
756: </div>
757: </div>
758: <div class="sect1" lang="en">
759: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
760: <a name="typography"></a>1.4. Typography</h2></div></div></div>
761: <p>When giving examples for commands, shell prompts are used to
762: show if the command should/can be issued as root, or if
763: “<span class="quote">normal</span>” user privileges are sufficient. We use a
764: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
765: shell prompt, assuming they use the C-shell or tcsh.</p>
766: </div>
767: </div>
768: <div class="part" lang="en">
769: <div class="titlepage"><div><div><h1 class="title">
770: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
771: <div class="toc">
772: <p><b>Table of Contents</b></p>
773: <dl>
774: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
775: <dd><dl>
776: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
777: <dd><dl>
778: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
779: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
780: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
781: </dl></dd>
782: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
783: <dd><dl>
784: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
785: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
786: </dl></dd>
787: </dl></dd>
788: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
789: <dd><dl>
790: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
791: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
792: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
793: <dd><dl>
794: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
795: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
796: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
797: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
798: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
799: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
800: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
801: </dl></dd>
802: </dl></dd>
803: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
804: <dd><dl>
805: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
806: <dd><dl>
807: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
808: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
809: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
810: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
811: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
812: <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>
813: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
814: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
815: </dl></dd>
816: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
817: <dd><dl>
818: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
819: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
820: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
821: </dl></dd>
822: </dl></dd>
823: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
824: <dd><dl>
825: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
826: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.4 rillig 827: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installion process</a></span></dt>
828: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 829: <dd><dl>
1.4 rillig 830: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
831: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
832: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 833: </dl></dd>
1.4 rillig 834: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
835: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 836: </dl></dd>
837: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
838: <dd><dl>
839: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
840: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6 ! rillig 841: </dl></dd>
! 842: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
! 843: builds)</a></span></dt>
1.1 dsieger 844: <dd><dl>
1.6 ! rillig 845: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
! 846: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
! 847: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
! 848: <dd><dl>
! 849: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
! 850: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
! 851: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
! 852: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
! 853: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
! 854: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
! 855: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
! 856: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
! 857: </dl></dd>
! 858: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
! 859: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.1. Configuration</a></span></dt></dl></dd>
! 860: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
! 861: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
! 862: </dl></dd>
! 863: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
! 864: <dd><dl>
! 865: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
! 866: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
! 867: </dl></dd>
! 868: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
! 869: <dd><dl>
! 870: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
! 871: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
! 872: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
! 873: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
! 874: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
! 875: <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>
! 876: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
! 877: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
! 878: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
! 879: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does “<span class="quote">Don't know how to make
1.1 dsieger 880: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.6 ! rillig 881: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</a></span></dt>
! 882: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
! 883: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
! 884: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
! 885: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
! 886: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
! 887: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</a></span></dt>
1.1 dsieger 888: </dl></dd>
889: </dl>
890: </div>
891: <div class="chapter" lang="en">
892: <div class="titlepage"><div><div><h2 class="title">
893: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
894: <div class="toc">
895: <p><b>Table of Contents</b></p>
896: <dl>
897: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
898: <dd><dl>
899: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
900: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
901: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
902: </dl></dd>
903: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
904: <dd><dl>
905: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
906: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
907: </dl></dd>
908: </dl>
909: </div>
910: <p>Before you download and extract the files, you need to decide
911: where you want to extract them. When using pkgsrc as root user, pkgsrc
912: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
913: free to install the sources and binary packages wherever you want in
914: your filesystem, provided that the pathname does not contain white-space
915: or other characters that are interpreted specially by the shell and some
916: other programs. A safe bet is to use only letters, digits, underscores
917: and dashes.</p>
918: <div class="sect1" lang="en">
919: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
920: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
921: <p>Before you download any pkgsrc files, you should decide
922: whether you want the <span class="emphasis"><em>current</em></span> branch or the
923: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
924: quarterly basis from the current branch and only gets modified
925: for security updates. The names of the stable branches are built
926: from the year and the quarter, for example
927: <code class="literal">2007Q1</code>.</p>
928: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
929: want to download pkgsrc. You can get it as a tar file, via SUP,
930: or via CVS. All three ways are described here.</p>
931: <div class="sect2" lang="en">
932: <div class="titlepage"><div><div><h3 class="title">
933: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
934: <p>The primary download location for all pkgsrc files is
935: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
936: number of subdirectories for different purposes, which are
937: described in detail in <a 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>
938: <p>The tar file for the current branch is in the directory
939: <code class="filename">current</code> and is called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
940: It is autogenerated daily.</p>
941: <p>The tar file for the stable branch 2007Q1 is in the
942: directory <code class="filename">pkgsrc-2007Q1</code> and is also called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2007Q1/pkgsrc-2007Q1.tar.gz" target="_top"><code class="filename">pkgsrc-2007Q1.tar.gz</code></a>.</p>
943: <p>After downloading the tar file, change to the directory
944: where you want to have pkgsrc. This is usually
945: <code class="filename">/usr</code>. Then, run <span><strong class="command">gzcat
946: pkgsrc.tar.gz | tar xf -</strong></span> to extract the files.</p>
947: </div>
948: <div class="sect2" lang="en">
949: <div class="titlepage"><div><div><h3 class="title">
950: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
951: <p>As an alternative to the tar file, you can get pkgsrc via
952: the Software Update Protocol, SUP. To do so, make sure your
953: supfile has a line
954:
955: </p>
956: <pre class="programlisting">
957: release=pkgsrc
958: </pre>
959: <p>
960:
961: in it, see the examples in
962: <code class="filename">/usr/share/examples/supfiles</code>, and that the
963: <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
964: run <span><strong class="command">sup -v
965: <em class="replaceable"><code>/path/to/your/supfile</code></em></strong></span>.</p>
966: </div>
967: <div class="sect2" lang="en">
968: <div class="titlepage"><div><div><h3 class="title">
969: <a name="getting-via-cvs"></a>2.1.3. Via anonymous CVS</h3></div></div></div>
970: <p>To get pkgsrc via CVS, make sure you have <a href="http://netbsd.gw.com/cgi-bin/man-cgi?cvs+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cvs</span>(1)</span></a>
971: installed. To do an initial (full) checkout of pkgsrc, you first
972: have to set some environment variables. For the C-Shell,
973: type:</p>
974: <pre class="screen">
975: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
976: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
977: </pre>
978: <p>Or, the same for the bourne shell:</p>
979: <pre class="screen">
980: <code class="prompt">$</code> <strong class="userinput"><code>CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
981: <code class="prompt">$</code> <strong class="userinput"><code>CVS_RSH="ssh"</code></strong>
982: <code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT CVS_RSH</code></strong>
983: </pre>
1.2 rillig 984: <p>By default, cvs doesn't do things like most people would
985: expect it to do, and this is unlikely to change. But there is a
986: way to convince cvs, by creating a file called
987: <code class="filename">.cvsrc</code> in your home directory and saving
988: the following lines to it. This file will save you lots of
989: headache and some bug reports, so we strongly recommend it. You
990: can find an explanation of this file in the CVS
991: documentation.</p>
992: <pre class="programlisting">
993: # recommended CVS configuration file from the pkgsrc guide
994: checkout -P
1.4 rillig 995: update -dP
1.2 rillig 996: release -d
1.4 rillig 997: diff -upN
1.2 rillig 998: cvs -q -z3
999: rdiff -u
1000: </pre>
1.1 dsieger 1001: <p>Then, you change to the directory where you want to have
1002: your copy of pkgsrc. In most cases this is
1003: <code class="filename">/usr</code>. In that directory you run the
1004: checkout command, which is <span><strong class="command">cvs -q checkout -P
1005: pkgsrc</strong></span> for the current branch and <span><strong class="command">cvs -q
1006: checkout -rpkgsrc-2007Q1 -P pkgsrc</strong></span> for the stable
1007: branch. This command will create a directory called
1008: <code class="filename">pkgsrc</code> with all the pkgsrc files in
1009: it.</p>
1010: </div>
1011: </div>
1012: <div class="sect1" lang="en">
1013: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1014: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1015: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1016: (which also works if you have first installed it via a tar
1017: file). It saves bandwidth and hard disk activity, compared to
1018: downloading the tar file again.</p>
1019: <div class="sect2" lang="en">
1020: <div class="titlepage"><div><div><h3 class="title">
1021: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1022: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1023: <h3 class="title">Warning</h3>
1024: <p>When updating from a tar file, you first need to
1025: completely remove the old pkgsrc directory. Otherwise those
1026: files that have been removed from pkgsrc in the mean time will
1027: not be removed on your local disk, resulting in inconsistencies.
1028: When removing the old files, any changes that you have done to
1029: the pkgsrc files will be lost after updating. Therefore updating
1030: via CVS is strongly recommended.</p>
1031: </div>
1032: <p>Note that by default the distfiles and the binary packages
1033: are saved in the pkgsrc tree, so don't forget to rescue them
1034: before updating. You can also configure pkgsrc to use other than
1035: the default directories by setting the
1036: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1037: variables. See <a href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1038: <p>To update pkgsrc from a tar file, download the tar file as
1039: explained above. Then, make sure that you have not made any
1040: changes to the files in the pkgsrc directory. Remove the pkgsrc
1041: directory and extract the new tar file. Done.</p>
1042: </div>
1043: <div class="sect2" lang="en">
1044: <div class="titlepage"><div><div><h3 class="title">
1045: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1046: <p>To update pkgsrc via CVS, make sure the environment
1047: variable <code class="varname">CVS_RSH</code> is set as above. Then,
1048: change to the pkgsrc directory and run <span><strong class="command">cvs -q update
1049: -dP</strong></span>.</p>
1050: <div class="sect3" lang="en">
1051: <div class="titlepage"><div><div><h4 class="title">
1052: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1053: <p>When updating pkgsrc, the CVS program keeps track of the
1054: branch you selected. But if you, for whatever reason, want to
1055: switch from the stable branch to the current one, you can do it
1056: by adding the option “<span class="quote">-A</span>” after the
1057: “<span class="quote">update</span>” keyword. To switch from the current branch
1058: back to the stable branch, add the
1059: “<span class="quote">-rpkgsrc-2007Q1</span>” option.</p>
1060: </div>
1061: <div class="sect3" lang="en">
1062: <div class="titlepage"><div><div><h4 class="title">
1063: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1064: <p>When you update pkgsrc, the CVS program will only touch
1065: those files that are registered in the CVS repository. That
1066: means that any packages that you created on your own will stay
1067: unmodified. If you change files that are managed by CVS, later
1068: updates will try to merge your changes with those that have been
1069: done by others. See the CVS manual, chapter
1070: “<span class="quote">update</span>” for details.</p>
1071: </div>
1072: </div>
1073: </div>
1074: </div>
1075: <div class="chapter" lang="en">
1076: <div class="titlepage"><div><div><h2 class="title">
1077: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1078: <div class="toc">
1079: <p><b>Table of Contents</b></p>
1080: <dl>
1081: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1082: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1083: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1084: <dd><dl>
1085: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
1086: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
1087: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
1088: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
1089: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
1090: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
1091: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1092: </dl></dd>
1093: </dl>
1094: </div>
1095: <div class="sect1" lang="en">
1096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1097: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1098: <p>
1099: We provide a bootstrap kit in both source and binary form for other
1100: platforms than NetBSD, consisting of the pkg administration tools and other
1101: tools required to use pkgsrc and build packages.
1102: </p>
1103: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1104: <h3 class="title">Note</h3>
1105: <p>
1106: Older binary snapshots are available in the
1107: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/archive/" target="_top">bootstrap-pkgsrc/archive</a>
1108: directory on ftp.NetBSD.org.</p>
1109: </div>
1110: <div class="table">
1111: <a name="binary-kits"></a><p class="title"><b>Table 3.1. Binary kits and available packages</b></p>
1112: <div class="table-contents"><table summary="Binary kits and available packages" border="1">
1113: <colgroup>
1114: <col>
1115: <col>
1116: <col>
1117: <col>
1118: </colgroup>
1119: <thead><tr>
1120: <th>Platform</th>
1121: <th>Latest snapshot</th>
1122: <th>Binary kit</th>
1123: <th>Binary packages</th>
1124: </tr></thead>
1125: <tbody>
1126: <tr>
1127: <td class="osname">Darwin 5.5/powerpc (Mac OS X 10.1.5)</td>
1128: <td class="date">20021209</td>
1129: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-5.5-powerpc-20021209.tar.gz" target="_top">binary kit</a></td>
1130: <td class="binary-pkgs-url"> </td>
1131: </tr>
1132: <tr>
1133: <td class="osname">Darwin 6.6/powerpc (Mac OS X 10.2.6)</td>
1134: <td class="date">20030623</td>
1135: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-6.6-powerpc-20030623.tar.gz" target="_top">binary kit</a></td>
1136: <td class="binary-pkgs-url"> </td>
1137: </tr>
1138: <tr>
1139: <td class="osname">Darwin 7.6/powerpc (Mac OS X 10.3.6)</td>
1140: <td class="date">20041219</td>
1141: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-7.6.0-powerpc-20041219.tar.gz" target="_top">binary kit</a></td>
1142: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Darwin-7.6/" target="_top">binary packages</a></td>
1143: </tr>
1144: <tr>
1145: <td class="osname">Darwin 7.8/powerpc (Mac OS X 10.3.8)</td>
1146: <td class="date">20050320</td>
1147: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-7.8.0-powerpc-20050320.tar.gz" target="_top">binary kit</a></td>
1148: <td class="binary-pkgs-url"> </td>
1149: </tr>
1150: <tr>
1151: <td class="osname">Darwin 8.1/powerpc (Mac OS X 10.4.1)</td>
1152: <td class="date">20050625</td>
1153: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-8.1.0-powerpc-20050625.tar.gz" target="_top">binary kit</a></td>
1154: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Darwin-8.1/powerpc/current/" target="_top">binary packages</a></td>
1155: </tr>
1156: <tr>
1157: <td class="osname">Debian GNU Linux/i386</td>
1158: <td class="date">20031023</td>
1159: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.4.22-debian-i386-20031023.tar.gz" target="_top">binary kit</a></td>
1160: <td class="binary-pkgs-url"> </td>
1161: </tr>
1162: <tr>
1163: <td class="osname">Fedora Core 2 Linux/i386</td>
1164: <td class="date">20050618</td>
1165: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.6.10-i386-fc2-20050618.tar.gz" target="_top">binary kit</a></td>
1166: <td class="binary-pkgs-url"> </td>
1167: </tr>
1168: <tr>
1169: <td class="osname">Fedora Core 4 Linux/i386</td>
1170: <td class="date">20060105</td>
1171: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.6.11-i386-fc4-20060105.tar.gz" target="_top">binary kit</a></td>
1172: <td class="binary-pkgs-url"> </td>
1173: </tr>
1174: <tr>
1175: <td class="osname">FreeBSD 3.5/i386</td>
1176: <td class="date">20030411</td>
1177: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-3.5-STABLE-i386-20030411.tar.gz" target="_top">binary kit</a></td>
1178: <td class="binary-pkgs-url"> </td>
1179: </tr>
1180: <tr>
1181: <td class="osname">FreeBSD 4.7/i386</td>
1182: <td class="date">20021211</td>
1183: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-4.7-RELEASE-i386-20021211.tar.gz" target="_top">binary kit</a></td>
1184: <td class="binary-pkgs-url"> </td>
1185: </tr>
1186: <tr>
1187: <td class="osname">FreeBSD 5.0/i386</td>
1188: <td class="date">20030411</td>
1189: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.0-RELEASE-i386-20030411.tar.gz" target="_top">binary kit</a></td>
1190: <td class="binary-pkgs-url"> </td>
1191: </tr>
1192: <tr>
1193: <td class="osname">FreeBSD 5.1/i386</td>
1194: <td class="date">20030630</td>
1195: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.1-RELEASE-i386-20030630.tar.gz" target="_top">binary kit</a></td>
1196: <td class="binary-pkgs-url"> </td>
1197: </tr>
1198: <tr>
1199: <td class="osname">FreeBSD 5.2.1/i386</td>
1200: <td class="date">20040227</td>
1201: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.2.1-RELEASE-i386-20040227.tar.gz" target="_top">binary kit</a></td>
1202: <td class="binary-pkgs-url"> </td>
1203: </tr>
1204: <tr>
1205: <td class="osname">FreeBSD 5.3/i386</td>
1206: <td class="date">20050119</td>
1207: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.3-RELEASE-i386-20050119.tar" target="_top">binary kit</a></td>
1208: <td class="binary-pkgs-url"> </td>
1209: </tr>
1210: <tr>
1211: <td class="osname">HP-UX 11.11/hppa</td>
1212: <td class="date">20070421</td>
1213: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-HPUX-B.11.11-hppa-20070421.tar.gz" target="_top">binary kit</a></td>
1214: <td class="binary-pkgs-url"> </td>
1215: </tr>
1216: <tr>
1217: <td class="osname">Interix 3.5</td>
1218: <td class="date">20061106</td>
1219: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Interix-3.5-i386-20061106.tar.gz" target="_top">binary kit</a></td>
1220: <td class="binary-pkgs-url"> </td>
1221: </tr>
1222: <tr>
1223: <td class="osname">IRIX 6.5 n32-bit ABI</td>
1224: <td class="date">20040911</td>
1225: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-IRIX-6.5-mips-20040911.tar.gz" target="_top">binary kit</a></td>
1226: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/n32/" target="_top">binary packages</a></td>
1227: </tr>
1228: <tr>
1229: <td class="osname">IRIX 6.5 64-bit ABI</td>
1230: <td class="date">20040912</td>
1231: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-IRIX64-6.5-mips-20040912.tar.gz" target="_top">binary kit</a></td>
1232: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/64/" target="_top">binary packages</a></td>
1233: </tr>
1234: <tr>
1235: <td class="osname">OpenBSD 3.2/i386</td>
1236: <td class="date">20030420</td>
1237: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OpenBSD-3.2-i386-20030420.tar.gz" target="_top">binary kit</a></td>
1238: <td class="binary-pkgs-url"> </td>
1239: </tr>
1240: <tr>
1241: <td class="osname">OpenBSD 3.3/i386</td>
1242: <td class="date">20030503</td>
1243: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OpenBSD-3.3-i386-20030503.tar.gz" target="_top">binary kit</a></td>
1244: <td class="binary-pkgs-url"> </td>
1245: </tr>
1246: <tr>
1247: <td class="osname">OpenBSD 3.5/i386</td>
1248: <td class="date">20040703</td>
1249: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OpenBSD-3.5-i386-20040703.tar.gz" target="_top">binary kit</a></td>
1250: <td class="binary-pkgs-url"> </td>
1251: </tr>
1252: <tr>
1253: <td class="osname">OSF1 5.1/alpha</td>
1254: <td class="date">20070420</td>
1255: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OSF1-V5.1-alpha-20070420.tar.gz" target="_top">binary kit</a></td>
1256: <td class="binary-pkgs-url"> </td>
1257: </tr>
1258: <tr>
1259: <td class="osname">Slackware Linux 8.1/i386</td>
1260: <td class="date">20030417</td>
1261: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.4.18-slackware-20030417.tar.gz" target="_top">binary kit</a></td>
1262: <td class="binary-pkgs-url"> </td>
1263: </tr>
1264: <tr>
1265: <td class="osname">Slackware Linux 9/i386</td>
1266: <td class="date">20040703</td>
1267: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.4.22-i386-slackware9-20040703.tar.gz" target="_top">binary kit</a></td>
1268: <td class="binary-pkgs-url"> </td>
1269: </tr>
1270: <tr>
1271: <td class="osname">Solaris 8/sparc</td>
1272: <td class="date">20050220</td>
1273: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.8-sparc-20050220.tar.gz" target="_top">binary kit</a></td>
1274: <td class="binary-pkgs-url"> </td>
1275: </tr>
1276: <tr>
1277: <td class="osname">Solaris 8/i386</td>
1278: <td class="date">20050220</td>
1279: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.8-i386-20050220.tar.gz" target="_top">binary kit</a></td>
1280: <td class="binary-pkgs-url"> </td>
1281: </tr>
1282: <tr>
1283: <td class="osname">Solaris 9/sparc</td>
1284: <td class="date">20060713</td>
1285: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.9-sparc-pkgsrc-2006Q2.tar.gz" target="_top">binary kit</a></td>
1286: <td class="binary-pkgs-url"> </td>
1287: </tr>
1288: <tr>
1289: <td class="osname">Solaris 9/i386</td>
1290: <td class="date">20030411</td>
1291: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.9-i386-20030411.tar.gz" target="_top">binary kit</a></td>
1292: <td class="binary-pkgs-url"> </td>
1293: </tr>
1294: </tbody>
1295: </table></div>
1296: </div>
1297: <br class="table-break"><p>
1298: Simply download the binary kit for your platform, and extract it into
1299: <code class="filename">/</code> e.g.
1300: </p>
1301: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
1302: <code class="prompt">#</code> <strong class="userinput"><code>gzip -c -d /tmp/bootstrap-pkgsrc-SunOS-5.9-sparc-20031023.tar.gz \
1303: | tar -xpf -</code></strong></pre>
1304: <p>
1305: Of course, as with any binary distributions, you should verify the
1306: checksum against the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/SUM" target="_top">SUM</a>
1307: or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/CKSUM" target="_top">CKSUM</a>
1308: file and inspect the contents before extracting it.
1309: </p>
1310: </div>
1311: <div class="sect1" lang="en">
1312: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1313: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1314: <p>Installing the bootstrap kit from source should be as simple as:</p>
1315: <pre class="screen">
1316: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
1317: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1318: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1319: </pre>
1320: <p>See <a 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
1321: pkgsrc before bootstrapping. The given
1322: <span><strong class="command">bootstrap</strong></span> command will use the defaults of
1323: <code class="filename">/usr/pkg</code> for the
1324: <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
1325: and <code class="filename">/var/db/pkg</code> for the package database
1326: directory where pkgsrc will do its internal bookkeeping.
1327: However, these can also be set using command-line
1328: arguments.</p>
1329: <p>Binary packages for the pkgsrc tools and an initial set of packages is
1330: available for supported platforms. An up-to-date list of these can be
1331: found on <a href="http://www.pkgsrc.org/" target="_top">www.pkgsrc.org</a>.
1332: Note that this only works for privileged builds that install
1333: into <code class="filename">/usr/pkg</code>.</p>
1334: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1335: <h3 class="title">Note</h3>
1336: <p>The bootstrap installs a <span><strong class="command">bmake</strong></span> tool.
1337: Use this <span><strong class="command">bmake</strong></span> when building via pkgsrc.
1338: For examples in this guide, use <span><strong class="command">bmake</strong></span>
1339: instead of “<span class="quote">make</span>”.</p>
1340: </div>
1341: </div>
1342: <div class="sect1" lang="en">
1343: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1344: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1345: <p>Here are some platform-specific notes you should be aware of.</p>
1346: <div class="sect2" lang="en">
1347: <div class="titlepage"><div><div><h3 class="title">
1348: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1349: <p>Darwin 5.x and up are supported. There are two methods of using
1350: pkgsrc on Mac OS X, by using a <a href="#platform.osx-image" title="3.3.1.1. Using a disk image">disk
1351: image</a>, or a <a href="#platform.osx-part" title="3.3.1.2. Using a UFS or HFSX partition">UFS or HFSX
1352: partition</a>.</p>
1353: <p>Before you start, you will need to download and install the Mac OS X Developer
1354: Tools from Apple's Developer Connection. See <a href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1355: for details. Also, make sure you install X11 for Mac OS X and the X11 SDK
1356: from <a href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
1357: if you intend to build packages that use the X11 Window System.</p>
1358: <p>If you already have a UFS or HFSX partition, or have a spare partition
1359: that you can format as UFS or HFSX, it is recommended to use that instead of
1360: the disk image. It'll be somewhat faster and will mount automatically
1361: at boot time, where you must manually mount a disk image.</p>
1362: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1363: <h3 class="title">Note</h3>
1364: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
1365: requires the file system to be case-sensitive. You can, however, use a case-sensitive HFS+ (aka HFSX) file system as found in Darwin 7.0 and newer.</p>
1366: </div>
1367: <div class="sect3" lang="en">
1368: <div class="titlepage"><div><div><h4 class="title">
1369: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
1370: <p>Create the disk image:</p>
1371: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1372: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 1024</code></strong> # megabytes - season to taste
1373: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
1374: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
1375: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1376: <h3 class="title">Note</h3>
1377: <p>darwindiskimage will mount the filesystem nosuid, which will cause problems for packages that depend on setgid. In the case of UFS, it will also mount the filesystem asynchronous, which is somewhat dangerous according to the mount(8) man page. In the case of HFSX, it will disable journalling.</p>
1378: </div>
1379: <p>Allow suid:</p>
1380: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.5 weinem 1381: <p>Changing the build directory:</p>
1382: <p>After bootstrapping you need to change the default package build directory to somewhere outside the disk image so it doesn't get filled up in the process of building packages. Add something like that to <code class="filename">mk.conf</code>.</p>
1383: <pre class="programlisting">
1384: WRKOBJDIR?= /tmp/pkgsrc # build here instead of in pkgsrc
1385: </pre>
1.1 dsieger 1386: </div>
1387: <div class="sect3" lang="en">
1388: <div class="titlepage"><div><div><h4 class="title">
1389: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1390: <p>By default, <code class="filename">/usr</code> will be on your root file
1391: system, normally HFS+. It is possible to use the default
1392: <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
1393: by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1394: or HFSX file system. Obviously, another symlink is required if you want to
1395: place the package database directory outside the
1396: <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1397: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
1398: <p>If you created your partitions at the time of installing Mac OS X
1399: and formatted the target partition as UFS or HFSX, it should automatically
1400: mount on <code class="filename">/Volumes/<volume name></code> when the
1401: machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1402: to ensure that the partition map correctly reflects
1403: “<span class="quote">Apple_UFS</span>” or “<span class="quote">Apple_HFSX</span>” and not “<span class="quote">Apple_HFS</span>”.</p>
1404: <p>The problem is that none of the disk tools will let you touch a
1405: disk that is booted from. You can unmount the partition, but even if
1406: you newfs it, the partition type will be incorrect and the
1407: automounter won't mount it. It can be mounted manually, but it won't
1408: appear in Finder.</p>
1409: <p>You'll need to boot off of the OS X Installation (User) CD. When
1410: the Installation program starts, go up to the menu and select Disk
1411: Utility. Now, you will be able to select the partition you want
1412: to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
1413: installer which will reboot your machine. The new UFS or HFSX file system
1414: will appear in Finder.</p>
1415: <p>Be aware that the permissions on the new file system will be writable
1416: by root only.</p>
1417: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1418: Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1419: </div>
1420: </div>
1421: <div class="sect2" lang="en">
1422: <div class="titlepage"><div><div><h3 class="title">
1423: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1424: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
1425: other versions may work.</p>
1426: <p>Care should be taken so that the tools that this kit installs do not conflict
1427: with the FreeBSD userland tools. There are several steps:</p>
1428: <div class="orderedlist"><ol type="1">
1429: <li><p>FreeBSD stores its ports pkg database in
1430: <code class="filename">/var/db/pkg</code>. It is therefore
1431: recommended that you choose a different location (e.g.
1432: <code class="filename">/usr/pkgdb</code>) by
1433: using the --pkgdbdir option to the bootstrap script.</p></li>
1434: <li>
1435: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1436: good idea to move them out of the way to avoid confusion, e.g.</p>
1437: <pre class="screen">
1438: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1439: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1440: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1441: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1442: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1443: </pre>
1444: </li>
1.4 rillig 1445: <li><p>An example <a href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1 dsieger 1446: <code class="filename">/etc/mk.conf.example</code> file
1447: when you use the bootstrap script.</p></li>
1448: </ol></div>
1449: </div>
1450: <div class="sect2" lang="en">
1451: <div class="titlepage"><div><div><h3 class="title">
1452: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1453: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1454: providing a Unix-like environment with a tighter kernel integration than
1455: available with Cygwin. It is part of the Windows Services for Unix
1456: package, available for free for any licensed copy of Windows 2000, XP
1457: (not including XP Home), or 2003. SFU can be downloaded from <a href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1458: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1459: are not officially supported. (The main difference in 3.0/3.1 is lack
1460: of pthreads, but other parts of libc may also be lacking.)</p>
1461: <p>Services for Unix Applications (aka SUA) is an integrated component
1462: of Windows Server 2003 R2 and Windows Vista. As of this writing, SUA's
1463: Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1464: <div class="sect3" lang="en">
1465: <div class="titlepage"><div><div><h4 class="title">
1466: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1467: <p>At an absolute minimum, the following packages must be installed from
1468: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1469: <div class="itemizedlist"><ul type="disc">
1470: <li><p>Utilities -> Base Utilities</p></li>
1471: <li><p>Interix GNU Components -> (all)</p></li>
1472: <li><p>Remote Connectivity</p></li>
1473: <li><p>Interix SDK</p></li>
1474: </ul></div>
1475: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1476: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1477: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1478: pkgsrc (or from a binary package).</p>
1479: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1480: not need to be installed, but Remote Connectivity itself should be
1481: installed in order to have a working inetd.</p>
1482: <p>During installation you may be asked whether to enable setuid
1483: behavior for Interix programs, and whether to make pathnames default to
1484: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1485: enabled. (Without case-sensitivity, a large number of packages including
1486: perl will not build.)</p>
1487: <p>NOTE: Newer Windows service packs change the way binary execution
1488: works (via the Data Execution Prevention feature). In order to use
1489: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1490: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1491: must be installed. Hotfixes are available from Microsoft through a
1492: support contract; however, a NetBSD developer has made most Interix
1493: hotfixes available for personal use from <a href="http://www.duh.org/interix/hotfixes.php" target="_top">http://www.duh.org/interix/hotfixes.php</a>.</p>
1494: <p>In addition to the hotfix noted above, it may be necessary to
1495: disable Data Execution Prevention entirely to make Interix functional.
1496: This may happen only with certain types of CPUs; the cause is not fully
1497: understood at this time. If gcc or other applications still segfault
1498: repeatedly after installing one of the hotfixes note above, the
1499: following option can be added to the appropriate "boot.ini" line on the
1500: Windows boot drive: /NoExecute=AlwaysOff
1501: (WARNING, this will disable DEP completely, which may be a security
1502: risk if applications are often run as a user in the Administrators
1503: group!)</p>
1504: </div>
1505: <div class="sect3" lang="en">
1506: <div class="titlepage"><div><div><h4 class="title">
1507: <a name="platform.interix-sfu-postinstall"></a>3.3.3.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1508: <p>If SFU is already installed and you wish to alter these settings to work
1509: with pkgsrc, note the following things.</p>
1510: <div class="itemizedlist"><ul type="disc">
1511: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1512: Windows Services for UNIX, then click Change. In the installer, choose
1513: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1514: <li>
1515: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1516: change the following registry key:</p>
1517: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1518: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1519: </li>
1520: <li>
1521: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1522: following registry key:</p>
1523: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1524: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1525: </li>
1526: </ul></div>
1527: </div>
1528: <div class="sect3" lang="en">
1529: <div class="titlepage"><div><div><h4 class="title">
1530: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1531: <p>The package manager (either the pkgsrc "su" user, or the user
1532: running "pkg_add") must be a member of the local Administrators
1533: group. Such a user must also be used to run the bootstrap. This is
1534: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1535: <p>The package manager should use a umask of 002. "make install" will
1536: automatically complain if this is not the case. This ensures that
1537: directories written in /var/db/pkg are Administrators-group writeable.</p>
1538: <p>The popular Interix binary packages from http://www.interopsystems.com/
1539: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1540: NOT be used in conjunction with pkgsrc. If you choose to use them at
1541: the same time as the pkgsrc packages, ensure that you use the proper
1542: pkg_* tools for each type of binary package.</p>
1543: <p>The TERM setting used for DOS-type console windows (including those
1544: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1545: don't have a termcap/terminfo entry for it, but the following .termcap
1546: entry provides adequate emulation in most cases:</p>
1547: <pre class="programlisting">
1548: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1549: </pre>
1550: </div>
1551: <div class="sect3" lang="en">
1552: <div class="titlepage"><div><div><h4 class="title">
1553: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1554: <p>Though Interix suffices as a familiar and flexible substitute
1555: for a full Unix-like platform, it has some drawbacks that should
1556: be noted for those desiring to make the most of Interix.</p>
1557: <div class="itemizedlist"><ul type="disc">
1558: <li>
1559: <p><span class="strong"><strong>X11:</strong></span></p>
1560: <p>Interix comes with the standard set of X11R6 client libraries,
1561: and can run X11 based applications, but it does
1562: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1563: <a href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1564: <a href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1565: (available in a trimmed version for Interix from Interop Systems as the
1566: <a href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1567: and the free X11 server included with
1568: <a href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1569: </li>
1570: <li>
1571: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1572: <p>Because Interix runs in a completely different NT subsystem from
1573: Win32 applications, it does not currently support various X11
1574: protocol extensions for acceleration (such as MIT-SHM or DGA).
1575: Most interactive applications to a local X server will run
1576: reasonably fast, but full motion video and other graphics
1577: intensive applications may require a faster-than-expected CPU.</p>
1578: </li>
1579: <li>
1580: <p><span class="strong"><strong>Audio:</strong></span></p>
1581: <p>Interix has no native support for audio output. For audio
1582: support, pkgsrc uses the <span><strong class="command">esound</strong></span> client/server
1583: audio system on Interix. Unlike on most platforms, the
1584: <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
1585: <span class="emphasis"><em>not</em></span> contain the <span><strong class="command">esd</strong></span>
1586: server component. To output audio via an Interix host, the
1587: <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
1588: must also be installed.</p>
1589: </li>
1590: <li>
1591: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1592: <p>Direct device access is not currently supported in Interix, so it
1593: is not currently possible to access CD/DVD drives, USB devices,
1594: or SCSI devices through non-filesystem means. Among other things,
1595: this makes it impossible to use Interix directly for CD/DVD
1596: burning.</p>
1597: </li>
1598: <li>
1599: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1600: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1601: drives are also not directly accessible in Interix. However,
1602: support is in work to make tape drive access possible by using
1603: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1604: esound server).</p>
1605: </li>
1606: </ul></div>
1607: </div>
1608: <div class="sect3" lang="en">
1609: <div class="titlepage"><div><div><h4 class="title">
1610: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1611: <p>It is not necessary, in general, to have a "root" user on the
1612: Windows system; any member of the local Administrators group will
1613: suffice. However, some packages currently assume that the user
1614: named "root" is the privileged user. To accommodate these, you
1615: may create such a user; make sure it is in the local group
1616: Administrators (or your language equivalent).</p>
1617: <p><span><strong class="command">pkg_add</strong></span> creates directories of mode
1618: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1619: time being, install packages as the local Administrator (or
1620: your language equivalent), or run the following command after
1621: installing a package to work around the issue:</p>
1622: <pre class="screen">
1623: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1624: </pre>
1625: </div>
1626: </div>
1627: <div class="sect2" lang="en">
1628: <div class="titlepage"><div><div><h3 class="title">
1629: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1630: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1631: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1632: according to your preference. If you do not have a license for the MIPSpro
1633: compiler suite, you can download a gcc tardist file from <a href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1634: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1635: version of IRIX providing support for <a 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 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>,
1636: etc.</p>
1637: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1638: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1639: you start out using "abi=n32", that's what all your packages will be built
1640: with.</p>
1641: <p>Therefore, please make sure that you have no conflicting
1642: <code class="varname">CFLAGS</code> in your environment or the
1.4 rillig 1643: <a href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.1 dsieger 1644: try to link n32 object files with lib64 or vice versa. Check your
1645: <code class="filename">/etc/compiler.defaults</code>!</p>
1646: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1647: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1648: as it appears that IRIX linker occasionally runs into issues when trying to
1649: link over a network-mounted file system.</p>
1650: <p>The bootstrapping process should set all the right options for programs such
1651: as imake(1), but you may want to set some options depending on your local
1652: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1653: course, your compiler's man pages for details.</p>
1654: <p>If you are using SGI's MIPSPro compiler, please set
1655:
1656: </p>
1657: <pre class="programlisting">
1658: PKGSRC_COMPILER= mipspro
1659: </pre>
1660: <p>
1661:
1.4 rillig 1662: in <a href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.1 dsieger 1663: are using gcc and may end up passing invalid flags to the compiler. Note that
1664: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1665: default.</p>
1666: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1667: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1668: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1669: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1670: '--preserve-path' flag.</p>
1671: </div>
1672: <div class="sect2" lang="en">
1673: <div class="titlepage"><div><div><h3 class="title">
1674: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1675: <p>Some versions of Linux (for example Debian GNU/Linux) need
1676: either libtermcap or libcurses (libncurses). Installing the
1677: distributions libncurses-dev package (or equivalent) should fix
1678: the problem.</p>
1679: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1680: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1681: i386 have been tested.</p>
1682: <p>To bootstrap using icc, assuming the default icc installation
1683: directory:</p>
1684: <pre class="programlisting">
1685: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
1686: ac_cv___attribute__=yes ./bootstrap
1687: </pre>
1688: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1689: <h3 class="title">Note</h3>
1690: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
1691: </div>
1692: <p>icc supports __attribute__, but the GNU configure test uses a nested
1693: function, which icc does not support. #undef'ing __attribute__ has the
1694: unfortunate side-effect of breaking many of the Linux header files, which
1695: cannot be compiled properly without __attribute__. The test must be
1696: overridden so that __attribute__ is assumed supported by the
1697: compiler.</p>
1698: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.4 rillig 1699: in <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 1700: <pre class="programlisting">
1701: PKGSRC_COMPILER= icc
1702: </pre>
1703: <p>The default installation directory for icc is
1704: <code class="filename">/opt/intel_cc_80</code>, which
1705: is also the pkgsrc default. If you have installed it into a different
1706: directory, set <code class="varname">ICCBASE</code> in
1.4 rillig 1707: <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 1708: <pre class="programlisting">
1709: ICCBASE= /opt/icc
1710: </pre>
1711: <p>pkgsrc uses the static linking method of the runtime libraries
1712: provided by icc, so binaries can be run on other systems which do not
1713: have the shared libraries installed.</p>
1714: <p>Libtool, however, extracts a list of libraries from the
1715: <a 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
1716: records it, throwing away the -Bstatic and -Bdynamic options
1717: interspersed between the libraries. This means that
1718: libtool-linked C++ shared libraries will have a runtime
1719: dependency on the icc libraries until this is fixed in
1720: libtool.</p>
1721: </div>
1722: <div class="sect2" lang="en">
1723: <div class="titlepage"><div><div><h3 class="title">
1724: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1725: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
1726: <p>Care should be taken so that the tools that this kit installs do not conflict
1727: with the OpenBSD userland tools. There are several steps:</p>
1728: <div class="orderedlist"><ol type="1">
1729: <li><p>OpenBSD stores its ports pkg database in
1730: <code class="filename">/var/db/pkg</code>. It is therefore
1731: recommended that you choose a different location (e.g.
1732: <code class="filename">/usr/pkgdb</code>) by
1733: using the --pkgdbdir option to the bootstrap script.</p></li>
1734: <li>
1735: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1736: good idea to move them out of the way to avoid confusion, e.g.</p>
1737: <pre class="screen">
1738: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1739: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1740: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1741: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1742: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1743: </pre>
1744: </li>
1745: <li>
1.4 rillig 1746: <p>An example <a href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1 dsieger 1747: <code class="filename">/etc/mk.conf.example</code> file
1748: when you use the bootstrap script. OpenBSD's make program uses
1.4 rillig 1749: <a href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 1750: as well. You can work around this by enclosing all the pkgsrc-specific parts
1751: of the file with:</p>
1752: <pre class="programlisting">
1753: .ifdef BSD_PKG_MK
1754: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1755: .else
1756: # OpenBSD stuff
1757: .endif
1758: </pre>
1759: </li>
1760: </ol></div>
1761: </div>
1762: <div class="sect2" lang="en">
1763: <div class="titlepage"><div><div><h3 class="title">
1764: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1765: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1766: You will need a working C compiler. Both gcc 2.95.3 and
1767: Sun WorkShop 5 have been tested.</p>
1768: <p>The following packages are required on Solaris 8 for the bootstrap
1769: process and to build packages.</p>
1770: <div class="itemizedlist"><ul type="disc">
1771: <li><p>SUNWsprot</p></li>
1772: <li><p>SUNWarc</p></li>
1773: <li><p>SUNWbtool</p></li>
1774: <li><p>SUNWtoo</p></li>
1775: <li><p>SUNWlibm</p></li>
1776: </ul></div>
1777: <p>Please note that the use of GNU binutils on Solaris is
1778: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1779: <p>Whichever compiler you use, please ensure the compiler tools and
1780: your $prefix are in your <code class="varname">PATH</code>. This includes
1781: <code class="filename">/usr/ccs/{bin,lib}</code>
1782: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1783: <div class="sect3" lang="en">
1784: <div class="titlepage"><div><div><h4 class="title">
1785: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1786: <p>It makes life much simpler if you only use the same gcc consistently
1787: for building all packages.</p>
1788: <p>It is recommended that an external gcc be used only for bootstrapping,
1789: then either build gcc from
1790: <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
1791: package, then remove gcc used during bootstrapping.</p>
1792: <p>Binary packages of gcc can be found through <a href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1793: </div>
1794: <div class="sect3" lang="en">
1795: <div class="titlepage"><div><div><h4 class="title">
1796: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1797: <p>You will need at least the following packages installed (from WorkShop
1798: 5.0)</p>
1799: <div class="itemizedlist"><ul type="disc">
1800: <li><p>SPROcc
1801: - Sun WorkShop Compiler C 5.0</p></li>
1802: <li><p>SPROcpl
1803: - Sun WorkShop Compiler C++ 5.0</p></li>
1804: <li><p>SPROild
1805: - Sun WorkShop Incremental Linker</p></li>
1806: <li><p>SPROlang
1807: - Sun WorkShop Compilers common components</p></li>
1808: </ul></div>
1809: <p>You should set the following variables in your
1.4 rillig 1810: <a href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1811: <pre class="programlisting">
1812: CC= cc
1813: CXX= CC
1814: CPP= cc -E
1815: CXXCPP= CC -E
1816: </pre>
1817: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1818: <h3 class="title">Note</h3>
1819: <p>The <code class="varname">CPP</code> setting might break some
1820: packages that use the C preprocessor for processing things other
1821: than C source code.</p>
1822: </div>
1823: </div>
1824: <div class="sect3" lang="en">
1825: <div class="titlepage"><div><div><h4 class="title">
1826: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1827: <p>To build 64-bit packages, you just need to have the
1.4 rillig 1828: following lines in your <a href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1829: <pre class="programlisting">
1830: PKGSRC_COMPILER= sunpro
1831: ABI= 64
1832: </pre>
1833: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1834: <h3 class="title">Note</h3>
1835: <p>This setting has been tested for the SPARC
1836: architecture. Intel and AMD machines need some more
1837: work.</p>
1838: </div>
1839: </div>
1840: <div class="sect3" lang="en">
1841: <div class="titlepage"><div><div><h4 class="title">
1842: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1843: <p>Sometimes, when using <span><strong class="command">libtool</strong></span>,
1844: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1845: The workaround is to use another shell for the configure
1846: 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.4 rillig 1847: to your <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 1848: <pre class="programlisting">
1849: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1850: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1851: </pre>
1852: <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>
1853: </div>
1854: </div>
1855: </div>
1856: </div>
1857: <div class="chapter" lang="en">
1858: <div class="titlepage"><div><div><h2 class="title">
1859: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1860: <div class="toc">
1861: <p><b>Table of Contents</b></p>
1862: <dl>
1863: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1864: <dd><dl>
1865: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1866: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1867: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1868: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1869: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1870: <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>
1871: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1872: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1873: </dl></dd>
1874: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1875: <dd><dl>
1876: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1877: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1878: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1879: </dl></dd>
1880: </dl>
1881: </div>
1882: <p>Basically, there are two ways of using pkgsrc. The first
1883: is to only install the package tools and to use binary packages
1884: that someone else has prepared. This is the “<span class="quote">pkg</span>”
1885: in pkgsrc. The second way is to install the “<span class="quote">src</span>”
1886: of pkgsrc, too. Then you are able to build your own packages,
1887: and you can still use binary packages from someone else.</p>
1888: <div class="sect1" lang="en">
1889: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1890: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.5 weinem 1891: <p>To use binary packages, you need some tools to manage them. On
1892: NetBSD, these tools are already installed. On all other operating
1893: systems, you need to install them first. For some platforms, these
1894: tools are already packages in an archive, ready to be extracted in the
1895: <code class="filename">/</code> directory. They can be found in the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/bootstrap-pkgsrc" target="_top"><code class="filename">bootstrap-pkgsrc</code></a>
1896: directory of the FTP server.</p>
1.1 dsieger 1897: <p>These pre-built package tools use
1898: <code class="filename">/usr/pkg</code> for the base directory, and
1899: <code class="filename">/var/db/pkg</code> for the database of installed
1900: packages. If you cannot use these directories for whatever
1901: reasons (maybe because you're not root), you have to build the
1902: package tools yourself, which is explained in <a href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, “Bootstrapping pkgsrc”</a>.</p>
1903: <div class="sect2" lang="en">
1904: <div class="titlepage"><div><div><h3 class="title">
1905: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1906: <p>To install binary packages, you first need to know from where
1907: to get them. The first place where you should look is on the main
1908: pkgsrc FTP server in the directory <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1909: <p>This directory contains binary packages for multiple
1910: platforms. First, select your operating system. (Ignore the
1911: directories with version numbers attached to it, they just exist for
1912: legacy reasons.) Then, select your hardware architecture, and in the
1913: third step, the OS version and the “<span class="quote">version</span>” of pkgsrc.
1914: This directory contains a subdirectory called
1915: <code class="filename">All</code>, where (almost) all binary packages are
1916: stored. Almost, because vulnerable packages are moved to the
1917: <code class="filename">vulnerable</code> directory so they don't get
1918: installed accidentally.</p>
1.1 dsieger 1919: </div>
1920: <div class="sect2" lang="en">
1921: <div class="titlepage"><div><div><h3 class="title">
1922: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1923: <p>If you have the files on a CD-ROM or downloaded them to
1924: your hard disk, you can install them with the following command
1925: (be sure to <span><strong class="command">su</strong></span> to root first):</p>
1926: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add /path/to/package.tgz</code></strong></pre>
1927: <p>If you have FTP access and you don't want to download the
1928: packages via FTP prior to installation, you can do this
1929: automatically by giving <span><strong class="command">pkg_add</strong></span> an FTP URL:</p>
1.5 weinem 1930: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add 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/<em class="replaceable"><code>package</code></em></code></strong></pre>
1.1 dsieger 1931: <p>Note that any prerequisite packages needed to run the
1932: package in question will be installed, too, assuming they are
1933: present where you install from.</p>
1934: <p>To save some typing, you can set the
1935: <code class="varname">PKG_PATH</code> environment variable to a semicolon-separated
1936: list of paths (including remote URLs); trailing slashes are not allowed.
1937: </p>
1938: <p>Additionally to the <code class="filename">All</code> directory
1939: there exists a <code class="filename">vulnerable</code> directory to
1940: which binary packages with known vulnerabilities are
1941: moved, since removing them could cause missing dependencies. To
1942: use these packages, add the <code class="filename">vulnerable</code>
1943: directory to your <code class="varname">PKG_PATH</code>. However, you should run
1944: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> regularly,
1945: especially after installing new packages, and verify that the
1946: vulnerabilities are acceptable for your configuration. An example
1947: <code class="varname">PKG_PATH</code> would be:
1948: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All;ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/vulnerable</code>
1949: Please note that semicolon (';') is a shell meta-character, so
1950: you'll probably have to quote it.</p>
1951: <p>After you've installed packages, be sure to have
1952: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1953: <code class="varname">PATH</code> so you can actually start the just
1954: installed program.</p>
1955: </div>
1956: <div class="sect2" lang="en">
1957: <div class="titlepage"><div><div><h3 class="title">
1958: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1959: <p>To deinstall a package, it does not matter whether it was
1960: installed from source code or from a binary package. The
1961: <span><strong class="command">pkg_delete</strong></span> command does not know it anyway.
1962: To delete a package, you can just run <span><strong class="command">pkg_delete
1963: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1964: name can be given with or without version number. Wildcards can
1965: also be used to deinstall a set of packages, for example
1966: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1967: so that the shell does not expand them before
1968: <code class="literal">pkg_delete</code> sees them.</p>
1969: <p>The <code class="option">-r</code> option is very powerful: it
1970: removes all the packages that require the package in question
1971: and then removes the package itself. For example:
1972:
1973: </p>
1974: <pre class="screen">
1975: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1976: </pre>
1977: <p>
1978:
1979: will remove jpeg and all the packages that used it; this allows
1980: upgrading the jpeg package.</p>
1981: </div>
1982: <div class="sect2" lang="en">
1983: <div class="titlepage"><div><div><h3 class="title">
1984: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1985: <p>The <span><strong class="command">pkg_info</strong></span> shows information about
1986: installed packages or binary package files.</p>
1987: </div>
1988: <div class="sect2" lang="en">
1989: <div class="titlepage"><div><div><h3 class="title">
1990: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1991: <p>
1992: The NetBSD Security-Officer and Packages Groups maintain a list of
1993: known security vulnerabilities to packages which are (or have been)
1994: included in pkgsrc. The list is available from the NetBSD
1995: FTP site at <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1996: </p>
1997: <p>
1998: Through <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>,
1999: this list can be downloaded
2000: automatically, and a security audit of all packages installed on a system
2001: can take place.
2002: </p>
2003: <p>
2004: There are two components to
2005: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>. The first
2006: component, “<span class="quote">download-vulnerability-list</span>”, is for downloading
2007: the list of vulnerabilities from the NetBSD FTP site. The second
2008: component, “<span class="quote">audit-packages</span>”, checks to see if any of your
2009: installed packages are vulnerable. If a package is vulnerable, you
2010: will see output similar to the following:
2011: </p>
2012: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
2013: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
2014: <p>
2015: One can set up <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> to download the
2016: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
2017: file daily, and include a package audit in the daily security script.
2018: Details on this are located in the <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/pkgsrc/security/audit-packages/MESSAGE?rev=HEAD&content-type=text/x-cvsweb-markup" target="_top">MESSAGE</a>
2019: file for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>.
2020: </p>
2021: </div>
2022: <div class="sect2" lang="en">
2023: <div class="titlepage"><div><div><h3 class="title">
2024: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
2025: <p>
2026: Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a> and run
2027: <span><strong class="command">lintpkgsrc</strong></span> with the “<span class="quote">-i</span>”
2028: argument to check if your packages are up-to-date, e.g.
2029: </p>
2030: <pre class="screen">
2031: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
2032: ...
2033: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
2034: </pre>
2035: <p>You can then use <span><strong class="command">make update</strong></span> to update the
2036: package on your system and rebuild any dependencies.
2037: </p>
2038: </div>
2039: <div class="sect2" lang="en">
2040: <div class="titlepage"><div><div><h3 class="title">
2041: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
2042: <p>The <span><strong class="command">pkg_admin</strong></span> executes various
2043: administrative functions on the package system.</p>
2044: </div>
2045: <div class="sect2" lang="en">
2046: <div class="titlepage"><div><div><h3 class="title">
2047: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
2048: <p>Please pay very careful attention to the warnings
2049: expressed in the <a 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
2050: inherent dangers of installing binary packages which you did
2051: not create yourself, and the security holes that can be
2052: introduced onto your system by indiscriminate adding of such
2053: files.</p>
2054: <p>The same warning of course applies to every package you
2055: install from source when you haven't completely read and
2056: understood the source code of the package, the compiler that
2057: is used to build the package and all the other tools that are
2058: involved.</p>
2059: </div>
2060: </div>
2061: <div class="sect1" lang="en">
2062: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2063: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
2064: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
2065: directory now contains a set of packages, organized into
2066: categories. You can browse the online index of packages, or run
2067: <span><strong class="command">make readme</strong></span> from the <code class="filename">pkgsrc</code>
2068: directory to build local <code class="filename">README.html</code> files for
2069: 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>
2070: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
2071: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
2072: should do so by setting <code class="varname">LOCALBASE</code> in
1.4 rillig 2073: <a href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 2074: different <code class="varname">LOCALBASE</code> definitions on the same
2075: system (inside a chroot is an exception). </p>
2076: <p>The rest of this chapter assumes that the package is already
2077: in pkgsrc. If it is not, see <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for
2078: instructions how to create your own packages.</p>
2079: <div class="sect2" lang="en">
2080: <div class="titlepage"><div><div><h3 class="title">
2081: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
2082: <p>To build packages from source, you need a working C
2083: compiler. On NetBSD, you need to install the
2084: “<span class="quote">comp</span>” and the “<span class="quote">text</span>” distribution
2085: sets. If you want to build X11-related packages, the
2086: “<span class="quote">xbase</span>” and “<span class="quote">xcomp</span>” distribution
2087: sets are required, too.</p>
2088: </div>
2089: <div class="sect2" lang="en">
2090: <div class="titlepage"><div><div><h3 class="title">
2091: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
2092: <p>The first step for building a package is downloading the
2093: distfiles (i.e. the unmodified source). If they have not yet been
2094: downloaded, pkgsrc will fetch them automatically.</p>
2095: <p>If you have all files that you need in the
2096: <code class="filename">distfiles</code> directory,
2097: you don't need to connect. If the distfiles are on CD-ROM, you can
2098: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
2099: </p>
2100: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
2101: <p>
1.4 rillig 2102: to your <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 2103: <p>By default a list of distribution sites will be randomly
2104: intermixed to prevent huge load on servers which holding popular
2105: packages (for example, SourceForge.net mirrors). Thus, every
2106: time when you need to fetch yet another distfile all the mirrors
2107: will be tried in new (random) order. You can turn this feature
2108: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
2109: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
2110: <p>You can overwrite some of the major distribution sites to
2111: fit to sites that are close to your own. By setting one or two
2112: variables you can modify the order in which the master sites are
2113: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
2114: delimited list of domain suffixes.
2115: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
2116: contains a whitespace delimited list of regular expressions. It
2117: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
2118: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
2119: some examples. This may save some of your bandwidth and
2120: time.</p>
2121: <p>You can change these settings either in your shell's environment, or,
2122: if you want to keep the settings, by editing the
1.4 rillig 2123: <a href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 2124: and adding the definitions there.</p>
2125: <p>
2126: If a package depends on many other packages (such as
2127: <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
2128: alternate between periods of
2129: downloading source, and compiling. To ensure you have all the source
2130: downloaded initially you can run the command:
2131: </p>
2132: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
2133: <p>
2134: which will output and run a set of shell commands to fetch the
2135: necessary files into the <code class="filename">distfiles</code> directory. You can
2136: also choose to download the files manually.
2137: </p>
2138: </div>
2139: <div class="sect2" lang="en">
2140: <div class="titlepage"><div><div><h3 class="title">
2141: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
2142: <p>
2143: Once the software has downloaded, any patches will be applied, then it
2144: will be compiled for you. This may take some time depending on your
2145: computer, and how many other packages the software depends on and their
2146: compile time.
2147: </p>
2148: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2149: <h3 class="title">Note</h3>
2150: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
2151: use the pkgsrc <span><strong class="command">bmake</strong></span> command instead of
2152: “<span class="quote">make</span>” in the examples in this guide.</p>
2153: </div>
2154: <p>For example, type</p>
2155: <pre class="screen">
2156: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2157: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
2158: </pre>
2159: <p>at the shell prompt to build the various components of the
2160: package.</p>
2161: <p>The next stage is to actually install the newly compiled
2162: program onto your system. Do this by entering:
2163:
2164: </p>
2165: <pre class="screen">
2166: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
2167: </pre>
2168: <p>
2169:
2170: while you are still in the directory for whatever package you
2171: are installing.</p>
2172: <p>Installing the package on your system may require you to
2173: be root. However, pkgsrc has a
2174: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2175: to only become root for the actual installation step.</p>
2176: <p>That's it, the software should now be installed and setup for use.
2177: You can now enter:
2178:
2179: </p>
2180: <pre class="screen">
2181: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2182: </pre>
2183: <p>
2184:
2185: to remove the compiled files in the work directory, as you shouldn't need
2186: them any more. If other packages were also added to your system
2187: (dependencies) to allow your program to compile, you can tidy these up
2188: also with the command:</p>
2189: <pre class="screen">
2190: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2191: </pre>
2192: <p>Taking the figlet utility as an example, we can install it on our
2193: system by building as shown in <a href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
2194: <p>The program is installed under the default root of the
2195: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2196: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2197: variable in your environment, and it will use that value as the
2198: root of your packages tree. So, to use
2199: <code class="filename">/usr/local</code>, set
2200: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2201: Please note that you should use a directory which is dedicated to
2202: packages and not shared with other programs (i.e., do not try and
2203: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2204: to add any of your own files or directories (such as
2205: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2206: <code class="filename">pkgsrc/</code>) below the
2207: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2208: conflicts between programs and other files installed by the
2209: package system and whatever else may have been installed
2210: there.</p>
1.4 rillig 2211: <p>Some packages look in <a href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 2212: alter some configuration options at build time. Have a look at
2213: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2214: of what will be set there by default. Environment variables such
2215: as <code class="varname">LOCALBASE</code> can be set in
1.4 rillig 2216: <a href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 2217: set them each time you want to use pkgsrc.</p>
2218: <p>Occasionally, people want to “<span class="quote">look under the
2219: covers</span>” to see what is going on when a package is building
2220: or being installed. This may be for debugging purposes, or out of
2221: simple curiosity. A number of utility values have been added to
2222: help with this.</p>
2223: <div class="orderedlist"><ol type="1">
2224: <li>
2225: <p>If you invoke the <a 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
2226: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2227: information will be displayed. For example,</p>
2228: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
2229: <p>will show all the commands that are invoked, up to and
2230: including the “<span class="quote">patch</span>” stage.</p>
2231: </li>
2232: <li>
2233: <p>If you want to know the value of a certain <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
2234: definition, then the <code class="varname">VARNAME</code> definition
2235: should be used, in conjunction with the show-var
2236: target. e.g. to show the expansion of the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
2237: variable <code class="varname">LOCALBASE</code>:</p>
2238: <pre class="screen">
2239: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
2240: /usr/pkg
2241: <code class="prompt">%</code>
2242: </pre>
2243: </li>
2244: </ol></div>
2245: <p>If you want to install a binary package that you've either
2246: created yourself (see next section), that you put into
2247: pkgsrc/packages manually or that is located on a remote FTP
2248: server, you can use the "bin-install" target. This target will
2249: install a binary package - if available - via <a 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>,
2250: else do a <span><strong class="command">make package</strong></span>. The list of remote FTP
2251: sites searched is kept in the variable
2252: <code class="varname">BINPKG_SITES</code>, which defaults to
2253: ftp.NetBSD.org. Any flags that should be added to <a 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>
2254: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2255: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2256: details.</p>
2257: <p>A final word of warning: If you set up a system that has a
2258: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2259: set that before any packages are installed, as you cannot use
2260: several directories for the same purpose. Doing so will result in
2261: pkgsrc not being able to properly detect your installed packages,
2262: and fail miserably. Note also that precompiled binary packages are
2263: usually built with the default <code class="varname">LOCALBASE</code> of
2264: <code class="filename">/usr/pkg</code>, and that you should
2265: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2266: <code class="varname">LOCALBASE</code>.</p>
2267: </div>
2268: </div>
2269: </div>
2270: <div class="chapter" lang="en">
2271: <div class="titlepage"><div><div><h2 class="title">
2272: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2273: <div class="toc">
2274: <p><b>Table of Contents</b></p>
2275: <dl>
2276: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2277: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.4 rillig 2278: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installion process</a></span></dt>
2279: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 2280: <dd><dl>
1.4 rillig 2281: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
2282: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2283: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 2284: </dl></dd>
1.4 rillig 2285: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2286: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 2287: </dl>
2288: </div>
1.4 rillig 2289: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 2290: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2291: that file depends on the installation. On NetBSD, when you use
2292: <a 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
2293: <code class="filename">/etc/</code>. In all other cases the default location is
2294: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2295: bootstrap program to install the binary packages.</p>
2296: <p>During the bootstrap, an example configuration file is created. To
2297: use that, you have to create the directory
2298: <code class="filename">${PREFIX}/etc</code> and copy the example file
2299: there.</p>
2300: <p>The format of the configuration file is that of the usual
2301: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2302: is done by setting variables in this file. Note that you can define all
2303: kinds of variables, and no special error checking (for example for
2304: spelling mistakes) takes place, so you have to try it out to see if it
2305: works.</p>
2306: <div class="sect1" lang="en">
2307: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2308: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2309: <p>In this section, you can find some variables that apply to all
2310: pkgsrc packages. A complete list of the variables that can be
2311: configured by the user is available in
2312: <code class="filename">mk/defaults/mk.conf</code>, together with some
2313: comments that describe each variable's intent.</p>
2314: <div class="itemizedlist"><ul type="disc">
2315: <li><p><code class="varname">LOCALBASE</code>: Where
2316: packages will be installed. The default is
2317: <code class="filename">/usr/pkg</code>. Do not mix binary packages
2318: with different <code class="varname">LOCALBASE</code>s!</p></li>
2319: <li><p><code class="varname">CROSSBASE</code>: Where
2320: “<span class="quote">cross</span>” category packages will be
2321: installed. The default is
2322: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
2323: <li><p><code class="varname">X11BASE</code>: Where
2324: X11 is installed on the system. The default is
2325: <code class="filename">/usr/X11R6</code>.</p></li>
2326: <li><p><code class="varname">DISTDIR</code>: Where to store the
2327: downloaded copies of the original source distributions used
2328: for building pkgsrc packages. The default is
2329: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
2330: <li><p><code class="varname">PKG_DBDIR</code>: Where the
2331: database about installed packages is stored. The default is
2332: <code class="filename">/var/db/pkg</code>.</p></li>
2333: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
2334: If set, override the packages'
2335: <code class="varname">MASTER_SITES</code> with this value.</p></li>
2336: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
2337: Backup location(s) for distribution files and patch files
2338: if not found locally or in
2339: <code class="filename">${MASTER_SITES}</code> or
2340: <code class="filename">${PATCH_SITES}</code> respectively.
2341: The defaults are
2342: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
2343: and
2344: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
2345: <li><p><code class="varname">BINPKG_SITES</code>:
2346: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2347: <em class="replaceable"><code>arch</code></em> are replaced with OS
2348: release (“<span class="quote">2.0</span>”, etc.) and architecture
2349: (“<span class="quote">mipsel</span>”, etc.).</p></li>
2350: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
2351: List of acceptable licenses. Whenever you try to build a package
2352: whose license is not in this list, you will get an error message
2353: that includes instructions on how to change this variable.</p></li>
2354: </ul></div>
2355: </div>
2356: <div class="sect1" lang="en">
2357: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2358: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2359: <p>XXX
2360: </p>
2361: <div class="itemizedlist"><ul type="disc">
2362: <li><p><code class="varname">PACKAGES</code>: The top level
2363: directory for the binary packages. The default is
2364: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
2365: <li><p><code class="varname">WRKOBJDIR</code>:
2366: The top level directory where, if defined, the separate
2367: working directories will get created, and symbolically
2368: linked to from <code class="filename">${WRKDIR}</code> (see below).
2369: This is useful for building packages on several
2370: architectures, then <code class="filename">${PKGSRCDIR}</code>
2371: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
2372: is local to every architecture. (It should be noted that
2373: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.6 ! rillig 2374: — it is an internal definition which refers to the
1.1 dsieger 2375: root of the pkgsrc tree. It is possible to have many
2376: pkgsrc tree instances.)</p></li>
2377: <li><p><code class="varname">LOCALPATCHES</code>:
2378: Directory for local patches that aren't part of pkgsrc.
1.6 ! rillig 2379: See <a href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.1 dsieger 2380: information.</p></li>
2381: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.4 rillig 2382: the <a href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 2383: BSD-style Makefile. If this is not set,
2384: <code class="varname">MAKECONF</code> is set to
2385: <code class="filename">/dev/null</code> to avoid picking up
2386: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
2387: <li><p><code class="varname">DEPENDS_TARGET</code>:
2388: By default, dependencies are only installed, and no binary
2389: package is created for them. You can set this variable to
2390: <code class="literal">package</code> to automatically create binary
2391: packages after installing dependencies.</p></li>
2392: </ul></div>
2393: </div>
2394: <div class="sect1" lang="en">
2395: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2396: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installion process</h2></div></div></div>
2397: <p>A growing number of packages support installation into a
2398: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2399: to be built, before the actual filesystem is touched. DESTDIR
2400: support exists in two variations:</p>
2401: <div class="itemizedlist"><ul type="disc">
2402: <li><p>Basic DESTDIR support means that the package
2403: installation and packaging is still run as
2404: root.</p></li>
2405: <li><p>Full DESTDIR support can run the complete build,
2406: installation and packaging as normal user. Root privileges are
2407: only needed to add packages.</p></li>
2408: </ul></div>
2409: <p>To use the DESTDIR support, set either
2410: <code class="varname">USE_DESTDIR=yes</code> to use the basic support for
2411: packages that offer it or <code class="varname">USE_DESTDIR=full</code> to
2412: get the full support with fallback to basic
2413: support. <code class="varname">USE_DESTDIR=full</code> needs <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> version 20070802 (or
2414: newer). It might become the default DESTDIR support later.</p>
2415: <p>DESTDIR support changes the behaviour of various targets
2416: slightly. To install a package after building it, use
2417: <code class="literal">package-install</code>. <code class="literal">package</code> and
2418: <code class="literal">install</code> don't do that any
2419: longer. <code class="literal">package-install</code> can be used as
2420: <code class="varname">DEPENDS_TARGET</code>. <code class="literal">bin-install</code>
2421: will ask for the root password to install the package and fail,
2422: <code class="literal">package-install</code> will ask again.</p>
2423: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2424: clean</code></strong> needs to be run as root.</p>
2425: </div>
2426: <div class="sect1" lang="en">
2427: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2428: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.1 dsieger 2429: <div class="sect2" lang="en">
2430: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2431: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 2432: <p>By default, pkgsrc will use GCC to build packages. This may be
2433: overridden by setting the following variables in /etc/mk.conf:</p>
2434: <div class="variablelist"><dl>
2435: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2436: <dd>
2437: <p>This is a list of values specifying the chain of
2438: compilers to invoke when building packages. Valid values
2439: are:</p>
2440: <div class="itemizedlist"><ul type="disc">
2441: <li><p><code class="varname">distcc</code>:
2442: distributed C/C++ (chainable)</p></li>
2443: <li><p><code class="varname">ccache</code>:
2444: compiler cache (chainable)</p></li>
2445: <li><p><code class="varname">gcc</code>:
2446: GNU C/C++ Compiler</p></li>
2447: <li><p><code class="varname">mipspro</code>:
2448: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
2449: <li><p><code class="varname">mipspro</code>:
2450: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
2451: <li><p><code class="varname">sunpro</code>:
2452: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2453: </ul></div>
2454: <p>The default is
2455: “<span class="quote"><code class="varname">gcc</code></span>”. You can use
2456: <code class="varname">ccache</code> and/or
2457: <code class="varname">distcc</code> with an appropriate
2458: <code class="varname">PKGSRC_COMPILER</code> setting,
2459: e.g. “<span class="quote"><code class="varname">ccache gcc</code></span>”. This
2460: variable should always be terminated with a value for
2461: a real compiler. Note that only one real compiler
2462: should be listed (e.g. “<span class="quote"><code class="varname">sunpro gcc</code></span>”
2463: is not allowed).</p>
2464: </dd>
2465: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2466: <dd><p>This specifies the minimum version of GCC to use
2467: when building packages. If the system GCC doesn't
2468: satisfy this requirement, then pkgsrc will build and
2469: install one of the GCC packages to use instead.</p></dd>
2470: </dl></div>
2471: </div>
2472: <div class="sect2" lang="en">
2473: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2474: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.1 dsieger 2475: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2476: please make sure to use the <code class="literal">+=</code> operator
2477: instead of the <code class="literal">=</code> operator:</p>
2478: <pre class="programlisting">
2479: CFLAGS+= -your -flags
2480: </pre>
2481: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
2482: “<span class="quote">+</span>”) may lead to problems with packages that need
2483: to add their own flags. Also, you may want to take a look at
2484: the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a> package if
2485: you're interested in optimization for the current CPU.</p>
2486: </div>
2487: <div class="sect2" lang="en">
2488: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2489: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.1 dsieger 2490: <p>If you want to pass flags to the linker, both in the configure
2491: step and the build step, you can do this in two ways. Either set
2492: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2493: between the two is that <code class="varname">LIBS</code> will be appended to
2494: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2495: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2496: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2497: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2498: <code class="varname">CFLAGS</code>, if you do not wish to override these
2499: settings, use the <code class="literal">+=</code> operator:</p>
2500: <pre class="programlisting">
2501: LDFLAGS+= -your -linkerflags
2502: </pre>
2503: </div>
2504: </div>
2505: <div class="sect1" lang="en">
2506: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2507: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.1 dsieger 2508: <p>XXX
2509: </p>
2510: <div class="itemizedlist"><ul type="disc">
2511: <li>
2512: <p><code class="varname">PKG_DEVELOPER</code>:
2513: Run some sanity checks that package developers want:
2514: </p>
2515: <div class="itemizedlist"><ul type="circle">
2516: <li><p>make sure patches apply with zero
2517: fuzz</p></li>
2518: <li><p>run check-shlibs to see that all
2519: binaries will find their shared libs.</p></li>
2520: </ul></div>
2521: <p>
2522: </p>
2523: </li>
2524: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
2525: of debugging output which is displayed whilst making and
2526: installing the package. The default value for this is 0,
2527: which will not display the commands as they are executed
2528: (normal, default, quiet operation); the value 1 will display
2529: all shell commands before their invocation, and the value 2
2530: will display both the shell commands before their invocation,
2531: and their actual execution progress with <span><strong class="command">set
2532: -x</strong></span> will be displayed.</p></li>
2533: </ul></div>
2534: <p>
2535: </p>
2536: </div>
2537: <div class="sect1" lang="en">
2538: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2539: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 2540: <p>Some packages have build time options, usually to select
2541: between different dependencies, enable optional support for big
2542: dependencies or enable experimental features.</p>
2543: <p>To see which options, if any, a package supports, and which
2544: options are mutually exclusive, run <span><strong class="command">make
2545: show-options</strong></span>, for example:</p>
2546: <pre class="programlisting">
2547: The following options are supported by this package:
2548: ssl Enable SSL support.
2549: Exactly one of the following gecko options is required:
2550: firefox Use firefox as gecko rendering engine.
2551: mozilla Use mozilla as gecko rendering engine.
2552: At most one of the following database options may be selected:
2553: mysql Enable support for MySQL database.
2554: pgsql Enable support for PostgreSQL database.
2555:
2556: These options are enabled by default: firefox
2557: These options are currently enabled: mozilla ssl
2558: </pre>
2559: <p>The following variables can be defined in
1.4 rillig 2560: <a href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 2561: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2562: which can be used to select or disable options for all packages
2563: that support them, and
2564: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2565: which can be used to select or disable options specifically for
2566: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
2567: these variables are selected, options preceded by “<span class="quote">-</span>”
2568: are disabled. A few examples:</p>
2569: <pre class="screen">
1.4 rillig 2570: <code class="prompt">$</code> <span><strong class="command">grep "PKG.*OPTION" <a href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.1 dsieger 2571: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2572: PKG_OPTIONS.kdebase= debug -sasl
2573: PKG_OPTIONS.apache= suexec </pre>
2574: <p>The following settings are consulted in the order given, and
2575: the last setting that selects or disables an option is
2576: used:</p>
2577: <div class="orderedlist"><ol type="1">
2578: <li><p>the default options as suggested by the package
2579: maintainer</p></li>
2580: <li><p>the options implied by the settings of legacy
2581: variables (see below)</p></li>
2582: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2583: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
2584: </ol></div>
2585: <p>For groups of mutually exclusive options, the last option
2586: selected is used, all others are automatically disabled. If an
2587: option of the group is explicitly disabled, the previously
2588: selected option, if any, is used. It is an error if no option
2589: from a required group of options is selected, and building the
2590: package will fail.</p>
2591: <p>Before the options framework was introduced, build options
2592: were selected by setting a variable (often named
2593: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.4 rillig 2594: <a href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2595: transition to the options framework for the user, these legacy
2596: variables are converted to the appropriate options setting
2597: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2598: automatically. A warning is issued to prompt the user to update
1.4 rillig 2599: <a href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2600: directly. Support for the legacy variables will be removed
2601: eventually.</p>
2602: </div>
2603: </div>
2604: <div class="chapter" lang="en">
2605: <div class="titlepage"><div><div><h2 class="title">
2606: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2607: <div class="toc">
2608: <p><b>Table of Contents</b></p>
2609: <dl>
2610: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2611: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2612: </dl>
2613: </div>
2614: <div class="sect1" lang="en">
2615: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2616: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
2617: <p>Once you have built and installed a package, you can create
2618: a <span class="emphasis"><em>binary package</em></span> which can be installed on
2619: another system with <a 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
2620: the same package on a group of hosts and wasting CPU time. It also
2621: provides a simple means for others to install your package, should
2622: you distribute it.</p>
2623: <p>To create a binary package, change into the appropriate
2624: directory in pkgsrc, and run <span><strong class="command">make
2625: package</strong></span>:</p>
2626: <pre class="screen">
2627: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2628: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2629: </pre>
2630: <p>This will build and install your package (if not already done),
2631: and then build a binary package from what was installed. You can
2632: then use the <span><strong class="command">pkg_*</strong></span> tools to manipulate
2633: it. Binary packages are created by default in
2634: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
2635: gzipped tar file. See <a href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
2636: 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.6 ! rillig 2637: <p>See <a href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a> for information on how to submit
1.1 dsieger 2638: such a binary package.</p>
2639: </div>
2640: <div class="sect1" lang="en">
2641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2642: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.6 ! rillig 2643: <p>See <a href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a>.</p>
! 2644: </div>
! 2645: </div>
! 2646: <div class="chapter" lang="en">
! 2647: <div class="titlepage"><div><div><h2 class="title">
! 2648: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
! 2649: builds)</h2></div></div></div>
! 2650: <div class="toc">
! 2651: <p><b>Table of Contents</b></p>
! 2652: <dl>
! 2653: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
! 2654: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
! 2655: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
! 2656: <dd><dl>
! 2657: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
! 2658: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
! 2659: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
! 2660: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
! 2661: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
! 2662: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
! 2663: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
! 2664: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
! 2665: </dl></dd>
! 2666: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
! 2667: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.1. Configuration</a></span></dt></dl></dd>
! 2668: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
! 2669: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
! 2670: </dl>
! 2671: </div>
! 2672: <p>When you have multiple machines that should run the same packages,
! 2673: it is wasted time if they all build their packages themselves from
! 2674: source. There are two ways of getting a set of binary packages: The old
! 2675: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
! 2676: system. This chapter describes how to set them up so that the packages
! 2677: are most likely to be usable later.</p>
! 2678: <div class="sect1" lang="en">
! 2679: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
! 2680: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
! 2681: <p>Since a bulk build takes several days or even weeks to finish, you
! 2682: should think about the setup before you start everything. Pay attention
! 2683: to at least the following points:</p>
! 2684: <div class="itemizedlist"><ul type="disc">
! 2685: <li>
! 2686: <p>If you want to upload the binary packages to
! 2687: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
! 2688: packages:</p>
! 2689: <div class="itemizedlist"><ul type="circle">
! 2690: <li><p>To end up on ftp.NetBSD.org, the packages must be built
! 2691: by a NetBSD developer on a trusted machine (that is, where you and only
! 2692: you have root access).</p></li>
! 2693: <li><p>Packages on ftp.NetBSD.org should only be created from
! 2694: the stable branches (like 2007Q1), so that users browsing the available
! 2695: collections can see at a glance how old the packages
! 2696: are.</p></li>
! 2697: <li><p>The packages must be built as root, since some packages
! 2698: require set-uid binaries at runtime, and creating those packages as
! 2699: unprivileged user doesn't work well at the moment.</p></li>
! 2700: </ul></div>
! 2701: </li>
! 2702: <li><p>Make sure that the bulk build cannot break anything in
! 2703: your system. Most bulk builds run as root, so they should be run at least
! 2704: in a chroot environment or something even more restrictive, depending on
! 2705: what the operating system provides. There have been numerous cases where
! 2706: certain packages tried to install files outside the
! 2707: <code class="filename">LOCALBASE</code> or wanted to edit some files in
! 2708: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
! 2709: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
! 2710: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
! 2711: that you don't need any package during the build.</p></li>
! 2712: </ul></div>
! 2713: </div>
! 2714: <div class="sect1" lang="en">
! 2715: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
! 2716: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
! 2717: <p>A complete bulk build requires lots of disk space. Some of the
! 2718: disk space can be read-only, some other must be writable. Some can be on
! 2719: remote filesystems (such as NFS) and some should be local. Some can be
! 2720: temporary filesystems, others must survive a sudden reboot.</p>
! 2721: <div class="itemizedlist"><ul type="disc">
! 2722: <li><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
! 2723: <li><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
! 2724: <li><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
! 2725: <li><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
! 2726: <li><p>5 GB for the log files (read-write, remote, permanent)</p></li>
! 2727: <li><p>5 GB for temporary files (read-write, local, temporary)</p></li>
! 2728: </ul></div>
1.1 dsieger 2729: </div>
2730: <div class="sect1" lang="en">
2731: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 2732: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
! 2733: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
! 2734: <h3 class="title">Warning</h3>
! 2735: <p>The rest of this section is rather old. Don't rely on it
! 2736: too much.</p>
! 2737: </div>
1.1 dsieger 2738: <div class="sect2" lang="en">
2739: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 2740: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.1 dsieger 2741: <div class="sect3" lang="en">
2742: <div class="titlepage"><div><div><h4 class="title">
1.6 ! rillig 2743: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.1 dsieger 2744: </h4></div></div></div>
2745: <p>The <code class="filename">build.conf</code> file is the main
2746: configuration file for bulk builds. You can configure how your
2747: copy of pkgsrc is kept up to date, how the distfiles are
2748: downloaded, how the packages are built and how the report is
2749: generated. You can find an annotated example file in
2750: <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2751: it, copy <code class="filename">build.conf-example</code> to
2752: <code class="filename">build.conf</code> and edit it, following the
2753: comments in that file.</p>
2754: </div>
2755: <div class="sect3" lang="en">
2756: <div class="titlepage"><div><div><h4 class="title">
1.6 ! rillig 2757: <a name="binary.mk.conf"></a>7.3.1.2. <a href="#mk.conf"><code class="filename">mk.conf</code></a>
1.4 rillig 2758: </h4></div></div></div>
2759: <p>You may want to set variables in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.1 dsieger 2760: Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2761: details of the default settings. You will want to ensure that
2762: <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
2763: As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
1.4 rillig 2764: completely bypasses the license check.</p>
1.1 dsieger 2765: <pre class="programlisting">
2766: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2767: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2768: BSDSRCDIR= /usr/src
2769: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2770: OBJHOSTNAME?= yes # use work.`hostname`
2771: FAILOVER_FETCH= yes # insist on the correct checksum
2772: PKG_DEVELOPER?= yes
2773: _ACCEPTABLE= yes
2774: </pre>
2775: <p>Some options that are especially useful for bulk builds
2776: can be found at the top lines of the file
2777: <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
2778: options of these are briefly described here.</p>
2779: <div class="itemizedlist"><ul type="disc">
2780: <li><p>If you are on a slow machine, you may want to
2781: set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
2782: “<span class="quote">no</span>”.</p></li>
2783: <li><p>If you are doing bulk builds from a read-only
2784: copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2785: to the directory where all log files are created. Otherwise the
2786: log files are created in the pkgsrc directory.</p></li>
2787: <li><p>Another important variable is
2788: <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2789: should be always available while building other
2790: packages.</p></li>
2791: </ul></div>
2792: <p>Some other options are scattered in the pkgsrc
2793: infrastructure:</p>
2794: <div class="itemizedlist"><ul type="disc">
2795: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
2796: should be set to <code class="literal">yes</code>. The purpose of the bulk
2797: builds is creating binary packages, no matter if they are
2798: vulnerable or not. When uploading the packages to a public
2799: server, the vulnerable packages will be put into a directory of
2800: their own. Leaving this variable unset would prevent the bulk
2801: build system from even trying to build them, so possible
2802: building errors would not show up.</p></li>
2803: <li><p><code class="varname">CHECK_FILES</code>
2804: (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
2805: “<span class="quote">yes</span>” to check that the installed set of files
2806: matches the <code class="filename">PLIST</code>.</p></li>
2807: <li><p><code class="varname">CHECK_INTERPRETER</code>
2808: (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
2809: “<span class="quote">yes</span>” to check that the installed
2810: “<span class="quote">#!</span>”-scripts will find their
2811: interpreter.</p></li>
2812: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
2813: set to “<span class="quote"><code class="literal">yes</code></span>” to run each
2814: package's self-test before installing it. Note that some
2815: packages make heavy use of “<span class="quote">good</span>” random
2816: numbers, so you need to assure that the machine on which you
2817: are doing the bulk builds is not completely idle. Otherwise
2818: some test programs will seem to hang, while they are just
2819: waiting for new random data to be
2820: available.</p></li>
2821: </ul></div>
2822: </div>
2823: <div class="sect3" lang="en">
2824: <div class="titlepage"><div><div><h4 class="title">
1.6 ! rillig 2825: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.1 dsieger 2826: </h4></div></div></div>
2827: <p>It is possible to configure the bulk build to perform
2828: certain site-specific tasks at the end of the pre-build
2829: stage. If the file
2830: <code class="filename">pre-build.local</code> exists in
2831: <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
2832: (as a <a 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
2833: stage. An example use of
2834: <code class="filename">pre-build.local</code> is to have the line:</p>
2835: <pre class="screen">echo "I do not have enough disk space to build this pig." \
2836: > misc/openoffice/$BROKENF</pre>
2837: <p>to prevent the system from trying to build a particular package
2838: which requires nearly 3 GB of disk space.</p>
2839: </div>
2840: </div>
2841: <div class="sect2" lang="en">
2842: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 2843: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.1 dsieger 2844: <p>As <code class="filename">/usr/pkg</code> will be completely
2845: deleted at the start of bulk builds, make sure your login
2846: shell is placed somewhere else. Either drop it into
2847: <code class="filename">/usr/local/bin</code> (and adjust your login
2848: shell in the passwd file), or (re-)install it via
2849: <a 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
2850: you can login after a reboot (remember that your current
2851: process won't die if the package is removed, you just can't
2852: start any new instances of the shell any more). Also, if you
2853: use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2854: version of ssh for some reason, be sure to install ssh before
2855: starting it from <code class="filename">rc.local</code>:</p>
2856: <pre class="programlisting">
2857: (cd /usr/pkgsrc/security/ssh && make bulk-install)
2858: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2859: /usr/pkg/etc/rc.d/sshd
2860: fi
2861: </pre>
2862: <p>Not doing so will result in you being not able to log in
2863: via ssh after the bulk build is finished or if the machine
2864: gets rebooted or crashes. You have been warned! :)</p>
2865: </div>
2866: <div class="sect2" lang="en">
2867: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 2868: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.1 dsieger 2869: <p>Make sure you don't need any of the packages still
2870: installed.</p>
2871: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2872: <h3 class="title">Warning</h3>
2873: <p>During the bulk build, <span class="emphasis"><em>all packages, their
2874: configuration files and some more files from
2875: <code class="filename">/var</code>, <code class="filename">/home</code> and
2876: possibly other locations will be removed! So don't run a bulk
2877: build with privileges that might harm your
2878: system.</em></span></p>
2879: </div>
2880: <p>Be sure to remove all other things that might
2881: interfere with builds, like some libs installed in
2882: <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2883: <pre class="screen">
2884: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2885: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2886: </pre>
2887: <p>If for some reason your last build didn't complete (power
2888: failure, system panic, ...), you can continue it by
2889: running:</p>
2890: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
2891: <p>At the end of the bulk build, you will get a summary via mail,
2892: and find build logs in the directory specified by
2893: <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2894: file.</p>
2895: </div>
2896: <div class="sect2" lang="en">
2897: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 2898: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.1 dsieger 2899: <p>The bulk builds consist of three steps:</p>
2900: <div class="variablelist"><dl>
2901: <dt><span class="term">1. pre-build</span></dt>
2902: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2903: cleans out any broken distfiles, and removes all
2904: packages installed.</p></dd>
2905: <dt><span class="term">2. the bulk build</span></dt>
2906: <dd><p>This is basically “<span class="quote">make bulk-package</span>” with
2907: an optimised order in which packages will be
2908: built. Packages that don't require other packages will
2909: be built first, and packages with many dependencies will
2910: be built later.</p></dd>
2911: <dt><span class="term">3. post-build</span></dt>
2912: <dd><p>Generates a report that's placed in the directory
2913: specified in the <code class="filename">build.conf</code> file
2914: named <code class="filename">broken.html</code>, a short version
2915: of that report will also be mailed to the build's
2916: admin.</p></dd>
2917: </dl></div>
2918: <p>During the build, a list of broken packages will be compiled
2919: in <code class="filename">/usr/pkgsrc/.broken</code> (or
2920: <code class="filename">.../.broken.${MACHINE}</code> if
2921: <code class="varname">OBJMACHINE</code> is set), individual build logs
2922: of broken builds can be found in the package's
2923: directory. These files are used by the bulk-targets to mark
2924: broken builds to not waste time trying to rebuild them, and
2925: they can be used to debug these broken package builds
2926: later.</p>
2927: </div>
2928: <div class="sect2" lang="en">
2929: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 2930: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.1 dsieger 2931: <p>Currently, roughly the following requirements are valid for
2932: NetBSD 2.0/i386:</p>
2933: <div class="itemizedlist"><ul type="disc">
2934: <li><p>10 GB - distfiles (NFS ok)</p></li>
2935: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
2936: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
2937: </ul></div>
2938: <p>Note that all pkgs will be de-installed as soon as they are
2939: turned into a binary package, and that sources are removed,
2940: so there is no excessively huge demand to disk
2941: space. Afterwards, if the package is needed again, it will
2942: be installed via <a 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
2943: there are no cycles wasted by recompiling.</p>
2944: </div>
2945: <div class="sect2" lang="en">
2946: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 2947: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.1 dsieger 2948: <p>If you don't want all the packages nuked from a machine
2949: (rendering it useless for anything but pkg compiling), there
2950: is the possibility of doing the package bulk build inside a
2951: chroot environment.</p>
2952: <p>The first step is to set up a chroot sandbox,
2953: e.g. <code class="filename">/usr/sandbox</code>. This can be done by
2954: using null mounts, or manually.</p>
2955: <p>There is a shell script called
2956: <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
2957: up the sandbox environment using null mounts. It will also
2958: create a script called <code class="filename">sandbox</code> in the
2959: root of the sandbox environment, which will allow the null
2960: mounts to be activated using the <span><strong class="command">sandbox
2961: mount</strong></span> command and deactivated using the
2962: <span><strong class="command">sandbox umount</strong></span> command.</p>
2963: <p>To set up a sandbox environment by hand, after extracting all
2964: the sets from a NetBSD installation or doing a <span><strong class="command">make
2965: distribution DESTDIR=/usr/sandbox</strong></span> in
2966: <code class="filename">/usr/src/etc</code>, be sure the following items
2967: are present and properly configured:</p>
2968: <div class="procedure"><ol type="1">
2969: <li>
2970: <p>Kernel</p>
2971: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2972: </li>
2973: <li>
2974: <p><code class="filename">/dev/*</code></p>
2975: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2976: </li>
2977: <li>
2978: <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>
2979: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2980: </li>
2981: <li>
2982: <p>Working(!) mail config (hostname, sendmail.cf):</p>
2983: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2984: </li>
2985: <li>
2986: <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>
2987: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2988: </li>
2989: <li>
2990: <p><code class="filename">/usr/src</code> (system sources,
1.6 ! rillig 2991: 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.1 dsieger 2992: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
2993: <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
2994: </li>
2995: <li>
2996: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
2997: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2998: </li>
2999: <li>
3000: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
3001: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
3002: </li>
3003: <li>
3004: <p>Checkout pkgsrc via cvs into
3005: <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
3006: <pre class="screen">
3007: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
3008: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
3009: </pre>
3010: <p>Do not mount/link this to the copy of your pkgsrc tree
3011: you do development in, as this will likely cause problems!</p>
3012: </li>
3013: <li><p>Make
3014: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
3015: <code class="filename">.../distfiles</code> point somewhere
3016: appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.6 ! rillig 3017: <li><p>Edit <a href="#mk.conf"><code class="filename">mk.conf</code></a>, see <a href="#binary.mk.conf" title="7.3.1.2. mk.conf">Section 7.3.1.2, “<code class="filename">mk.conf</code>”</a>.</p></li>
1.1 dsieger 3018: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
3019: </ol></div>
3020: <p>When the chroot sandbox is set up, you can start
3021: the build with the following steps:</p>
3022: <pre class="screen">
3023: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
3024: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
3025: </pre>
3026: <p>This will just jump inside the sandbox and start building. At
3027: the end of the build, mail will be sent with the results of
3028: the build. Created binary pkgs will be in
3029: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
3030: (wherever that points/mounts to/from).</p>
3031: </div>
3032: <div class="sect2" lang="en">
3033: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 3034: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.1 dsieger 3035: <p>In addition to building a complete set of all packages in
3036: pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
3037: may be used to build a subset of the packages contained in
3038: pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
1.4 rillig 3039: in <a href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.1 dsieger 3040: <div class="itemizedlist"><ul type="disc">
3041: <li><p>SITE_SPECIFIC_PKGS</p></li>
3042: <li><p>HOST_SPECIFIC_PKGS</p></li>
3043: <li><p>GROUP_SPECIFIC_PKGS</p></li>
3044: <li><p>USER_SPECIFIC_PKGS</p></li>
3045: </ul></div>
3046: <p>will define the set of packages which should be built.
3047: The bulk build code will also include any packages which are
3048: needed as dependencies for the explicitly listed packages.</p>
3049: <p>One use of this is to do a bulk build with
3050: <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
3051: periodically to have a complete set of the binary packages
3052: needed for your site available without the overhead of
3053: building extra packages that are not needed.</p>
3054: </div>
3055: <div class="sect2" lang="en">
3056: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 3057: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.1 dsieger 3058: <p>This section describes how pkgsrc developers can upload binary
3059: pkgs built by bulk builds to ftp.NetBSD.org.</p>
3060: <p>If you would like to automatically create checksum files for the
3061: binary packages you intend to upload, remember to set
3062: <code class="varname">MKSUMS=yes</code> in your
3063: <code class="filename">mk/bulk/build.conf</code>.</p>
3064: <p>If you would like to PGP sign the checksum files (highly
3065: recommended!), remember to set
3066: <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
3067: <code class="filename">mk/bulk/build.conf</code>. This will prompt you for
3068: your GPG password to sign the files before uploading everything.</p>
3069: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
3070: set properly in your <code class="filename">mk/bulk/build.conf</code>
3071: file, i.e. adjust it to something like one of the following:</p>
3072: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
3073: <p>Please use appropriate values for "packages-200xQy",
3074: "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
3075: is different from your local login, write your login directly
3076: into the variable, e.g. my local account is "feyrer", but for my
3077: login "hubertf", I use:</p>
3078: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
3079: <p>A separate <code class="filename">upload</code> directory is used
3080: here to allow "closing" the directory during upload. To do
3081: so, run the following command on ftp.NetBSD.org next:</p>
3082: <pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</code></strong></pre>
3083: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
3084: only appropriate for packages for the NetBSD operating
3085: system. Binary packages for other operating systems should go
3086: into <code class="filename">/pub/pkgsrc</code>.</p>
3087: <p>Before uploading the binary pkgs, ssh authentication needs
3088: to be set up. This example shows how to set up temporary keys
3089: for the root account <span class="emphasis"><em>inside the sandbox</em></span>
3090: (assuming that no keys should be present there usually):</p>
3091: <pre class="screen">
3092: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
3093: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
3094: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
3095: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
3096: </pre>
3097: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
3098: append it to your <code class="filename">~/.ssh/authorized_keys</code>
3099: file on ftp.NetBSD.org. You can remove the key after the
3100: upload is done!</p>
3101: <p>Next, test if your ssh connection really works:</p>
3102: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
3103: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
3104: <p>Now after all this works, you can exit the sandbox and start
3105: the upload:</p>
3106: <pre class="screen">
3107: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
3108: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
3109: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
3110: </pre>
3111: <p>The upload process may take quite some time. Use <a 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
3112: <a 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
3113: upload. The upload script will take care of not uploading
3114: restricted packages and putting vulnerable packages into the
3115: <code class="filename">vulnerable</code> subdirectory.</p>
3116: <p>After the upload has ended, first thing is to revoke ssh access:</p>
3117: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
3118: Gdd:x! </pre>
3119: <p>Use whatever is needed to remove the key you've entered
3120: before! Last, move the uploaded packages out of the
3121: <code class="filename">upload</code> directory to have them accessible
3122: to everyone:</p>
3123: <pre class="screen">
3124: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
3125: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
3126: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
3127: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
3128: </pre>
3129: </div>
3130: </div>
3131: <div class="sect1" lang="en">
3132: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 3133: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
! 3134: <div class="sect2" lang="en">
! 3135: <div class="titlepage"><div><div><h3 class="title">
! 3136: <a name="bulk.pbulk.conf"></a>7.4.1. Configuration</h3></div></div></div>
! 3137: <p>TODO; see <a href="http://wiki.netbsd.se/index.php/pbulk-HOWTO" target="_top">the wiki</a> for
! 3138: more information.</p>
! 3139: </div>
! 3140: </div>
! 3141: <div class="sect1" lang="en">
! 3142: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
! 3143: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 3144: <p>After your pkgsrc bulk-build has completed, you may wish to
3145: create a CD-ROM set of the resulting binary packages to assist
3146: in installing packages on other machines. The
3147: <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
3148: a simple tool for creating the ISO 9660 images.
3149: <span><strong class="command">cdpack</strong></span> arranges the packages on the CD-ROMs in a
3150: way that keeps all the dependencies for a given package on the same
3151: CD as that package.</p>
3152: <div class="sect2" lang="en">
3153: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 3154: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 3155: <p>Complete documentation for cdpack is found in the cdpack(1)
3156: man page. The following short example assumes that the binary
3157: packages are left in
3158: <code class="filename">/usr/pkgsrc/packages/All</code> and that
3159: sufficient disk space exists in <code class="filename">/u2</code> to
3160: hold the ISO 9660 images.</p>
3161: <pre class="screen">
3162: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
3163: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
3164: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
3165: </pre>
3166: <p>If you wish to include a common set of files
3167: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
3168: etc.) on each CD in the collection, then you need to create a
3169: directory which contains these files. e.g.</p>
3170: <pre class="screen">
3171: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
3172: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
3173: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
3174: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
3175: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
3176: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
3177: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
3178: </pre>
3179: <p>Now create the images:</p>
3180: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
3181: <p>Each image will contain <code class="filename">README</code>,
3182: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
3183: in their root directories.</p>
3184: </div>
3185: </div>
3186: </div>
3187: <div class="chapter" lang="en">
3188: <div class="titlepage"><div><div><h2 class="title">
1.6 ! rillig 3189: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 3190: <div class="toc">
3191: <p><b>Table of Contents</b></p>
3192: <dl>
1.6 ! rillig 3193: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
! 3194: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.1 dsieger 3195: </dl>
3196: </div>
3197: <p>The files that are installed by pkgsrc are organized in a way that
3198: is similar to what you find in the <code class="filename">/usr</code> directory
3199: of the base system. But some details are different. This is because
3200: pkgsrc initially came from FreeBSD and had adopted its file system
3201: hierarchy. Later it was largely influenced by NetBSD. But no matter
3202: which operating system you are using pkgsrc with, you can expect the
3203: same layout for pkgsrc.</p>
3204: <p>There are mainly four root directories for pkgsrc, which are all
3205: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
3206: When pkgsrc has been installed as root, the default locations
3207: are:</p>
3208: <pre class="programlisting">
3209: LOCALBASE= /usr/pkg
3210: PKG_SYSCONFBASE= /usr/pkg/etc
3211: VARBASE= /var
3212: PKG_DBDIR= /var/db/pkg
3213: </pre>
3214: <p>In unprivileged mode (when pkgsrc has been installed as any other
3215: user), the default locations are:</p>
3216: <pre class="programlisting">
3217: LOCALBASE= ${HOME}/pkg
3218: PKG_SYSCONFBASE= ${HOME}/pkg/etc
3219: VARBASE= ${HOME}/pkg/var
3220: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
3221: </pre>
3222: <p>What these four directories are for, and what they look like is
3223: explained below.</p>
3224: <div class="itemizedlist"><ul type="disc">
3225: <li><p><code class="varname">LOCALBASE</code> corresponds to the
3226: <code class="filename">/usr</code> directory in the base system. It is the
3227: “<span class="quote">main</span>” directory where the files are installed and contains
3228: the well-known subdirectories like <code class="filename">bin</code>,
3229: <code class="filename">include</code>, <code class="filename">lib</code>,
3230: <code class="filename">share</code> and
3231: <code class="filename">sbin</code>.</p></li>
3232: <li><p><code class="varname">VARBASE</code> corresponds to
3233: <code class="filename">/var</code> in the base system. Some programs (especially
3234: games, network daemons) need write access to it during normal
3235: operation.</p></li>
3236: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
3237: <code class="filename">/etc</code> in the base system. It contains configuration
1.4 rillig 3238: files of the packages, as well as pkgsrc's <a href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 3239: itself.</p></li>
3240: </ul></div>
3241: <div class="sect1" lang="en">
3242: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 3243: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 3244: </h2></div></div></div>
3245: <p>The following directories exist in a typical pkgsrc installation
3246: in <code class="filename">${LOCALBASE}</code>.</p>
3247: <div class="variablelist"><dl>
3248: <dt><span class="term"><code class="filename">bin</code></span></dt>
3249: <dd><p>Contains executable programs that are intended to be
3250: directly used by the end user.</p></dd>
3251: <dt><span class="term"><code class="filename">emul</code></span></dt>
3252: <dd><p>Contains files for the emulation layers of various other
3253: operating systems, especially for
3254: NetBSD.</p></dd>
3255: <dt><span class="term"><code class="filename">etc</code> (the usual location of
3256: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3257: <dd><p>Contains
3258: the configuration files.</p></dd>
3259: <dt><span class="term"><code class="filename">include</code></span></dt>
3260: <dd><p>Contains headers for the C and C++ programming
3261: languages.</p></dd>
3262: <dt><span class="term"><code class="filename">info</code></span></dt>
3263: <dd><p>Contains GNU info files of various
3264: packages.</p></dd>
3265: <dt><span class="term"><code class="filename">lib</code></span></dt>
3266: <dd><p>Contains shared and static
3267: libraries.</p></dd>
3268: <dt><span class="term"><code class="filename">libdata</code></span></dt>
3269: <dd><p>Contains data files that don't change after
3270: installation. Other data files belong into
3271: <code class="filename">${VARBASE}</code>.</p></dd>
3272: <dt><span class="term"><code class="filename">libexec</code></span></dt>
3273: <dd><p>Contains programs that are not intended to be used by
3274: end users, such as helper programs or network
3275: daemons.</p></dd>
3276: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3277: <dd><p>Contains programs that are intended to be executed as
3278: CGI scripts by a web server.</p></dd>
3279: <dt><span class="term"><code class="filename">man</code> (the usual value of
3280: <code class="filename">${PKGMANDIR}</code>)</span></dt>
3281: <dd><p>Contains brief
3282: documentation in form of manual pages.</p></dd>
3283: <dt><span class="term"><code class="filename">sbin</code></span></dt>
3284: <dd><p>Contains programs that are intended to be used only by
3285: the super-user.</p></dd>
3286: <dt><span class="term"><code class="filename">share</code></span></dt>
3287: <dd><p>Contains platform-independent data files that don't
3288: change after installation.</p></dd>
3289: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3290: <dd><p>Contains documentation files provided by the
3291: packages.</p></dd>
3292: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3293: <dd><p>Contains example files provided by the packages. Among
3294: others, the original configuration files are saved here and copied to
3295: <code class="filename">${PKG_SYSCONFDIR}</code> during
3296: installation.</p></dd>
3297: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3298: <dd><p>Contains the original files for rc.d
3299: scripts.</p></dd>
3300: <dt><span class="term"><code class="filename">var</code> (the usual location of
3301: <code class="filename">${VARBASE}</code>)</span></dt>
3302: <dd><p>Contains files
3303: that may be modified after
3304: installation.</p></dd>
3305: </dl></div>
3306: </div>
3307: <div class="sect1" lang="en">
3308: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 3309: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 3310: </h2></div></div></div>
3311: <div class="variablelist"><dl>
3312: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3313: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3314: <dd><p>Contains
3315: information about the currently installed
3316: packages.</p></dd>
3317: <dt><span class="term"><code class="filename">games</code></span></dt>
3318: <dd><p>Contains highscore
3319: files.</p></dd>
3320: <dt><span class="term"><code class="filename">log</code></span></dt>
3321: <dd><p>Contains log files.</p></dd>
3322: <dt><span class="term"><code class="filename">run</code></span></dt>
3323: <dd><p>Contains informational files about daemons that are
3324: currently running.</p></dd>
3325: </dl></div>
3326: </div>
3327: </div>
3328: <div class="chapter" lang="en">
3329: <div class="titlepage"><div><div><h2 class="title">
1.6 ! rillig 3330: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 3331: <div class="toc">
3332: <p><b>Table of Contents</b></p>
3333: <dl>
1.6 ! rillig 3334: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
! 3335: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
! 3336: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
! 3337: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
! 3338: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
! 3339: <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>
! 3340: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
! 3341: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
! 3342: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
! 3343: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does “<span class="quote">Don't know how to make
1.1 dsieger 3344: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.6 ! rillig 3345: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</a></span></dt>
! 3346: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
! 3347: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
! 3348: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
! 3349: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
! 3350: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
! 3351: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</a></span></dt>
1.1 dsieger 3352: </dl>
3353: </div>
3354: <p>This section contains hints, tips & tricks on special things in
3355: pkgsrc that we didn't find a better place for in the previous chapters, and
3356: it contains items for both pkgsrc users and developers.</p>
3357: <div class="sect1" lang="en">
3358: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 3359: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 3360: <p>The following mailing lists may be of interest to pkgsrc users:</p>
3361: <div class="itemizedlist"><ul type="disc">
1.4 rillig 3362: <li><p><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.1 dsieger 3363: This is a general purpose list for most issues regarding
3364: pkgsrc, regardless of platform, e.g. soliciting user help
3365: for pkgsrc configuration, unexpected build failures, using
3366: particular packages, upgrading pkgsrc installations,
3367: questions regarding the pkgsrc release branches, etc. General announcements or
3368: proposals for changes that impact the pkgsrc user community,
3369: e.g. major infrastructure changes, new features, package
3370: removals, etc., may also be posted.</p></li>
1.4 rillig 3371: <li><p><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.1 dsieger 3372: A list where the results of pkgsrc bulk builds are sent and
3373: discussed.</p></li>
1.4 rillig 3374: <li><p><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.1 dsieger 3375: This list is for those who are interested in getting a
3376: commit message for every change committed to pkgsrc. It is
3377: also available in digest form, meaning one daily message
3378: containing all commit messages for changes to the package
3379: source tree in that 24 hour period.</p></li>
3380: </ul></div>
3381: <p>To subscribe, do:</p>
3382: <pre class="programlisting">
3383: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
3384: </pre>
3385: <p>Archives for all these mailing lists are available from
3386: <a href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
3387: </div>
3388: <div class="sect1" lang="en">
3389: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 3390: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.1 dsieger 3391: <p>Pkgviews is tightly integrated with buildlink. You can find a
3392: pkgviews User's guide in
3393: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
3394: </div>
3395: <div class="sect1" lang="en">
3396: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 3397: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 3398: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
3399: a number of useful utilities for both users and developers of pkgsrc. This
3400: section attempts only to make the reader aware of the utilities and when
3401: they might be useful, and not to duplicate the documentation that comes
3402: with each package.</p>
3403: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
3404: <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>:
3405: Symlinks for use by buildlink.</p></li></ul></div>
3406: <p>OS tool augmentation (automatically installed when needed):</p>
3407: <div class="itemizedlist"><ul type="disc">
3408: <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>:
3409: Calculates various kinds of checksums (including SHA1).</p></li>
3410: <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>:
3411: Compatibility library for pkgsrc tools.</p></li>
3412: <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
3413: non-BSD systems due to lack of native mtree.</p></li>
3414: <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>:
3415: Up-to-date replacement for
3416: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
3417: systems where pkg_install is not present.</p></li>
3418: </ul></div>
3419: <p>Utilities used by pkgsrc (not automatically installed):</p>
3420: <div class="itemizedlist"><ul type="disc">
3421: <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>:
3422: Create a binary package from an
3423: already-installed package. Used by <span><strong class="command">make replace</strong></span> to
3424: save the old package.</p></li>
3425: <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>:
3426: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3427: from multiple locations. It currently supports the following
3428: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
3429: <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
3430: packages someplace else (enabled by default).</p></li>
3431: <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 the
3432: best compiler flags to optimise code for your current CPU and
3433: compiler.</p></li>
3434: </ul></div>
3435: <p>Utilities for keeping track of installed packages, being up to date,
3436: etc:</p>
3437: <div class="itemizedlist"><ul type="disc">
3438: <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
3439: packages whose installed versions do not match the latest pkgsrc
3440: entries.</p></li>
3441: <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
3442: dependency graphs of packages, to aid in choosing a strategy for
3443: updating.</p></li>
3444: <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
3445: 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>
3446: <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
3447: pkglint(1) program checks a pkgsrc entry for errors, lintpkgsrc(1)
3448: does various checks on the complete pkgsrc system.</p></li>
3449: <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
3450: packages you have installed.</p></li>
3451: </ul></div>
3452: <p>Utilities for people maintaining or creating individual packages:</p>
3453: <div class="itemizedlist"><ul type="disc">
3454: <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
3455: making and maintaining patches for a package (includes pkgdiff,
3456: pkgvi, mkpatches, etc.).</p></li>
3457: <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>,
3458: <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
3459: converting to pkgsrc.</p></li>
3460: <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
3461: pkgsrc to a Solaris package.</p></li>
3462: </ul></div>
3463: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3464: utilities)</p>
3465: <div class="itemizedlist"><ul type="disc">
3466: <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
3467: packages in a chrooted area.</p></li>
3468: <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
3469: kernel version for chrooted cross builds.</p></li>
3470: </ul></div>
3471: </div>
3472: <div class="sect1" lang="en">
3473: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 3474: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.1 dsieger 3475: <p>If you want to use pkgsrc as non-root user, you can set some
3476: variables to make pkgsrc work under these conditions. At the very least,
3477: you need to set <code class="varname">UNPRIVILEGED</code> to “<span class="quote">yes</span>”; this
3478: will turn on unprivileged mode and set multiple related variables to allow
3479: installation of packages as non-root.</p>
3480: <p>In case the defaults are not enough, you may want to tune some other
3481: variables used. For example, if the automatic user/group detection leads
3482: to incorrect values (or not the ones you would like to use), you can change
3483: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3484: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3485: <p>As regards bootstrapping, please note that the
3486: <span><strong class="command">bootstrap</strong></span> script will ease non-root configuration when
3487: given the “<span class="quote">--ignore-user-check</span>” flag, as it will choose and
3488: use multiple default directories under <code class="filename">~/pkg</code> as the
3489: installation targets. These directories can be overridden by the
3490: “<span class="quote">--prefix</span>” flag provided by the script, as well as some others
3491: that allow finer tuning of the tree layout.</p>
3492: </div>
3493: <div class="sect1" lang="en">
3494: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 3495: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 3496: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3497: enable this feature by adding the option
3498: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.4 rillig 3499: <a href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 3500: distfile is found, pkgsrc will try to resume it.</p>
3501: <p>You can also
3502: use a different program than the default <a 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
3503: <code class="varname">FETCH_CMD</code> variable. Don't forget to set
3504: <code class="varname">FETCH_RESUME_ARGS</code> and
3505: <code class="varname">FETCH_OUTPUT_ARGS</code> if you are not using default
3506: values.</p>
3507: <p>For example, if you want to use
3508: <code class="filename">wget</code> to resume downloads, you'll have to use something
3509: like:</p>
3510: <pre class="programlisting">
3511: FETCH_CMD= wget
3512: FETCH_BEFORE_ARGS= --passive-ftp
3513: FETCH_RESUME_ARGS= -c
3514: FETCH_OUTPUT_ARGS= -O
3515: </pre>
3516: </div>
3517: <div class="sect1" lang="en">
3518: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 3519: <a name="x.org-from-pkgsrc"></a>9.6. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.4 rillig 3520: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 3521: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
3522: you will have to add the following line into
1.4 rillig 3523: <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 3524: <pre class="programlisting">
1.4 rillig 3525: X11_TYPE=modular
1.1 dsieger 3526: </pre>
3527: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
3528: <h3 class="title">Note</h3>
1.4 rillig 3529: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3530: </p>
1.1 dsieger 3531: </div>
3532: </div>
3533: <div class="sect1" lang="en">
3534: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 3535: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 3536: <p>If you are sitting behind a firewall which does not allow direct
3537: connections to Internet hosts (i.e. non-NAT), you may specify the
3538: relevant proxy hosts. This is done using an environment variable in the
3539: form of a URL, e.g. in Amdahl, the machine
3540: “<span class="quote">orpheus.amdahl.com</span>” is one of the firewalls, and it uses
3541: port 80 as the proxy port number. So the proxy environment variables
3542: are:</p>
3543: <pre class="programlisting">
3544: ftp_proxy=ftp://orpheus.amdahl.com:80/
3545: http_proxy=http://orpheus.amdahl.com:80/
3546: </pre>
3547: </div>
3548: <div class="sect1" lang="en">
3549: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 3550: <a name="passive-ftp"></a>9.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.1 dsieger 3551: <p>This depends on which utility is used to retrieve distfiles. From
3552: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
3553: the first available command from the following list:</p>
3554: <div class="itemizedlist"><ul type="disc">
3555: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3556: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
3557: </ul></div>
3558: <p>On a default NetBSD installation, this will be
3559: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
3560: connections first, and falls back to active connections if the server
3561: refuses to do passive. For the other tools, add the following to your
1.4 rillig 3562: <a href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 3563: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3564: <p>Having that option present will prevent
3565: <code class="filename">/usr/bin/ftp</code> from falling back to active
3566: transfers.</p>
3567: </div>
3568: <div class="sect1" lang="en">
3569: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 3570: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 3571: <p>You would like to download all the distfiles in a single batch
3572: from work or university, where you can't run a <span><strong class="command">make
3573: fetch</strong></span>. There is an archive of distfiles on <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/" target="_top">ftp.NetBSD.org</a>,
3574: but downloading the entire directory may not be appropriate.</p>
3575: <p>The answer here is to do a <span><strong class="command">make fetch-list</strong></span> in
3576: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
3577: resulting list to your machine at work/school and use it there. If you
3578: don't have a NetBSD-compatible <a 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
3579: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3580: URL:</p>
3581: <p>At home:</p>
3582: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3583: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3584: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3585: <p>At work:</p>
3586: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
3587: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
3588: home.</p>
3589: <p>If you have a machine running NetBSD, and you want to get
3590: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3591: machine architecture), you can do so by using the above-mentioned
3592: <span><strong class="command">make fetch-list</strong></span> approach, or fetch the distfiles
3593: directly by running:</p>
3594: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3595: <p>If you even decide to ignore
3596: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3597: by running:</p>
3598: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3599: </div>
3600: <div class="sect1" lang="en">
3601: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 3602: <a name="tmac.andoc-missing"></a>9.10. What does “<span class="quote">Don't know how to make
1.1 dsieger 3603: /usr/share/tmac/tmac.andoc</span>” mean?</h2></div></div></div>
3604: <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>
3605: package, you get the error from make that it doesn't know how to make
3606: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
3607: you don't have installed the “<span class="quote">text</span>” set (nroff, ...) from
3608: the NetBSD base distribution on your machine. It is recommended to do
3609: that to format man pages.</p>
3610: <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
3611: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.4 rillig 3612: environment or in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 3613: </div>
3614: <div class="sect1" lang="en">
3615: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 3616: <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.1 dsieger 3617: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
3618: when you installed your NetBSD machine. Please get and install it, by
3619: extracting it in <code class="filename">/</code>:</p>
3620: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3621: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
3622: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
3623: the one that corresponds to your release (determine via <span><strong class="command">uname
3624: -r</strong></span>).</p>
3625: </div>
3626: <div class="sect1" lang="en">
3627: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 3628: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 3629: <p>When installing packages as non-root user and using the just-in-time
3630: <a 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
3631: password for each required package installed. To avoid this, the sudo
3632: package can be used, which does password caching over a limited time. To
3633: use it, install sudo (either as binary package or from
3634: <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.4 rillig 3635: following into your <a href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 3636: <span class="emphasis"><em>after</em></span> the definition of the
3637: <code class="varname">LOCALBASE</code> variable:</p>
3638: <pre class="programlisting">
3639: .if exists(${LOCALBASE}/bin/sudo)
3640: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3641: .endif
3642: </pre>
3643: </div>
3644: <div class="sect1" lang="en">
3645: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 3646: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 3647: <p>As the system administrator, you can choose where configuration files
3648: are installed. The default settings make all these files go into
3649: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
3650: be suboptimal depending on your expectations (e.g., a read-only,
3651: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3652: configuration of the provided packages).</p>
3653: <p>In order to change the defaults, you can modify the
3654: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.4 rillig 3655: <a href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 3656: directory; some common examples include <code class="filename">/etc</code> or
3657: <code class="filename">/etc/pkg</code>.</p>
3658: <p>Furthermore, you can change this value on a per-package basis by
3659: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3660: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3661: package you would like to modify, that is, the contents of
3662: <code class="varname">PKGBASE</code>.</p>
3663: <p>Note that after changing these settings, you must rebuild and
3664: reinstall any affected packages.</p>
3665: </div>
3666: <div class="sect1" lang="en">
3667: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 3668: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1 dsieger 3669: <p>Please be aware that there can often be bugs in third-party software,
3670: and some of these bugs can leave a machine vulnerable to exploitation by
3671: attackers. In an effort to lessen the exposure, the NetBSD packages team
3672: maintains a database of known-exploits to packages which have at one time
3673: been included in pkgsrc. The database can be downloaded automatically, and
3674: a security audit of all packages installed on a system can take place. To
3675: do this, install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> package. It has two
3676: components:</p>
3677: <div class="orderedlist"><ol type="1">
3678: <li>
3679: <p><span><strong class="command">download-vulnerability-list</strong></span>, an easy way to
3680: download a list of the security vulnerabilities information. This list
3681: is kept up to date by the NetBSD security officer and the NetBSD
3682: packages team, and is distributed from the NetBSD ftp server:</p>
3683: <p><a 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>
3684: </li>
3685: <li><p><span><strong class="command">audit-packages</strong></span>, an easy way to audit the
3686: current machine, checking each vulnerability which is known. If a
3687: vulnerable package is installed, it will be shown by output to stdout,
3688: including a description of the type of vulnerability, and a URL
3689: containing more information.</p></li>
3690: </ol></div>
3691: <p>Use of the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>
3692: package is strongly recommended! After
3693: “<span class="quote">audit-packages</span>” is installed, please read
3694: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
3695: audit-packages</code></strong>.</p>
3696: <p>If this package is installed, pkgsrc builds will use it to
3697: perform a security check before building any package. See <a 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
3698: check.</p>
3699: </div>
3700: <div class="sect1" lang="en">
3701: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 3702: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.1 dsieger 3703: <p>When you add your own preferences to the
3704: <code class="varname">CFLAGS</code> variable in your
1.4 rillig 3705: <a href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 3706: environment variables to the <code class="filename">./configure</code>
3707: scripts and to <a 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
3708: <code class="varname">CFLAGS</code> from the environment variable by
3709: overriding them in the <code class="filename">Makefile</code>s of their
3710: package.</p>
3711: <p>Currently there is no solution to this problem. If you
3712: really need the package to use your <code class="varname">CFLAGS</code>
3713: you should run <span><strong class="command">make patch</strong></span> in the package
3714: directory and then inspect any <code class="filename">Makefile</code> and
3715: <code class="filename">Makefile.in</code> for whether they define
3716: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
3717: these lines. But be aware that some “<span class="quote">smart</span>”
3718: programmers write so bad code that it only works for the
3719: specific combination of <code class="varname">CFLAGS</code> they have
3720: chosen.</p>
3721: </div>
3722: <div class="sect1" lang="en">
3723: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 3724: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.1 dsieger 3725: <div class="procedure"><ol type="1">
3726: <li><p>Make sure that your copy of pkgsrc is consistent. A
3727: case that occurs often is that people only update pkgsrc in
3728: parts, because of performance reasons. Since pkgsrc is one large
3729: system, not a collection of many small systems, there are
3730: sometimes changes that only work when the whole pkgsrc tree is
3731: updated.</p></li>
3732: <li><p>Make sure that you don't have any CVS conflicts.
3733: Search for “<span class="quote"><<<<<<</span>” or
3734: “<span class="quote">>>>>>></span>” in all your pkgsrc
3735: files.</p></li>
3736: <li><p>Make sure that you don't have old copies of the packages
3737: extracted. Run <span><strong class="command">make clean clean-depends</strong></span> to
3738: verify this.</p></li>
3739: <li><p>If the problem still exists, write a mail to the
3740: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3741: </ol></div>
3742: </div>
3743: <div class="sect1" lang="en">
3744: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 3745: <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.1 dsieger 3746: <p>You have modified a file from pkgsrc, and someone else has
3747: modified that same file afterwards in the CVS repository. Both changes
3748: are in the same region of the file, so when you updated pkgsrc, the
3749: <code class="literal">cvs</code> command marked the conflicting changes in the
3750: file. Because of these markers, the file is no longer a valid
3751: <code class="filename">Makefile</code>.</p>
3752: <p>Have a look at that file, and if you don't need your local changes
3753: anymore, you can remove that file and run <span><strong class="command">cvs -q update
3754: -dP</strong></span> in that directory to download the current version.</p>
3755: </div>
3756: </div>
3757: </div>
3758: <div class="part" lang="en">
3759: <div class="titlepage"><div><div><h1 class="title">
3760: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
3761: <div class="partintro" lang="en">
3762: <div></div>
3763: <p>This part of the book deals with creating and
3764: modifying packages. It starts with a “<span class="quote">HOWTO</span>”-like
3765: guide on creating a new package. The remaining chapters are more
3766: like a reference manual for pkgsrc.</p>
3767: <div class="toc">
3768: <p><b>Table of Contents</b></p>
3769: <dl>
1.6 ! rillig 3770: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 3771: <dd><dl>
1.6 ! rillig 3772: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3773: <dd><dl>
1.6 ! rillig 3774: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
! 3775: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.1 dsieger 3776: </dl></dd>
1.6 ! rillig 3777: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
! 3778: <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>
! 3779: </dl></dd>
! 3780: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
! 3781: <dd><dl>
! 3782: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
! 3783: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
! 3784: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
! 3785: <dd><dl>
! 3786: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
! 3787: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
! 3788: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
! 3789: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
! 3790: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
! 3791: </dl></dd>
! 3792: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
! 3793: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
! 3794: <dd><dl>
! 3795: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
! 3796: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
! 3797: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
! 3798: </dl></dd>
! 3799: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
! 3800: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
! 3801: </dl></dd>
! 3802: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
! 3803: <dd><dl>
! 3804: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
! 3805: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
! 3806: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
! 3807: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
! 3808: <dd><dl>
! 3809: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
! 3810: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
! 3811: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
! 3812: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
! 3813: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
! 3814: </dl></dd>
! 3815: </dl></dd>
! 3816: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
! 3817: <dd><dl>
! 3818: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
! 3819: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
! 3820: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
! 3821: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
! 3822: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
! 3823: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
! 3824: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
! 3825: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
! 3826: </dl></dd>
! 3827: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
! 3828: <dd><dl>
! 3829: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
! 3830: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
! 3831: <dd><dl>
! 3832: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
! 3833: <dt><span class="sect2"><a href="#updating-buildlink-depends">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</a></span></dt>
! 3834: </dl></dd>
! 3835: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
! 3836: <dd><dl>
! 3837: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
! 3838: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
! 3839: </dl></dd>
! 3840: </dl></dd>
! 3841: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
! 3842: <dd><dl>
! 3843: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
! 3844: <dd><dl>
! 3845: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
! 3846: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
! 3847: </dl></dd>
! 3848: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
! 3849: <dd><dl>
! 3850: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
! 3851: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
! 3852: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
! 3853: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
! 3854: </dl></dd>
! 3855: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
! 3856: <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>
! 3857: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
! 3858: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
! 3859: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
! 3860: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
! 3861: <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>
! 3862: </dl></dd>
! 3863: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
! 3864: <dd><dl>
! 3865: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
! 3866: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
! 3867: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
! 3868: </dl></dd>
! 3869: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
! 3870: <dd><dl>
! 3871: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
! 3872: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
! 3873: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
! 3874: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
! 3875: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
! 3876: <dd><dl>
! 3877: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
! 3878: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
! 3879: </dl></dd>
! 3880: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
! 3881: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
! 3882: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
! 3883: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
! 3884: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
! 3885: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
! 3886: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
! 3887: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
! 3888: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
! 3889: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
! 3890: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
! 3891: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
! 3892: </dl></dd>
! 3893: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
! 3894: <dd><dl>
! 3895: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
! 3896: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
! 3897: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
! 3898: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
! 3899: </dl></dd>
! 3900: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
! 3901: <dd><dl>
! 3902: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
! 3903: <dd><dl>
! 3904: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
! 3905: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
! 3906: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
! 3907: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
! 3908: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
! 3909: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
! 3910: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
! 3911: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
! 3912: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
! 3913: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
! 3914: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
! 3915: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
! 3916: </dl></dd>
! 3917: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
! 3918: <dd><dl>
! 3919: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
! 3920: <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>
! 3921: </dl></dd>
! 3922: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
! 3923: <dd><dl>
! 3924: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
! 3925: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
! 3926: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
! 3927: </dl></dd>
! 3928: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
! 3929: <dd><dl>
! 3930: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
! 3931: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
! 3932: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
! 3933: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
! 3934: </dl></dd>
! 3935: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
! 3936: <dd><dl>
! 3937: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
! 3938: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
! 3939: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
! 3940: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
! 3941: </dl></dd>
! 3942: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
! 3943: <dd><dl>
! 3944: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
! 3945: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
! 3946: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
! 3947: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
! 3948: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
! 3949: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
! 3950: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
! 3951: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
! 3952: <dt><span class="sect2"><a href="#gconf2-data-files">19.6.9. Packages installing GConf2 data files</a></span></dt>
! 3953: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
! 3954: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
! 3955: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
! 3956: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
! 3957: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
! 3958: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
! 3959: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
! 3960: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
! 3961: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 3962: emulation</a></span></dt>
1.6 ! rillig 3963: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
! 3964: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 3965: </dl></dd>
1.6 ! rillig 3966: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3967: </dl></dd>
1.6 ! rillig 3968: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
! 3969: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 3970: <dd><dl>
1.6 ! rillig 3971: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
! 3972: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
! 3973: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
! 3974: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
! 3975: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
! 3976: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
! 3977: </dl></dd>
! 3978: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
! 3979: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
! 3980: <dd><dl>
! 3981: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
! 3982: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
! 3983: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
! 3984: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 3985: </dl></dd>
3986: </dl>
3987: </div>
3988: </div>
3989: <div class="chapter" lang="en">
3990: <div class="titlepage"><div><div><h2 class="title">
1.6 ! rillig 3991: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 3992: <div class="toc">
3993: <p><b>Table of Contents</b></p>
3994: <dl>
1.6 ! rillig 3995: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3996: <dd><dl>
1.6 ! rillig 3997: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
! 3998: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.1 dsieger 3999: </dl></dd>
1.6 ! rillig 4000: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
! 4001: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.1 dsieger 4002: </dl>
4003: </div>
4004: <p>When you find a package that is not yet in pkgsrc, you
4005: most likely have a URL from where you can download the source
4006: code. Starting with this URL, creating a package involves only a
4007: few steps.</p>
4008: <div class="procedure"><ol type="1">
4009: <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>
4010: <li><p>Then, choose one of the top-level directories as the
4011: category in which you want to place your package. You can also create a
4012: directory of your own (maybe called <code class="filename">local</code>). In that
4013: category directory, create another directory for your package and change
4014: into it.</p></li>
4015: <li><p>Run the program <span><strong class="command">url2pkg</strong></span>, which will ask
4016: you for a URL. Enter the URL of the distribution file (in most cases a
4017: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
4018: of your package are created automatically. The distribution file is
4019: extracted automatically to fill in some details in the
4020: <code class="filename">Makefile</code> that would otherwise have to be done
4021: manually.</p></li>
4022: <li>
4023: <p>Examine the extracted files to determine the dependencies of
4024: your package. Ideally, this is mentioned in some
4025: <code class="filename">README</code> file, but things may differ. For each of
4026: these dependencies, look where it exists in pkgsrc, and if there is a
4027: file called <code class="filename">buildlink3.mk</code> in that directory, add a
4028: line to your package <code class="filename">Makefile</code> which includes that
4029: file just before the last line. If the
4030: <code class="filename">buildlink3.mk</code> file does not exist, add a
4031: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
4032: version of the dependency and where it can be found in pkgsrc. This line
4033: should be placed in the third paragraph. If the dependency is only
4034: needed for building the package, but not when using it, use
4035: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
4036: Your package may then look like this:</p>
4037: <pre class="programlisting">
4038: [...]
4039:
4040: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
4041: DEPENDS+= screen-[0-9]*:../../misc/screen
4042: DEPENDS+= screen>=4.0:../../misc/screen
4043:
4044: [...]
4045:
4046: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
4047: .include "../../devel/glib2/buildlink3.mk"
4048: .include "../../mk/bsd.pkg.mk"
4049: </pre>
4050: </li>
4051: <li><p>Run <span><strong class="command">pkglint</strong></span> to see what things still need
4052: to be done to make your package a “<span class="quote">good</span>” one. If you don't
4053: know what pkglint's warnings want to tell you, try <span><strong class="command">pkglint
4054: --explain</strong></span> or <span><strong class="command">pkglint
4055: -e</strong></span>, which outputs additional
4056: explanations.</p></li>
4057: <li><p>In many cases the package is not yet ready to build. You can
1.6 ! rillig 4058: find instructions for the most common cases in the next section, <a href="#creating.common" title="10.1. Common types of packages">Section 10.1, “Common types of packages”</a>. After you have followed the instructions
1.1 dsieger 4059: over there, you can hopefully continue here.</p></li>
4060: <li><p>Run <span><strong class="command">bmake clean</strong></span> to clean the working
4061: directory from the extracted files. Besides these files, a lot of cache
4062: files and other system information has been saved in the working
4063: directory, which may become wrong after you edited the
4064: <code class="filename">Makefile</code>.</p></li>
4065: <li><p>Now, run <span><strong class="command">bmake</strong></span> to build the package. For
1.6 ! rillig 4066: the various things that can go wrong in this phase, consult <a href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.1 dsieger 4067: <li><p>When the package builds fine, the next step is to install
4068: the package. Run <span><strong class="command">bmake install</strong></span> and hope that
4069: everything works.</p></li>
4070: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
4071: contains a list of the files that are installed by the package, is
4072: nearly empty. Run <span><strong class="command">bmake print-PLIST
4073: >PLIST</strong></span> to generate a probably correct list. Check
4074: the file using your preferred text editor to see if the list of
4075: files looks plausible.</p></li>
4076: <li><p>Run <span><strong class="command">pkglint</strong></span> again to see if the generated
4077: <code class="filename">PLIST</code> contains garbage or not.</p></li>
4078: <li><p>When you ran <span><strong class="command">bmake install</strong></span>, the package
4079: has been registered in the database of installed files, but with an
4080: empty list of files. To fix this, run <span><strong class="command">bmake deinstall</strong></span>
4081: and <span><strong class="command">bmake install</strong></span> again. Now the package is
4082: registered with the list of files from
4083: <code class="filename">PLIST</code>.</p></li>
4084: <li><p>Run <span><strong class="command">bmake package</strong></span> to create a binary
4085: package from the set of installed files.</p></li>
4086: </ol></div>
4087: <div class="sect1" lang="en">
4088: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 4089: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.1 dsieger 4090: <div class="sect2" lang="en">
4091: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 4092: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 4093: <p>Simple Perl modules are handled automatically by
4094: <span><strong class="command">url2pkg</strong></span>, including dependencies.</p>
4095: </div>
4096: <div class="sect2" lang="en">
4097: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 4098: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.1 dsieger 4099: <p>KDE applications should always include
4100: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
4101: settings that are typical of KDE packages.</p>
4102: </div>
4103: </div>
4104: <div class="sect1" lang="en">
4105: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 4106: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.1 dsieger 4107: <div class="sect2" lang="en">
4108: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 4109: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.1 dsieger 4110: <div class="sect3" lang="en">
4111: <div class="titlepage"><div><div><h4 class="title">
1.6 ! rillig 4112: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 4113: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
4114: that the “<span class="quote">nvu</span>” package has not yet been imported into
4115: pkgsrc. As the description says it has to do with the web, the obvious
4116: choice for the category is “<span class="quote">www</span>”.</p>
4117: <pre class="programlisting">
4118: <code class="prompt">$</code> mkdir www/nvu
4119: <code class="prompt">$</code> cd www/nvu
4120: </pre>
4121: <p>The web site says that the sources are available as a tar file, so
4122: I fed that URL to the <span><strong class="command">url2pkg</strong></span> program:</p>
4123: <pre class="programlisting">
4124: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4125: </pre>
4126: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
4127: below the <code class="varname">DISTNAME</code> line, as the package name should
4128: not have the word “<span class="quote">sources</span>” in it. I also filled in the
4129: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
4130: <code class="varname">COMMENT</code> fields. Then the package
4131: <code class="filename">Makefile</code> looked like that:</p>
4132: <pre class="programlisting">
4133: # $NetBSD$
4134: #
4135:
4136: DISTNAME= nvu-1.0-sources
4137: PKGNAME= nvu-1.0
4138: CATEGORIES= www
4139: MASTER_SITES= http://cvs.nvu.com/download/
4140: EXTRACT_SUFX= .tar.bz2
4141:
4142: MAINTAINER= rillig@NetBSD.org
4143: HOMEPAGE= http://cvs.nvu.com/
4144: COMMENT= Web Authoring System
4145:
4146: # url2pkg-marker (please do not remove this line.)
4147: .include "../../mk/bsd.pkg.mk"
4148: </pre>
4149: <p>Then, I quit the editor and watched pkgsrc downloading a large
4150: source archive:</p>
4151: <pre class="programlisting">
4152: url2pkg> Running "make makesum" ...
4153: => Required installed package digest>=20010302: digest-20060826 found
4154: => Fetching nvu-1.0-sources.tar.bz2
4155: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4156: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
4157: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4158: url2pkg> Running "make extract" ...
4159: => Required installed package digest>=20010302: digest-20060826 found
4160: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4161: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4162: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4163: ===> Installing dependencies for nvu-1.0
4164: ===> Overriding tools for nvu-1.0
4165: ===> Extracting for nvu-1.0
4166: url2pkg> Adjusting the Makefile.
4167:
4168: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
4169:
4170: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
4171: </pre>
4172: </div>
4173: <div class="sect3" lang="en">
4174: <div class="titlepage"><div><div><h4 class="title">
1.6 ! rillig 4175: <a name="creating.nvu.problems"></a>10.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.1 dsieger 4176: <p>Now that the package has been extracted, let's see what's inside
4177: it. The package has a <code class="filename">README.txt</code>, but that only
4178: says something about mozilla, so it's probably useless for seeing what
4179: dependencies this package has. But since there is a GNU configure script
4180: in the package, let's hope that it will complain about everything it
4181: needs.</p>
4182: <pre class="programlisting">
4183: <code class="prompt">$</code> bmake
4184: => Required installed package digest>=20010302: digest-20060826 found
4185: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4186: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4187: ===> Patching for nvu-1.0
4188: ===> Creating toolchain wrappers for nvu-1.0
4189: ===> Configuring for nvu-1.0
4190: [...]
4191: configure: error: Perl 5.004 or higher is required.
4192: [...]
4193: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4194: [...]
4195: </pre>
4196: <p>That worked quite well. So I opened the package Makefile in my
4197: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
4198: just appended “<span class="quote">perl</span>” to it. Since the dependencies of the
4199: package have changed now, and since a perl wrapper is automatically
4200: installed in the “<span class="quote">tools</span>” phase, I need to build the package
4201: from scratch.</p>
4202: <pre class="programlisting">
4203: <code class="prompt">$</code> bmake clean
4204: ===> Cleaning for nvu-1.0
4205: <code class="prompt">$</code> bmake
4206: [...]
4207: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4208: GNU Make. You will not be able to build Mozilla without GNU Make.
4209: [...]
4210: </pre>
4211: <p>So I added “<span class="quote">gmake</span>” to the
4212: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4213: <pre class="programlisting">
4214: [...]
4215: checking for GTK - version >= 1.2.0... no
4216: *** Could not run GTK test program, checking why...
4217: [...]
4218: </pre>
4219: <p>Now to the other dependencies. The first question is: Where is the
4220: GTK package hidden in pkgsrc?</p>
4221: <pre class="programlisting">
4222: <code class="prompt">$</code> echo ../../*/gtk*
4223: [many packages ...]
4224: <code class="prompt">$</code> echo ../../*/gtk
4225: ../../x11/gtk
4226: <code class="prompt">$</code> echo ../../*/gtk2
4227: ../../x11/gtk2
4228: <code class="prompt">$</code> echo ../../*/gtk2/bui*
4229: ../../x11/gtk2/buildlink3.mk
4230: </pre>
4231: <p>The first try was definitely too broad. The second one had exactly
4232: one result, which is very good. But there is one pitfall with GNOME
4233: packages. Before GNOME 2 had been released, there were already many
4234: GNOME 1 packages in pkgsrc. To be able to continue to use these
4235: packages, the GNOME 2 packages were imported as separate packages, and
4236: their names usually have a “<span class="quote">2</span>” appended. So I checked
4237: whether this was the case here, and indeed it was.</p>
4238: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4239: file, adding the dependency is very easy. I just inserted an
4240: <code class="literal">.include</code> line before the last line of the package
4241: <code class="filename">Makefile</code>, so that it now looks like this:</p>
4242: <pre class="programlisting">
4243: [...]
4244: .include "../../x11/gtk2/buildlink3.mk"
4245: .include "../../mk/bsd.pkg.mk
4246: </pre>
4247: <p>After another <span><strong class="command">bmake clean && bmake</strong></span>, the answer
4248: was:</p>
4249: <pre class="programlisting">
4250: [...]
4251: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4252: checking for GTK - version >= 1.2.0... no
4253: *** Could not run GTK test program, checking why...
4254: *** The test program failed to compile or link. See the file config.log for the
4255: *** exact error that occured. This usually means GTK was incorrectly installed
4256: *** or that you have moved GTK since it was installed. In the latter case, you
4257: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4258: configure: error: Test for GTK failed.
4259: [...]
4260: </pre>
4261: <p>In this particular case, the assumption that “<span class="quote">every package
4262: prefers GNOME 2</span>” had been wrong. The first of the lines above
4263: told me that this package really wanted to have the GNOME 1 version of
4264: GTK. If the package had looked for GTK2, it would have looked for
4265: <span><strong class="command">pkg-config</strong></span> instead of <span><strong class="command">gtk-config</strong></span>.
4266: So I changed the <code class="literal">x11/gtk2</code> to
4267: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4268: and tried again.</p>
4269: <pre class="programlisting">
4270: [...]
4271: 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
4272: In file included from xpidl.c:42:
4273: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4274: In file included from xpidl.c:42:
4275: xpidl.h:132: error: parse error before "IDL_ns"
4276: [...]
4277: </pre>
4278: <p>The package still does not find all of its dependencies. Now the
4279: question is: Which package provides the
4280: <code class="filename">libIDL/IDL.h</code> header file?</p>
4281: <pre class="programlisting">
4282: <code class="prompt">$</code> echo ../../*/*idl*
4283: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4284: <code class="prompt">$</code> echo ../../*/*IDL*
4285: ../../net/libIDL
4286: </pre>
4287: <p>Let's take the one from the second try. So I included the
4288: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4289: again. But the error didn't change. After digging through some of the
4290: code, I concluded that the build process of the package was broken and
4291: couldn't have ever worked, but since the Mozilla source tree is quite
4292: large, I didn't want to fix it. So I added the following to the package
4293: <code class="filename">Makefile</code> and tried again:</p>
4294: <pre class="programlisting">
4295: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4296: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
4297: </pre>
4298: <p>The latter line is needed because the package expects the library
4299: <code class="filename">libIDL.so</code>, but only
4300: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4301: wrapper to rewrite that on the fly.</p>
4302: <p>The next problem was related to a recent change of the FreeType
4303: 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>
4304: which patch files were relevant for this issue and copied them to the
4305: <code class="filename">patches</code> directory. Then I retried, fixed the
4306: patches so that they applied cleanly and retried again. This time,
4307: everything worked.</p>
4308: </div>
4309: <div class="sect3" lang="en">
4310: <div class="titlepage"><div><div><h4 class="title">
1.6 ! rillig 4311: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 4312: <pre class="programlisting">
4313: <code class="prompt">$</code> bmake CHECK_FILES=no install
4314: [...]
4315: <code class="prompt">$</code> bmake print-PLIST >PLIST
4316: <code class="prompt">$</code> bmake deinstall
4317: <code class="prompt">$</code> bmake install
4318: </pre>
4319: </div>
4320: </div>
4321: </div>
4322: </div>
4323: <div class="chapter" lang="en">
4324: <div class="titlepage"><div><div><h2 class="title">
1.6 ! rillig 4325: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 4326: <div class="toc">
4327: <p><b>Table of Contents</b></p>
4328: <dl>
1.6 ! rillig 4329: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
! 4330: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
! 4331: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
! 4332: <dd><dl>
! 4333: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
! 4334: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
! 4335: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
! 4336: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
! 4337: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
! 4338: </dl></dd>
! 4339: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
! 4340: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
! 4341: <dd><dl>
! 4342: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
! 4343: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
! 4344: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 4345: </dl></dd>
1.6 ! rillig 4346: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
! 4347: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 4348: </dl>
4349: </div>
4350: <p>Whenever you're preparing a package, there are a number of
4351: files involved which are described in the following
4352: sections.</p>
4353: <div class="sect1" lang="en">
4354: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 4355: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1 dsieger 4356: </h2></div></div></div>
4357: <p>Building, installation and creation of a binary package are all
4358: controlled by the package's <code class="filename">Makefile</code>.
4359: The <code class="filename">Makefile</code> describes various things about
4360: a package, for example from where to get it, how to configure,
4361: build, and install it.</p>
4362: <p>A package <code class="filename">Makefile</code> contains several
4363: sections that describe the package.</p>
4364: <p>In the first section there are the following variables, which
4365: should appear exactly in the order given here. The order and
4366: grouping of the variables is mostly historical and has no further
4367: meaning.</p>
4368: <div class="itemizedlist"><ul type="disc">
4369: <li><p><code class="varname">DISTNAME</code> is the basename of the
4370: distribution file to be downloaded from the package's
4371: website.</p></li>
4372: <li><p><code class="varname">PKGNAME</code> is the name of the
4373: package, as used by pkgsrc. You only need to provide it if
4374: <code class="varname">DISTNAME</code> (which is the default) is not a good
4375: name for the package in pkgsrc. Usually it is the pkgsrc
4376: directory name together with the version number. It must match the
4377: regular expression
4378: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4379: starts with a letter or digit, and contains only letters, digits,
4380: dashes, underscores, dots and plus signs.</p></li>
4381: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
4382: the package file to create if the <code class="varname">PKGNAME</code>
4383: isn't unique on a SVR4 system. The default is
4384: <code class="varname">PKGNAME</code>, which may be shortened when you use
4385: <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
4386: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4387: does not produce an unique package name on a SVR4 system.
4388: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4389: characters.</p></li>
4390: <li>
4391: <p><code class="varname">CATEGORIES</code> is a list of categories
4392: which the package fits in. You can choose any of the top-level
4393: directories of pkgsrc for it.</p>
4394: <p>Currently the following values are available for
4395: <code class="varname">CATEGORIES</code>. If more than
4396: one is used, they need to be separated by spaces:</p>
4397: <pre class="programlisting">
4398: archivers cross geography meta-pkgs security
4399: audio databases graphics misc shells
4400: benchmarks devel ham multimedia sysutils
4401: biology editors inputmethod net textproc
4402: cad emulators lang news time
4403: chat finance mail parallel wm
4404: comms fonts math pkgtools www
4405: converters games mbone print x11
4406: </pre>
4407: </li>
4408: <li><p><code class="varname">MASTER_SITES</code>,
4409: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4410: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4411: and <code class="varname">DISTFILES</code> are discussed in detail in
1.6 ! rillig 4412: <a href="#build.fetch" title="17.5. The fetch phase">Section 17.5, “The <span class="emphasis"><em>fetch</em></span> phase”</a>.</p></li>
1.1 dsieger 4413: </ul></div>
4414: <p>The second section contains information about separately
4415: downloaded patches, if any.
4416: </p>
4417: <div class="itemizedlist"><ul type="disc">
4418: <li><p><code class="varname">PATCHFILES:</code>
4419: Name(s) of additional files that contain distribution patches.
4420: There is no default. pkgsrc will look for them at
4421: <code class="varname">PATCH_SITES</code>.
4422: They will automatically be uncompressed before patching if
4423: the names end with <code class="filename">.gz</code> or
4424: <code class="filename">.Z</code>.</p></li>
4425: <li><p><code class="varname">PATCH_SITES</code>:
4426: Primary location(s) for distribution patch files (see
4427: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
4428: </ul></div>
4429: <p>The third section contains the following variables.
4430: </p>
4431: <div class="itemizedlist"><ul type="disc">
4432: <li><p><code class="varname">MAINTAINER</code> is the email address
4433: of the person who feels responsible for this package, and who is
4434: most likely to look at problems or questions regarding this
4435: package which have been reported with <a 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>. Other
4436: developers should contact the <code class="varname">MAINTAINER</code> before
4437: making major changes to the package. When packaging a new program,
4438: set <code class="varname">MAINTAINER</code> to yourself. If you really can't
4439: maintain the package for future updates, set it to
4440: <code class="email"><<a href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
4441: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
4442: find more information about the package.</p></li>
4443: <li><p><code class="varname">COMMENT</code> is a one-line
4444: description of the package (should not include the package
4445: name).</p></li>
4446: </ul></div>
4447: <p>Other variables that affect the build:
4448: </p>
4449: <div class="itemizedlist"><ul type="disc"><li>
4450: <p><code class="varname">WRKSRC</code>: The directory where the
4451: interesting distribution files of the package are found. The
4452: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4453: works for most packages.</p>
4454: <p>If a package doesn't create a subdirectory for itself
4455: (most GNU software does, for instance), but extracts itself in
4456: the current directory, you should set
4457: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4458: <p>If a package doesn't create a subdirectory with the
4459: name of <code class="varname">DISTNAME</code> but some different name,
4460: set <code class="varname">WRKSRC</code> to point to the proper name in
4461: <code class="filename">${WRKDIR}</code>, for example
4462: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
4463: <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>
4464: <p>The name of the working directory created by pkgsrc is
4465: taken from the <code class="varname">WRKDIR_BASENAME</code>
4466: variable. By default, its value is
4467: <code class="filename">work</code>. If you want to use the same
4468: pkgsrc tree for building different kinds of binary packages,
4469: you can change the variable according to your needs. Two
4470: other variables handle common cases of setting
4471: <code class="varname">WRKDIR_BASENAME</code> individually. If
4472: <code class="varname">OBJHOSTNAME</code> is defined in
1.4 rillig 4473: <a href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 4474: the host's name is attached to the directory name. If
4475: <code class="varname">OBJMACHINE</code> is defined, the platform name
4476: is attached, which might look like
4477: <code class="filename">work.i386</code> or
4478: <code class="filename">work.sparc</code>.</p>
4479: </li></ul></div>
4480: <p>Please pay attention to the following gotchas:</p>
4481: <div class="itemizedlist"><ul type="disc">
4482: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
4483: installed in compressed form by the package. For packages using
4484: BSD-style makefiles which honor MANZ, there is
4485: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
4486: <li><p>Replace <code class="filename">/usr/local</code> with
4487: “<span class="quote">${PREFIX}</span>” in all files (see patches,
4488: below).</p></li>
1.6 ! rillig 4489: <li><p>If the package installs any info files, see <a href="#faq.info-files" title="19.6.7. Packages installing info files">Section 19.6.7, “Packages installing info files”</a>.</p></li>
1.1 dsieger 4490: </ul></div>
4491: </div>
4492: <div class="sect1" lang="en">
4493: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 4494: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1 dsieger 4495: </h2></div></div></div>
4496: <p>The <code class="filename">distinfo</code> file contains the message
4497: digest, or checksum, of each distfile needed for the package. This
4498: ensures that the distfiles retrieved from the Internet have not been
4499: corrupted during transfer or altered by a malign force to introduce
4500: a security hole. Due to recent rumor about weaknesses of digest
4501: algorithms, all distfiles are protected using both SHA1 and RMD160
4502: message digests, as well as the file size.</p>
4503: <p>The <code class="filename">distinfo</code> file also contains the
4504: checksums for all the patches found in the
1.6 ! rillig 4505: <code class="filename">patches</code> directory (see <a href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a>).</p>
1.1 dsieger 4506: <p>To regenerate the <code class="filename">distinfo</code> file, use the
4507: <span><strong class="command">make makedistinfo</strong></span> or <span><strong class="command">make mdi</strong></span>
4508: command.</p>
4509: <p>Some packages have different sets of distfiles depending on
4510: 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
4511: <code class="filename">distinfo</code> file and care should be taken when
4512: upgrading such a package to ensure distfile information is not
4513: lost.</p>
4514: </div>
4515: <div class="sect1" lang="en">
4516: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 4517: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.1 dsieger 4518: <p>Many packages still don't work out-of-the box on the various
4519: platforms that are supported by pkgsrc. Therefore, a number of custom
4520: patch files are needed to make the package work. These patch files are
4521: found in the <code class="filename">patches/</code> directory.</p>
4522: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4523: applied to the files in <code class="varname">WRKSRC</code> directory after
4524: extracting them, in <a href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
4525: order</a>, so <code class="filename">patch-aa</code> is applied before
4526: <code class="filename">patch-ab</code>, etc.</p>
4527: <div class="sect2" lang="en">
4528: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 4529: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 4530: <p>The <code class="filename">patch-*</code> files should be in
4531: <span><strong class="command">diff -bu</strong></span> format, and apply without a fuzz to avoid
4532: problems. (To force patches to apply with fuzz you can set
4533: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
4534: should contain only changes for a single file, and no file should be
4535: patched by more than one patch file. This helps to keep future
4536: modifications simple.</p>
4537: <p>Each patch file is structured as follows: In the first line,
4538: there is the RCS Id of the patch itself. The second line should be
4539: empty for aesthetic reasons. After that, there should be a comment for
4540: each change that the patch does. There are a number of standard
4541: cases:</p>
4542: <div class="itemizedlist"><ul type="disc">
4543: <li><p>Patches that replace the <code class="literal">==</code>
4544: operator for <a 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
4545: should contain a reference to , to avoid
4546: redundant explanations.</p></li>
4547: <li><p>Patches for commonly known vulnerabilities should
4548: mention the vulnerability ID (CAN, CVE).</p></li>
4549: <li><p>Patches that change source code should mention the
4550: platform and other environment (for example, the compiler) that the
4551: patch is needed for.</p></li>
4552: </ul></div>
4553: <p>In all other cases, the patch should be commented so that any
4554: developer who knows the code of the application can make some use of
4555: the patch. Special care should be taken for the upstream developers,
4556: since we generally want that they accept our patches, so we have less
4557: work in the future.</p>
4558: </div>
4559: <div class="sect2" lang="en">
4560: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 4561: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 4562: <p>One important thing to mention is to pay attention that no RCS
4563: IDs get stored in the patch files, as these will cause problems when
4564: later checked into the NetBSD CVS tree. Use the
4565: <span><strong class="command">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
4566: problems.</p>
4567: <p>For even more automation, we recommend using
4568: <span><strong class="command">mkpatches</strong></span> from the same package to make a
4569: whole set of patches. You just have to backup files before you
4570: edit them to <code class="filename">filename.orig</code>, e.g. with
4571: <span><strong class="command">cp -p filename filename.orig</strong></span> or, easier, by
4572: using <span><strong class="command">pkgvi</strong></span> again from the same package. If
4573: you upgrade a package this way, you can easily compare the new
4574: set of patches with the previously existing one with
4575: <span><strong class="command">patchdiff</strong></span>. Copy the patches you want to use
4576: or update from the <code class="filename">work/.newpatches</code>
4577: directory to <code class="filename">patches/</code>.</p>
4578: <p>When you have finished a package, remember to generate
4579: the checksums for the patch files by using the <span><strong class="command">make
1.6 ! rillig 4580: makepatchsum</strong></span> command, see <a href="#components.distinfo" title="11.2. distinfo">Section 11.2, “<code class="filename">distinfo</code>”</a>.</p>
1.1 dsieger 4581: <p>When adding a patch that corrects a problem in the
4582: distfile (rather than e.g. enforcing pkgsrc's view of where
4583: man pages should go), send the patch as a bug report to the
4584: maintainer. This benefits non-pkgsrc users of the package,
4585: and usually makes it possible to remove the patch in future
4586: version.</p>
1.2 rillig 4587: <p>The file names of the patch files are usually of the form
4588: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.1 dsieger 4589: </div>
4590: <div class="sect2" lang="en">
4591: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 4592: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 4593: <p>If you want to share patches between multiple packages
4594: in pkgsrc, e.g. because they use the same distfiles, set
4595: <code class="varname">PATCHDIR</code> to the path where the patch files
4596: can be found, e.g.:</p>
4597: <pre class="programlisting">
4598: PATCHDIR= ${.CURDIR}/../xemacs/patches
4599: </pre>
4600: <p>Patch files that are distributed by the author or other
4601: maintainers can be listed in
4602: <code class="varname">PATCHFILES</code>.</p>
4603: <p>If it is desired to store any patches that should not be
4604: committed into pkgsrc, they can be kept outside the pkgsrc
4605: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4606: directory tree there is expected to have the same
4607: “<span class="quote">category/package</span>” structure as pkgsrc, and
4608: patches are expected to be stored inside these dirs (also
4609: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4610: example, if you want to keep a private patch for
4611: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4612: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4613: files in the named directory are expected to be patch files,
4614: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4615: applied</em></span>.</p>
4616: </div>
4617: <div class="sect2" lang="en">
4618: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 4619: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 4620: <p>When fixing a portability issue in the code do not use
4621: preprocessor magic to check for the current operating system nor
4622: platform. Doing so hurts portability to other platforms because
4623: the OS-specific details are not abstracted appropriately.</p>
4624: <p>The general rule to follow is: instead of checking for the
4625: operating system the application is being built on, check for the
4626: specific <span class="emphasis"><em>features</em></span> you need. For example,
4627: instead of assuming that kqueue is available under NetBSD and
4628: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.6 ! rillig 4629: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 4630: yes, this generally involves patching the
4631: <span><strong class="command">configure</strong></span> script. There is absolutely nothing
4632: that prevents some OSes from adopting interfaces from other OSes
4633: (e.g. Linux implementing kqueue), something that the above checks
4634: cannot take into account.</p>
4635: <p>Of course, checking for features generally involves more
4636: work on the developer's side, but the resulting changes are
4637: cleaner and there are chances they will work on many other
4638: platforms. Not to mention that there are higher chances of being
4639: later integrated into the mainstream sources. Remember:
4640: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4641: <p>Some typical examples:</p>
4642: <div class="table">
1.6 ! rillig 4643: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.1 dsieger 4644: <div class="table-contents"><table summary="Patching examples" border="1">
4645: <colgroup>
4646: <col>
4647: <col>
4648: <col>
4649: </colgroup>
4650: <thead><tr>
4651: <th>Where</th>
4652: <th>Incorrect</th>
4653: <th>Correct</th>
4654: </tr></thead>
4655: <tbody>
4656: <tr>
4657: <td>configure script</td>
4658: <td>
4659: <pre class="programlisting">
4660: case ${target_os} in
4661: netbsd*) have_kvm=yes ;;
4662: *) have_kvm=no ;;
4663: esac
4664: </pre>
4665: </td>
4666: <td>
4667: <pre class="programlisting">
4668: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4669: </pre>
4670: </td>
4671: </tr>
4672: <tr>
4673: <td>C source file</td>
4674: <td>
4675: <pre class="programlisting">
4676: #if defined(__NetBSD__)
4677: # include <sys/event.h>
4678: #endif
4679: </pre>
4680: </td>
4681: <td>
4682: <pre class="programlisting">
4683: #if defined(HAVE_SYS_EVENT_H)
4684: # include <sys/event.h>
4685: #endif
4686: </pre>
4687: </td>
4688: </tr>
4689: <tr>
4690: <td>C source file</td>
4691: <td>
4692: <pre class="programlisting">
4693: int
4694: monitor_file(...)
4695: {
4696: #if defined(__NetBSD__)
4697: int fd = kqueue();
4698: ...
4699: #else
4700: ...
4701: #endif
4702: }
4703: </pre>
4704: </td>
4705: <td>
4706: <pre class="programlisting">
4707: int
4708: monitor_file(...)
4709: {
4710: #if defined(HAVE_KQUEUE)
4711: int fd = kqueue();
4712: ...
4713: #else
4714: ...
4715: #endif
4716: }
4717: </pre>
4718: </td>
4719: </tr>
4720: </tbody>
4721: </table></div>
4722: </div>
4723: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
4724: packager-friendly software</em></span> article (<a href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
4725: 1</a>, <a href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
4726: 2</a>). It summarizes multiple details on how to make
4727: software easier to package; all the suggestions in it were
4728: collected from our experience in pkgsrc work, so they are possibly
4729: helpful when creating patches too.</p>
4730: </div>
4731: <div class="sect2" lang="en">
4732: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 4733: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 4734: <p>Always, always, <span class="strong"><strong>always</strong></span>
4735: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4736: improvements you do to a package to the mainstream developers.
4737: This is the only way to get their attention on portability issues
4738: and to ensure that future versions can be built out-of-the box on
4739: NetBSD. Furthermore, any user that gets newer distfiles will get
4740: the fixes straight from the packaged code.</p>
4741: <p>This generally involves cleaning up the patches
4742: (because sometimes the patches that are
4743: added to pkgsrc are quick hacks), filling bug reports in the
4744: appropriate trackers for the projects and working with the
4745: mainstream authors to accept your changes. It is
4746: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4747: the packages in pkgsrc are kept simple and thus further changes
4748: can be done without much hassle.</p>
4749: <p>Support the idea of free software!</p>
4750: </div>
4751: </div>
4752: <div class="sect1" lang="en">
4753: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 4754: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.1 dsieger 4755: <div class="variablelist"><dl>
4756: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
4757: <dd><p>A multi-line description of the piece of software. This should include
4758: any credits where they are due. Please bear in mind that others do not
4759: share your sense of humour (or spelling idiosyncrasies), and that others
4760: will read everything that you write here.</p></dd>
4761: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
4762: <dd><p>This file governs the files that are installed on your
4763: system: all the binaries, manual pages, etc. There are other
4764: directives which may be entered in this file, to control the
4765: creation and deletion of directories, and the location of
1.6 ! rillig 4766: inserted files. See <a href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.1 dsieger 4767: information.</p></dd>
4768: </dl></div>
4769: </div>
4770: <div class="sect1" lang="en">
4771: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 4772: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.1 dsieger 4773: <div class="sect2" lang="en">
4774: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 4775: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.1 dsieger 4776: <div class="variablelist"><dl>
4777: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
4778: <dd><p>This shell script is invoked twice by <a 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>.
4779: First time after package extraction and before files are
4780: moved in place, the second time after the files to install
4781: are moved in place. This can be used to do any custom
4782: procedures not possible with @exec commands in
4783: <code class="filename">PLIST</code>. See <a 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
1.6 ! rillig 4784: <a 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 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.1 dsieger 4785: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
4786: <dd><p>This script is executed before and after any files are removed. It is
4787: this script's responsibility to clean up any additional messy details
4788: around the package's installation, since all pkg_delete knows is how to
4789: delete the files created in the original distribution.
4790: See <a 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>
4791: and <a 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>
4792: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4793: <dd>
4794: <p>This file is displayed after installation of the package.
4795: Useful for things like legal notices on almost-free
4796: software and hints for updating config files after
4797: installing modules for apache, PHP etc.
4798: Please note that you can modify variables in it easily by using
4799: <code class="varname">MESSAGE_SUBST</code> in the package's
4800: <code class="filename">Makefile</code>:</p>
4801: <pre class="programlisting">
4802: MESSAGE_SUBST+= SOMEVAR="somevalue"
4803: </pre>
4804: <p>replaces "${SOMEVAR}" with “<span class="quote">somevalue</span>” in
4805: <code class="filename">MESSAGE</code>. By default, substitution is
4806: performed for <code class="varname">PKGNAME</code>,
4807: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4808: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4809: <code class="varname">X11BASE</code>,
4810: <code class="varname">PKG_SYSCONFDIR</code>,
4811: <code class="varname">ROOT_GROUP</code>, and
4812: <code class="varname">ROOT_GROUP</code>.</p>
4813: <p>You can display a different or additional files by
4814: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4815: default is <code class="filename">MESSAGE</code>, if the file
4816: exists.</p>
4817: </dd>
4818: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4819: <dd><p>FIXME: There is no documentation on the
4820: alternatives framework.</p></dd>
4821: </dl></div>
4822: </div>
4823: <div class="sect2" lang="en">
4824: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 4825: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.1 dsieger 4826: <div class="variablelist"><dl>
4827: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4828: <dd><p>This file contains arbitrary things that could
4829: also go into a <code class="filename">Makefile</code>, but its purpose is
4830: to be used by more than one package. This file should only be
4831: used when the packages that will use the file are known in
4832: advance. For other purposes it is often better to write a
4833: <code class="filename">*.mk</code> file and give it a good name that
4834: describes what it does.</p></dd>
4835: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4836: <dd><p>This file contains the dependency information
1.6 ! rillig 4837: for the buildlink3 framework (see <a href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
1.1 dsieger 4838: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4839: <dd><p>This file contains workarounds for compiler bugs
4840: and similar things. It is included automatically by the pkgsrc
4841: infrastructure, so you don't need an extra
4842: <code class="literal">.include</code> line for
4843: it.</p></dd>
4844: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4845: <dd><p>This file contains the code for the
1.6 ! rillig 4846: package-specific options (see <a href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.1 dsieger 4847: selected by the user. If a package has only one or two options,
4848: it is equally acceptable to put the code directly into the
4849: <code class="filename">Makefile</code>.</p></dd>
4850: </dl></div>
4851: </div>
4852: <div class="sect2" lang="en">
4853: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 4854: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.1 dsieger 4855: <div class="variablelist"><dl>
4856: <dt><span class="term"><code class="filename">README*</code></span></dt>
4857: <dd><p>These files do not take place in the creation of
4858: a package and thus are purely informative to the package
4859: developer.</p></dd>
4860: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4861: <dd><p>This file contains things that need to be done
4862: to make the package even
4863: better.</p></dd>
4864: </dl></div>
4865: </div>
4866: </div>
4867: <div class="sect1" lang="en">
4868: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 4869: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1 dsieger 4870: </h2></div></div></div>
4871: <p>When you type <span><strong class="command">make</strong></span>, the distribution files are
4872: unpacked into the directory denoted by
4873: <code class="varname">WRKDIR</code>. It can be removed by running
4874: <span><strong class="command">make clean</strong></span>. Besides the sources, this
4875: directory is also used to keep various timestamp files.
4876: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4877: The default is <code class="filename">${.CURDIR}/work</code>
4878: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4879: if <code class="varname">OBJMACHINE</code> is set.</p>
4880: </div>
4881: <div class="sect1" lang="en">
4882: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 4883: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1 dsieger 4884: </h2></div></div></div>
4885: <p>If you have any files that you wish to be placed in the package prior
4886: to configuration or building, you could place these files here and use
4887: a <span><strong class="command">${CP}</strong></span> command in the
4888: “<span class="quote">pre-configure</span>” target to achieve
4889: this. Alternatively, you could simply diff the file against
4890: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4891: the creation of this file.</p>
4892: <p>If you want to share files in this way with other
4893: packages, set the <code class="varname">FILESDIR</code> variable to point
4894: to the other package's <code class="filename">files</code> directory,
4895: e.g.:</p>
4896: <pre class="programlisting">
4897: FILESDIR=${.CURDIR}/../xemacs/files
4898: </pre>
4899: </div>
4900: </div>
4901: <div class="chapter" lang="en">
4902: <div class="titlepage"><div><div><h2 class="title">
1.6 ! rillig 4903: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 4904: <div class="toc">
4905: <p><b>Table of Contents</b></p>
4906: <dl>
1.6 ! rillig 4907: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
! 4908: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
! 4909: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
! 4910: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
! 4911: <dd><dl>
! 4912: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
! 4913: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
! 4914: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
! 4915: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
! 4916: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.1 dsieger 4917: </dl></dd>
4918: </dl>
4919: </div>
4920: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4921: each of which forms a well-defined part of the pkgsrc system. Using
4922: the <a 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
4923: like pkgsrc requires some discipline to keep the code correct and
4924: understandable.</p>
4925: <p>The basic ingredients for <code class="filename">Makefile</code>
4926: programming are variables (which are actually macros) and shell
4927: commands. Among these shell commands may even be more complex ones
4928: like <a 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
4929: as intended it is necessary to quote all variables correctly when they
4930: are used.</p>
4931: <p>This chapter describes some patterns, that appear quite often in
4932: <code class="filename">Makefile</code>s, including the pitfalls that come along
4933: with them.</p>
4934: <div class="sect1" lang="en">
4935: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 4936: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.1 dsieger 4937: <div class="itemizedlist"><ul type="disc"><li>
4938: <p>When you are creating a file as a
4939: target of a rule, always write the data to a temporary file first
4940: and finally rename that file. Otherwise there might occur an error
4941: in the middle of generating the file, and when the user runs
4942: <a 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
4943: regenerated properly. Example:</p>
4944: <pre class="programlisting">
4945: wrong:
4946: @echo "line 1" > ${.TARGET}
4947: @echo "line 2" >> ${.TARGET}
4948: @false
4949:
4950: correct:
4951: @echo "line 1" > ${.TARGET}.tmp
4952: @echo "line 2" >> ${.TARGET}.tmp
4953: @false
4954: @mv ${.TARGET}.tmp ${.TARGET}
4955: </pre>
4956: <p>When you run <span><strong class="command">make wrong</strong></span> twice, the file
4957: <code class="filename">wrong</code> will exist, although there was an error
4958: message in the first run. On the other hand, running <span><strong class="command">make
4959: correct</strong></span> gives an error message twice, as expected.</p>
4960: <p>You might remember that <a 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
4961: <code class="literal">${.TARGET}</code> in case of error, but this only
4962: happens when it is interrupted, for example by pressing
4963: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
4964: when one of the commands fails (like <a 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>
4965: </li></ul></div>
4966: </div>
4967: <div class="sect1" lang="en">
4968: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 4969: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1 dsieger 4970: <p><code class="filename">Makefile</code> variables contain strings that
4971: can be processed using the five operators ``='', ``+='', ``?='',
4972: ``:='', and ``!='', which are described in the <a 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
4973: page.</p>
4974: <p>When a variable's value is parsed from a
4975: <code class="filename">Makefile</code>, the hash character ``#'' and the
4976: backslash character ``\'' are handled specially. If a backslash is
4977: followed by a newline, any whitespace immediately in front of the
4978: backslash, the backslash, the newline, and any whitespace
4979: immediately behind the newline are replaced with a single space. A
4980: backslash character and an immediately following hash character are
4981: replaced with a single hash character. Otherwise, the backslash is
4982: passed as is. In a variable assignment, any hash character that is
4983: not preceded by a backslash starts a comment that continues upto the
4984: end of the logical line.</p>
4985: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4986: the only way to create a variable consisting of a single backslash
4987: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4988: <p>So far for defining variables. The other thing you can do with
4989: variables is evaluating them. A variable is evaluated when it is
4990: part of the right side of the ``:='' or the ``!='' operator, or
4991: directly before executing a shell command which the variable is part
4992: of. In all other cases, <a 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
4993: is, variables are not evaluated until there's no other way. The
4994: ``modifiers'' mentioned in the man page also evaluate the
4995: variable.</p>
4996: <p>Some of the modifiers split the string into words and then
4997: operate on the words, others operate on the string as a whole. When
4998: a string is split into words, it is split as you would expect
4999: it from <a 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.6 ! rillig 5000: <p>No rule without exception—the <span><strong class="command">.for</strong></span>
1.1 dsieger 5001: loop does not follow the shell quoting rules but splits at sequences
5002: of whitespace.</p>
5003: <p>There are several types of variables that should be handled
5004: differently. Strings and two types of lists.</p>
5005: <div class="itemizedlist"><ul type="disc">
5006: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
5007: characters. Nevertheless, you should restrict yourself to only
5008: using printable characters. Examples are
5009: <code class="varname">PREFIX</code> and
5010: <code class="varname">COMMENT</code>.</p></li>
5011: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
5012: are never exported to any shell command. Their elements are
5013: separated by whitespace. Therefore, the elements themselves cannot
5014: have embedded whitespace. Any other characters are allowed.
5015: Internal lists can be used in <span><strong class="command">.for</strong></span> loops.
5016: Examples are <code class="varname">DEPENDS</code> and
5017: <code class="varname">BUILD_DEPENDS</code>.</p></li>
5018: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
5019: may be exported to a shell command. Their elements can contain any
5020: characters, including whitespace. That's why they cannot be used
5021: in <span><strong class="command">.for</strong></span> loops. Examples are
5022: <code class="varname">DISTFILES</code> and
5023: <code class="varname">MASTER_SITES</code>.</p></li>
5024: </ul></div>
5025: <div class="sect2" lang="en">
5026: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 5027: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.1 dsieger 5028: <div class="itemizedlist"><ul type="disc">
5029: <li><p>All variable names starting with an underscore
5030: are reserved for use by the pkgsrc infrastructure. They shall
5031: not be used by package
5032: <code class="filename">Makefile</code>s.</p></li>
5033: <li><p>In <span><strong class="command">.for</strong></span> loops you should use
5034: lowercase variable names for the iteration
5035: variables.</p></li>
5036: <li><p>All list variables should have a ``plural''
5037: name, e.g. <code class="varname">PKG_OPTIONS</code> or
5038: <code class="varname">DISTFILES</code>.</p></li>
5039: </ul></div>
5040: </div>
5041: </div>
5042: <div class="sect1" lang="en">
5043: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 5044: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.1 dsieger 5045: <p>This section presents you with some code snippets you should
5046: use in your own code. If you don't find anything appropriate here,
5047: you should test your code and add it here.</p>
5048: <div class="sect2" lang="en">
5049: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 5050: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.1 dsieger 5051: <pre class="programlisting">
5052: STRING= foo * bar `date`
5053: INT_LIST= # empty
5054: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
5055: EXT_LIST= # empty
5056: ANOTHER_EXT_LIST= a=b c=d
5057:
5058: INT_LIST+= ${STRING} # 1
5059: INT_LIST+= ${ANOTHER_INT_LIST} # 2
5060: EXT_LIST+= ${STRING:Q} # 3
5061: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
5062: </pre>
5063: <p>When you add a string to an external list (example 3), it
5064: must be quoted. In all other cases, you must not add a quoting
5065: level. You must not merge internal and external lists, unless you
5066: are sure that all entries are correctly interpreted in both
5067: lists.</p>
5068: </div>
5069: <div class="sect2" lang="en">
5070: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 5071: <a name="converting-internal-to-external"></a>12.3.2. Converting an internal list into an external list</h3></div></div></div>
1.1 dsieger 5072: <pre class="programlisting">
5073: EXT_LIST= # empty
5074: .for i in ${INT_LIST}
5075: EXT_LIST+= ${i:Q}""
5076: .endfor
5077: </pre>
5078: <p>This code converts the internal list
5079: <code class="varname">INT_LIST</code> into the external list
5080: <code class="varname">EXT_LIST</code>. As the elements of an internal list
5081: are unquoted they must be quoted here. The reason for appending
5082: <code class="varname">""</code> is explained below.</p>
5083: </div>
5084: <div class="sect2" lang="en">
5085: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 5086: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.1 dsieger 5087: <p>Sometimes you may want to print an arbitrary string. There
5088: are many ways to get it wrong and only few that can handle every
5089: nastiness.</p>
5090: <pre class="programlisting">
5091: STRING= foo bar < > * `date` $$HOME ' "
5092: EXT_LIST= string=${STRING:Q} x=second\ item
5093:
5094: all:
5095: echo ${STRING} # 1
5096: echo "${STRING}" # 2
5097: echo "${STRING:Q}" # 3
5098: echo ${STRING:Q} # 4
5099: echo x${STRING:Q} | sed 1s,.,, # 5
5100: printf "%s\\n" ${STRING:Q}"" # 6
5101: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
5102: </pre>
5103: <p>Example 1 leads to a syntax error in the shell, as the
5104: characters are just copied.</p>
5105: <p>Example 2 leads to a syntax error too, and if you leave out
5106: the last " character from <code class="varname">${STRING}</code>,
5107: <a 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
5108: variable would be evaluated, too.</p>
5109: <p>Example 3 outputs each space character preceded by a
5110: backslash (or not), depending on the implementation of the
5111: <a 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>
5112: <p>Example 4 handles correctly every string that does not start
5113: with a dash. In that case, the result depends on the
5114: implementation of the <a 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
5115: guarantee that your input does not start with a dash, this form is
5116: appropriate.</p>
5117: <p>Example 5 handles even the case of a leading dash
5118: correctly.</p>
5119: <p>Example 6 also works with every string and is the
5120: light-weight solution, since it does not involve a pipe, which has
5121: its own problems.</p>
5122: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
5123: because the quoting has already been done when adding elements to
5124: the list.</p>
5125: <p>As internal lists shall not be passed to the shell, there is
5126: no example for it.</p>
5127: </div>
5128: <div class="sect2" lang="en">
5129: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 5130: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.1 dsieger 5131: <p>There are many possible sources of wrongly quoted variables.
5132: This section lists some of the commonly known ones.</p>
5133: <div class="itemizedlist"><ul type="disc">
5134: <li>
5135: <p>Whenever you use the value of a list, think
5136: about what happens to leading or trailing whitespace. If the
5137: list is a well-formed shell expression, you can apply the
5138: <code class="varname">:M*</code> modifier to strip leading and trailing
5139: whitespace from each word. The <code class="varname">:M</code> operator
5140: first splits its argument according to the rules of the shell,
5141: and then creates a new list consisting of all words that match
5142: the shell glob expression <code class="varname">*</code>, that is: all.
5143: One class of situations where this is needed is when adding a
5144: variable like <code class="varname">CPPFLAGS</code> to
5145: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
5146: invokes other configure scripts, it strips the leading and
5147: trailing whitespace from the variable and then passes it to the
5148: other configure scripts. But these configure scripts expect the
5149: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
5150: the parent <code class="varname">CPPFLAGS</code>. That's why we better
5151: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
5152: here is how we do it:</p>
5153: <pre class="programlisting">
5154: CPPFLAGS= # empty
5155: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
5156: CPPFLAGS+= ${MY_CPPFLAGS}
5157:
5158: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
5159:
5160: all:
5161: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5162: echo x${CONFIGURE_ARGS}x # properly trimmed
5163: </pre>
5164: </li>
5165: <li><p>The example above contains one bug: The
5166: <code class="varname">${PREFIX}</code> is a properly quoted shell
5167: expression, but there is the C compiler after it, which also
5168: expects a properly quoted string (this time in C syntax). The
5169: version above is therefore only correct if
5170: <code class="varname">${PREFIX}</code> does not have embedded backslashes
5171: or double quotes. If you want to allow these, you have to add
5172: another layer of quoting to each variable that is used as a C
5173: string literal. You cannot use the <code class="varname">:Q</code>
5174: operator for it, as this operator only works for the
5175: shell.</p></li>
5176: <li>
5177: <p>Whenever a variable can be empty, the
5178: <code class="varname">:Q</code> operator can have surprising results. Here
5179: are two completely different cases which can be solved with the
5180: same trick.</p>
5181: <pre class="programlisting">
5182: EMPTY= # empty
5183: empty_test:
5184: for i in a ${EMPTY:Q} c; do \
5185: echo "$$i"; \
5186: done
5187:
5188: for_test:
5189: .for i in a:\ a:\test.txt
5190: echo ${i:Q}
5191: echo "foo"
5192: .endfor
5193: </pre>
5194: <p>The first example will only print two of the three lines
5195: we might have expected. This is because
5196: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5197: the shell cannot see. The workaround is to write
5198: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5199: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5200: -f ${FNAME:Q}</code> (both of these are wrong).</p>
5201: <p>The second example will only print three lines instead of
5202: four. The first line looks like <code class="varname">a:\ echo foo</code>.
5203: This is because the backslash of the value
5204: <code class="varname">a:\</code> is interpreted as a line-continuation by
5205: <a 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
5206: <a 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
5207: <code class="varname">${i:Q}""</code>.</p>
5208: </li>
5209: </ul></div>
5210: </div>
5211: <div class="sect2" lang="en">
5212: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 5213: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.1 dsieger 5214: <p>The pkgsrc bmake program does not handle the following
5215: assignment correctly. In case <code class="varname">_othervar_</code>
5216: contains a ``-'' character, one of the closing braces is included
5217: in <code class="varname">${VAR}</code> after this code executes.</p>
5218: <pre class="programlisting">
5219: VAR:= ${VAR:N${_othervar_:C/-//}}
5220: </pre>
5221: <p>For a more complex code snippet and a workaround, see the
5222: 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
5223: <code class="varname">bug1</code>.</p>
5224: </div>
5225: </div>
5226: </div>
5227: <div class="chapter" lang="en">
5228: <div class="titlepage"><div><div><h2 class="title">
1.6 ! rillig 5229: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1 dsieger 5230: <div class="toc">
5231: <p><b>Table of Contents</b></p>
5232: <dl>
1.6 ! rillig 5233: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
! 5234: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
! 5235: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
! 5236: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
! 5237: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
! 5238: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
! 5239: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
! 5240: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.1 dsieger 5241: </dl>
5242: </div>
5243: <p>The <code class="filename">PLIST</code> file contains a package's
5244: “<span class="quote">packing list</span>”, i.e. a list of files that belong to
5245: the package (relative to the <code class="filename">${PREFIX}</code>
5246: directory it's been installed in) plus some additional statements
5247: - see the <a 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.
5248: This chapter addresses some issues that need attention when
5249: dealing with the <code class="filename">PLIST</code> file (or files, see
5250: below!).</p>
5251: <div class="sect1" lang="en">
5252: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 5253: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1 dsieger 5254: <p>Be sure to add a RCS ID line as the first thing in any
5255: <code class="filename">PLIST</code> file you write:</p>
5256: <pre class="programlisting">
5257: @comment $NetBSD$
5258: </pre>
5259: </div>
5260: <div class="sect1" lang="en">
5261: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 5262: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.1 dsieger 5263: <p>You can use the <span><strong class="command">make print-PLIST</strong></span> command
5264: to output a PLIST that matches any new files since the package
1.6 ! rillig 5265: was extracted. See <a href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a> for
1.1 dsieger 5266: more information on this target.</p>
5267: </div>
5268: <div class="sect1" lang="en">
5269: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 5270: <a name="print-PLIST"></a>13.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span>
1.1 dsieger 5271: </h2></div></div></div>
5272: <p>If you have used any of the *-dirs packages, as explained in
1.6 ! rillig 5273: <a href="#faq.common-dirs" title="13.8. Sharing directories between packages">Section 13.8, “Sharing directories between packages”</a>, you may have noticed that
1.1 dsieger 5274: <span><strong class="command">make print-PLIST</strong></span> outputs a set of
5275: <code class="varname">@comment</code>s instead of real
5276: <code class="varname">@dirrm</code> lines. You can also do this for
5277: specific directories and files, so that the results of that
5278: command are very close to reality. This helps <span class="emphasis"><em>a
5279: lot</em></span> during the update of packages.</p>
5280: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5281: of AWK patterns and actions that are used to filter the output of
5282: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5283: scripting you like to it, but be careful with quoting.</p>
5284: <p>For example, to get all files inside the
5285: <code class="filename">libdata/foo</code> directory removed from the
5286: resulting PLIST:</p>
5287: <pre class="programlisting">
5288: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
5289: </pre>
5290: <p>And to get all the <code class="varname">@dirrm</code> lines referring
5291: to a specific (shared) directory converted to
5292: <code class="varname">@comment</code>s:</p>
5293: <pre class="programlisting">
5294: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
5295: </pre>
5296: </div>
5297: <div class="sect1" lang="en">
5298: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 5299: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1 dsieger 5300: <p>A number of variables are substituted automatically in
5301: PLISTs when a package is installed on a system. This includes the
5302: following variables:</p>
5303: <div class="variablelist"><dl>
5304: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5305: <dd>
5306: <p>Some packages like emacs and perl embed information
5307: about which architecture they were built on into the
5308: pathnames where they install their files. To handle this
5309: case, PLIST will be preprocessed before actually used, and
5310: the symbol
5311: “<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>” will be
5312: replaced by what <span><strong class="command">uname -p</strong></span> gives. The
5313: same is done if the string
5314: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5315: PLIST somewhere - use this on packages that have GNU
5316: autoconf-created configure scripts.</p>
5317: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
5318: <h3 class="title">Legacy note</h3>
5319: <p>There used to be a symbol
5320: “<span class="quote"><code class="varname">$ARCH</code></span>” that
5321: was replaced by the output of <span><strong class="command">uname
5322: -m</strong></span>, but that's no longer supported and has
5323: been removed.</p>
5324: </div>
5325: </dd>
5326: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5327: <dd>
5328: <p>Some packages want to embed the OS name and version
5329: into some paths. To do this, use these variables in the
5330: <code class="filename">PLIST</code>:
5331: </p>
5332: <div class="itemizedlist"><ul type="disc">
5333: <li><p><code class="varname">${OPSYS}</code> - output of “<span class="quote"><span><strong class="command">uname -s</strong></span></span>”</p></li>
5334: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. “<span class="quote">solaris</span>”)</p></li>
5335: <li><p><code class="varname">${OS_VERSION}</code> - “<span class="quote"><span><strong class="command">uname -r</strong></span></span>”</p></li>
5336: </ul></div>
5337: </dd>
5338: </dl></div>
5339: <p>For a complete list of values which are replaced by
5340: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5341: search for <code class="varname">PLIST_SUBST</code>).</p>
5342: <p>If you want to change other variables not listed above, you
5343: can add variables and their expansions to this variable in the
1.6 ! rillig 5344: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a href="#components.optional" title="11.5. Optional files">Section 11.5, “Optional files”</a>):</p>
1.1 dsieger 5345: <pre class="programlisting">
5346: PLIST_SUBST+= SOMEVAR="somevalue"
5347: </pre>
5348: <p>This replaces all occurrences of “<span class="quote">${SOMEVAR}</span>”
5349: in the <code class="filename">PLIST</code> with
5350: “<span class="quote">somevalue</span>”.</p>
5351: </div>
5352: <div class="sect1" lang="en">
5353: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 5354: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1 dsieger 5355: <p>Man pages should be installed in compressed form if
5356: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5357: and uncompressed otherwise. To handle this in the
5358: <code class="filename">PLIST</code> file, the suffix “<span class="quote">.gz</span>” is
5359: appended/removed automatically for man pages according to
5360: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5361: or not, see above for details. This modification of the
5362: <code class="filename">PLIST</code> file is done on a copy of it, not
5363: <code class="filename">PLIST</code> itself.</p>
5364: </div>
5365: <div class="sect1" lang="en">
5366: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 5367: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1 dsieger 5368: </h2></div></div></div>
5369: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
5370: in generating the binary package, set the variable
5371: <code class="varname">PLIST_SRC</code> to the names of that file(s).
5372: The files are later concatenated using <a 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
5373: important. The default for <code class="varname">PLIST_SRC</code> is
5374: <code class="filename">${PKGDIR}/PLIST</code>.</p>
5375: </div>
5376: <div class="sect1" lang="en">
5377: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 5378: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1 dsieger 5379: <p>Some packages decide to install a different set of files based on
5380: the operating system being used. These differences can be
5381: automatically handled by using the following files:</p>
5382: <div class="itemizedlist"><ul type="disc">
5383: <li><p><code class="filename">PLIST.common</code></p></li>
5384: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5385: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5386: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5387: <li><p><code class="filename">PLIST.common_end</code></p></li>
5388: </ul></div>
5389: </div>
5390: <div class="sect1" lang="en">
5391: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 5392: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.1 dsieger 5393: <p>A “<span class="quote">shared directory</span>” is a directory where
5394: multiple (and unrelated) packages install files. These
5395: directories are problematic because you have to add special tricks
5396: in the PLIST to conditionally remove them, or have some
5397: centralized package handle them.</p>
5398: <p>Within pkgsrc, you'll find both approaches. If a directory
5399: is shared by a few unrelated packages, it's often not worth to add
5400: an extra package to remove it. Therefore, one simply does:</p>
5401: <pre class="programlisting">
5402: @unexec ${RMDIR} %D/path/to/shared/directory 2>/dev/null || ${TRUE}
5403: </pre>
5404: <p>in the PLISTs of all affected packages, instead of the
5405: regular "@dirrm" line.</p>
5406: <p>However, if the directory is shared across many packages, two
5407: different solutions are available:</p>
5408: <div class="orderedlist"><ol type="1">
5409: <li><p>If the packages have a common dependency, the directory
5410: can be removed in that. For example, see
5411: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/scrollkeeper/README.html" target="_top"><code class="filename">textproc/scrollkeeper</code></a>, which
5412: removes the shared directory
5413: <code class="filename">share/omf</code>.</p></li>
5414: <li><p>If the packages using the directory are not related at
5415: all (they have no common dependencies), a *-dirs package is
5416: used.</p></li>
5417: </ol></div>
5418: <p>From now on, we'll discuss the second solution. To get an
5419: idea of the *-dirs packages available, issue:</p>
5420: <pre class="programlisting">
5421: <code class="prompt">%</code> cd .../pkgsrc
5422: <code class="prompt">%</code> ls -d */*-dirs
5423: </pre>
5424: <p>Their use from other packages is very simple. The
5425: <code class="varname">USE_DIRS</code> variable takes a list of package names
5426: (without the “<span class="quote">-dirs</span>” part) together with the required
5427: version number (always pick the latest one when writing new
5428: packages).</p>
5429: <p>For example, if a package installs files under
5430: <code class="filename">share/applications</code>, it should have the
5431: following line in it:</p>
5432: <pre class="programlisting">
5433: USE_DIRS+= xdg-1.1
5434: </pre>
5435: <p>After regenerating the PLIST using <span><strong class="command">make
5436: print-PLIST</strong></span>, you should get the right (commented out)
5437: lines.</p>
5438: <p>Note that even if your package is using
5439: <code class="filename">$X11BASE</code>, it must not depend on the
5440: *-x11-dirs packages. Just specify the name without that part and
5441: pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
5442: care of it.</p>
5443: </div>
5444: </div>
5445: <div class="chapter" lang="en">
5446: <div class="titlepage"><div><div><h2 class="title">
1.6 ! rillig 5447: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1 dsieger 5448: <div class="toc">
5449: <p><b>Table of Contents</b></p>
5450: <dl>
1.6 ! rillig 5451: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
! 5452: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 5453: <dd><dl>
1.6 ! rillig 5454: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
! 5455: <dt><span class="sect2"><a href="#updating-buildlink-depends">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</a></span></dt>
1.1 dsieger 5456: </dl></dd>
1.6 ! rillig 5457: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.1 dsieger 5458: <dd><dl>
1.6 ! rillig 5459: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
! 5460: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.1 dsieger 5461: </dl></dd>
5462: </dl>
5463: </div>
5464: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
5465: are seen by a package's configure and build processes. This is implemented
5466: in a two step process:</p>
5467: <div class="orderedlist"><ol type="1">
5468: <li><p>Symlink headers and libraries for dependencies into
5469: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5470: of <code class="varname">WRKDIR</code>.</p></li>
5471: <li><p>Create wrapper scripts that are used in place of the normal compiler
5472: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5473: <code class="option">-L${LOCALBASE}/lib</code> into references to
5474: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5475: native compiler on some operating systems look like GCC, so that
5476: packages that expect GCC won't require modifications to build with
5477: those native compilers.</p></li>
5478: </ol></div>
5479: <p>This normalizes the environment in which a package is built so that the
5480: package may be built consistently despite what other software may be
5481: installed. Please note that the normal system header and library paths,
5482: e.g. <code class="filename">/usr/include</code>,
5483: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5484: designed to insulate the package build from non-system-supplied
5485: software.</p>
5486: <div class="sect1" lang="en">
5487: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 5488: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1 dsieger 5489: <p>The process of converting packages to use the buildlink3
5490: framework (“<span class="quote">bl3ifying</span>”) is fairly straightforward.
5491: The things to keep in mind are:</p>
5492: <div class="orderedlist"><ol type="1">
5493: <li><p>Ensure that the build always calls the wrapper scripts
5494: instead of the actual toolchain. Some packages are tricky,
5495: and the only way to know for sure is the check
5496: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5497: wrappers are being invoked.</p></li>
5498: <li><p>Don't override <code class="varname">PREFIX</code> from within
5499: the package Makefile, e.g. Java VMs, standalone shells,
5500: etc., because the code to symlink files into
5501: <code class="filename">${BUILDLINK_DIR}</code> looks for files
5502: relative to “<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”.
5503: </p></li>
5504: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
5505: <code class="filename">buildlink3.mk</code> files that you list in a
5506: package's Makefile are added as dependencies for that package.
5507: </p></li>
5508: </ol></div>
5509: <p>If a dependency on a particular package is required for its libraries and
5510: headers, then we replace:</p>
5511: <pre class="programlisting">
5512: DEPENDS+= foo>=1.1.0:../../category/foo
5513: </pre>
5514: <p>with</p>
5515: <pre class="programlisting">
5516: .include "../../category/foo/buildlink3.mk"
5517: </pre>
5518: <p>The buildlink3.mk files usually define the required dependencies.
5519: If you need a newer version of the dependency when using buildlink3.mk
5520: files, then you can define it in your Makefile; for example:</p>
5521: <pre class="programlisting">
5522: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5523: .include "../../category/foo/buildlink3.mk"
5524: </pre>
5525: <p>There are several <code class="filename">buildlink3.mk</code>
5526: files in <code class="filename">pkgsrc/mk</code>
5527: that handle special package issues:</p>
5528: <div class="itemizedlist"><ul type="disc">
5529: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
5530: the native or a pkgsrc Berkeley DB implementation based on
5531: the values of <code class="varname">BDB_ACCEPTED</code> and
5532: <code class="varname">BDB_DEFAULT</code>.</p></li>
5533: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
5534: comes with neither Curses nor NCurses, this will take care
5535: 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>
5536: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
5537: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5538: adding a dependency on Heimdal or MIT-krb5 for packages that
5539: require a Kerberos 5 implementation.</p></li>
5540: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
5541: system-provided Motif installation or adds a dependency on
5542: <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
5543: <code class="varname">MOTIF_TYPE</code> to “<span class="quote">dt</span>”,
5544: “<span class="quote">lesstif</span>”, or “<span class="quote">openmotif</span>” to choose
5545: which Motif version will be used.</p></li>
5546: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
5547: variables that may be used by packages that use the
5548: Open Sound System (OSS) API.</p></li>
5549: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
5550: either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
5551: the file for more information.</p></li>
5552: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
5553: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
5554: 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>
5555: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
5556: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5557: library.</p></li>
5558: </ul></div>
5559: <p>The comments in those <code class="filename">buildlink3.mk</code>
5560: files provide a more complete
5561: description of how to use them properly.</p>
5562: </div>
5563: <div class="sect1" lang="en">
5564: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 5565: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.1 dsieger 5566: <p>A package's <code class="filename">buildlink3.mk</code> file is
5567: included by Makefiles to indicate the need to compile and link
5568: against header files and libraries provided by the package. A
5569: <code class="filename">buildlink3.mk</code> file should always provide
5570: enough information to add the correct type of dependency
5571: relationship and include any other
5572: <code class="filename">buildlink3.mk</code> files that it needs to find
5573: headers and libraries that it needs in turn.</p>
5574: <p>To generate an initial <code class="filename">buildlink3.mk</code>
5575: 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>
5576: package is highly recommended. For most packages, the following
5577: command will generate a good starting point for
5578: <code class="filename">buildlink3.mk</code> files:</p>
5579: <pre class="screen">
5580: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5581: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5582: </pre>
5583: <div class="sect2" lang="en">
5584: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 5585: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1 dsieger 5586: <p>The following real-life example
5587: <code class="filename">buildlink3.mk</code> is taken
5588: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
5589: <pre class="programlisting">
5590: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
5591:
5592: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH}+
5593: TIFF_BUILDLINK3_MK:= ${TIFF_BUILDLINK3_MK}+
5594:
5595: .if ${BUILDLINK_DEPTH} == "+"
5596: BUILDLINK_DEPENDS+= tiff
5597: .endif
5598:
5599: BUILDLINK_PACKAGES:= ${BUILDLINK_PACKAGES:Ntiff}
5600: BUILDLINK_PACKAGES+= tiff
5601:
5602: .if ${TIFF_BUILDLINK3_MK} == "+"
5603: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5604: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
5605: .endif # TIFF_BUILDLINK3_MK
5606:
5607: .include "../../devel/zlib/buildlink3.mk"
5608: .include "../../graphics/jpeg/buildlink3.mk"
5609:
5610: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH:S/+$//}
5611: </pre>
5612: <p>The header and footer manipulate
5613: <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
5614: <code class="filename">buildlink3.mk</code> files and is used to track
5615: at what depth we are including
5616: <code class="filename">buildlink3.mk</code> files.</p>
5617: <p>The first section controls if the dependency on
5618: <em class="replaceable"><code>pkg</code></em> is added.
5619: <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
5620: packages for which dependencies are added by
5621: buildlink3.</p>
5622: <p>The second section advises pkgsrc that the
5623: <code class="filename">buildlink3.mk</code> file for
5624: <em class="replaceable"><code>pkg</code></em> has been included at some point.
5625: <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
5626: packages for which <code class="filename">buildlink3.mk</code> files
5627: have been included. It must <span class="emphasis"><em>always</em></span> be
5628: appended to within a <code class="filename">buildlink3.mk</code>
5629: file.</p>
5630: <p>The third section is protected from multiple inclusion
5631: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5632: added. Several important variables are set in the section:</p>
5633: <div class="itemizedlist"><ul type="disc">
5634: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5635: is the actual dependency recorded in the installed
5636: package; this should always be set using
5637: <span><strong class="command">+=</strong></span> to ensure that
5638: we're appending to any pre-existing list of values. This
5639: variable should be set to the first version of the
5640: package that had an API change.
5641: </p></li>
5642: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
5643: is the location of the <em class="replaceable"><code>pkg</code></em>
5644: pkgsrc directory.</p></li>
5645: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5646: (not shown above) controls whether we use
5647: <code class="varname">BUILD_DEPENDS</code> or
5648: <code class="varname">DEPENDS</code> to add the dependency on
5649: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5650: selected by setting
5651: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5652: to “<span class="quote">build</span>”. By default, the full dependency is
5653: used.</p></li>
5654: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
5655: and
5656: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5657: (not shown above) are lists of subdirectories of
5658: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5659: to add to the header and library search paths. These
5660: default to “<span class="quote">include</span>” and “<span class="quote">lib</span>”
5661: respectively.</p></li>
5662: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
5663: (not shown above) is the list of preprocessor flags to add
5664: to <code class="varname">CPPFLAGS</code>, which are passed on to the
5665: configure and build phases. The “<span class="quote">-I</span>” option
5666: should be avoided and instead be handled using
5667: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
5668: above.</p></li>
5669: </ul></div>
5670: <p>The following variables are all optionally defined within
5671: this second section (protected against multiple inclusion) and
5672: control which package files are symlinked into
5673: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5674: transformed during the symlinking:</p>
5675: <div class="itemizedlist"><ul type="disc">
5676: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
5677: (not shown above) is a shell glob pattern relative to
5678: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5679: to be symlinked into
5680: <code class="filename">${BUILDLINK_DIR}</code>,
5681: e.g. <code class="filename">include/*.h</code>.</p></li>
5682: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
5683: (not shown above) is a shell pipeline that
5684: outputs to stdout a list of files relative to
5685: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5686: The resulting files are to be symlinked
5687: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5688: this takes the <code class="filename">+CONTENTS</code> of a
5689: <em class="replaceable"><code>pkg</code></em> and filters it through
5690: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
5691: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
5692: (not shown above) is a filter command that filters
5693: <code class="filename">+CONTENTS</code> input into a list of files
5694: relative to
5695: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5696: on stdout. By default for overwrite packages,
5697: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
5698: outputs the contents of the <code class="filename">include</code>
5699: and <code class="filename">lib</code> directories in the package
5700: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
5701: it outputs any libtool archives in
5702: <code class="filename">lib</code> directories.</p></li>
5703: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
5704: (not shown above) is a list of sed arguments used to
5705: transform the name of the source filename into a
5706: destination filename, e.g. <span><strong class="command">-e
5707: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
5708: </ul></div>
5709: <p>The last section includes any
5710: <code class="filename">buildlink3.mk</code> needed for
5711: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5712: Including these <code class="filename">buildlink3.mk</code> files
5713: means that the headers and libraries for these
5714: dependencies are also symlinked into
5715: <code class="filename">${BUILDLINK_DIR}</code>
5716: whenever the <em class="replaceable"><code>pkg</code></em>
5717: <code class="filename">buildlink3.mk</code>
5718: file is included.</p>
5719: </div>
5720: <div class="sect2" lang="en">
5721: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 5722: <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.1 dsieger 5723: <p>The situation that requires increasing the dependency listed in
5724: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5725: after a package update is when the API or interface to the
5726: header files change.</p>
5727: <p>In this case,
5728: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5729: should be adjusted to require at least the new package
5730: version. In some cases, the packages that depend on this new
5731: version may need their <code class="varname">PKGREVISION</code>s
5732: increased and, if they have <code class="filename">buildlink3.mk</code>
5733: files, their
5734: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5735: adjusted, too. This is needed so pkgsrc will require the
5736: correct package dependency and not settle for an older one
5737: when building the source.</p>
5738: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5739: should be increased when the binary interface or sonames
5740: (major number of the library version) of any installed
5741: shared libraries change. This is needed so that binary
5742: packages made using it will require the correct package
5743: dependency and not settle for an older one which will not
5744: contain the necessary shared libraries.</p>
1.6 ! rillig 5745: <p>See <a href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.1 dsieger 5746: more information about dependencies on other packages,
5747: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
5748: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5749: <p>Please take careful consideration before adjusting
5750: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5751: or
5752: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5753: as we don't want to cause unneeded package deletions and
5754: rebuilds. In many cases, new versions of packages work just
5755: fine with older dependencies.</p>
5756: <p>Also it is not needed to set
5757: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5758: when it is identical to
5759: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
5760: </div>
5761: </div>
5762: <div class="sect1" lang="en">
5763: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 5764: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1 dsieger 5765: <p>Some packages in pkgsrc install headers and libraries that
5766: coincide with headers and libraries present in the base system.
5767: Aside from a <code class="filename">buildlink3.mk</code> file, these
5768: packages should also include a <code class="filename">builtin.mk</code>
5769: file that includes the necessary checks to decide whether using
5770: the built-in software or the pkgsrc software is
5771: appropriate.</p>
5772: <p>The only requirements of a builtin.mk file for
5773: <em class="replaceable"><code>pkg</code></em> are:</p>
5774: <div class="orderedlist"><ol type="1">
5775: <li><p>It should set
5776: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5777: to either “<span class="quote">yes</span>” or “<span class="quote">no</span>”
5778: after it is included.</p></li>
5779: <li><p>It should <span class="emphasis"><em>not</em></span> override any
5780: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5781: which is already set before the
5782: <code class="filename">builtin.mk</code> file is included.</p></li>
5783: <li><p>It should be written to allow multiple inclusion. This
5784: is <span class="emphasis"><em>very</em></span> important and takes careful
5785: attention to <code class="filename">Makefile</code> coding.</p></li>
5786: </ol></div>
5787: <div class="sect2" lang="en">
5788: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 5789: <a name="anatomy-of-builtin.mk"></a>14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.1 dsieger 5790: <p>The following is the recommended template for builtin.mk
5791: files:</p>
5792: <pre class="programlisting">
5793: .if !defined(IS_BUILTIN.foo)
5794: #
5795: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5796: # genuinely exists in the system or not.
5797: #
5798: IS_BUILTIN.foo?= no
5799:
5800: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5801: # version can be determined.
5802: #
5803: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5804: BUILTIN_PKG.foo?= foo-1.0
5805: . endif
5806: .endif # IS_BUILTIN.foo
5807:
5808: .if !defined(USE_BUILTIN.foo)
5809: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5810: . if defined(BUILTIN_PKG.foo)
5811: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5812: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5813: USE_BUILTIN.foo!= \
5814: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5815: && ${ECHO} "yes" || ${ECHO} "no"
5816: . endif
5817: . endfor
5818: . endif
5819: .endif # USE_BUILTIN.foo
5820:
5821: CHECK_BUILTIN.foo?= no
5822: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5823: #
5824: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5825: # "yes" or "no".
5826: #
5827: .endif # CHECK_BUILTIN.foo
5828: </pre>
5829: <p>The first section sets
5830: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5831: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5832: in the base system. This should not be a base system software
5833: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
5834: it should only be “<span class="quote">yes</span>” if the actual package is
5835: included as part of the base system. This variable is only
5836: used internally within the <code class="filename">builtin.mk</code>
5837: file.</p>
5838: <p>The second section sets
5839: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5840: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5841: system if it exists (if
5842: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5843: is “<span class="quote">yes</span>”). This variable is only used internally
5844: within the <code class="filename">builtin.mk</code> file.</p>
5845: <p>The third section sets
5846: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5847: and is <span class="emphasis"><em>required</em></span> in all
5848: <code class="filename">builtin.mk</code> files. The code in this
5849: section must make the determination whether the built-in
5850: software is adequate to satisfy the dependencies listed in
5851: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5852: This is typically done by comparing
5853: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5854: against each of the dependencies in
5855: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5856: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5857: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5858: end of the <code class="filename">builtin.mk</code> file. Note that
5859: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5860: may be “<span class="quote">yes</span>” even if
5861: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5862: is “<span class="quote">no</span>” because we may make the determination
5863: that the built-in version of the software is similar enough to
5864: be used as a replacement.</p>
5865: <p>The last section is guarded by
5866: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5867: and includes code that uses the value of
5868: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5869: set in the previous section. This typically includes, e.g.,
5870: adding additional dependency restrictions and listing additional
5871: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5872: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
5873: </div>
5874: <div class="sect2" lang="en">
5875: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 5876: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1 dsieger 5877: <p>When building packages, it's possible to choose whether to set
5878: a global preference for using either the built-in (native)
5879: version or the pkgsrc version of software to satisfy a
5880: dependency. This is controlled by setting
5881: <code class="varname">PREFER_PKGSRC</code> and
5882: <code class="varname">PREFER_NATIVE</code>. These variables take values
5883: of either “<span class="quote">yes</span>”, “<span class="quote">no</span>”, or a list of
5884: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5885: use the pkgsrc versions of software, while
5886: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5887: built-in versions. Preferences are determined by the most
5888: specific instance of the package in either
5889: <code class="varname">PREFER_PKGSRC</code> or
5890: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5891: in neither or in both variables, then
5892: <code class="varname">PREFER_PKGSRC</code> has precedence over
5893: <code class="varname">PREFER_NATIVE</code>. For example, to require
5894: using pkgsrc versions of software for all but the most basic
5895: bits on a NetBSD system, you can set:</p>
5896: <pre class="programlisting">
5897: PREFER_PKGSRC= yes
5898: PREFER_NATIVE= getopt skey tcp_wrappers
5899: </pre>
5900: <p>A package <span class="emphasis"><em>must</em></span> have a
5901: <code class="filename">builtin.mk</code>
5902: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5903: otherwise it is simply ignored in that list.</p>
5904: </div>
5905: </div>
5906: </div>
5907: <div class="chapter" lang="en">
5908: <div class="titlepage"><div><div><h2 class="title">
1.6 ! rillig 5909: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1 dsieger 5910: <div class="toc">
5911: <p><b>Table of Contents</b></p>
5912: <dl>
1.6 ! rillig 5913: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.1 dsieger 5914: <dd><dl>
1.6 ! rillig 5915: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
! 5916: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1 dsieger 5917: </dl></dd>
1.6 ! rillig 5918: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1 dsieger 5919: <dd><dl>
1.6 ! rillig 5920: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
! 5921: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
! 5922: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
! 5923: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
! 5924: </dl></dd>
! 5925: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
! 5926: <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>
! 5927: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
! 5928: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
! 5929: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
! 5930: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
! 5931: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.1 dsieger 5932: </dl>
5933: </div>
5934: <p>This chapter describes the framework known as
5935: <code class="literal">pkginstall</code>, whose key features are:</p>
5936: <div class="itemizedlist"><ul type="disc">
5937: <li><p>Generic installation and manipulation of directories and files
5938: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
5939: <li><p>Automatic handling of configuration files during installation,
5940: provided that packages are correctly designed.</p></li>
5941: <li><p>Generation and installation of system startup scripts.</p></li>
5942: <li><p>Registration of system users and groups.</p></li>
5943: <li><p>Registration of system shells.</p></li>
5944: <li><p>Automatic updating of fonts databases.</p></li>
5945: </ul></div>
5946: <p>The following sections inspect each of the above points in detail.</p>
5947: <p>You may be thinking that many of the things described here could be
5948: easily done with simple code in the package's post-installation target
5949: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5950: as the code in them is only executed when building from source. Machines
5951: using binary packages could not benefit from it at all (as the code itself
5952: could be unavailable). Therefore, the only way to achieve any of the items
5953: described above is by means of the installation scripts, which are
5954: automatically generated by pkginstall.</p>
5955: <div class="sect1" lang="en">
5956: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 5957: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1 dsieger 5958: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5959: of files and directories that belong to a package. The names used in it
5960: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5961: which means that it cannot register files outside this directory (absolute
5962: path names are not allowed). Despite this restriction, some packages need
5963: to install files outside this location; e.g., under
5964: <code class="filename">${VARBASE}</code> or
5965: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5966: is to create such files during installation time by using
5967: installation scripts.</p>
5968: <p>The generic installation scripts are shell scripts that can
5969: contain arbitrary code. The list of scripts to execute is taken from
5970: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5971: <code class="filename">INSTALL</code>. A similar variable exists for package
5972: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5973: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5974: commands, so they have the potential to create and manage files
5975: anywhere in the file system.</p>
5976: <p>Using these general installation files is not recommended, but
5977: may be needed in some special cases. One reason for avoiding them is
5978: that the user has to trust the packager that there is no unwanted or
5979: simply erroneous code included in the installation script. Also,
5980: previously there were many similar scripts for the same functionality,
5981: and fixing a common error involved finding and changing all of
5982: them.</p>
5983: <p>The pkginstall framework offers another, standardized way. It
5984: provides generic scripts to abstract the manipulation of such files
5985: and directories based on variables set in the package's
5986: <code class="filename">Makefile</code>. The rest of this section describes
5987: these variables.</p>
5988: <div class="sect2" lang="en">
5989: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 5990: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1 dsieger 5991: <p>The following variables can be set to request the creation of
5992: directories anywhere in the file system:</p>
5993: <div class="itemizedlist"><ul type="disc">
5994: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
5995: contain a list of directories that should be created and should attempt
5996: to be destroyed by the installation scripts. The difference between
5997: the two is that the latter prompts the administrator to remove any
5998: directories that may be left after deinstallation (because they were
5999: not empty), while the former does not.</p></li>
6000: <li>
6001: <p><code class="varname">MAKE_DIRS_PERMS</code> and
6002: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
6003: which directories should be created and should attempt to be destroyed
6004: by the installation scripts. Each tuple holds the following values,
6005: separated by spaces: the directory name, its owner, its group and its
6006: numerical mode. For example:</p>
6007: <pre class="programlisting">
6008: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
6009: </pre>
6010: <p>The difference between the two is exactly the same as their
6011: non-<code class="varname">PERMS</code> counterparts.</p>
6012: </li>
6013: </ul></div>
6014: </div>
6015: <div class="sect2" lang="en">
6016: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 6017: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1 dsieger 6018: <p>Creating non-empty files outside the installation prefix is tricky
6019: because the <code class="filename">PLIST</code> forces all files to be inside it.
6020: To overcome this problem, the only solution is to extract the file in the
6021: known place (i.e., inside the installation prefix) and copy it to the
6022: appropriate location during installation (done by the installation scripts
6023: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
6024: file</em></span> in the following paragraphs, which describe the variables
6025: that can be used to automatically and consistently handle files outside the
6026: installation prefix:</p>
6027: <div class="itemizedlist"><ul type="disc">
6028: <li>
6029: <p><code class="varname">CONF_FILES</code> and
6030: <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
6031: During installation time, the master file is copied to the target one
6032: if and only if the latter does not exist. Upon deinstallation, the
6033: target file is removed provided that it was not modified by the
6034: installation.</p>
6035: <p>The difference between the two is that the latter prompts the
6036: administrator to remove any files that may be left after
6037: deinstallation (because they were not empty), while the former does
6038: not.</p>
6039: </li>
6040: <li>
6041: <p><code class="varname">CONF_FILES_PERMS</code> and
6042: <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
6043: files as well as their target locations. For each of them, it also
6044: specifies their owner, their group and their numeric permissions, in
6045: this order. For example:</p>
6046: <pre class="programlisting">
6047: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
6048: </pre>
6049: <p>The difference between the two is exactly the same as their
6050: non-<code class="varname">PERMS</code> counterparts.</p>
6051: </li>
6052: </ul></div>
6053: </div>
6054: </div>
6055: <div class="sect1" lang="en">
6056: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 6057: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1 dsieger 6058: <p>Configuration files are special in the sense that they are installed
6059: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
6060: need special treatment during installation (most of which is automated by
6061: pkginstall). The main concept you must bear in mind is that files marked
6062: as configuration files are automatically copied to the right place (somewhere
6063: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
6064: and only if</em></span> they didn't exist before. Similarly, they will not
6065: be removed if they have local modifications. This ensures that
6066: administrators never lose any custom changes they may have made.</p>
6067: <div class="sect2" lang="en">
6068: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 6069: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.1 dsieger 6070: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
6071: specifies where configuration files shall be installed. Its contents are
6072: set based upon the following variables:</p>
6073: <div class="itemizedlist"><ul type="disc">
6074: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
6075: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
6076: be overridden by the user to point to his preferred location (e.g.,
6077: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
6078: Packages must not use it directly.</p></li>
6079: <li>
6080: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
6081: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
6082: for the package being built shall be installed. The definition of this
6083: variable only makes sense in the package's
6084: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
6085: <p>As an example, consider the Apache package,
6086: <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
6087: configuration files under the
6088: <code class="filename">httpd/</code> subdirectory of
6089: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
6090: Makefile.</p>
6091: </li>
6092: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
6093: variable that holds this package's configuration directory (if
6094: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
6095: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
6096: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
6097: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
6098: directory where the configuration files for the package identified by
6099: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
6100: </ul></div>
6101: <p>Based on the above variables, pkginstall determines the value of
6102: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
6103: variable that can be used within a package to refer to its configuration
6104: directory. The algorithm used to set its value is basically the
6105: following:</p>
6106: <div class="orderedlist"><ol type="1">
6107: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
6108: its value is used.</p></li>
6109: <li><p>If the previous variable is not defined but
6110: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
6111: <code class="filename">Makefile</code>, the resulting value is
6112: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
6113: <li><p>Otherwise, it is set to
6114: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
6115: </ol></div>
6116: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.6 ! rillig 6117: automatically added to <code class="filename">OWN_DIRS</code>. See <a href="#dirs-outside-prefix" title="15.1.1. Directory manipulation">Section 15.1.1, “Directory manipulation”</a> what this means.</p>
1.1 dsieger 6118: </div>
6119: <div class="sect2" lang="en">
6120: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 6121: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1 dsieger 6122: <p>Given that pkgsrc (and users!) expect configuration files to be in a
6123: known place, you need to teach each package where it shall install its
6124: files. In some cases you will have to patch the package Makefiles to
6125: achieve it. If you are lucky, though, it may be as easy as passing an
6126: extra flag to the configuration script; this is the case of GNU Autoconf-
6127: generated files:</p>
6128: <pre class="programlisting">
6129: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
6130: </pre>
6131: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
6132: for</em></span> its configuration files, not where they will be originally
6133: installed (although the difference is never explicit,
6134: unfortunately).</p>
6135: </div>
6136: <div class="sect2" lang="en">
6137: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 6138: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1 dsieger 6139: <p>As said before, pkginstall automatically handles configuration files.
6140: This means that <span class="strong"><strong>the packages themselves must not
6141: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
6142: directly</strong></span>. Bad news is that many software installation scripts
6143: will, out of the box, mess with the contents of that directory. So what is
6144: the correct procedure to fix this issue?</p>
6145: <p>You must teach the package (usually by manually patching it) to
6146: install any configuration files under the examples hierarchy,
6147: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
6148: <code class="filename">PLIST</code> registers them and the administrator always
6149: has the original copies available.</p>
6150: <p>Once the required configuration files are in place (i.e., under the
6151: examples hierarchy), the pkginstall framework can use them as master copies
6152: during the package installation to update what is in
6153: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
6154: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.6 ! rillig 6155: used. Check out <a href="#files-outside-prefix" title="15.1.2. File manipulation">Section 15.1.2, “File manipulation”</a> for information
1.1 dsieger 6156: about their syntax and their purpose. Here is an example, taken from the
6157: <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>
6158: <pre class="programlisting">
6159: EGDIR= ${PREFIX}/share/doc/mutt/samples
6160: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
6161: </pre>
6162: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
6163: package and has no meaning outside it.</p>
6164: </div>
6165: <div class="sect2" lang="en">
6166: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 6167: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1 dsieger 6168: <p>The automatic copying of config files can be toggled by setting the
6169: environment variable <code class="varname">PKG_CONFIG</code> prior to package
6170: installation.</p>
6171: </div>
6172: </div>
6173: <div class="sect1" lang="en">
6174: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 6175: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1 dsieger 6176: <p>System startup scripts are special files because they must be
6177: installed in a place known by the underlying OS, usually outside the
1.6 ! rillig 6178: installation prefix. Therefore, the same rules described in <a href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, “Files and directories outside the installation prefix”</a> apply, and the same solutions
1.1 dsieger 6179: can be used. However, pkginstall provides a special mechanism to handle
6180: these files.</p>
6181: <p>In order to provide system startup scripts, the package has
6182: to:</p>
6183: <div class="orderedlist"><ol type="1">
6184: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
6185: the <code class="literal">.sh</code> suffix appended. Considering the
6186: <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
6187: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
6188: <li>
6189: <p>Tell pkginstall to handle it, appending the name of the script,
6190: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6191: Continuing the previous example:</p>
6192: <pre class="programlisting">
6193: RCD_SCRIPTS+= cupsd
6194: </pre>
6195: </li>
6196: </ol></div>
6197: <p>Once this is done, pkginstall will do the following steps for each
6198: script in an automated fashion:</p>
6199: <div class="orderedlist"><ol type="1">
6200: <li><p>Process the file found in the files directory applying all the
6201: substitutions described in the <code class="filename">FILES_SUBST</code>
6202: variable.</p></li>
6203: <li><p>Copy the script from the files directory to the examples
6204: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
6205: that this master file must be explicitly registered in the
6206: <code class="filename">PLIST</code>.</p></li>
6207: <li><p>Add code to the installation scripts to copy the startup script
6208: from the examples hierarchy into the system-wide startup scripts
6209: directory.</p></li>
6210: </ol></div>
6211: <div class="sect2" lang="en">
6212: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 6213: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1 dsieger 6214: <p>The automatic copying of config files can be toggled by setting the
6215: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6216: installation. Note that the scripts will be always copied inside the
6217: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
6218: matter what the value of this variable is.</p>
6219: </div>
6220: </div>
6221: <div class="sect1" lang="en">
6222: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 6223: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1 dsieger 6224: <p>If a package needs to create special users and/or groups during
6225: installation, it can do so by using the pkginstall framework.</p>
6226: <p>Users can be created by adding entries to the
6227: <code class="varname">PKG_USERS</code> variable. Each entry has the following
6228: syntax:</p>
6229: <pre class="programlisting">
6230: user:group
6231: </pre>
6232: <p>Further specification of user details may be done by setting
6233: per-user variables.
6234: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6235: numeric UID for the user.
6236: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6237: user's description or comment.
6238: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6239: user's home directory, and defaults to
6240: <code class="filename">/nonexistent</code> if not specified.
6241: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
6242: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
6243: not specified.</p>
6244: <p>Similarly, groups can be created by adding entries to the
6245: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6246: <pre class="programlisting">
6247: group
6248: </pre>
6249: <p>The numeric GID of the group may be set by defining
6250: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6251: <p>If a package needs to create the users and groups at an earlier
6252: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6253: either <code class="literal">configure</code> or <code class="literal">build</code> to
6254: indicate the phase before which the users and groups are created. In
6255: this case, the numeric UIDs and GIDs of the created users and groups
6256: are automatically hardcoded into the final installation scripts.</p>
6257: </div>
6258: <div class="sect1" lang="en">
6259: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 6260: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1 dsieger 6261: <p>Packages that install system shells should register them in the shell
6262: database, <code class="filename">/etc/shells</code>, to make things easier to the
6263: administrator. This must be done from the installation scripts to keep
6264: binary packages working on any system. pkginstall provides an easy way to
6265: accomplish this task.</p>
6266: <p>When a package provides a shell interpreter, it has to set the
6267: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
6268: add some hooks to the installation scripts to handle it. Consider the
6269: 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>
6270: <pre class="programlisting">
6271: PKG_SHELL= ${PREFIX}/bin/zsh
6272: </pre>
6273: <div class="sect2" lang="en">
6274: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 6275: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1 dsieger 6276: <p>The automatic registration of shell interpreters can be disabled by
6277: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
6278: environment variable to <code class="literal">NO</code>.</p>
6279: </div>
6280: </div>
6281: <div class="sect1" lang="en">
6282: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 6283: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1 dsieger 6284: <p>Packages that install X11 fonts should update the database files
6285: that index the fonts within each fonts directory. This can easily be
6286: accomplished within the pkginstall framework.</p>
6287: <p>When a package installs X11 fonts, it must list the directories in
6288: which fonts are installed in the
6289: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
6290: where <em class="replaceable"><code>type</code></em> can be one of “<span class="quote">ttf</span>”,
6291: “<span class="quote">type1</span>” or “<span class="quote">x11</span>”. This will add hooks to the
6292: installation scripts to run the appropriate commands to update the fonts
6293: database files within each of those directories. For convenience, if the
6294: directory path is relative, it is taken to be relative to the package's
6295: 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>
6296: <pre class="programlisting">
6297: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
6298: </pre>
6299: <div class="sect2" lang="en">
6300: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 6301: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1 dsieger 6302: <p>The automatic update of fonts databases can be disabled by
6303: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
6304: environment variable to <code class="literal">NO</code>.</p>
6305: </div>
6306: </div>
6307: </div>
6308: <div class="chapter" lang="en">
6309: <div class="titlepage"><div><div><h2 class="title">
1.6 ! rillig 6310: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1 dsieger 6311: <div class="toc">
6312: <p><b>Table of Contents</b></p>
6313: <dl>
1.6 ! rillig 6314: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
! 6315: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
! 6316: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.1 dsieger 6317: </dl>
6318: </div>
6319: <p>Many packages have the ability to be built to support different
6320: sets of features. <code class="filename">bsd.options.mk</code> is a framework
6321: in pkgsrc that provides generic handling of those options that
6322: determine different ways in which the packages can be built. It's
6323: possible for the user to specify exactly which sets of options will be
6324: built into a package or to allow a set of global default options
6325: apply.</p>
6326: <div class="sect1" lang="en">
6327: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 6328: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1 dsieger 6329: <p>Global default options are listed in
6330: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6331: that should be built into every package if that option is supported.
1.4 rillig 6332: This variable should be set in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 6333: </div>
6334: <div class="sect1" lang="en">
6335: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 6336: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1 dsieger 6337: </h2></div></div></div>
6338: <p>The following example shows how
6339: <code class="filename">bsd.options.mk</code> should be used
6340: by the hypothetical ``wibble'' package, either in the package
6341: <code class="filename">Makefile</code>, or in a file,
6342: e.g. <code class="filename">options.mk</code>, that is included by the
6343: main package <code class="filename">Makefile</code>.</p>
6344: <pre class="programlisting">
6345: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6346: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6347: PKG_OPTIONS_OPTIONAL_GROUPS= database
6348: PKG_OPTIONS_GROUP.database= mysql pgsql
6349: PKG_SUGGESTED_OPTIONS= wibble-foo
6350: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6351: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6352:
6353: .include "../../mk/bsd.prefs.mk"
6354:
6355: # this package was previously named wibble2
6356: .if defined(PKG_OPTIONS.wibble2)
6357: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6358: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6359: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6360: .endif
6361:
6362: .include "../../mk/bsd.options.mk"
6363:
6364: # Package-specific option-handling
6365:
6366: ###
6367: ### FOO support
6368: ###
6369: .if !empty(PKG_OPTIONS:Mwibble-foo)
6370: CONFIGURE_ARGS+= --enable-foo
6371: .endif
6372:
6373: ###
6374: ### LDAP support
6375: ###
6376: .if !empty(PKG_OPTIONS:Mldap)
6377: . include "../../databases/openldap-client/buildlink3.mk"
6378: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6379: .endif
6380:
6381: ###
6382: ### database support
6383: ###
6384: .if !empty(PKG_OPTIONS:Mmysql)
6385: . include "../../mk/mysql.buildlink3.mk"
6386: .endif
6387: .if !empty(PKG_OPTIONS:Mpgsql)
6388: . include "../../mk/pgsql.buildlink3.mk"
6389: .endif
6390: </pre>
6391: <p>The first section contains the information about which build
6392: options are supported by the package, and any default options settings
6393: if needed.</p>
6394: <div class="orderedlist"><ol type="1">
6395: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
6396: <a 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
6397: options. It should be set to
6398: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6399: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6400: at the point where the options are processed.</p></li>
6401: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6402: build options supported by the package.</p></li>
6403: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6404: list of names of groups of mutually exclusive options. The options in
6405: each group are listed in
6406: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6407: The most specific setting of any option from the group takes
6408: precedence over all other options in the group. Options from the
6409: groups will be automatically added to
6410: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6411: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6412: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6413: packages will fail if no option from the group is
6414: selected.</p></li>
6415: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6416: of names of sets of options. At least one option from each set must
6417: be selected. The options in each set are listed in
6418: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6419: Options from the sets will be automatically added to
6420: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6421: fail if no option from the set is selected.</p></li>
6422: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6423: build options which are enabled by default.</p></li>
6424: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6425: of
6426: “<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”
1.4 rillig 6427: pairs that map legacy <a href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1 dsieger 6428: their option counterparts. Pairs should be added with
6429: “<span class="quote">+=</span>” to keep the listing of global legacy variables. A
6430: warning will be issued if the user uses a legacy
6431: variable.</p></li>
6432: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6433: of
6434: “<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”
6435: pairs that map options that have been renamed to their new
6436: counterparts. Pairs should be added with “<span class="quote">+=</span>” to keep
6437: the listing of global legacy options. A warning will be issued if
6438: the user uses a legacy option.</p></li>
6439: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6440: options implied by deprecated variables used. This can be used for
6441: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6442: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6443: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6444: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6445: a list of warnings about deprecated variables or options used, and
6446: what to use instead.</p></li>
6447: </ol></div>
6448: <p>A package should never modify
6449: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6450: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6451: To suggest a default set of options, use
6452: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6453: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
6454: including <code class="filename">bsd.options.mk</code>. If none of
6455: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6456: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6457: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6458: happen with platform-specific options if none of them is supported on
6459: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6460: empty list and the package is otherwise treated as not using the
6461: options framework.</p>
6462: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
6463: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6464: build options, properly filtered to remove unsupported and duplicate
6465: options.</p>
6466: <p>The remaining sections contain the logic that is specific to
6467: each option. The correct way to check for an option is to check
6468: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6469: <pre class="programlisting">
6470: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
6471: </pre>
6472: </div>
6473: <div class="sect1" lang="en">
6474: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 6475: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1 dsieger 6476: <p>Options that enable similar features in different packages (like
6477: optional support for a library) should use a common name in all
6478: packages that support it (like the name of the library). If another
6479: package already has an option with the same meaning, use the same
6480: name.</p>
6481: <p>Options that enable features specific to one package, where it's
6482: unlikely that another (unrelated) package has the same (or a similar)
6483: optional feature, should use a name prefixed with
6484: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6485: <p>If a group of related packages share an optional feature
6486: specific to that group, prefix it with the name of the
6487: “<span class="quote">main</span>” package
6488: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6489: <p>For new options, add a line to
6490: <code class="filename">mk/defaults/options.description</code>. Lines have two
6491: fields, separated by tab. The first field is the option name, the
6492: second its description. The description should be a whole sentence
6493: (starting with an uppercase letter and ending with a period) that
6494: describes what enabling the option does. E. g. “<span class="quote">Enable ispell
6495: support.</span>” The file is sorted by option names.</p>
6496: </div>
6497: </div>
6498: <div class="chapter" lang="en">
6499: <div class="titlepage"><div><div><h2 class="title">
1.6 ! rillig 6500: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1 dsieger 6501: <div class="toc">
6502: <p><b>Table of Contents</b></p>
6503: <dl>
1.6 ! rillig 6504: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
! 6505: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
! 6506: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
! 6507: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
! 6508: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
! 6509: <dd><dl>
! 6510: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
! 6511: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
! 6512: </dl></dd>
! 6513: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
! 6514: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
! 6515: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
! 6516: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
! 6517: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
! 6518: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
! 6519: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
! 6520: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
! 6521: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
! 6522: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
! 6523: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
! 6524: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1 dsieger 6525: </dl>
6526: </div>
6527: <div class="sect1" lang="en">
6528: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 6529: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1 dsieger 6530: <p>This chapter gives a detailed description on how a package is
6531: built. Building a package is separated into different
6532: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6533: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
6534: described in the following sections. Each phase is splitted into
6535: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6536: containing phase, prefixed by one of <code class="varname">pre-</code>,
6537: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6538: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6539: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
6540: <p>Never override the regular targets (like
6541: <code class="varname">fetch</code>), if you have to, override the
6542: <code class="varname">do-*</code> ones instead.</p>
6543: <p>The basic steps for building a program are always the same. First
6544: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6545: the local system and then extracted. After any pkgsrc-specific patches
6546: to compile properly are applied, the software can be configured, then
6547: built (usually by compiling), and finally the generated binaries, etc.
6548: can be put into place on the system.</p>
6549: <p>To get more details about what is happening at each step,
6550: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6551: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6552: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
6553: </div>
6554: <div class="sect1" lang="en">
6555: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 6556: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1 dsieger 6557: <p>Before outlining the process performed by the NetBSD package system in
6558: the next section, here's a brief discussion on where programs are
6559: installed, and which variables influence this.</p>
6560: <p>The automatic variable <code class="varname">PREFIX</code> indicates
6561: where all files of the final program shall be installed. It is
6562: usually set to <code class="varname">LOCALBASE</code>
6563: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
6564: for pkgs in the <code class="filename">cross</code> category. The value of
6565: <code class="varname">PREFIX</code> needs to be put
6566: into the various places in the program's source where paths to
1.6 ! rillig 6567: these files are encoded. See <a href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> and <a href="#fixes.libtool" title="19.3.1. Shared libraries - libtool">Section 19.3.1, “Shared libraries - libtool”</a> for more details.</p>
1.1 dsieger 6568: <p>When choosing which of these variables to use,
6569: follow the following rules:</p>
6570: <div class="itemizedlist"><ul type="disc">
6571: <li><p><code class="varname">PREFIX</code> always points to the location
6572: where the current pkg will be installed. When referring to a
6573: pkg's own installation path, use
6574: “<span class="quote">${PREFIX}</span>”.</p></li>
6575: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
6576: are installed. If you need to construct a -I or -L argument
6577: to the compiler to find includes and libraries installed by
6578: another non-X11 pkg, use “<span class="quote">${LOCALBASE}</span>”. The name
6579: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6580: installed all packages in <code class="filename">/usr/local</code>. As
6581: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6582: administrator, this variable is a misnomer.</p></li>
6583: <li><p><code class="varname">X11BASE</code> is where the actual X11
6584: distribution (from xsrc, etc.) is installed. When looking for
6585: <span class="emphasis"><em>standard</em></span> X11 includes (not those
6586: installed by a package), use “<span class="quote">${X11BASE}</span>”.</p></li>
6587: <li>
6588: <p>X11-based packages are special in that they may be
6589: installed in either <code class="varname">X11BASE</code> or
6590: <code class="varname">LOCALBASE</code>.</p>
6591: <p>Usually, X11 packages should be installed under
6592: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6593: will need to include
6594: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6595: request the presence of X11 and to get the right compilation
6596: flags.</p>
6597: <p>Even though, there are some packages that cannot be installed
6598: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6599: files. These packages are special and they must be placed under
6600: <code class="varname">X11BASE</code>. To accomplish this, set either
6601: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6602: your package.</p>
6603: <p>Some notes: If you need
6604: to find includes or libraries installed by a pkg that has
6605: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6606: its pkg <code class="filename">Makefile</code>, you need to look in
6607: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6608: <code class="filename">${LOCALBASE}</code>. To force installation of
6609: all X11 packages in <code class="varname">LOCALBASE</code>, the
6610: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
6611: is enabled by default.</p>
6612: </li>
6613: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
6614: the installed location of an X11
6615: package. <code class="varname">X11PREFIX</code> will be set to
6616: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6617: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6618: installed.</p></li>
6619: <li>
6620: <p>If xpkgwedge is installed, it is possible to have some
6621: packages installed in <code class="varname">X11BASE</code> and some in
6622: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6623: installed package, the <code class="varname">EVAL_PREFIX</code>
6624: definition can be used. It takes pairs in the format
6625: “<span class="quote">DIRNAME=<package></span>”, and the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
6626: variable <code class="varname">DIRNAME</code> will be set to the prefix
6627: of the installed package <package>, or
6628: “<span class="quote">${X11PREFIX}</span>” if the package is not
6629: installed.</p>
6630: <p>This is best illustrated by example.</p>
6631: <p>The following lines are taken from
6632: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
6633: <pre class="programlisting">
6634: EVAL_PREFIX+= GTKDIR=gtk+
6635: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6636: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6637: CONFIGURE_ARGS+= --enable-multibyte
6638: </pre>
6639: <p>Specific defaults can be defined for the packages
6640: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6641: definition of the form:</p>
6642: <pre class="programlisting">
6643: GTKDIR_DEFAULT= ${LOCALBASE}
6644: </pre>
6645: <p>where <code class="varname">GTKDIR</code> corresponds
6646: to the first definition in
6647: the <code class="varname">EVAL_PREFIX</code> pair.</p>
6648: </li>
6649: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
6650: install files according to <a 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
6651: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6652: <code class="filename">${PREFIX}/share/man</code>.</p></li>
6653: </ul></div>
6654: </div>
6655: <div class="sect1" lang="en">
6656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 6657: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.1 dsieger 6658: <p>When building a package, a number of directories is used to store
6659: source files, temporary files, pkgsrc-internal files, and so on. These
6660: directories are explained here.</p>
6661: <p>Some of the directory variables contain relative pathnames. There
6662: are two common base directories for these relative directories:
6663: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6664: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6665: inside the package itself.</p>
6666: <div class="variablelist"><dl>
6667: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6668: <dd><p>This is an absolute pathname that points to the pkgsrc
6669: root directory. Generally, you don't need
6670: it.</p></dd>
6671: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6672: <dd><p>This is an absolute pathname that points to the
6673: current package.</p></dd>
6674: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6675: <dd><p>This is a pathname relative to
6676: <code class="varname">PKGSRCDIR</code> that points to the current
6677: package.</p></dd>
6678: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6679: <dd><p>This is an absolute pathname pointing to the directory
6680: where all work takes place. The distfiles are extracted to this
6681: directory. It also contains temporary directories and log files used by
6682: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6683: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
6684: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6685: <dd><p>This is an absolute pathname pointing to the directory
6686: where the distfiles are extracted. It is usually a direct subdirectory
6687: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6688: that isn't hidden. This variable may be changed by a package
6689: <code class="filename">Makefile</code>.</p></dd>
6690: </dl></div>
6691: </div>
6692: <div class="sect1" lang="en">
6693: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 6694: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.1 dsieger 6695: <p>You can run a particular phase by typing <span><strong class="command">make
6696: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6697: phase. This will automatically run all phases that are required for this
6698: phase. The default phase is <code class="varname">build</code>, that is, when you
6699: run <span><strong class="command">make</strong></span> without parameters in a package directory,
6700: the package will be built, but not installed.</p>
6701: </div>
6702: <div class="sect1" lang="en">
6703: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 6704: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 6705: <p>The first step in building a package is to fetch the
6706: distribution files (distfiles) from the sites that are providing
6707: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6708: phase.</p>
6709: <div class="sect2" lang="en">
6710: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 6711: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.1 dsieger 6712: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6713: defines all URLs from where the distfile, whose name is
6714: derived from the <code class="varname">DISTNAME</code> variable, is
6715: fetched. The more complicated cases are described
6716: below.</p>
6717: <p>The variable <code class="varname">DISTFILES</code> specifies
6718: the list of distfiles that have to be fetched. Its value
6719: defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6720: so that most packages don't need to define it at all.
6721: <code class="varname">EXTRACT_SUFX</code> is
6722: <code class="literal">.tar.gz</code> by default, but can be changed
6723: freely. Note that if your package requires additional
6724: distfiles to the default one, you cannot just append the
6725: additional filenames using the <code class="literal">+=</code>
6726: operator, but you have write for example:</p>
6727: <pre class="programlisting">
6728: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6729: </pre>
6730: <p>Each distfile is fetched from a list of sites, usually
6731: <code class="varname">MASTER_SITES</code>. If the package has multiple
6732: <code class="varname">DISTFILES</code> or multiple
6733: <code class="varname">PATCHFILES</code> from different sites, you can
6734: set
6735: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6736: to the list of URLs where the file
6737: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6738: (including the suffix) can be found.</p>
6739: <pre class="programlisting">
6740: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6741: DISTFILES+= foo-file.tar.gz
6742: SITES.foo-file.tar.gz= \
6743: http://www.somewhere.com/somehow/ \
6744: http://www.somewhereelse.com/mirror/somehow/
6745: </pre>
6746: <p>When actually fetching the distfiles, each item from
6747: <code class="varname">MASTER_SITES</code> or
6748: <code class="varname">SITES.*</code> gets the name of each distfile
6749: appended to it, without an intermediate slash. Therefore,
6750: all site values have to end with a slash or other separator
6751: character. This allows for example to set
6752: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6753: that gets the name of the distfile as a parameter. In this
6754: case, the definition would look like:</p>
6755: <pre class="programlisting">
6756: MASTER_SITES= http://www.example.com/download.cgi?file=
6757: </pre>
6758: <p>There are some predefined values for
6759: <code class="varname">MASTER_SITES</code>, which can be used in
6760: packages. The names of the variables should speak for
6761: themselves.</p>
6762: <pre class="programlisting">
6763: ${MASTER_SITE_APACHE}
6764: ${MASTER_SITE_BACKUP}
6765: ${MASTER_SITE_CYGWIN}
6766: ${MASTER_SITE_DEBIAN}
6767: ${MASTER_SITE_FREEBSD}
6768: ${MASTER_SITE_FREEBSD_LOCAL}
6769: ${MASTER_SITE_GENTOO}
6770: ${MASTER_SITE_GNOME}
6771: ${MASTER_SITE_GNU}
6772: ${MASTER_SITE_GNUSTEP}
6773: ${MASTER_SITE_IFARCHIVE}
6774: ${MASTER_SITE_KDE}
6775: ${MASTER_SITE_MOZILLA}
6776: ${MASTER_SITE_MYSQL}
6777: ${MASTER_SITE_OPENOFFICE}
6778: ${MASTER_SITE_PERL_CPAN}
6779: ${MASTER_SITE_PGSQL}
6780: ${MASTER_SITE_R_CRAN}
6781: ${MASTER_SITE_SOURCEFORGE}
6782: ${MASTER_SITE_SOURCEFORGE_JP}
6783: ${MASTER_SITE_SUNSITE}
6784: ${MASTER_SITE_SUSE}
6785: ${MASTER_SITE_TEX_CTAN}
6786: ${MASTER_SITE_XCONTRIB}
6787: ${MASTER_SITE_XEMACS}
6788: </pre>
6789: <p>Some explanations for the less self-explaining ones:
6790: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
6791: for packages that are maintained in <a 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
6792: package source distributions that are maintained in <a 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>
6793: <p>If you choose one of these predefined sites, you may
6794: want to specify a subdirectory of that site. Since these
6795: macros may expand to more than one actual site, you
6796: <span class="emphasis"><em>must</em></span> use the following construct to
6797: specify a subdirectory:</p>
6798: <pre class="programlisting">
6799: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6800: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6801: </pre>
6802: <p>Note the trailing slash after the subdirectory
6803: name.</p>
6804: </div>
6805: <div class="sect2" lang="en">
6806: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 6807: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1 dsieger 6808: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6809: all the distfiles exist in a local directory
6810: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
6811: user). If the files do not exist, they are fetched using
6812: commands of the form</p>
6813: <pre class="programlisting">
6814: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6815: </pre>
6816: <p>where <code class="literal">${site}</code> varies through
6817: several possibilities in turn: first,
6818: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6819: sites specified in either <code class="varname">SITES.file</code> if
6820: defined, else <code class="varname">MASTER_SITES</code> or
6821: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6822: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
6823: all except the first and the last can be optionally sorted
6824: by the user, via setting either
6825: <code class="varname">MASTER_SORT_RANDOM</code>, and
6826: <code class="varname">MASTER_SORT_AWK</code> or
6827: <code class="varname">MASTER_SORT_REGEX</code>.</p>
6828: <p>The distfiles mirror run by the NetBSD Foundation uses the
6829: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6830: distfiles, if they are freely distributable. Packages setting
6831: <code class="varname">NO_SRC_ON_FTP</code> (usually to
6832: “<span class="quote">${RESTRICTED}</span>”) will not have their distfiles
6833: mirrored.</p>
6834: </div>
6835: </div>
6836: <div class="sect1" lang="en">
6837: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 6838: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1 dsieger 6839: <p>After the distfile(s) are fetched, their checksum is
6840: generated and compared with the checksums stored in the
6841: distinfo file. If the checksums don't match, the build is
6842: aborted. This is to ensure the same distfile is used for
6843: building, and that the distfile wasn't changed, e.g. by some
6844: malign force, deliberately changed distfiles on the master
6845: distribution site or network lossage.</p>
6846: </div>
6847: <div class="sect1" lang="en">
6848: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 6849: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1 dsieger 6850: <p>When the distfiles are present on the local system, they
6851: need to be extracted, as they usually come in the form of some
6852: compressed archive format.</p>
6853: <p>By default, all <code class="varname">DISTFILES</code> are
6854: extracted. If you only need some of them, you can set the
6855: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6856: files.</p>
6857: <p>Extracting the files is usually done by a little
6858: program, <code class="filename">mk/extract/extract</code>, which
6859: already knows how to extract various archive formats, so most
6860: likely you will not need to change anything here. But if you
6861: need, the following variables may help you:</p>
6862: <div class="variablelist"><dl>
6863: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6864: <dd><p>Use these variables to override the default
6865: options for an extract command, which are defined in
6866: <code class="filename">mk/extract/extract</code>.</p></dd>
6867: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6868: <dd><p>This variable can be set to
6869: <code class="literal">gtar</code>, <code class="literal">nbtar</code> (which is the
6870: default value), <code class="literal">pax</code>, or an
6871: absolute pathname pointing to the command with which tar
6872: archives should be
6873: extracted.</p></dd>
6874: </dl></div>
6875: <p>If the <code class="filename">extract</code> program doesn't
6876: serve your needs, you can also override the
6877: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6878: command used for extracting the files. This command is
6879: executed in the <code class="filename">${WRKSRC}</code>
6880: directory. During execution of this command, the shell
6881: variable <code class="varname">extract_file</code> holds the absolute
6882: pathname of the file that is going to be extracted.</p>
6883: <p>And if that still does not suffice, you can override the
6884: <code class="varname">do-extract</code> target in the package
6885: Makefile.</p>
6886: </div>
6887: <div class="sect1" lang="en">
6888: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 6889: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1 dsieger 6890: <p>After extraction, all the patches named by the
6891: <code class="varname">PATCHFILES</code>, those present in the patches
6892: subdirectory of the package as well as in
6893: $LOCALPATCHES/$PKGPATH (e.g.
6894: <code class="filename">/usr/local/patches/graphics/png</code>) are
6895: applied. Patchfiles ending in <code class="filename">.Z</code> or
6896: <code class="filename">.gz</code> are uncompressed before they are
6897: applied, files ending in <code class="filename">.orig</code> or
6898: <code class="filename">.rej</code> are ignored. Any special options to
6899: <a 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
1.6 ! rillig 6900: <code class="varname">PATCH_DIST_ARGS</code>. See <a href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more details.</p>
1.1 dsieger 6901: <p>By default <a 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
6902: it fail if the patches apply with some lines of fuzz. Please
6903: fix (regen) the patches so that they apply cleanly. The
6904: rationale behind this is that patches that don't apply cleanly
6905: may end up being applied in the wrong place, and cause severe
6906: harm there.</p>
6907: </div>
6908: <div class="sect1" lang="en">
6909: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 6910: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
! 6911: <p>This is covered in <a href="#tools" title="Chapter 18. Tools needed for building or running">Chapter 18, <i>Tools needed for building or running</i></a>.
1.1 dsieger 6912: </p>
6913: </div>
6914: <div class="sect1" lang="en">
6915: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 6916: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1 dsieger 6917: <p>This phase creates wrapper programs for the compilers and
6918: linkers. The following variables can be used to tweak the
6919: wrappers.</p>
6920: <div class="variablelist"><dl>
6921: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6922: <dd><p>The command used to print progress
6923: messages. Does nothing by default. Set to
6924: <code class="literal">${ECHO}</code> to see the progress
6925: messages.</p></dd>
6926: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6927: <dd><p>This variable can be set to
6928: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6929: depending on whether you want additional information in the
6930: wrapper log file.</p></dd>
6931: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6932: <dd><p>This variable can be set to
6933: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6934: on whether the wrapper should use its cache, which will
6935: improve the speed. The default value is
6936: <code class="literal">yes</code>, but is forced to
6937: <code class="literal">no</code> if the platform does not support
6938: it.</p></dd>
6939: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6940: <dd><p>A list of reordering commands. A reordering
6941: command has the form
6942: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6943: It ensures that that
6944: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6945: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6946: </p></dd>
6947: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6948: <dd><p>A list of transformation commands. [TODO:
6949: investigate further]</p></dd>
6950: </dl></div>
6951: </div>
6952: <div class="sect1" lang="en">
6953: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 6954: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 6955: <p>Most pieces of software need information on the header
6956: files, system calls, and library routines which are available
6957: on the platform they run on. The process of determining this
6958: information is known as configuration, and is usually
6959: automated. In most cases, a script is supplied with the
6960: distfiles, and its invocation results in generation of header
6961: files, Makefiles, etc.</p>
6962: <p>If the package contains a configure script, this can be
6963: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
6964: “<span class="quote">yes</span>”. If the configure script is a GNU autoconf
6965: script, you should set <code class="varname">GNU_CONFIGURE</code> to
6966: “<span class="quote">yes</span>” instead. What happens in the
6967: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6968: <pre class="programlisting">
6969: .for d in ${CONFIGURE_DIRS}
6970: cd ${WRKSRC} \
6971: && cd ${d} \
6972: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6973: .endfor
6974: </pre>
6975: <p><code class="varname">CONFIGURE_DIRS</code> (default:
6976: “<span class="quote">.</span>”) is a list of pathnames relative to
6977: <code class="varname">WRKSRC</code>. In each of these directories, the
6978: configure script is run with the environment
6979: <code class="varname">CONFIGURE_ENV</code> and arguments
6980: <code class="varname">CONFIGURE_ARGS</code>. The variables
6981: <code class="varname">CONFIGURE_ENV</code>,
6982: <code class="varname">CONFIGURE_SCRIPT</code> (default:
6983: “<span class="quote">./configure</span>”) and
6984: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6985: package.</p>
6986: <p>If the program uses an <code class="filename">Imakefile</code>
6987: for configuration, the appropriate steps can be invoked by
6988: setting <code class="varname">USE_IMAKE</code> to
6989: “<span class="quote">yes</span>”. (If you only want the package installed in
6990: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
6991: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6992: xmkmf's environment by adding them to the
6993: <code class="varname">SCRIPTS_ENV</code> variable.</p>
6994: <p>If there is no configure step at all, set
6995: <code class="varname">NO_CONFIGURE</code> to “<span class="quote">yes</span>”.</p>
6996: </div>
6997: <div class="sect1" lang="en">
6998: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 6999: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 7000: <p>For building a package, a rough equivalent of the
7001: following code is executed.</p>
7002: <pre class="programlisting">
7003: .for d in ${BUILD_DIRS}
7004: cd ${WRKSRC} \
7005: && cd ${d} \
7006: && env ${MAKE_ENV} \
7007: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
7008: -f ${MAKE_FILE} \
7009: ${BUILD_TARGET}
7010: .endfor
7011: </pre>
7012: <p><code class="varname">BUILD_DIRS</code> (default:
7013: “<span class="quote">.</span>”) is a list of pathnames relative to
7014: <code class="varname">WRKSRC</code>. In each of these directories,
7015: <code class="varname">MAKE_PROGRAM</code> is run with the environment
7016: <code class="varname">MAKE_ENV</code> and arguments
7017: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
7018: <code class="varname">MAKE_ENV</code>,
7019: <code class="varname">BUILD_MAKE_FLAGS</code>,
7020: <code class="varname">MAKE_FILE</code> and
7021: <code class="varname">BUILD_TARGET</code> may all be changed by the
7022: package.</p>
7023: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
7024: “<span class="quote">gmake</span>” if <code class="varname">USE_TOOLS</code> contains
7025: “<span class="quote">gmake</span>”, “<span class="quote">make</span>” otherwise. The
7026: default value of <code class="varname">MAKE_FILE</code> is
7027: “<span class="quote">Makefile</span>”, and <code class="varname">BUILD_TARGET</code>
7028: defaults to “<span class="quote">all</span>”.</p>
7029: <p>If there is no build step at all, set
7030: <code class="varname">NO_BUILD</code> to “<span class="quote">yes</span>”.</p>
7031: </div>
7032: <div class="sect1" lang="en">
7033: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 7034: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1 dsieger 7035: <p>[TODO]</p>
7036: </div>
7037: <div class="sect1" lang="en">
7038: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 7039: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 7040: <p>Once the build stage has completed, the final step is to
7041: install the software in public directories, so users can
7042: access the programs and files.</p>
7043: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
7044: equivalent of the following code is executed. Additionally,
7045: before and after this code, much magic is performed to do
7046: consistency checks, registering the package, and so on.</p>
7047: <pre class="programlisting">
7048: .for d in ${INSTALL_DIRS}
7049: cd ${WRKSRC} \
7050: && cd ${d} \
7051: && env ${MAKE_ENV} \
7052: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
7053: -f ${MAKE_FILE} \
7054: ${INSTALL_TARGET}
7055: .endfor
7056: </pre>
7057: <p>The variable's meanings are analogous to the ones in the
7058: <span class="emphasis"><em>build</em></span> phase.
7059: <code class="varname">INSTALL_DIRS</code> defaults to
7060: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
7061: is “<span class="quote">install</span>” by default, plus
7062: “<span class="quote">install.man</span>” if <code class="varname">USE_IMAKE</code> is
7063: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
7064: defined.</p>
7065: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
7066: variables are useful. They are all variations of the
7067: <a 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
7068: permissions preset. <code class="varname">INSTALL</code> is the plain
7069: install command. The specialized variants, together with their
7070: intended use, are:</p>
7071: <div class="variablelist"><dl>
7072: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
7073: <dd><p>directories that contain
7074: binaries</p></dd>
7075: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
7076: <dd><p>directories that contain
7077: scripts</p></dd>
7078: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
7079: <dd><p>directories that contain shared and static
7080: libraries</p></dd>
7081: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
7082: <dd><p>directories that contain data
7083: files</p></dd>
7084: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
7085: <dd><p>directories that contain man
7086: pages</p></dd>
7087: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
7088: <dd><p>binaries that can be stripped from debugging
7089: symbols</p></dd>
7090: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
7091: <dd><p>binaries that cannot be
7092: stripped</p></dd>
7093: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
7094: <dd><p>game
7095: binaries</p></dd>
7096: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
7097: <dd><p>shared and static
7098: libraries</p></dd>
7099: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
7100: <dd><p>data files</p></dd>
7101: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
7102: <dd><p>data files for
7103: games</p></dd>
7104: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
7105: <dd><p>man pages</p></dd>
7106: </dl></div>
7107: <p>Some other variables are:</p>
7108: <div class="variablelist"><dl>
7109: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
7110: <dd><p>A list of directories relative to
7111: <code class="varname">PREFIX</code> that are created by pkgsrc at the
7112: beginning of the <span class="emphasis"><em>install</em></span> phase.
7113: The package is supposed to create all needed directories itself
7114: before installing files to it and list all other directories here.
7115: </p></dd>
7116: </dl></div>
7117: <p>In the rare cases that a package shouldn't install anything,
7118: set <code class="varname">NO_INSTALL</code> to “<span class="quote">yes</span>”. This is
7119: mostly relevant for packages in the <code class="filename">regress</code>
7120: category.</p>
7121: </div>
7122: <div class="sect1" lang="en">
7123: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 7124: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1 dsieger 7125: <p>Once the install stage has completed, a binary package of
7126: the installed files can be built. These binary packages can be
7127: used for quick installation without previous compilation, e.g. by
7128: the <span><strong class="command">make bin-install</strong></span> or by using
7129: <span><strong class="command">pkg_add</strong></span>.</p>
7130: <p>By default, the binary packages are created in
7131: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
7132: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
7133: one for each category in the <code class="varname">CATEGORIES</code>
7134: variable. <code class="varname">PACKAGES</code> defaults to
7135: <code class="filename">pkgsrc/packages</code>.</p>
7136: <p>If there should be no binary package, set
7137: <code class="varname">NO_PACKAGE</code> to “<span class="quote">yes</span>”.
7138: This should only be used in rare cases, like when a package
7139: definitely is only usable on the machine where it is built and even
7140: then, a binary package can be useful.</p>
7141: </div>
7142: <div class="sect1" lang="en">
7143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 7144: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1 dsieger 7145: <p>Once you're finished with a package, you can clean the work
7146: directory by running <span><strong class="command">make clean</strong></span>. If you want
7147: to clean the work directories of all dependencies too, use
7148: <span><strong class="command">make clean-depends</strong></span>.</p>
7149: </div>
7150: <div class="sect1" lang="en">
7151: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 7152: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.1 dsieger 7153: <div class="variablelist"><dl>
7154: <dt><span class="term">pre/post-*</span></dt>
7155: <dd><p>For any of the main targets described in the
7156: previous section, two auxiliary targets exist with
7157: “<span class="quote">pre-</span>” and “<span class="quote">post-</span>” used as a
7158: prefix for the main target's name. These targets are
7159: invoked before and after the main target is called,
7160: allowing extra configuration or installation steps be
7161: performed from a package's Makefile, for example, which
7162: a program's configure script or install target
7163: omitted.</p></dd>
7164: <dt><span class="term">do-*</span></dt>
7165: <dd><p>Should one of the main targets do the wrong thing,
7166: and should there be no variable to fix this, you can
7167: redefine it with the do-* target. (Note that redefining
7168: the target itself instead of the do-* target is a bad
7169: idea, as the pre-* and post-* targets won't be called
7170: anymore, etc.) You will not usually need to do
7171: this.</p></dd>
7172: <dt><span class="term">reinstall</span></dt>
7173: <dd>
7174: <p>If you did a <span><strong class="command">make install</strong></span> and
7175: you noticed some file was not installed properly, you
7176: can repeat the installation with this target, which will
7177: ignore the “<span class="quote">already installed</span>” flag.</p>
7178: <p>This is the default value of
7179: <code class="varname">DEPENDS_TARGET</code> except in the case of
7180: <span><strong class="command">make update</strong></span> and <span><strong class="command">make
7181: package</strong></span>, where the defaults are
7182: “<span class="quote">package</span>” and “<span class="quote">update</span>”,
7183: respectively.</p>
7184: </dd>
7185: <dt><span class="term">deinstall</span></dt>
7186: <dd>
7187: <p>This target does a <a 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
7188: current directory, effectively de-installing the
7189: package. The following variables can be used to tune the
7190: behaviour:</p>
7191: <div class="variablelist"><dl>
7192: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
7193: <dd><p>Add a "-v" to the <a 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>
7194: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
7195: <dd><p>Remove all packages that require (depend on)
7196: the given package. This can be used to remove any
7197: packages that may have been pulled in by a given
7198: package, e.g. if <span><strong class="command">make deinstall
7199: DEINSTALLDEPENDS=1</strong></span> is done in
7200: <code class="filename">pkgsrc/x11/kde</code>, this is
7201: likely to remove whole KDE. Works by adding
7202: “<span class="quote">-R</span>” to the <a 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>
7203: command line.</p></dd>
7204: </dl></div>
7205: </dd>
7206: <dt><span class="term">bin-install</span></dt>
7207: <dd><p>Install a binary package from local disk and via FTP
7208: from a list of sites (see the
7209: <code class="varname">BINPKG_SITES</code> variable), and do a
7210: <span><strong class="command">make package</strong></span> if no binary package is
7211: available anywhere. The arguments given to
7212: <span><strong class="command">pkg_add</strong></span> can be set via
7213: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7214: operation, etc.</p></dd>
7215: <dt><span class="term">update</span></dt>
7216: <dd>
7217: <p>This target causes the current package to be
7218: updated to the latest version. The package and all
7219: depending packages first get de-installed, then current
7220: versions of the corresponding packages get compiled and
7221: installed. This is similar to manually noting which
7222: packages are currently installed, then performing a
7223: series of <span><strong class="command">make deinstall</strong></span> and
7224: <span><strong class="command">make install</strong></span> (or whatever
7225: <code class="varname">UPDATE_TARGET</code> is set to) for these
7226: packages.</p>
7227: <p>You can use the “<span class="quote">update</span>” target to
7228: resume package updating in case a previous <span><strong class="command">make
7229: update</strong></span> was interrupted for some reason.
7230: However, in this case, make sure you don't call
7231: <span><strong class="command">make clean</strong></span> or otherwise remove the
7232: list of dependent packages in <code class="varname">WRKDIR</code>.
7233: Otherwise, you lose the ability to automatically update
7234: the current package along with the dependent packages
7235: you have installed.</p>
7236: <p>Resuming an interrupted <span><strong class="command">make
7237: update</strong></span> will only work as long as the package
7238: tree remains unchanged. If the source code for one of
7239: the packages to be updated has been changed, resuming
7240: <span><strong class="command">make update</strong></span> will most certainly
7241: fail!</p>
7242: <p>The following variables can be used either on the
1.4 rillig 7243: command line or in <a href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7244: alter the behaviour of <span><strong class="command">make
7245: update</strong></span>:</p>
7246: <div class="variablelist"><dl>
7247: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
7248: <dd><p>Install target to recursively use for the
7249: updated package and the dependent packages.
7250: Defaults to <code class="varname">DEPENDS_TARGET</code> if
7251: set, “<span class="quote">install</span>” otherwise for
7252: <span><strong class="command">make update</strong></span>. Other good
7253: targets are “<span class="quote">package</span>” or
7254: “<span class="quote">bin-install</span>”. Do not set this to
7255: “<span class="quote">update</span>” or you will get stuck in an
7256: endless loop!</p></dd>
7257: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
7258: <dd><p>Don't clean up after updating. Useful if
7259: you want to leave the work sources of the updated
7260: packages around for inspection or other purposes.
7261: Be sure you eventually clean up the source tree
7262: (see the “<span class="quote">clean-update</span>” target below)
7263: or you may run into troubles with old source code
7264: still lying around on your next
7265: <span><strong class="command">make</strong></span> or <span><strong class="command">make
7266: update</strong></span>.</p></dd>
7267: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
7268: <dd><p>Deinstall each package before installing
7269: (making <code class="varname">DEPENDS_TARGET</code>). This
7270: may be necessary if the
7271: “<span class="quote">clean-update</span>” target (see below) was
7272: called after interrupting a running <span><strong class="command">make
7273: update</strong></span>.</p></dd>
7274: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
7275: <dd><p>Allows you to disable recursion and hardcode
7276: the target for packages. The default is
7277: “<span class="quote">update</span>” for the update target,
7278: facilitating a recursive update of prerequisite
7279: packages. Only set
7280: <code class="varname">DEPENDS_TARGET</code> if you want to
7281: disable recursive updates. Use
7282: <code class="varname">UPDATE_TARGET</code> instead to just
7283: set a specific target for each package to be
7284: installed during <span><strong class="command">make update</strong></span>
7285: (see above).</p></dd>
7286: </dl></div>
7287: </dd>
7288: <dt><span class="term">clean-update</span></dt>
7289: <dd>
7290: <p>Clean the source tree for all packages that would
7291: get updated if <span><strong class="command">make update</strong></span> was called
7292: from the current directory. This target should not be
7293: used if the current package (or any of its depending
7294: packages) have already been de-installed (e.g., after
7295: calling <span><strong class="command">make update</strong></span>) or you may lose
7296: some packages you intended to update. As a rule of
7297: thumb: only use this target <span class="emphasis"><em>before</em></span>
7298: the first time you run <span><strong class="command">make update</strong></span>
7299: and only if you have a dirty package tree (e.g., if you
7300: used <code class="varname">NOCLEAN</code>).</p>
7301: <p>If you are unsure about whether your tree is
7302: clean, you can either perform a <span><strong class="command">make
7303: clean</strong></span> at the top of the tree, or use the
7304: following sequence of commands from the directory of the
7305: package you want to update (<span class="emphasis"><em>before</em></span>
7306: running <span><strong class="command">make update</strong></span> for the first
7307: time, otherwise you lose all the packages you wanted to
7308: update!):</p>
7309: <pre class="screen">
7310: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
7311: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
7312: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7313: </pre>
7314: <p>The following variables can be used either on the
1.4 rillig 7315: command line or in <a href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7316: <span><strong class="command">make clean-update</strong></span>:</p>
1.1 dsieger 7317: <div class="variablelist"><dl>
7318: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
7319: <dd><p>After <span><strong class="command">make clean</strong></span>, do not
7320: reconstruct the list of directories to update for
7321: this package. Only use this if <span><strong class="command">make
7322: update</strong></span> successfully installed all
7323: packages you wanted to update. Normally, this is
7324: done automatically on <span><strong class="command">make
7325: update</strong></span>, but may have been suppressed by
7326: the <code class="varname">NOCLEAN</code> variable (see
7327: above).</p></dd>
7328: </dl></div>
7329: </dd>
7330: <dt><span class="term">replace</span></dt>
7331: <dd>
7332: <p>Update the installation of the current package. This
7333: differs from update in that it does not replace dependent
7334: 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
7335: target to work.</p>
7336: <p><span class="emphasis"><em>Be careful when using this
7337: target!</em></span> There are no guarantees that dependent
7338: packages will still work, in particular they will most
7339: certainly break if you <span><strong class="command">make replace</strong></span> a
7340: library package whose shared library major version changed
7341: between your installed version and the new one. For this
7342: reason, this target is not officially supported and only
7343: recommended for advanced users.</p>
7344: </dd>
7345: <dt><span class="term">info</span></dt>
7346: <dd><p>This target invokes <a 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
7347: package. You can use this to check which version of a
7348: package is installed.</p></dd>
7349: <dt><span class="term">index</span></dt>
7350: <dd>
7351: <p>This is a top-level command, i.e. it should be used in
7352: the <code class="filename">pkgsrc</code> directory. It creates a
7353: database of all packages in the local pkgsrc tree, including
7354: dependencies, comment, maintainer, and some other useful
7355: information. Individual entries are created by running
7356: <span><strong class="command">make describe</strong></span> in the packages'
7357: directories. This index file is saved as
7358: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
7359: verbose format by running <span><strong class="command">make
7360: print-index</strong></span>. You can search in it with
7361: <span><strong class="command">make search
7362: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7363: extract a list of all packages that depend on a particular
7364: one by running <span><strong class="command">make show-deps
7365: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7366: <p>Running this command takes a very long time, some
7367: hours even on fast machines!</p>
7368: </dd>
7369: <dt><span class="term">readme</span></dt>
7370: <dd>
7371: <p>This target generates a
7372: <code class="filename">README.html</code> file, which can be
7373: 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
7374: contain references to any packages which are in the
7375: <code class="varname">PACKAGES</code> directory on the local
7376: host. The generated files can be made to refer to URLs
7377: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7378: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7379: wanted to generate <code class="filename">README.html</code>
7380: files which pointed to binary packages on the local
7381: machine, in the directory
7382: <code class="filename">/usr/packages</code>, set
7383: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7384: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7385: <code class="varname">${PACKAGES}</code> directory and its
7386: subdirectories will be searched for all the binary
7387: packages.</p>
7388: <p>The target can be run at the toplevel or in category
7389: directories, in which case it descends recursively.</p>
7390: </dd>
7391: <dt><span class="term">readme-all</span></dt>
7392: <dd><p>This is a top-level command, run it in
7393: <code class="filename">pkgsrc</code>. Use this target to create a
7394: file <code class="filename">README-all.html</code> which contains a
7395: list of all packages currently available in the NetBSD
7396: Packages Collection, together with the category they belong
7397: to and a short description. This file is compiled from the
7398: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
7399: to run this <span class="emphasis"><em>after</em></span> a <span><strong class="command">make
7400: readme</strong></span>.</p></dd>
7401: <dt><span class="term">cdrom-readme</span></dt>
7402: <dd><p>This is very much the same as the
7403: “<span class="quote">readme</span>” target (see above), but is to be
7404: used when generating a pkgsrc tree to be written to a
7405: CD-ROM. This target also produces
7406: <code class="filename">README.html</code> files, and can be made
7407: to refer to URLs based on
7408: <code class="varname">CDROM_PKG_URL_HOST</code> and
7409: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
7410: <dt><span class="term">show-distfiles</span></dt>
7411: <dd><p>This target shows which distfiles and patchfiles
7412: are needed to build the package
7413: (<code class="varname">ALLFILES</code>, which contains all
7414: <code class="varname">DISTFILES</code> and
7415: <code class="varname">PATCHFILES</code>, but not
7416: <code class="filename">patches/*</code>).</p></dd>
7417: <dt><span class="term">show-downlevel</span></dt>
7418: <dd><p>This target shows nothing if the package is not
7419: installed. If a version of this package is installed,
7420: but is not the version provided in this version of
7421: pkgsrc, then a warning message is displayed. This target
7422: can be used to show which of your installed packages are
7423: downlevel, and so the old versions can be deleted, and
7424: the current ones added.</p></dd>
7425: <dt><span class="term">show-pkgsrc-dir</span></dt>
7426: <dd><p>This target shows the directory in the pkgsrc
7427: hierarchy from which the package can be built and
7428: installed. This may not be the same directory as the one
7429: from which the package was installed. This target is
7430: intended to be used by people who may wish to upgrade
7431: many packages on a single host, and can be invoked from
7432: the top-level pkgsrc Makefile by using the
7433: “<span class="quote">show-host-specific-pkgs</span>” target.</p></dd>
7434: <dt><span class="term">show-installed-depends</span></dt>
7435: <dd><p>This target shows which installed packages match
7436: the current package's <code class="varname">DEPENDS</code>. Useful
7437: if out of date dependencies are causing build
7438: problems.</p></dd>
7439: <dt><span class="term">check-shlibs</span></dt>
7440: <dd><p>After a package is installed, check all its
7441: binaries and (on ELF platforms) shared libraries to see
7442: if they find the shared libs they need. Run by default
1.4 rillig 7443: if <code class="varname">PKG_DEVELOPER</code> is set in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.1 dsieger 7444: <dt><span class="term">print-PLIST</span></dt>
7445: <dd>
7446: <p>After a “<span class="quote">make install</span>” from a new or
7447: upgraded pkg, this prints out an attempt to generate a
7448: new <code class="filename">PLIST</code> from a <span><strong class="command">find
7449: -newer work/.extract_done</strong></span>. An attempt is made
7450: to care for shared libs etc., but it is
7451: <span class="emphasis"><em>strongly</em></span> recommended to review the
7452: result before putting it into
7453: <code class="filename">PLIST</code>. On upgrades, it's useful to
7454: diff the output of this command against an already
7455: existing <code class="filename">PLIST</code> file.</p>
7456: <p>If the package installs files via <a 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
7457: other methods that don't update file access times, be
7458: sure to add these files manually to your
7459: <code class="filename">PLIST</code>, as the “<span class="quote">find
7460: -newer</span>” command used by this target won't catch
7461: them!</p>
1.6 ! rillig 7462: <p>See <a href="#print-PLIST" title="13.3. Tweaking output of make print-PLIST">Section 13.3, “Tweaking output of <span><strong class="command">make print-PLIST</strong></span>”</a> for more
1.1 dsieger 7463: information on this target.</p>
7464: </dd>
7465: <dt><span class="term">bulk-package</span></dt>
7466: <dd>
7467: <p>Used to do bulk builds. If an appropriate binary
7468: package already exists, no action is taken. If not, this
7469: target will compile, install and package it (and its
7470: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.6 ! rillig 7471: properly. See <a href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, “Configuration”</a>).
1.1 dsieger 7472: After creating the binary package, the sources, the
7473: just-installed package and its required packages are
7474: removed, preserving free disk space.</p>
7475: <p><span class="emphasis"><em>Beware that this target may deinstall
7476: all packages installed on a system!</em></span></p>
7477: </dd>
7478: <dt><span class="term">bulk-install</span></dt>
7479: <dd>
7480: <p>Used during bulk-installs to install required
7481: packages. If an up-to-date binary package is available,
7482: it will be installed via <a 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,
7483: <span><strong class="command">make bulk-package</strong></span> will be executed,
7484: but the installed binary won't be removed.</p>
7485: <p>A binary package is considered
7486: “<span class="quote">up-to-date</span>” to be installed via
7487: <a 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>
7488: <div class="itemizedlist"><ul type="disc">
7489: <li><p>None of the package's files
7490: (<code class="filename">Makefile</code>, ...) were modified
7491: since it was built.</p></li>
7492: <li><p>None of the package's required (binary)
7493: packages were modified since it was built.</p></li>
7494: </ul></div>
7495: <p><span class="emphasis"><em>Beware that this target may deinstall
7496: all packages installed on a system!</em></span></p>
7497: </dd>
7498: </dl></div>
7499: </div>
7500: </div>
7501: <div class="chapter" lang="en">
7502: <div class="titlepage"><div><div><h2 class="title">
1.6 ! rillig 7503: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 7504: <div class="toc">
7505: <p><b>Table of Contents</b></p>
7506: <dl>
1.6 ! rillig 7507: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
! 7508: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
! 7509: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
! 7510: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.1 dsieger 7511: </dl>
7512: </div>
7513: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
7514: by pkgsrc and also for individual packages to define what commands
7515: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7516: or for later run-time of an installed packaged (such as
7517: <code class="varname">DEPENDS</code>).
7518: If the native system provides an adequate tool, then in many cases, a pkgsrc
7519: package will not be used.</p>
7520: <p>When building a package, the replacement tools are
7521: made available in a directory (as symlinks or wrapper scripts)
7522: that is early in the executable search path. Just like the buildlink
7523: system, this helps with consistent builds.</p>
7524: <p>A tool may be needed to help build a specific package. For example,
7525: perl, GNU make (gmake) or yacc may be needed.</p>
7526: <p>Also a tool may be needed, for example, because the native system's supplied
7527: tool may be inefficient for building a package with pkgsrc.
7528: For example, a package may need GNU awk, bison (instead of
7529: yacc) or a better sed.</p>
7530: <p>The tools used by a package can be listed by running
7531: <span><strong class="command">make show-tools</strong></span>.</p>
7532: <div class="sect1" lang="en">
7533: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 7534: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1 dsieger 7535: <p>The default set of tools used by pkgsrc is defined in
7536: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
7537: such as: <span><strong class="command">cat</strong></span>, <span><strong class="command">awk</strong></span>,
7538: <span><strong class="command">chmod</strong></span>, <span><strong class="command">test</strong></span>, and so on.
7539: These can be seen by running:
7540: <span><strong class="command">make show-var VARNAME=USE_TOOLS</strong></span>.</p>
7541: <p>If a package needs a specific program to build
7542: then the <code class="varname">USE_TOOLS</code> variable can be used
7543: to define the tools needed.</p>
7544: </div>
7545: <div class="sect1" lang="en">
7546: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 7547: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.1 dsieger 7548: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
7549: and not the native version for a build dependency.
7550: And the :run means that it is used for a
7551: run-time dependencies also (and becomes a DEPENDS).
7552: The default is a build dependency which can be set with
7553: :build. (So in this example, it is the same as gmake:build
7554: and pkg-config:build.)</p>
7555: <pre class="programlisting">
7556: USE_TOOLS+= mktemp:pkgsrc
7557: USE_TOOLS+= gmake perl:run pkg-config
7558: </pre>
7559: <p>When using the tools framework, a
7560: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7561: which contains the full path to the appropriate tool. For example,
7562: <code class="varname">TOOLS_PATH.bash</code> could be “<span class="quote">/bin/bash</span>”
7563: on Linux systems.</p>
7564: <p>If you always need a pkgsrc version of the
7565: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7566: </p>
7567: </div>
7568: <div class="sect1" lang="en">
7569: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 7570: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1 dsieger 7571: <p>When improving or porting pkgsrc to a new platform, have a look
7572: at (or create) the corresponding platform specific make file fragment under
7573: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
7574: the name of the common tools. For example:</p>
7575: <pre class="programlisting">
7576: .if exists(/usr/bin/bzcat)
7577: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7578: .elif exists(/usr/bin/bzip2)
7579: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7580: .endif
7581:
7582: TOOLS_PLATFORM.true?= true # shell builtin
7583: </pre>
7584: </div>
7585: <div class="sect1" lang="en">
7586: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 7587: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.1 dsieger 7588: <div class="qandaset">
7589: <dl>
1.6 ! rillig 7590: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.1 dsieger 7591: </dt>
1.6 ! rillig 7592: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.1 dsieger 7593: tools?</a>
7594: </dt>
1.6 ! rillig 7595: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.1 dsieger 7596: package is using while being built? I want to know whether it
7597: uses sed or not.</a>
7598: </dt>
7599: </dl>
7600: <table border="0" summary="Q and A Set">
7601: <col align="left" width="1%">
7602: <tbody>
7603: <tr class="question">
7604: <td align="left" valign="top">
1.6 ! rillig 7605: <a name="tools.new"></a><a name="id2708056"></a><b>18.4.1.</b>
1.1 dsieger 7606: </td>
7607: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7608: </tr>
7609: <tr class="answer">
7610: <td align="left" valign="top"></td>
7611: <td align="left" valign="top"><p>TODO</p></td>
7612: </tr>
7613: <tr class="question">
7614: <td align="left" valign="top">
1.6 ! rillig 7615: <a name="tools.listall"></a><a name="id2708066"></a><b>18.4.2.</b>
1.1 dsieger 7616: </td>
7617: <td align="left" valign="top"><p>How do I get a list of all available
7618: tools?</p></td>
7619: </tr>
7620: <tr class="answer">
7621: <td align="left" valign="top"></td>
7622: <td align="left" valign="top"><p>TODO</p></td>
7623: </tr>
7624: <tr class="question">
7625: <td align="left" valign="top">
1.6 ! rillig 7626: <a name="tools.used"></a><a name="id2708145"></a><b>18.4.3.</b>
1.1 dsieger 7627: </td>
7628: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7629: package is using while being built? I want to know whether it
7630: uses sed or not.</p></td>
7631: </tr>
7632: <tr class="answer">
7633: <td align="left" valign="top"></td>
7634: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7635: to do it.)</p></td>
7636: </tr>
7637: </tbody>
7638: </table>
7639: </div>
7640: </div>
7641: </div>
7642: <div class="chapter" lang="en">
7643: <div class="titlepage"><div><div><h2 class="title">
1.6 ! rillig 7644: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1 dsieger 7645: <div class="toc">
7646: <p><b>Table of Contents</b></p>
7647: <dl>
1.6 ! rillig 7648: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1 dsieger 7649: <dd><dl>
1.6 ! rillig 7650: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
! 7651: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
! 7652: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
! 7653: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
! 7654: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
! 7655: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
! 7656: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
! 7657: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
! 7658: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
! 7659: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
! 7660: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
! 7661: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
! 7662: </dl></dd>
! 7663: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
! 7664: <dd><dl>
! 7665: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
! 7666: <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>
! 7667: </dl></dd>
! 7668: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
! 7669: <dd><dl>
! 7670: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
! 7671: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
! 7672: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
! 7673: </dl></dd>
! 7674: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
! 7675: <dd><dl>
! 7676: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
! 7677: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
! 7678: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
! 7679: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
! 7680: </dl></dd>
! 7681: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
! 7682: <dd><dl>
! 7683: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
! 7684: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
! 7685: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
! 7686: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
! 7687: </dl></dd>
! 7688: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
! 7689: <dd><dl>
! 7690: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
! 7691: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
! 7692: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
! 7693: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
! 7694: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
! 7695: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
! 7696: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
! 7697: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
! 7698: <dt><span class="sect2"><a href="#gconf2-data-files">19.6.9. Packages installing GConf2 data files</a></span></dt>
! 7699: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
! 7700: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
! 7701: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
! 7702: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
! 7703: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
! 7704: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
! 7705: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
! 7706: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
! 7707: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 7708: emulation</a></span></dt>
1.6 ! rillig 7709: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
! 7710: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 7711: </dl></dd>
1.6 ! rillig 7712: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 7713: </dl>
7714: </div>
7715: <div class="sect1" lang="en">
7716: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 7717: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.1 dsieger 7718: <div class="sect2" lang="en">
7719: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 7720: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.1 dsieger 7721: <p>One appealing feature of pkgsrc is that it runs on many
7722: different platforms. As a result, it is important to ensure,
7723: where possible, that packages in pkgsrc are portable. This
7724: chapter mentions some particular details you should pay
7725: attention to while working on pkgsrc.</p>
7726: </div>
7727: <div class="sect2" lang="en">
7728: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 7729: <a name="pulling-vars-from-etc-mk.conf"></a>19.1.2. How to pull in user-settable variables from <a href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 7730: </h3></div></div></div>
7731: <p>The pkgsrc user can configure pkgsrc by overriding several
7732: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.4 rillig 7733: which is <a href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 7734: want to use those variables in the preprocessor directives of
7735: <a 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
7736: <code class="literal">.for</code>), you need to include the file
7737: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7738: loads the user preferences.</p>
7739: <p>But note that some variables may not be completely defined
7740: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7741: included, as they may contain references to variables that are
7742: not yet defined. In shell commands this is no problem, since
7743: variables are actually macros, which are only expanded when they
7744: are used. But in the preprocessor directives mentioned above and
7745: in dependency lines (of the form <code class="literal">target:
7746: dependencies</code>) the variables are expanded at load
7747: time.</p>
7748: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
7749: <h3 class="title">Note</h3>
7750: <p>Currently there is no exhaustive list of all
7751: variables that tells you whether they can be used at load time
7752: or only at run time, but it is in preparation.</p>
7753: </div>
7754: </div>
7755: <div class="sect2" lang="en">
7756: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 7757: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.1 dsieger 7758: <p>Occasionally, packages require interaction from the user,
7759: and this can be in a number of ways:</p>
7760: <div class="itemizedlist"><ul type="disc">
7761: <li><p>When fetching the distfiles, some packages require user
7762: interaction such as entering username/password or accepting a
7763: license on a web page.</p></li>
7764: <li><p>When extracting the distfiles, some packages may ask for
7765: passwords.</p></li>
7766: <li><p>help to configure the package before it is built</p></li>
7767: <li><p>help during the build process</p></li>
7768: <li><p>help during the installation of a package</p></li>
7769: </ul></div>
7770: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7771: provided to notify the pkgsrc mechanism of an interactive stage
7772: which will be needed, and this should be set in the package's
7773: <code class="filename">Makefile</code>, e.g.:</p>
7774: <pre class="programlisting">
7775: INTERACTIVE_STAGE= build
7776: </pre>
7777: <p>Multiple interactive stages can be specified:</p>
7778: <pre class="programlisting">
7779: INTERACTIVE_STAGE= configure install
7780: </pre>
7781: <p>The user can then decide to skip this package by setting the
7782: <code class="varname">BATCH</code> variable.</p>
7783: </div>
7784: <div class="sect2" lang="en">
7785: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 7786: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.1 dsieger 7787: <p>Authors of software can choose the licence under which
7788: software can be copied. This is due to copyright law, and reasons
7789: for license choices are outside the scope of pkgsrc. The pkgsrc
7790: system recognizes that there are a number of licenses which some
7791: users may find objectionable or difficult or impossible to comply
7792: with. The Free Software Foundation has declared some licenses
7793: "Free", and the Open Source Initiative has a definition of "Open
7794: Source". The pkgsrc system, as a policy choice, does not label
7795: packages which have licenses that are Free or Open Source.
7796: However, packages without a license meeting either of those tests
7797: are labeled with a license tag denoting the license. Note that a
7798: package with no license to copy trivially does not meet either the
7799: Free or Open Source test.</p>
7800: <p>For packages which are not Free or Open Source, pkgsrc will
7801: not build the package unless the user has indicated to pkgsrc that
7802: packages with that particular license may be built. Note that
7803: this documentation avoids the term "accepted the license". The
7804: pkgsrc system is merely providing a mechanism to avoid
7805: accidentally building a package with a non-free license;
7806: judgement and responsibility remain with the user. (Installation
7807: of binary packages are not currently subject to this mechanism;
7808: this is a bug.)</p>
7809: <p>One might want to only install packages with a BSD license,
7810: or the GPL, and not the other. The pkgsrc license tag mechanism
7811: does not provide a way to do this. It might be possible to put in
7812: tags for free licenses, and have a default
7813: <code class="varname">ACCEPTABLE_LICENSES</code> variable value, but this is
7814: widely viewed as having a very poor ratio of benefit to
7815: work.</p>
7816: <p>The license tag mechanism is intended to address
7817: copyright-related issues surrounding building, installing and
7818: using a package, and not to address redistribution issues (see
7819: <code class="varname">RESTRICTED</code> and
7820: <code class="varname">NO_SRC_ON_FTP</code>, etc.). However, the above
7821: definition of licenses for which tags are not needed implies
7822: that packages with redistribution restrictions should have
7823: tags, because Free or Open Source programs do not have
7824: redistribution restrictions.</p>
7825: <p>Denoting that a package may be copied according to a
7826: particular license is done by placing the license in
7827: <code class="filename">pkgsrc/licenses</code> and setting the
7828: <code class="varname">LICENSE</code> variable to a string identifying the
7829: 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>
7830: <pre class="programlisting">
7831: LICENSE= xv-license
7832: </pre>
7833: <p>When trying to build, the user will get a notice that the
7834: package is covered by a license which has not been placed in the
7835: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7836: <pre class="programlisting">
7837: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7838: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7839: ===> To view the license, enter "/usr/bin/make show-license".
7840: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7841: ===> ACCEPTABLE_LICENSES+=xv-license
7842: *** Error code 1
7843: </pre>
7844: <p>The license can be viewed with <span><strong class="command">make
7845: show-license</strong></span>, and if the user so chooses, the line
1.4 rillig 7846: printed above can be added to <a href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7847: convey to pkgsrc that it should not in the future fail because of
7848: that license:</p>
7849: <pre class="programlisting">
7850: ACCEPTABLE_LICENSES+=xv-license
7851: </pre>
7852: <p>When adding a package with a new license, the license text
7853: should be added to <code class="filename">pkgsrc/licenses</code> for
7854: displaying. A list of known licenses can be seen in this
7855: directory.</p>
7856: <p>When the license changes (in a way other than formatting),
7857: please make sure that the new license has a different name (e.g.,
7858: append the version number if it exists, or the date). Just
7859: because a user told pkgsrc to build programs under a previous
7860: version of a license does not mean that pkgsrc should build
7861: programs under the new licenses. The higher-level point is that
7862: pkgsrc does not evaluate licenses for reasonableness; the only
7863: test is a mechanistic test of whether a particular text has been
7864: approved by either of two bodies.</p>
7865: <p>The use of <code class="varname">LICENSE=shareware</code>,
7866: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7867: is deprecated because it does not crisply refer to a particular
7868: license text. Another problem with such usage is that it does not
7869: enable a user to tell pkgsrc to proceed for a single package
7870: without also telling pkgsrc to proceed for all packages with that
7871: tag.</p>
7872: </div>
7873: <div class="sect2" lang="en">
7874: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 7875: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.1 dsieger 7876: <p>Some licenses restrict how software may be re-distributed.
7877: Because a license tag is required unless the package is Free or
7878: Open Source, all packages with restrictions should have license
7879: tags. By declaring the restrictions, package tools can
7880: automatically refrain from e.g. placing binary packages on FTP
7881: sites.</p>
7882: <p>There are four restrictions that may be encoded, which are
7883: the cross product of sources (distfiles) and binaries not being
7884: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7885: language in any license, and because non-Free licenses tend to be
7886: different from each other, pkgsrc adopts a definition of FTP and
7887: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7888: should not be made available over the Internet at no charge.
7889: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7890: made available on some kind of media, together with other source
7891: and binary packages, and which is sold for a distribution charge.
7892: </p>
7893: <p>In order to encode these restrictions, the package system
7894: defines five make variables that can be set to note these
7895: restrictions:</p>
7896: <div class="itemizedlist"><ul type="disc">
7897: <li>
7898: <p><code class="varname">RESTRICTED</code></p>
7899: <p>This variable should be set whenever a restriction
7900: exists (regardless of its kind). Set this variable to a
7901: string containing the reason for the restriction. It should
7902: be understood that those wanting to understand the restriction
7903: will have to read the license, and perhaps seek advice of
7904: counsel.</p>
7905: </li>
7906: <li>
7907: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7908: <p>Binaries may not be placed on CD-ROM containing other
7909: binary packages, for which a distribution charge may be made.
7910: In this case, set this variable to
7911: <code class="varname">${RESTRICTED}</code>.</p>
7912: </li>
7913: <li>
7914: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7915: <p>Binaries may not made available on the Internet without
7916: charge. In this case, set this variable to
7917: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7918: binary packages will not be included on ftp.NetBSD.org.</p>
7919: </li>
7920: <li>
7921: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7922: <p>Distfiles may not be placed on CD-ROM, together with
7923: other distfiles, for which a fee may be charged. In this
7924: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7925: </p>
7926: </li>
7927: <li>
7928: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7929: <p>Distfiles may not made available via FTP at no charge.
7930: In this case, set this variable to
7931: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7932: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7933: </li>
7934: </ul></div>
7935: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
7936: <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
7937: generic make variables to denote restrictions is deprecated,
7938: because they unconditionally prevent users from generating
7939: binary packages!</p>
7940: </div>
7941: <div class="sect2" lang="en">
7942: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 7943: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.1 dsieger 7944: <p>Your package may depend on some other package being present
7945: - and there are various ways of expressing this dependency.
7946: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7947: <code class="varname">DEPENDS</code> definitions, the
7948: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7949: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7950: to handle dependencies, and which uses the variables named above.
1.6 ! rillig 7951: See <a href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.1 dsieger 7952: <p>The basic difference between the two variables is as
7953: follows: The <code class="varname">DEPENDS</code> definition registers
7954: that pre-requisite in the binary package so it will be pulled in
7955: when the binary package is later installed, whilst the
7956: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7957: dependency that is only needed for building the package.</p>
7958: <p>This means that if you only need a package present whilst
7959: you are building, it should be noted as a
7960: <code class="varname">BUILD_DEPENDS</code>.</p>
7961: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
7962: <code class="varname">DEPENDS</code> definition is:</p>
7963: <pre class="programlisting">
7964: <pre-req-package-name>:../../<category>/<pre-req-package>
7965: </pre>
7966: <p>Please note that the “<span class="quote">pre-req-package-name</span>”
7967: may include any of the wildcard version numbers recognized by
7968: <a 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>
7969: <div class="orderedlist"><ol type="1">
7970: <li>
7971: <p>If your package needs another package's binaries or
7972: libraries to build or run, and if that package has a
7973: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7974: <pre class="programlisting">
7975: .include "../../graphics/jpeg/buildlink3.mk"
7976: </pre>
7977: </li>
7978: <li>
7979: <p>If your package needs to use another package to build
7980: itself and there is no <code class="filename">buildlink3.mk</code>
7981: file available, use the <code class="varname">BUILD_DEPENDS</code>
7982: definition:</p>
7983: <pre class="programlisting">
7984: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
7985: </pre>
7986: </li>
7987: <li>
7988: <p>If your package needs a library with which to link and
7989: again there is no <code class="filename">buildlink3.mk</code> file
7990: available, this is specified using the
7991: <code class="varname">DEPENDS</code> definition. For example:</p>
7992: <pre class="programlisting">
7993: DEPENDS+= xpm-3.4j:../../graphics/xpm
7994: </pre>
7995: <p>You can also use wildcards in package dependences:</p>
7996: <pre class="programlisting">
7997: DEPENDS+= xpm-[0-9]*:../../graphics/xpm
7998: </pre>
7999: <p>Note that such wildcard dependencies are retained when
8000: creating binary packages. The dependency is checked when
8001: installing the binary package and any package which matches
8002: the pattern will be used. Wildcard dependencies should be
8003: used with care.</p>
8004: <p>The “<span class="quote">-[0-9]*</span>” should be used instead of
8005: “<span class="quote">-*</span>” to avoid potentially ambiguous matches
8006: such as “<span class="quote">tk-postgresql</span>” matching a
8007: “<span class="quote">tk-*</span>” <code class="varname">DEPENDS</code>.</p>
8008: <p>Wildcards can also be used to specify that a package
8009: will only build against a certain minimum version of a
8010: pre-requisite:</p>
8011: <pre class="programlisting">
8012: DEPENDS+= tiff>=3.5.4:../../graphics/tiff
8013: </pre>
8014: <p>This means that the package will build against version
8015: 3.5.4 of the tiff library or newer. Such a dependency may
8016: be warranted if, for example, the API of the library has
8017: changed with version 3.5.4 and a package would not compile
8018: against an earlier version of tiff.</p>
8019: <p>Please note that such dependencies should only be
8020: updated if a package requires a newer pre-requisite, but
8021: not to denote recommendations such as
8022: ABI changes that do not prevent a package from building
8023: correctly. Such recommendations can be expressed using
8024: <code class="varname">ABI_DEPENDS</code>:</p>
8025: <pre class="programlisting">
8026: ABI_DEPENDS+= tiff>=3.6.1:../../graphics/tiff
8027: </pre>
8028: <p>In addition to the above <code class="varname">DEPENDS</code>
8029: line, this denotes that while a package will build against
8030: tiff>=3.5.4, at least version 3.6.1 is recommended.
8031: <code class="varname">ABI_DEPENDS</code> entries will be turned into
8032: dependencies unless explicitly ignored (in which case a
8033: warning will be printed).</p>
8034: <p>To ignore these ABI dependency recommendations and just
8035: use the required <code class="varname">DEPENDS</code>, set
8036: <code class="varname">USE_ABI_DEPENDS=NO</code>. This may make
8037: it easier and faster to update packages built using pkgsrc,
8038: since older compatible dependencies can continue to be
8039: used. This is useful for people who watch their rebuilds
8040: very carefully; it is not very good as a general-purpose
8041: hammer. If you use it, you need to be mindful of possible
8042: ABI changes, including those from the underlying OS.</p>
8043: <p>Packages that are built with recommendations ignored
8044: may not be uploaded to ftp.NetBSD.org by developers and
8045: should not be used across different systems that may have
8046: different versions of binary packages installed.</p>
8047: <p>For security fixes, please update the package
1.6 ! rillig 8048: vulnerabilities file. See <a 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.1 dsieger 8049: information.</p>
8050: </li>
8051: <li>
8052: <p>If your package needs some executable to be able to run
8053: correctly and if there's no
8054: <code class="filename">buildlink3.mk</code> file, this is specified
8055: using the <code class="varname">DEPENDS</code> variable. The
8056: <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
8057: be able to execute the latex binary from the teTeX package
8058: when it runs, and that is specified:</p>
8059: <pre class="programlisting">
8060: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
8061: </pre>
8062: <p>The comment about wildcard dependencies from previous
8063: paragraph applies here, too.</p>
8064: </li>
8065: </ol></div>
8066: <p>If your package needs files from another package to build,
8067: add the relevant distribution files to
8068: <code class="varname">DISTFILES</code>, so they will be extracted
8069: 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.
8070: (It relies on the jpeg sources being present in source form
8071: during the build.)</p>
8072: </div>
8073: <div class="sect2" lang="en">
8074: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8075: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 8076: <p>Your package may conflict with other packages a user might
8077: already have installed on his system, e.g. if your package
8078: installs the same set of files as another package in the pkgsrc
8079: tree.</p>
8080: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
8081: space-separated list of packages (including version string) your
8082: package conflicts with.</p>
8083: <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>
8084: 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>
8085: install the same shared library, thus you set in
8086: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
8087: <pre class="programlisting">
8088: CONFLICTS= Xaw-Xpm-[0-9]*
8089: </pre>
8090: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
8091: <pre class="programlisting">
8092: CONFLICTS= Xaw3d-[0-9]*
8093: </pre>
8094: <p>Packages will automatically conflict with other packages
8095: with the name prefix and a different version
8096: string. “<span class="quote">Xaw3d-1.5</span>” e.g. will automatically
8097: conflict with the older version “<span class="quote">Xaw3d-1.3</span>”.</p>
8098: </div>
8099: <div class="sect2" lang="en">
8100: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8101: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 8102: <p>There are several reasons why a package might be
8103: instructed to not build under certain circumstances. If the
8104: package builds and runs on most platforms, the exceptions
8105: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
8106: the package builds and runs on a small handful of platforms,
8107: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
8108: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
8109: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
8110: (OS-version-platform) that can use glob-style
8111: wildcards.</p>
8112: <p>Some packages are tightly bound to a specific version of an
8113: 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
8114: backwards compatible with other versions of the OS, and should be
8115: uploaded to a version specific directory on the FTP server. Mark
8116: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
8117: “<span class="quote">yes</span>”. This variable is not currently used by any of
8118: the package system internals, but may be used in the
8119: future.</p>
8120: <p>If the package should be skipped (for example, because it
8121: provides functionality already provided by the system), set
8122: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
8123: the package should fail because some preconditions are not met,
8124: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
8125: message.</p>
8126: </div>
8127: <div class="sect2" lang="en">
8128: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8129: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 8130: <p>To ensure that a package may not be deleted, once it has been
8131: installed, the <code class="varname">PKG_PRESERVE</code> definition should
8132: be set in the package Makefile. This will be carried into any
8133: binary package that is made from this pkgsrc entry. A
8134: “<span class="quote">preserved</span>” package will
8135: not be deleted using <a 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
8136: “<span class="quote">-f</span>” option is used.</p>
8137: </div>
8138: <div class="sect2" lang="en">
8139: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8140: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 8141: <p>When a vulnerability is found, this should be noted in
8142: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
8143: and after committing that file, use <span><strong class="command">make upload</strong></span>
8144: in the same directory to update the file on ftp.NetBSD.org.</p>
8145: <p>After fixing the vulnerability by a patch, its
8146: <code class="varname">PKGREVISION</code> should be increased (this
8147: is of course not necessary if the problem is fixed by using
8148: a newer release of the software).</p>
8149: <p>Also, if the fix should be applied to the stable pkgsrc
8150: branch, be sure to submit a pullup request!</p>
8151: <p>Binary packages already on ftp.NetBSD.org will be handled
8152: semi-automatically by a weekly cron job.</p>
8153: </div>
8154: <div class="sect2" lang="en">
8155: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8156: <a name="bumping-pkgrevision"></a>19.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.1 dsieger 8157: <p>When making fixes to an existing package it can be useful
8158: to change the version number in <code class="varname">PKGNAME</code>. To
8159: avoid conflicting with future versions by the original author, a
8160: “<span class="quote">nb1</span>”, “<span class="quote">nb2</span>”, ... suffix can be used
8161: on package versions by setting <code class="varname">PKGREVISION=1</code>
8162: (2, ...). The “<span class="quote">nb</span>” is treated like a
8163: “<span class="quote">.</span>” by the package tools. e.g.</p>
8164: <pre class="programlisting">
8165: DISTNAME= foo-17.42
8166: PKGREVISION= 9
8167: </pre>
8168: <p>will result in a <code class="varname">PKGNAME</code> of
8169: “<span class="quote">foo-17.42nb9</span>”. If you want to use the original
8170: value of <code class="varname">PKGNAME</code> without the “<span class="quote">nbX</span>”
8171: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8172: <code class="varname">PKGNAME_NOREV</code>.</p>
8173: <p>When a new release of the package is released, the
8174: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8175: minor release of the above package, things should be like:</p>
8176: <pre class="programlisting">
8177: DISTNAME= foo-17.43
8178: </pre>
8179: <p><code class="varname">PKGREVISION</code> should be incremented for any
8180: non-trivial change in the resulting binary package. Without a
8181: <code class="varname">PKGREVISION</code> bump, someone with the previous
8182: version installed has no way of knowing that their package is out
8183: of date. Thus, changes without increasing
8184: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8185: trivial that no reasonable person would want to upgrade", and this
8186: is the rough test for when increasing
8187: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8188: changes that do not merit increasing
8189: <code class="varname">PKGREVISION</code> are:</p>
8190: <div class="itemizedlist"><ul type="disc">
8191: <li><p>Changing <code class="varname">HOMEPAGE</code>, <code class="varname">MAINTAINER</code>,
8192: or comments in Makefile.</p></li>
8193: <li><p>
8194: Changing build variables if the resulting binary package is the same.</p></li>
8195: <li><p>
8196: Changing <code class="filename">DESCR</code>.</p></li>
8197: <li><p>
8198: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8199: </ul></div>
8200: <p>Examples of changes that do merit an increase to
8201: <code class="varname">PKGREVISION</code> include:</p>
8202: <div class="itemizedlist"><ul type="disc">
8203: <li><p>
8204: Security fixes</p></li>
8205: <li><p>
8206: Changes or additions to a patch file</p></li>
8207: <li><p>
8208: Changes to the <code class="filename">PLIST</code></p></li>
8209: </ul></div>
8210: <p>PKGREVISION must also be incremented when dependencies have ABI
8211: changes.</p>
8212: </div>
8213: <div class="sect2" lang="en">
8214: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8215: <a name="fixes.subst"></a>19.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.1 dsieger 8216: <p>When you want to replace the same text in multiple files
8217: or when the replacement text varies, patches alone cannot help.
8218: This is where the SUBST framework comes in. It provides an
8219: easy-to-use interface for replacing text in files.
8220: Example:</p>
8221: <pre class="programlisting">
8222: SUBST_CLASSES+= fix-paths
8223: SUBST_STAGE.fix-paths= pre-configure
8224: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8225: SUBST_FILES.fix-paths= src/*.c
8226: SUBST_FILES.fix-paths+= scripts/*.sh
8227: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8228: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
8229: </pre>
8230: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
8231: that are used to identify the different SUBST blocks that are
8232: defined. The SUBST framework is heavily used by pkgsrc, so it is
8233: important to always use the <code class="literal">+=</code> operator with
8234: this variable. Otherwise some substitutions may be
8235: skipped.</p>
8236: <p>The remaining variables of each SUBST block are
8237: parameterized with the identifier from the first line
8238: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8239: parameters to a function call.</p>
8240: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
8241: which the replacement will take place. All combinations of
8242: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8243: <code class="literal">post-</code> together with a phase name are
8244: possible, though only few are actually used. Most commonly used
8245: are <code class="literal">post-patch</code> and
8246: <code class="literal">pre-configure</code>. Of these two,
8247: <code class="literal">pre-configure</code> should be preferred because
8248: then it is possible to run <span><strong class="command">bmake patch</strong></span> and
8249: have the state after applying the patches but before making any
8250: other changes. This is especially useful when you are debugging
8251: a package in order to create new patches for it. Similarly,
8252: <code class="literal">post-build</code> is preferred over
8253: <code class="literal">pre-install</code>, because the install phase should
8254: generally be kept as simple as possible. When you use
8255: <code class="literal">post-build</code>, you have the same files in the
8256: working directory that will be installed later, so you can check
8257: if the substitution has succeeded.</p>
8258: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
8259: that is printed just before the substitution is done.</p>
8260: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
8261: globbing patterns that specifies the files in which the
8262: substitution will take place. The patterns are interpreted
8263: relatively to the <code class="varname">WRKSRC</code> directory.</p>
8264: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
8265: <a 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
8266: command should be prefixed with <code class="literal">-e</code>, so that
8267: all SUBST blocks look uniform.</p>
8268: <p>There are some more variables, but they are so seldomly
8269: used that they are only documented in the
8270: <code class="filename">mk/subst.mk</code> file.</p>
8271: </div>
8272: </div>
8273: <div class="sect1" lang="en">
8274: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 8275: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 8276: <div class="sect2" lang="en">
8277: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8278: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.1 dsieger 8279: <p>If you need to download from a dynamic URL you can set
8280: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span><strong class="command">make
8281: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8282: with the name of each file to download as an argument, expecting
8283: it to output the URL of the directory from which to download
8284: 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
8285: example of this usage.</p>
8286: <p>If the download can't be automated, because the user must
8287: submit personal information to apply for a password, or must pay
8288: for the source, or whatever, you can set
8289: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8290: displayed to the user before aborting the build. Example:</p>
8291: <pre class="programlisting">
8292: FETCH_MESSAGE= "Please download the files"
8293: FETCH_MESSAGE+= " "${DISTFILES:Q}
8294: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
8295: </pre>
8296: </div>
8297: <div class="sect2" lang="en">
8298: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8299: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.1 dsieger 8300: <p>Sometimes authors of a software package make some
8301: modifications after the software was released, and they put up a
8302: new distfile without changing the package's version number. If a
8303: package is already in pkgsrc at that time, the checksum will
8304: no longer match. The contents of the new distfile should be
8305: compared against the old one before changing anything, to make
8306: sure the distfile was really updated on purpose, and that
8307: no trojan horse or so crept in.
8308: Please mention that the distfiles were compared and what was found
8309: in your commit message.
8310: Then, the correct way to work around this is to
8311: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8312: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8313: <code class="varname">DISTFILES</code> and
8314: <code class="varname">PATCHFILES</code> for this package will be put in that
8315: subdirectory of the local distfiles directory.
1.6 ! rillig 8316: (See <a 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.1 dsieger 8317: In case this
8318: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8319: including the <code class="filename">nbX</code> suffix) or a date stamp
8320: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
8321: Do not forget regenerating the <code class="filename">distinfo</code> file
8322: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8323: path in the filenames.
8324: Also increase the PKGREVISION if the installed package is different.
8325: Furthermore, a mail to the package's authors seems appropriate
8326: telling them that changing distfiles after releases without
8327: changing the file names is not good practice.</p>
8328: </div>
8329: </div>
8330: <div class="sect1" lang="en">
8331: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 8332: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 8333: <div class="sect2" lang="en">
8334: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8335: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 8336: <p>pkgsrc supports many different machines, with different
8337: object formats like a.out and ELF, and varying abilities to do
8338: shared library and dynamic loading at all. To accompany this,
8339: varying commands and options have to be passed to the
8340: compiler, linker, etc. to get the Right Thing, which can be
8341: pretty annoying especially if you don't have all the machines
8342: at your hand to test things. The
8343: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
8344: can help here, as it just “<span class="quote">knows</span>” how to build
8345: both static and dynamic libraries from a set of source files,
8346: thus being platform-independent.</p>
8347: <p>Here's how to use libtool in a package in seven simple
8348: steps:</p>
8349: <div class="orderedlist"><ol type="1">
8350: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
8351: Makefile.</p></li>
8352: <li><p>For library objects, use “<span class="quote">${LIBTOOL} --mode=compile
8353: ${CC}</span>” in place of “<span class="quote">${CC}</span>”. You could even
8354: add it to the definition of <code class="varname">CC</code>, if only
8355: libraries are being built in a given Makefile. This one command
8356: will build both PIC and non-PIC library objects, so you need not
8357: have separate shared and non-shared library rules.</p></li>
8358: <li>
8359: <p>For the linking of the library, remove any
8360: “<span class="quote">ar</span>”, “<span class="quote">ranlib</span>”, and “<span class="quote">ld
8361: -Bshareable</span>” commands, and instead use:</p>
8362: <pre class="programlisting">
8363: ${LIBTOOL} --mode=link \
8364: ${CC} -o ${.TARGET:.a=.la} \
8365: ${OBJS:.o=.lo} \
8366: -rpath ${PREFIX}/lib \
8367: -version-info major:minor
8368: </pre>
8369: <p>Note that the library is changed to have a
8370: <code class="filename">.la</code> extension, and the objects are
8371: changed to have a <code class="filename">.lo</code>
8372: extension. Change <code class="varname">OBJS</code> as
8373: necessary. This automatically creates all of the
8374: <code class="filename">.a</code>,
8375: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8376: necessary) in the build directory. Be sure to include
8377: “<span class="quote">-version-info</span>”, especially when major and
8378: minor are zero, as libtool will otherwise strip off the
8379: shared library version.</p>
8380: <p>From the libtool manual:</p>
8381: <pre class="programlisting">
8382: So, libtool library versions are described by three integers:
8383:
8384: CURRENT
8385: The most recent interface number that this library implements.
8386:
8387: REVISION
8388: The implementation number of the CURRENT interface.
8389:
8390: AGE
8391: The difference between the newest and oldest interfaces that
8392: this library implements. In other words, the library implements
8393: all the interface numbers in the range from number `CURRENT -
8394: AGE' to `CURRENT'.
8395:
8396: If two libraries have identical CURRENT and AGE numbers, then the
8397: dynamic linker chooses the library with the greater REVISION number.
8398: </pre>
8399: <p>The “<span class="quote">-release</span>” option will produce
8400: different results for a.out and ELF (excluding symlinks)
8401: in only one case. An ELF library of the form
8402: “<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8403: will have a symlink of
8404: “<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8405: on an a.out platform. This is handled
8406: automatically.</p>
8407: <p>The “<span class="quote">-rpath argument</span>” is the install
8408: directory of the library being built.</p>
8409: <p>In the <code class="filename">PLIST</code>, include only the
8410: <code class="filename">.la</code> file, the other files will be
8411: added automatically.</p>
8412: </li>
8413: <li>
8414: <p>When linking shared object (<code class="filename">.so</code>)
8415: files, i.e. files that are loaded via <a 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
8416: shared libraries, use “<span class="quote">-module
8417: -avoid-version</span>” to prevent them getting version
8418: tacked on.</p>
8419: <p>The <code class="filename">PLIST</code> file gets the
8420: <code class="filename">foo.so</code> entry.</p>
8421: </li>
8422: <li>
8423: <p>When linking programs that depend on these libraries
8424: <span class="emphasis"><em>before</em></span> they are installed, preface
8425: the <a 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 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}
8426: --mode=link</span>”, and it will find the correct
8427: libraries (static or shared), but please be aware that
8428: libtool will not allow you to specify a relative path in
8429: -L (such as “<span class="quote">-L../somelib</span>”), because it
8430: expects you to change that argument to be the
8431: <code class="filename">.la</code> file. e.g.</p>
8432: <pre class="programlisting">
8433: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
8434: </pre>
8435: <p>should be changed to:</p>
8436: <pre class="programlisting">
8437: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
8438: </pre>
8439: <p>and it will do the right thing with the libraries.</p>
8440: </li>
8441: <li>
8442: <p>When installing libraries, preface the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
8443: or <a 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}
8444: --mode=install</span>”, and change the library name to
8445: <code class="filename">.la</code>. e.g.</p>
8446: <pre class="programlisting">
8447: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
8448: </pre>
8449: <p>This will install the static <code class="filename">.a</code>,
8450: shared library, any needed symlinks, and run
8451: <a 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>
8452: </li>
8453: <li><p>In your <code class="filename">PLIST</code>, include only
8454: the <code class="filename">.la</code>
8455: file (this is a change from previous behaviour).</p></li>
8456: </ol></div>
8457: </div>
8458: <div class="sect2" lang="en">
8459: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8460: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 8461: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8462: package Makefile. This will override the package's own libtool
8463: in most cases. For older libtool using packages, libtool is
8464: made by ltconfig script during the do-configure step; you can
8465: check the libtool script location by doing <span><strong class="command">make
8466: configure; find work*/ -name libtool</strong></span>.</p>
8467: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8468: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
8469: default, it is set to “<span class="quote">libtool */libtool
8470: */*/libtool</span>”. If this does not match the location of the
8471: package's libtool script(s), set it as appropriate.</p>
8472: <p>If you do not need <code class="filename">*.a</code> static
8473: libraries built and installed, then use
8474: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8475: <p>If your package makes use of the platform-independent library
8476: for loading dynamic shared objects, that comes with libtool
8477: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8478: <p>Some packages use libtool incorrectly so that the package
8479: may not work or build in some circumstances. Some of the more
8480: common errors are:</p>
8481: <div class="itemizedlist"><ul type="disc">
8482: <li>
8483: <p>The inclusion of a shared object (-module) as a dependent library in an
8484: executable or library. This in itself isn't a problem if one of two things
8485: has been done:</p>
8486: <div class="orderedlist"><ol type="1">
8487: <li><p>The shared object is named correctly, i.e.
8488: <code class="filename">libfoo.la</code>, not
8489: <code class="filename">foo.la</code></p></li>
8490: <li><p>The -dlopen option is used when linking an executable.</p></li>
8491: </ol></div>
8492: </li>
8493: <li><p>The use of libltdl without the correct calls to initialisation routines.
8494: The function lt_dlinit() should be called and the macro
8495: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8496: executables.</p></li>
8497: </ul></div>
8498: </div>
8499: <div class="sect2" lang="en">
8500: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8501: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 8502: <p>If a package needs GNU autoconf or automake to be executed
8503: to regenerate the configure script and Makefile.in makefile
8504: templates, then they should be executed in a pre-configure
8505: target.</p>
8506: <p>For packages that need only autoconf:</p>
8507: <pre class="programlisting">
8508: AUTOCONF_REQD= 2.50 # if default version is not good enough
8509: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8510: ...
8511:
8512: pre-configure:
8513: cd ${WRKSRC} && autoconf
8514:
8515: ...
8516: </pre>
8517: <p>and for packages that need automake and autoconf:</p>
8518: <pre class="programlisting">
8519: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8520: USE_TOOLS+= automake # use "automake14" for automake-1.4
8521: ...
8522:
8523: pre-configure:
8524: set -e; cd ${WRKSRC}; \
8525: aclocal; autoheader; automake -a --foreign -i; autoconf
8526:
8527: ...
8528: </pre>
8529: <p>Packages which use GNU Automake will almost certainly
8530: require GNU Make.</p>
8531: <p>There are times when the configure process makes
8532: additional changes to the generated files, which then causes
8533: the build process to try to re-execute the automake sequence.
8534: This is prevented by touching various files in the configure
8535: stage. If this causes problems with your package you can set
8536: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8537: Makefile.</p>
8538: </div>
8539: </div>
8540: <div class="sect1" lang="en">
8541: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 8542: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.1 dsieger 8543: <div class="sect2" lang="en">
8544: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8545: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 8546: <p>Compilers for the C, C++, and Fortran languages comes with
8547: the NetBSD base system. By default, pkgsrc assumes that a package
8548: is written in C and will hide all other compilers (via the wrapper
1.6 ! rillig 8549: framework, see <a href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 8550: <p>To declare which language's compiler a package needs, set
8551: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
8552: currently are “<span class="quote">c</span>”, “<span class="quote">c++</span>”, and
8553: “<span class="quote">fortran</span>” (and any combination). The default is
8554: “<span class="quote">c</span>”. Packages using GNU configure scripts, even if
8555: written in C++, usually need a C compiler for the configure
8556: phase.</p>
8557: </div>
8558: <div class="sect2" lang="en">
8559: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8560: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1 dsieger 8561: <p>If a program is written in Java, use the Java framework in
8562: pkgsrc. The package must include
8563: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8564: provides the following variables:</p>
8565: <div class="itemizedlist"><ul type="disc">
8566: <li><p><code class="varname">USE_JAVA</code> defines if a build
8567: dependency on the JDK is added. If
8568: <code class="varname">USE_JAVA</code> is set to “<span class="quote">run</span>”, then
8569: there is only a runtime dependency on the JDK. The default is
8570: “<span class="quote">yes</span>”, which also adds a build dependency on the
8571: JDK.</p></li>
8572: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
8573: a package needs a Java2 implementation. The supported values
8574: are “<span class="quote">yes</span>”, “<span class="quote">1.4</span>”, and
8575: “<span class="quote">1.5</span>”. “<span class="quote">yes</span>” accepts any Java2
8576: implementation, “<span class="quote">1.4</span>” insists on versions 1.4 or
8577: above, and “<span class="quote">1.5</span>” only accepts versions 1.5 or
8578: above. This variable is not set by default.</p></li>
8579: </ul></div>
8580: </div>
8581: <div class="sect2" lang="en">
8582: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8583: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 8584: <p>If your package contains interpreted perl scripts, add
8585: “<span class="quote">perl</span>” to the <code class="varname">USE_TOOLS</code> variable
8586: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8587: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8588: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8589: that you want adjusted. Every occurrence of
8590: <code class="filename">*/bin/perl</code> will be replaced with the full
8591: path to the perl executable.</p>
8592: <p>If a particular version of perl is needed, set the
8593: <code class="varname">PERL5_REQD</code> variable to the version number. The
8594: default is “<span class="quote">5.0</span>”.</p>
1.6 ! rillig 8595: <p>See <a href="#perl-modules" title="19.6.6. Packages installing perl modules">Section 19.6.6, “Packages installing perl modules”</a> for information
1.1 dsieger 8596: about handling perl modules.</p>
8597: </div>
8598: <div class="sect2" lang="en">
8599: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8600: <a name="other-programming-languages"></a>19.4.4. Other programming languages</h3></div></div></div>
1.1 dsieger 8601: <p>Currently, there is no special handling for other languages
8602: in pkgsrc. If a compiler package provides a
8603: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8604: just add a (build) dependency on the appropriate compiler
8605: package.</p>
8606: </div>
8607: </div>
8608: <div class="sect1" lang="en">
8609: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 8610: <a name="fixes.build"></a>19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 8611: <p>The most common failures when building a package are that
8612: some platforms do not provide certain header files, functions or
8613: libraries, or they provide the functions in a library that the
8614: original package author didn't know. To work around this, you
8615: can rewrite the source code in most cases so that it does not
8616: use the missing functions or provides a replacement function.</p>
8617: <div class="sect2" lang="en">
8618: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8619: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 8620: <p>If a package already comes with a GNU configure script, the
8621: preferred way to fix the build failure is to change the
8622: configure script, not the code. In the other cases, you can
8623: utilize the C preprocessor, which defines certain macros
8624: depending on the operating system and hardware architecture it
8625: compiles for. These macros can be queried using for example
8626: <code class="varname">#if defined(__i386)</code>. Almost every operating
8627: system, hardware architecture and compiler has its own macro.
8628: For example, if the macros <code class="varname">__GNUC__</code>,
8629: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8630: are all defined, you know that you are using NetBSD on an i386
8631: compatible CPU, and your compiler is GCC.</p>
8632: <p>The list of the following macros for hardware and
8633: operating system depends on the compiler that is used. For
8634: example, if you want to conditionally compile code on Solaris,
8635: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8636: does not define it. Use <code class="varname">__sun</code> instead.</p>
8637: <div class="sect3" lang="en">
8638: <div class="titlepage"><div><div><h4 class="title">
1.6 ! rillig 8639: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.1 dsieger 8640: <p>To distinguish between 4.4 BSD-derived systems and the
8641: rest of the world, you should use the following code.</p>
8642: <pre class="programlisting">
8643: #include <sys/param.h>
8644: #if (defined(BSD) && BSD >= 199306)
8645: /* BSD-specific code goes here */
8646: #else
8647: /* non-BSD-specific code goes here */
8648: #endif
8649: </pre>
8650: <p>If this distinction is not fine enough, you can also test
8651: for the following macros.</p>
8652: <pre class="programlisting">
8653: FreeBSD __FreeBSD__
8654: DragonFly __DragonFly__
8655: Interix __INTERIX
8656: IRIX __sgi (TODO: get a definite source for this)
8657: Linux linux, __linux, __linux__
8658: NetBSD __NetBSD__
8659: OpenBSD __OpenBSD__
8660: Solaris sun, __sun
8661: </pre>
8662: </div>
8663: <div class="sect3" lang="en">
8664: <div class="titlepage"><div><div><h4 class="title">
1.6 ! rillig 8665: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.1 dsieger 8666: <pre class="programlisting">
8667: i386 i386, __i386, __i386__
8668: MIPS __mips
8669: SPARC sparc, __sparc
8670: </pre>
8671: </div>
8672: <div class="sect3" lang="en">
8673: <div class="titlepage"><div><div><h4 class="title">
1.6 ! rillig 8674: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.1 dsieger 8675: <pre class="programlisting">
8676: GCC __GNUC__ (major version), __GNUC_MINOR__
8677: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8678: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8679: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8680: </pre>
8681: </div>
8682: </div>
8683: <div class="sect2" lang="en">
8684: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8685: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 8686: <p>Some source files trigger bugs in the compiler, based on
8687: combinations of compiler version and architecture and almost
8688: always relation to optimisation being enabled. Common symptoms
8689: are gcc internal errors or never finishing compiling a
8690: file.</p>
8691: <p>Typically, a workaround involves testing the
8692: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8693: optimisation for that combination of file,
8694: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
8695: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
8696: number of examples.</p>
8697: </div>
8698: <div class="sect2" lang="en">
8699: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8700: <a name="undefined-reference"></a>19.5.3. Undefined reference to “<span class="quote">...</span>”</h3></div></div></div>
1.1 dsieger 8701: <p>This error message often means that a package did not
8702: link to a shared library it needs. The following functions are
8703: known to cause this error message over and over.</p>
8704: <div class="informaltable">
8705: <a name="undefined-reference-functions"></a><table border="1">
8706: <colgroup>
8707: <col>
8708: <col>
8709: <col>
8710: </colgroup>
8711: <thead><tr>
8712: <th>Function</th>
8713: <th>Library</th>
8714: <th>Affected platforms</th>
8715: </tr></thead>
8716: <tbody>
8717: <tr>
8718: <td>accept, bind, connect</td>
8719: <td>-lsocket</td>
8720: <td>Solaris</td>
8721: </tr>
8722: <tr>
8723: <td>crypt</td>
8724: <td>-lcrypt</td>
8725: <td>DragonFly, NetBSD</td>
8726: </tr>
8727: <tr>
8728: <td>dlopen, dlsym</td>
8729: <td>-ldl</td>
8730: <td>Linux</td>
8731: </tr>
8732: <tr>
8733: <td>gethost*</td>
8734: <td>-lnsl</td>
8735: <td>Solaris</td>
8736: </tr>
8737: <tr>
8738: <td>inet_aton</td>
8739: <td>-lresolv</td>
8740: <td>Solaris</td>
8741: </tr>
8742: <tr>
8743: <td>nanosleep, sem_*, timer_*</td>
8744: <td>-lrt</td>
8745: <td>Solaris</td>
8746: </tr>
8747: <tr>
8748: <td>openpty</td>
8749: <td>-lutil</td>
8750: <td>Linux</td>
8751: </tr>
8752: </tbody>
8753: </table>
8754: </div>
8755: <p>To fix these linker errors, it is often sufficient to say
8756: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8757: -l<em class="replaceable"><code>foo</code></em></code> to the package
8758: <code class="filename">Makefile</code> and then say <span><strong class="command">bmake clean;
8759: bmake</strong></span>.</p>
8760: <div class="sect3" lang="en">
8761: <div class="titlepage"><div><div><h4 class="title">
1.6 ! rillig 8762: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 8763: <p>When you are using the SunPro compiler, there is another
8764: possibility. That compiler cannot handle the following code:</p>
8765: <pre class="programlisting">
8766: extern int extern_func(int);
8767:
8768: static inline int
8769: inline_func(int x)
8770: {
8771: return extern_func(x);
8772: }
8773:
8774: int main(void)
8775: {
8776: return 0;
8777: }
8778: </pre>
8779: <p>It generates the code for <code class="function">inline_func</code> even if
8780: that function is never used. This code then refers to
8781: <code class="function">extern_func</code>, which can usually not be resolved. To
8782: solve this problem you can try to tell the package to disable inlining
8783: of functions.</p>
8784: </div>
8785: </div>
8786: <div class="sect2" lang="en">
8787: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8788: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1 dsieger 8789: <p>Sometimes packages fail to build because the compiler runs
8790: into an operating system specific soft limit. With the
8791: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8792: to unlimit the resources. Currently, the allowed values are
8793: “<span class="quote">datasize</span>” and “<span class="quote">stacksize</span>” (or both).
8794: Setting this variable is similar to running the shell builtin
8795: <span><strong class="command">ulimit</strong></span> command to raise the maximum data
8796: segment size or maximum stack size of a process, respectively, to
8797: their hard limits.</p>
8798: </div>
8799: </div>
8800: <div class="sect1" lang="en">
8801: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 8802: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 8803: <div class="sect2" lang="en">
8804: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8805: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.1 dsieger 8806: <p>The BSD-compatible <span><strong class="command">install</strong></span> supplied
8807: with some operating systems cannot create more than one
8808: directory at a time. As such, you should call
8809: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8810: <pre class="programlisting">
8811: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8812: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
8813: </pre>
8814: <p>You can also just append “<span class="quote"><code class="literal">dir1
8815: dir2</code></span>” to the
8816: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8817: automatically do the right thing.</p>
8818: </div>
8819: <div class="sect2" lang="en">
8820: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8821: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 8822: <p>In general, documentation should be installed into
8823: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8824: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8825: includes the version number of the package).</p>
8826: <p>Many modern packages using GNU autoconf allow to set the
8827: directory where HTML documentation is installed with the
8828: “<span class="quote">--with-html-dir</span>” option. Sometimes using this flag
8829: is needed because otherwise the documentation ends up in
8830: <code class="filename">${PREFIX}/share/doc/html</code> or other
8831: places.</p>
8832: <p>An exception to the above is that library API documentation
8833: 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
8834: browsers (devhelp) should be left at their default location, which
8835: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8836: documentation can be recognized from files ending in
8837: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8838: (It is also acceptable to install such files in
8839: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8840: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8841: <code class="filename">.devhelp*</code> file must be directly in that
8842: directory then, no additional subdirectory level is allowed in
8843: this case. This is usually achieved by using
8844: “<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”.
8845: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8846: though.)</p>
8847: </div>
8848: <div class="sect2" lang="en">
8849: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8850: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 8851: <p>Certain packages, most of them in the games category, install
8852: a score file that allows all users on the system to record their
8853: highscores. In order for this to work, the binaries need to be
8854: installed setgid and the score files owned by the appropriate
8855: group and/or owner (traditionally the "games" user/group). The
8856: following variables, documented in more detail in
8857: <code class="filename">mk/defaults/mk.conf</code>, control this
8858: behaviour: <code class="varname">SETGIDGAME</code>,
8859: <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
8860: <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
8861: <p>Note that per default, setgid installation of games is
8862: disabled; setting <code class="varname">SETGIDGAME=YES</code> will set all
8863: the other variables accordingly.</p>
8864: <p>A package should therefor never hard code file ownership or
8865: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8866: <code class="varname">INSTALL_GAME_DATA</code> to set these
8867: correctly.</p>
8868: </div>
8869: <div class="sect2" lang="en">
8870: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8871: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.4 rillig 8872: <div class="itemizedlist"><ul type="disc">
8873: <li><p>All installation operations have to be prefixed with
8874: <code class="filename">${DESTDIR}</code>.</p></li>
8875: <li><p>automake gets this DESTDIR mostly right
8876: automatically. Many manual rules and pre/post-install often are
8877: incorrect; fix them.</p></li>
8878: <li><p>If files are installed with special owner/group
8879: either use @owner/@group in the <code class="filename">PLIST</code>
8880: (preferred) or use <code class="varname">SPECIAL_PERMS</code>
8881: (discouraged). Note that @owner/@group are sticky during
8882: install, keep this in mind.</p></li>
8883: <li><p>In general, packages should support
8884: <code class="varname">UNPRIVILEGED</code> to be able to use
8885: DESTDIR.</p></li>
8886: </ul></div>
8887: </div>
8888: <div class="sect2" lang="en">
8889: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8890: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8891: <p>Your package may also contain scripts with hardcoded paths to
8892: other interpreters besides (or as well as) perl. To correct the
8893: full pathname to the script interpreter, you need to set the
8894: following definitions in your <code class="filename">Makefile</code> (we
8895: shall use <span><strong class="command">tclsh</strong></span> in this example):</p>
8896: <pre class="programlisting">
8897: REPLACE_INTERPRETER+= tcl
8898: REPLACE.tcl.old= .*/bin/tclsh
8899: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8900: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8901: # relative to ${WRKSRC}, just as in REPLACE_PERL
8902: </pre>
8903: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8904: <h3 class="title">Note</h3>
8905: <p>Before March 2006, these variables were called
8906: <code class="varname">_REPLACE.*</code> and
8907: <code class="varname">_REPLACE_FILES.*</code>.</p>
8908: </div>
8909: </div>
8910: <div class="sect2" lang="en">
8911: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8912: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 8913: <p>Makefiles of packages providing perl5 modules should include
8914: the Makefile fragment
8915: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
8916: <span><strong class="command">do-configure</strong></span> target for the standard perl
8917: configuration for such modules as well as various hooks to tune
8918: this configuration. See comments in this file for
8919: details.</p>
8920: <p>Perl5 modules will install into different places depending
8921: on the version of perl used during the build process. To
8922: address this, pkgsrc will append lines to the
8923: <code class="filename">PLIST</code> corresponding to the files listed in
8924: the installed <code class="filename">.packlist</code> file generated by
8925: most perl5 modules. This is invoked by defining
8926: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
8927: paths to packlist files, e.g.:</p>
8928: <pre class="programlisting">
8929: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
8930: </pre>
8931: <p>The variables <code class="varname">PERL5_SITELIB</code>,
8932: <code class="varname">PERL5_SITEARCH</code>, and
8933: <code class="varname">PERL5_ARCHLIB</code> represent the three locations
8934: in which perl5 modules may be installed, and may be used by
8935: perl5 packages that don't have a packlist. These three
8936: variables are also substituted for in the
8937: <code class="filename">PLIST</code>.</p>
8938: </div>
8939: <div class="sect2" lang="en">
8940: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8941: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 8942: <p>Some packages install info files or use the
8943: “<span class="quote">makeinfo</span>” or “<span class="quote">install-info</span>”
8944: commands. <code class="varname">INFO_FILES</code> should be defined in
8945: the package Makefile so that <code class="filename">INSTALL</code> and
8946: <code class="filename">DEINSTALL</code> scripts will be generated to
8947: handle registration of the info files in the Info directory
8948: file. The “<span class="quote">install-info</span>” command used for the info
8949: files registration is either provided by the system, or by a
8950: special purpose package automatically added as dependency if
8951: needed.</p>
8952: <p><code class="varname">PKGINFODIR</code> is the directory under
8953: <code class="filename">${PREFIX}</code> where info files are primarily
8954: located. <code class="varname">PKGINFODIR</code> defaults to
8955: “<span class="quote">info</span>” and can be overridden by the user.</p>
8956: <p>The info files for the package should be listed in the
8957: package <code class="filename">PLIST</code>; however any split info files
8958: need not be listed.</p>
8959: <p>A package which needs the “<span class="quote">makeinfo</span>” command
8960: at build time must add “<span class="quote">makeinfo</span>” to
8961: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
8962: version of the “<span class="quote">makeinfo</span>” command is needed it
8963: should be noted with the <code class="varname">TEXINFO_REQD</code>
8964: variable in the package <code class="filename">Makefile</code>. By
8965: default, a minimum version of 3.12 is required. If the system
8966: does not provide a <span><strong class="command">makeinfo</strong></span> command or if it
8967: does not match the required minimum, a build dependency on the
8968: <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
8969: be added automatically.</p>
8970: <p>The build and installation process of the software provided
8971: by the package should not use the
8972: <span><strong class="command">install-info</strong></span> command as the registration of
8973: info files is the task of the package
8974: <code class="filename">INSTALL</code> script, and it must use the
8975: appropriate <span><strong class="command">makeinfo</strong></span> command.</p>
8976: <p>To achieve this goal, the pkgsrc infrastructure creates
8977: overriding scripts for the <span><strong class="command">install-info</strong></span> and
8978: <span><strong class="command">makeinfo</strong></span> commands in a directory listed early
8979: in <code class="varname">PATH</code>.</p>
8980: <p>The script overriding <span><strong class="command">install-info</strong></span> has
8981: no effect except the logging of a message. The script overriding
8982: <span><strong class="command">makeinfo</strong></span> logs a message and according to the
8983: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
8984: <span><strong class="command">makeinfo</strong></span> command or exit on error.</p>
8985: </div>
8986: <div class="sect2" lang="en">
8987: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 8988: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 8989: <p>All packages that install manual pages should install them
8990: into the same directory, so that there is one common place to look
8991: for them. In pkgsrc, this place is
8992: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8993: should be used in packages. The default for
8994: <code class="varname">PKGMANDIR</code> is
8995: “<span class="quote"><code class="filename">man</code></span>”. Another often-used value
8996: is “<span class="quote"><code class="filename">share/man</code></span>”.</p>
8997: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8998: <h3 class="title">Note</h3>
8999: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9000: is far from complete.</p>
9001: </div>
9002: <p>The <code class="filename">PLIST</code> files can just use
9003: <code class="filename">man/</code> as the top level directory for the man
9004: page file entries, and the pkgsrc framework will convert as
9005: needed. In all other places, the correct
9006: <code class="varname">PKGMANDIR</code> must be used.</p>
9007: <p>Packages that are
9008: configured with <code class="varname">GNU_CONFIGURE</code> set as
9009: “<span class="quote">yes</span>”, by default will use the
9010: <code class="filename">./configure</code>
9011: --mandir switch to set where the man pages should be installed.
9012: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9013: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9014: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9015: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
9016: to “<span class="quote">no</span>”.
9017: Or if the <code class="filename">./configure</code> script uses
9018: a non-standard use of --mandir, you can set
9019: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.6 ! rillig 9020: <p>See <a href="#manpage-compression" title="13.5. Man page compression">Section 13.5, “Man page compression”</a> for
1.1 dsieger 9021: information on installation of compressed manual pages.</p>
9022: </div>
9023: <div class="sect2" lang="en">
9024: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 9025: <a name="gconf2-data-files"></a>19.6.9. Packages installing GConf2 data files</h3></div></div></div>
1.1 dsieger 9026: <p>If a package installs <code class="filename">.schemas</code> or
9027: <code class="filename">.entries</code> files, used by GConf2,
9028: you need to take some extra steps to make sure they get registered
9029: in the database:</p>
9030: <div class="orderedlist"><ol type="1">
9031: <li><p>Include <code class="filename">../../devel/GConf2/schemas.mk</code>
9032: instead of its <code class="filename">buildlink3.mk</code> file. This
9033: takes care of rebuilding the GConf2 database at installation and
9034: deinstallation time, and tells the package where to install
9035: GConf2 data files using some standard configure arguments. It
9036: also disallows any access to the database directly from the
9037: package.</p></li>
9038: <li><p>Ensure that the package installs its
9039: <code class="filename">.schemas</code> files under
9040: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
9041: installed under <code class="filename">${PREFIX}/etc</code>, you will
9042: need to manually patch the package.</p></li>
9043: <li><p>Check the PLIST and remove any entries under the etc/gconf
9044: directory, as they will be handled automatically. See
1.6 ! rillig 9045: <a 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.1 dsieger 9046: <li><p>Define the <code class="varname">GCONF2_SCHEMAS</code> variable in
9047: your <code class="filename">Makefile</code> with a list of all
9048: <code class="filename">.schemas</code> files installed by the package, if
9049: any. Names must not contain any directories in them.</p></li>
9050: <li><p>Define the <code class="varname">GCONF2_ENTRIES</code> variable in
9051: your <code class="filename">Makefile</code> with a
9052: list of all <code class="filename">.entries</code> files installed by the
9053: package, if any. Names must not contain any directories in
9054: them.</p></li>
9055: </ol></div>
9056: </div>
9057: <div class="sect2" lang="en">
9058: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 9059: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper data files</h3></div></div></div>
1.1 dsieger 9060: <p>If a package installs <code class="filename">.omf</code> files, used by
9061: scrollkeeper, you need to take some extra steps to make sure they
9062: get registered in the database:</p>
9063: <div class="orderedlist"><ol type="1">
9064: <li><p>Include
9065: <code class="filename">../../textproc/scrollkeeper/omf.mk</code>
9066: instead of its <code class="filename">buildlink3.mk</code> file. This
9067: takes care of rebuilding the scrollkeeper database at
9068: installation and deinstallation time, and disallows any access
9069: to it directly from the package.</p></li>
9070: <li><p>Check the PLIST and remove any entries under the
9071: <code class="filename">libdata/scrollkeeper</code> directory, as they
9072: will be handled automatically.</p></li>
9073: <li><p>Remove the <code class="filename">share/omf</code> directory from
9074: the PLIST. It will be handled by scrollkeeper.</p></li>
9075: </ol></div>
9076: </div>
9077: <div class="sect2" lang="en">
9078: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 9079: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 9080: <p>If a package installs font files, you will need to rebuild
9081: the fonts database in the directory where they get installed at
9082: installation and deinstallation time. This can be automatically
9083: done by using the pkginstall framework.</p>
9084: <p>You can list the directories where fonts are installed in the
9085: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9086: variables, where <em class="replaceable"><code>type</code></em> can be one of
9087: “<span class="quote">ttf</span>”, “<span class="quote">type1</span>” or “<span class="quote">x11</span>”.
9088: Also make sure that the database file
9089: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
9090: <p>Note that you should not create new directories for fonts;
9091: instead use the standard ones to avoid that the user needs to
9092: manually configure his X server to find them.</p>
9093: </div>
9094: <div class="sect2" lang="en">
9095: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 9096: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 9097: <p>If a package installs GTK2 immodules or loaders, you need to
9098: take some extra steps to get them registered in the GTK2 database
9099: properly:</p>
9100: <div class="orderedlist"><ol type="1">
9101: <li><p>Include
9102: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9103: <code class="filename">buildlink3.mk</code> file. This takes care of
9104: rebuilding the database at installation and deinstallation time.</p></li>
9105: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
9106: your package installs GTK2 immodules.</p></li>
9107: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
9108: GTK2 loaders.</p></li>
9109: <li>
9110: <p>Patch the package to not touch any of the GTK2
9111: databases directly. These are:</p>
9112: <div class="itemizedlist"><ul type="disc">
9113: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9114: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
9115: </ul></div>
9116: </li>
9117: <li><p>Check the <code class="filename">PLIST</code> and remove
9118: any entries under the <code class="filename">libdata/gtk-2.0</code>
9119: directory, as they will be handled automatically.</p></li>
9120: </ol></div>
9121: </div>
9122: <div class="sect2" lang="en">
9123: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 9124: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 9125: <p>If a package installs SGML or XML data files that need to be
9126: registered in system-wide catalogs (like DTDs, sub-catalogs,
9127: etc.), you need to take some extra steps:</p>
9128: <div class="orderedlist"><ol type="1">
9129: <li><p>Include
9130: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9131: your <code class="filename">Makefile</code>, which takes care of
9132: registering those files in system-wide catalogs at
9133: installation and deinstallation time.</p></li>
9134: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
9135: any SGML catalogs installed by the package.</p></li>
9136: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
9137: any XML catalogs installed by the package.</p></li>
9138: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
9139: to be added to the SGML catalog. These come in groups of
9140: three strings; see xmlcatmgr(1) for more information
9141: (specifically, arguments recognized by the 'add' action).
9142: Note that you will normally not use this variable.</p></li>
9143: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
9144: to be added to the XML catalog. These come in groups of three
9145: strings; see xmlcatmgr(1) for more information (specifically,
9146: arguments recognized by the 'add' action). Note that you will
9147: normally not use this variable.</p></li>
9148: </ol></div>
9149: </div>
9150: <div class="sect2" lang="en">
9151: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 9152: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 9153: <p>If a package provides extensions to the MIME database by
9154: installing <code class="filename">.xml</code> files inside
9155: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9156: need to take some extra steps to ensure that the database is kept
9157: consistent with respect to these new files:</p>
9158: <div class="orderedlist"><ol type="1">
9159: <li><p>Include
9160: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9161: (avoid using the <code class="filename">buildlink3.mk</code> file from
9162: this same directory, which is reserved for inclusion from
9163: other <code class="filename">buildlink3.mk</code> files). It takes
9164: care of rebuilding the MIME database at installation and
9165: deinstallation time, and disallows any access to it directly
9166: from the package.</p></li>
9167: <li><p>Check the PLIST and remove any entries under the
9168: <code class="filename">share/mime</code> directory,
9169: <span class="emphasis"><em>except</em></span> for files saved under
9170: <code class="filename">share/mime/packages</code>. The former are
9171: handled automatically by
9172: the update-mime-database program, but the latter are
9173: package-dependent and must be removed by the package that
9174: installed them in the first place.</p></li>
9175: <li><p>Remove any <code class="filename">share/mime/*</code> directories
9176: from the PLIST. They will be handled by the shared-mime-info
9177: package.</p></li>
9178: </ol></div>
9179: </div>
9180: <div class="sect2" lang="en">
9181: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 9182: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 9183: <p>If a package uses intltool during its build, add
9184: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9185: which forces it to use the intltool package provided by pkgsrc,
9186: instead of the one bundled with the distribution file.</p>
9187: <p>This tracks intltool's build-time dependencies and uses the
9188: latest available version; this way, the package benefits of any
9189: bug fixes that may have appeared since it was released.</p>
9190: </div>
9191: <div class="sect2" lang="en">
9192: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 9193: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 9194: <p>If a package contains a rc.d script, it won't be copied into
9195: the startup directory by default, but you can enable it, by adding
9196: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.4 rillig 9197: <a href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 9198: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9199: it will automatically remove the scripts when the package is
9200: deinstalled.</p>
9201: </div>
9202: <div class="sect2" lang="en">
9203: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 9204: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 9205: <p>If a package installs TeX packages into the texmf tree,
9206: the <code class="filename">ls-R</code> database of the tree needs to be
9207: updated.</p>
9208: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9209: <h3 class="title">Note</h3>
9210: <p>Except the main TeX packages such as teTeX-texmf,
9211: packages should install files
9212: into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
9213: not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
9214: </div>
9215: <div class="orderedlist"><ol type="1">
9216: <li><p>Include
9217: <code class="filename">../../print/teTeX/module.mk</code> instead
9218: of <code class="filename">../../mk/tex.buildlink3.mk</code>. This
9219: takes care of rebuilding the <code class="filename">ls-R</code>
9220: database at installation and deinstallation time.</p></li>
9221: <li>
9222: <p>If your package installs files into a texmf
9223: tree other than the one
9224: at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
9225: set <code class="varname">TEXMFDIRS</code> to the list of all texmf
9226: trees that need database update.</p>
9227: <p>If your package also installs font map files that need
9228: to be registered using <span><strong class="command">updmap</strong></span>,
9229: set <code class="varname">TEX_FONTMAPS</code> to the list of all
9230: such font map files. Then <span><strong class="command">updmap</strong></span> will
9231: be run automatically at installation/deinstallation to
9232: enable/disable font map files for TeX output
9233: drivers.</p>
9234: </li>
9235: <li><p>Make sure that none of <code class="filename">ls-R</code>
9236: databases are included in <code class="filename">PLIST</code>, as
9237: they will be removed only by the teTeX-bin package.</p></li>
9238: </ol></div>
9239: </div>
9240: <div class="sect2" lang="en">
9241: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 9242: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1 dsieger 9243: emulation</h3></div></div></div>
9244: <p>There are some packages that provide libraries and
9245: executables for running binaries from a one operating system
9246: on a different one (if the latter supports it). One example
9247: is running Linux binaries on NetBSD.</p>
9248: <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>
9249: helps in extracting and packaging Linux rpm packages.</p>
9250: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
9251: avoid the <span><strong class="command">check-shlibs</strong></span> target, which tests
9252: if all libraries for each installed executable can be found by
9253: the dynamic linker. Since the standard dynamic linker is run,
9254: this fails for emulation packages, because the libraries used
9255: by the emulation are not in the standard directories.</p>
9256: </div>
9257: <div class="sect2" lang="en">
9258: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 9259: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1 dsieger 9260: <p>If a package installs images under the
9261: <code class="filename">share/icons/hicolor</code> and/or updates the
9262: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9263: database, you need to take some extra steps to make sure that the
9264: shared theme directory is handled appropriately and that the cache
9265: database is rebuilt:</p>
9266: <div class="orderedlist"><ol type="1">
9267: <li><p>Include
9268: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9269: <li><p>Check the <code class="filename">PLIST</code> and remove the
9270: entry that refers to the theme cache.</p></li>
9271: <li><p>Ensure that the PLIST does not remove the shared icon
9272: directories from the <code class="filename">share/icons/hicolor</code>
9273: hierarchy because they will be handled automatically.</p></li>
9274: </ol></div>
9275: <p>The best way to verify that the PLIST is correct with
9276: respect to the last two points is to regenerate it using
9277: <span><strong class="command">make print-PLIST</strong></span>.</p>
9278: </div>
9279: <div class="sect2" lang="en">
9280: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 9281: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1 dsieger 9282: <p>If a package installs <code class="filename">.desktop</code> files
9283: under <code class="filename">share/applications</code> and these include
9284: MIME information, you need to take extra steps to ensure that they
9285: are registered into the MIME database:</p>
9286: <div class="orderedlist"><ol type="1">
9287: <li><p>Include
9288: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9289: <li><p>Check the PLIST and remove the entry that refers to the
9290: <code class="filename">share/applications/mimeinfo.cache</code> file.
9291: It will be handled automatically.</p></li>
9292: </ol></div>
9293: <p>The best way to verify that the PLIST is correct with
9294: respect to the last point is to regenerate it using <span><strong class="command">make
9295: print-PLIST</strong></span>.</p>
9296: </div>
9297: </div>
9298: <div class="sect1" lang="en">
9299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 9300: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1 dsieger 9301: <p>In some cases one does not have the time to solve a problem
9302: immediately. There are currently two ways to declare that one knows
9303: that a package has problems.</p>
9304: <div class="itemizedlist"><ul type="disc">
9305: <li><p>The first way is to plainly mark it as broken. For
9306: this, one just sets the variable <code class="varname">BROKEN</code> to the
9307: reason why the package is broken (similar to the
9308: <code class="varname">RESTRICTED</code> variable). A user trying to build
9309: the package will immediately be shown this message, and the build
9310: will not be even tried.</p></li>
9311: <li><p>After each pkgsrc freeze period (a time when the
9312: tree is stabilized and a new pkgsrc branch is cut), the packages
9313: that were not building in the official branch build on the latest
9314: NetBSD release will be marked as broken on that branch. This is
9315: done by setting the <code class="varname">BROKEN_IN</code> variable to the
9316: branch name (or appending the branch name to it). If a user tries
9317: to build such a package and the build fails, the user gets a
9318: message that says that the package was broken on the respective
9319: branch(es).</p></li>
9320: </ul></div>
9321: <p>Both types of packages are removed from pkgsrc in irregular
9322: intervals.</p>
9323: </div>
9324: </div>
9325: <div class="chapter" lang="en">
9326: <div class="titlepage"><div><div><h2 class="title">
1.6 ! rillig 9327: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1 dsieger 9328: <p>To check out all the gotchas when building a package, here are
9329: the steps that I do in order to get a package working. Please note
9330: this is basically the same as what was explained in the previous
9331: sections, only with some debugging aids.</p>
9332: <div class="itemizedlist"><ul type="disc">
1.4 rillig 9333: <li><p>Be sure to set <code class="varname">PKG_DEVELOPER=yes</code> in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></li>
1.1 dsieger 9334: <li>
9335: <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>,
9336: create a directory for a new package, change into it, then run
9337: <span><strong class="command">url2pkg</strong></span>:</p>
9338: <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>
9339: <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>
9340: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9341: </li>
9342: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9343: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9344: <li><p>Run <span><strong class="command">make configure</strong></span></p></li>
9345: <li><p>Add any dependencies glimpsed from documentation and the
9346: configure step to the package's
9347: <code class="filename">Makefile</code>.</p></li>
9348: <li>
9349: <p>Make the package compile, doing multiple rounds of</p>
9350: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9351: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9352: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9353: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9354: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9355: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9356: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
9357: <p>Doing this step as non-root user will ensure that no files
9358: are modified that shouldn't be, especially during the build
9359: phase. <span><strong class="command">mkpatches</strong></span>,
9360: <span><strong class="command">patchdiff</strong></span> and <span><strong class="command">pkgvi</strong></span> are
9361: 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>
9362: package.</p>
9363: </li>
9364: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.6 ! rillig 9365: necessary; see <a href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
1.1 dsieger 9366: <li>
9367: <p>Generate a <code class="filename">PLIST</code>:</p>
9368: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9369: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9370: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9371: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9372: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
9373: <p>You usually need to be <code class="username">root</code> to do
9374: this. Look if there are any files left:</p>
9375: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9376: <p>If this reveals any files that are missing in
9377: <code class="filename">PLIST</code>, add them.</p>
9378: </li>
9379: <li>
9380: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9381: package again and make a binary package:</p>
9382: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9383: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9384: </li>
9385: <li>
9386: <p>Delete the installed package:</p>
9387: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
9388: </li>
9389: <li>
9390: <p>Repeat the above <span><strong class="command">make print-PLIST</strong></span>
9391: command, which shouldn't find anything now:</p>
9392: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9393: </li>
9394: <li>
9395: <p>Reinstall the binary package:</p>
9396: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
9397: </li>
9398: <li><p>Play with it. Make sure everything works.</p></li>
9399: <li>
9400: <p>Run <span><strong class="command">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
9401: reports:</p>
9402: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9403: </li>
1.6 ! rillig 9404: <li><p>Submit (or commit, if you have cvs access); see <a href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a>.</p></li>
1.1 dsieger 9405: </ul></div>
9406: </div>
9407: <div class="chapter" lang="en">
9408: <div class="titlepage"><div><div><h2 class="title">
1.6 ! rillig 9409: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1 dsieger 9410: <div class="toc">
9411: <p><b>Table of Contents</b></p>
9412: <dl>
1.6 ! rillig 9413: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
! 9414: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
! 9415: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
! 9416: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
! 9417: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
! 9418: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 9419: </dl>
9420: </div>
9421: <div class="sect1" lang="en">
9422: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 9423: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 9424: <p>Our policy is that we accept binaries only from pkgsrc
9425: developers to guarantee that the packages don't contain any
9426: trojan horses etc. This is not to annoy anyone but rather to
9427: protect our users! You're still free to put up your home-made
9428: binary packages and tell the world where to get them. NetBSD
9429: developers doing bulk builds and wanting to upload them please
1.6 ! rillig 9430: see <a 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.1 dsieger 9431: </div>
9432: <div class="sect1" lang="en">
9433: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 9434: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 9435: <p>First, check that your package is complete, compiles and
1.6 ! rillig 9436: runs well; see <a href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.1 dsieger 9437: document. Next, generate an uuencoded gzipped <a href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
9438: archive that contains all files that make up the package.
9439: Finally, send this package to the pkgsrc bug tracking system,
9440: either with the <a 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
9441: that, go to the web page
1.4 rillig 9442: <a href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.1 dsieger 9443: which contains some instructions and a link to a form, where you
9444: can submit packages.</p>
9445: <p>In the form of the problem report, the category should be
9446: “<span class="quote">pkg</span>”, the synopsis should include the package name
9447: and version number, and the description field should contain a
9448: short description of your package (contents of the COMMENT
9449: variable or DESCR file are OK). The uuencoded package data should
9450: go into the “<span class="quote">fix</span>” field.</p>
9451: <p>If you want to submit several packages, please send a
9452: separate PR for each one, it's easier for us to track things
9453: that way.</p>
9454: <p>Alternatively, you can also import new packages into
9455: pkgsrc-wip (“<span class="quote">pkgsrc work-in-progress</span>”); see the
9456: homepage at <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
9457: for details.</p>
9458: </div>
9459: <div class="sect1" lang="en">
9460: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 9461: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 9462: <p>Please note all package additions, updates, moves, and
9463: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
9464: important to keep this file up to date and conforming to the
9465: existing format, because it will be used by scripts to
9466: automatically update pages on <a href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
9467: sites. Additionally, check the
9468: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
9469: for the package you updated or removed, in case it was mentioned
9470: there.</p>
9471: <p>When the <code class="varname">PKGREVISION</code> of a package is
9472: bumped, the change should appear in
9473: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
9474: related or otherwise relevant. Mass bumps that result from a
9475: dependency being updated should not be mentioned. In all other
9476: cases it's the developer's decision.</p>
9477: <p>There is a make target that helps in creating proper
9478: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span><strong class="command">make
9479: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9480: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
9481: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
9482: file is up-to-date (to avoid having to resolve conflicts later-on)
9483: and then to <span><strong class="command">cd</strong></span> to the package directory. For
9484: package updates, <span><strong class="command">make changes-entry</strong></span> is enough.
9485: For new packages, or package moves or removals, set the
9486: <code class="varname">CTYPE</code> variable on the command line to "Added",
9487: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.4 rillig 9488: in <a href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.1 dsieger 9489: not the same as your NetBSD login name. Don't forget to commit
9490: the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
9491: </div>
9492: <div class="sect1" lang="en">
9493: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 9494: <a name="committing-importing"></a>21.4. Committing: Importing a package into CVS</h2></div></div></div>
1.1 dsieger 9495: <p>This section is only of interest for pkgsrc developers with write
9496: access to the pkgsrc repository. Please remember that cvs
9497: imports files relative to the current working directory, and that
9498: the pathname that you
9499: give the <span><strong class="command">cvs import</strong></span> command is so that it knows where
9500: to place the files in the repository. Newly created packages should be
9501: imported with a vendor tag of “<span class="quote">TNF</span>” and a release tag of
9502: “<span class="quote">pkgsrc-base</span>”, e.g:</p>
9503: <pre class="programlisting">
9504: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
9505: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
9506: </pre>
9507: <p>Remember to move the directory from which you imported out of
9508: the way, or cvs will complain the next time you “<span class="quote">cvs
9509: update</span>” your source tree. Also don't forget to add the new
9510: package to the category's <code class="filename">Makefile</code>.</p>
9511: <p>The commit message of the initial import should include part of the
9512: <code class="filename">DESCR</code> file, so people reading the mailing lists know
9513: what the package is/does.</p>
9514: <p>For new packages, “<span class="quote">cvs import</span>” is preferred to “<span class="quote">cvs
9515: add</span>” because the former gets everything with a single command,
9516: and provides a consistent tag.</p>
9517: </div>
9518: <div class="sect1" lang="en">
9519: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 9520: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 9521: <p>Please always put a concise, appropriate and relevant summary of the
9522: changes between old and new versions into the commit log when updating
9523: a package. There are various reasons for this:</p>
9524: <div class="itemizedlist"><ul type="disc">
9525: <li><p>A URL is volatile, and can change over time. It may go away completely
9526: or its information may be overwritten by newer information.</p></li>
9527: <li><p>Having the change information between old and new versions in our CVS
9528: repository is very useful for people who use either cvs or anoncvs.</p></li>
9529: <li><p>Having the change information between old and new versions in our CVS
9530: repository is very useful for people who read the pkgsrc-changes mailing
9531: list, so that they can make tactical decisions about when to upgrade
9532: the package.</p></li>
9533: </ul></div>
9534: <p>Please also recognize that, just because a new version of a package
9535: has been released, it should not automatically be upgraded in the CVS
9536: repository. We prefer to be conservative in the packages that are
9537: included in pkgsrc - development or beta packages are not really the
9538: best thing for most places in which pkgsrc is used. Please use your
9539: judgement about what should go into pkgsrc, and bear in mind that
9540: stability is to be preferred above new and possibly untested features.</p>
9541: </div>
9542: <div class="sect1" lang="en">
9543: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 9544: <a name="moving-package"></a>21.6. Moving a package in pkgsrc</h2></div></div></div>
1.1 dsieger 9545: <div class="orderedlist"><ol type="1">
9546: <li><p>Make a copy of the directory somewhere else.</p></li>
9547: <li>
9548: <p>Remove all CVS dirs.</p>
9549: <p>Alternatively to the first two steps you can also do:</p>
9550: <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>
9551: <p>and use that for further work.</p>
9552: </li>
9553: <li><p>Fix <code class="varname">CATEGORIES</code> and any
9554: <code class="varname">DEPENDS</code> paths that just did “<span class="quote">../package</span>”
9555: instead of “<span class="quote">../../category/package</span>”.</p></li>
9556: <li><p><span><strong class="command">cvs import</strong></span> the modified package in the new
9557: place.</p></li>
9558: <li>
9559: <p>Check if any package depends on it:
9560: </p>
9561: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9562: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9563: </li>
9564: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
9565: <li><p><span><strong class="command">cvs rm (-f)</strong></span> the package at the old location.</p></li>
9566: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9567: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9568: <li>
9569: <p>Commit the changed and removed files:</p>
9570: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
9571: <p>(and any packages from step 5, of course).</p>
9572: </li>
9573: </ol></div>
9574: </div>
9575: </div>
9576: <div class="chapter" lang="en">
9577: <div class="titlepage"><div><div><h2 class="title">
1.6 ! rillig 9578: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 9579: <p>This section contains the answers to questions that may
9580: arise when you are writing a package. If you don't find your
9581: question answered here, first have a look in the other chapters,
9582: and if you still don't have the answer, ask on the
9583: <code class="literal">pkgsrc-users</code> mailing list.</p>
9584: <div class="qandaset">
9585: <dl>
1.6 ! rillig 9586: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 9587: MAKEFLAGS, .MAKEFLAGS and
9588: MAKE_FLAGS?</a>
9589: </dt>
1.6 ! rillig 9590: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 9591: MAKE, GMAKE and
9592: MAKE_PROGRAM?</a>
9593: </dt>
1.6 ! rillig 9594: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 9595: CC, PKG_CC and
9596: PKGSRC_COMPILER?</a>
9597: </dt>
1.6 ! rillig 9598: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 9599: BUILDLINK_LDFLAGS,
9600: BUILDLINK_LDADD and
9601: BUILDLINK_LIBS?</a>
9602: </dt>
1.6 ! rillig 9603: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 9604: VARNAME=BUILDLINK_PREFIX.foo
9605: say it's empty?</a>
9606: </dt>
1.6 ! rillig 9607: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 9608: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9609: don't understand the := inside
9610: it.</a>
9611: </dt>
1.6 ! rillig 9612: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 9613: developers?</a>
9614: </dt>
1.6 ! rillig 9615: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 9616: documentation?</a>
9617: </dt>
1.6 ! rillig 9618: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.1 dsieger 9619: do?</a>
9620: </dt>
9621: </dl>
9622: <table border="0" summary="Q and A Set">
9623: <col align="left" width="1%">
9624: <tbody>
9625: <tr class="question">
9626: <td align="left" valign="top">
1.6 ! rillig 9627: <a name="devfaq.makeflags"></a><a name="id2713952"></a><b>22.1.</b>
1.1 dsieger 9628: </td>
9629: <td align="left" valign="top"><p>What is the difference between
9630: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9631: <code class="varname">MAKE_FLAGS</code>?</p></td>
9632: </tr>
9633: <tr class="answer">
9634: <td align="left" valign="top"></td>
9635: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
9636: to the pkgsrc-internal invocations of <a 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
9637: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9638: the <code class="varname">MAKE_PROGRAM</code> when building the
9639: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9640: </tr>
9641: <tr class="question">
9642: <td align="left" valign="top">
1.6 ! rillig 9643: <a name="devfaq.make"></a><a name="id2713990"></a><b>22.2.</b>
1.1 dsieger 9644: </td>
9645: <td align="left" valign="top"><p>What is the difference between
9646: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9647: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9648: </tr>
9649: <tr class="answer">
9650: <td align="left" valign="top"></td>
9651: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
9652: <a 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
9653: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9654: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9655: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9656: Make program that is used for building the
9657: package.</p></td>
9658: </tr>
9659: <tr class="question">
9660: <td align="left" valign="top">
1.6 ! rillig 9661: <a name="devfaq.cc"></a><a name="id2714030"></a><b>22.3.</b>
1.1 dsieger 9662: </td>
9663: <td align="left" valign="top"><p>What is the difference between
9664: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9665: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9666: </tr>
9667: <tr class="answer">
9668: <td align="left" valign="top"></td>
9669: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9670: compiler, which can be configured by the pkgsrc user.
9671: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9672: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9673: path to a compiler, but the type of compiler that should be
9674: used. See <code class="filename">mk/compiler.mk</code> for more
9675: information about the latter variable.</p></td>
9676: </tr>
9677: <tr class="question">
9678: <td align="left" valign="top">
1.6 ! rillig 9679: <a name="devfaq.bl3flags"></a><a name="id2714070"></a><b>22.4.</b>
1.1 dsieger 9680: </td>
9681: <td align="left" valign="top"><p>What is the difference between
9682: <code class="varname">BUILDLINK_LDFLAGS</code>,
9683: <code class="varname">BUILDLINK_LDADD</code> and
9684: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9685: </tr>
9686: <tr class="answer">
9687: <td align="left" valign="top"></td>
9688: <td align="left" valign="top"><p>[FIXME]</p></td>
9689: </tr>
9690: <tr class="question">
9691: <td align="left" valign="top">
1.6 ! rillig 9692: <a name="devfaq.bl3prefix"></a><a name="id2714090"></a><b>22.5.</b>
1.1 dsieger 9693: </td>
9694: <td align="left" valign="top"><p>Why does <span><strong class="command">make show-var
9695: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9696: say it's empty?</p></td>
9697: </tr>
9698: <tr class="answer">
9699: <td align="left" valign="top"></td>
9700: <td align="left" valign="top"><p>For optimization reasons, some variables are only
9701: available in the “<span class="quote">wrapper</span>” phase and later. To
9702: “<span class="quote">simulate</span>” the wrapper phase, append
9703: <span><strong class="command">PKG_PHASE=wrapper</strong></span> to the above
9704: command.</p></td>
9705: </tr>
9706: <tr class="question">
9707: <td align="left" valign="top">
1.6 ! rillig 9708: <a name="devfaq.master_sites"></a><a name="id2714120"></a><b>22.6.</b>
1.1 dsieger 9709: </td>
9710: <td align="left" valign="top"><p>What does
9711: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9712: don't understand the <code class="literal">:=</code> inside
9713: it.</p></td>
9714: </tr>
9715: <tr class="answer">
9716: <td align="left" valign="top"></td>
9717: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9718: assignment operator, like you might expect at first sight.
9719: Instead, it is a degenerate form of
9720: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
9721: which is documented in the <a 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
9722: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9723: case of <code class="varname">MASTER_SITE_*</code>,
9724: <em class="replaceable"><code>old_string</code></em> is the empty string and
9725: <em class="replaceable"><code>new_string</code></em> is
9726: <code class="literal">package/</code>. That's where the
9727: <code class="literal">:</code> and the <code class="literal">=</code> fall
9728: together.</p></td>
9729: </tr>
9730: <tr class="question">
9731: <td align="left" valign="top">
1.6 ! rillig 9732: <a name="devfaq.mailinglists"></a><a name="id2714197"></a><b>22.7.</b>
1.1 dsieger 9733: </td>
9734: <td align="left" valign="top"><p>Which mailing lists are there for package
9735: developers?</p></td>
9736: </tr>
9737: <tr class="answer">
9738: <td align="left" valign="top"></td>
9739: <td align="left" valign="top"><div class="variablelist"><dl>
1.4 rillig 9740: <dt><span class="term"><a href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.1 dsieger 9741: <dd><p>This is a list for technical discussions related
9742: to pkgsrc development, e.g. soliciting feedback for changes to
9743: pkgsrc infrastructure, proposed new features, questions related
9744: to porting pkgsrc to a new platform, advice for maintaining a
9745: package, patches that affect many packages, help requests moved
9746: from pkgsrc-users when an infrastructure bug is found,
9747: etc.</p></dd>
1.4 rillig 9748: <dt><span class="term"><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.1 dsieger 9749: <dd><p>All bug reports in category "pkg" sent with
9750: <a 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
9751: directly; use one of the other mailing
9752: lists.</p></dd>
9753: </dl></div></td>
9754: </tr>
9755: <tr class="question">
9756: <td align="left" valign="top">
1.6 ! rillig 9757: <a name="devfaq.documentation"></a><a name="id2714304"></a><b>22.8.</b>
1.1 dsieger 9758: </td>
9759: <td align="left" valign="top"><p>Where is the pkgsrc
9760: documentation?</p></td>
9761: </tr>
9762: <tr class="answer">
9763: <td align="left" valign="top"></td>
9764: <td align="left" valign="top">
9765: <p>There are many places where you can find
9766: documentation about pkgsrc:</p>
9767: <div class="itemizedlist"><ul type="disc">
9768: <li><p>The pkgsrc guide (this document) is a collection
9769: of chapters that explain large parts of pkgsrc, but some
9770: chapters tend to be outdated. Which ones they are is hard to
9771: say.</p></li>
9772: <li><p>On the mailing list archives (see <a href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
9773: about certain features, announcements of new parts of the pkgsrc
9774: infrastructure and sometimes even announcements that a certain
9775: feature has been marked as obsolete. The benefit here is that
9776: each message has a date appended to it.</p></li>
9777: <li><p>Many of the files in the
9778: <code class="filename">mk/</code> directory start with a comment that
9779: describes the purpose of the file and how it can be used by the
9780: pkgsrc user and package authors. An easy way to find this
9781: documentation is to run <span><strong class="command">bmake
9782: help</strong></span>.</p></li>
9783: <li><p>The CVS log messages are a rich source of
9784: information, but they tend to be highly abbreviated, especially
9785: for actions that occur often. Some contain a detailed
9786: description of what has changed, but they are geared towards the
9787: other pkgsrc developers, not towards an average pkgsrc user.
9788: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9789: don't know what has been before, these messages may not be worth
9790: too much to you.</p></li>
9791: <li><p>Some parts of pkgsrc are only “<span class="quote">implicitly
9792: documented</span>”, that is the documentation exists only in the
9793: mind of the developer who wrote the code. To get this
9794: information, use the <span><strong class="command">cvs annotate</strong></span> command
9795: to see who has written it and ask on the
9796: <code class="literal">tech-pkg</code> mailing list, so that others can
9797: find your questions later (see above). To be sure that the
9798: developer in charge reads the mail, you may CC him or
9799: her.</p></li>
9800: </ul></div>
9801: </td>
9802: </tr>
9803: <tr class="question">
9804: <td align="left" valign="top">
1.6 ! rillig 9805: <a name="devfaq.too-much-time"></a><a name="id2714365"></a><b>22.9.</b>
1.1 dsieger 9806: </td>
9807: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9808: do?</p></td>
9809: </tr>
9810: <tr class="answer">
9811: <td align="left" valign="top"></td>
9812: <td align="left" valign="top">
9813: <p>This is not really an FAQ yet, but here's the answer
9814: anyway.</p>
9815: <div class="itemizedlist"><ul type="disc">
9816: <li><p>Run <span><strong class="command">pkg_chk -N</strong></span> (from the
9817: <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
9818: will tell you about newer versions of installed packages that are
9819: available, but not yet updated in pkgsrc.</p></li>
9820: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.6 ! rillig 9821: — it contains a list of suggested new packages and a list of
1.1 dsieger 9822: cleanups and enhancements for pkgsrc that would be nice to
9823: have.</p></li>
9824: <li><p>Review packages for which review was requested on
9825: the <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
9826: mailing list.</p></li>
9827: </ul></div>
9828: </td>
9829: </tr>
9830: </tbody>
9831: </table>
9832: </div>
9833: </div>
9834: <div class="chapter" lang="en">
9835: <div class="titlepage"><div><div><h2 class="title">
1.6 ! rillig 9836: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1 dsieger 9837: <div class="toc">
9838: <p><b>Table of Contents</b></p>
9839: <dl>
1.6 ! rillig 9840: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
! 9841: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
! 9842: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
! 9843: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 9844: </dl>
9845: </div>
9846: <p>Quoting <a href="http://www.gnome.org/" target="_top">GNOME's web
9847: site</a>:</p>
9848: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9849: environment, an intuitive and attractive desktop for users, and the
9850: GNOME development platform, an extensive framework for building
9851: applications that integrate into the rest of the desktop.</p></blockquote></div>
9852: <p>pkgsrc provides a seamless way to automatically build and install
9853: a complete GNOME environment <span class="emphasis"><em>under many different
9854: platforms</em></span>. We can say with confidence that pkgsrc is one of
9855: the most advanced build and packaging systems for GNOME due to its
9856: included technologies buildlink3, the wrappers and tools framework and
9857: automatic configuration file management. Lots of efforts are put into
9858: achieving a completely clean deinstallation of installed software
9859: components.</p>
9860: <p>Given that pkgsrc is <a href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9861: the above also means that great efforts are put into making GNOME work
9862: under this operating system. Recently, <a href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
9863: pkgsrc as its preferred packaging system, contributing lots of
9864: portability fixes to make GNOME build and install under it.</p>
9865: <p>This chapter is aimed at pkgsrc developers and other people
9866: interested in helping our GNOME porting and packaging efforts. It
9867: provides instructions on how to manage the existing packages and some
9868: important information regarding their internals.</p>
9869: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9870: <h3 class="title">We need your help!</h3>
9871: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9872: and GNOME and are willing to learn new exciting stuff, please jump
9873: straight to the <a href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
9874: work</a> list! There is still a long way to go to get a
9875: fully-functional GNOME desktop under NetBSD and we need your help to
9876: achieve it!</p>
9877: </div>
9878: <div class="sect1" lang="en">
9879: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 9880: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1 dsieger 9881: <p>pkgsrc includes three GNOME-related meta packages:</p>
9882: <div class="itemizedlist"><ul type="disc">
9883: <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
9884: the core GNOME desktop environment. It only includes the necessary
9885: bits to get it to boot correctly, although it may lack important
9886: functionality for daily operation. The idea behind this package is
9887: to let end users build their own configurations on top of this one,
9888: first installing this meta package to achieve a functional setup and
9889: then adding individual applications.</p></li>
9890: <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
9891: complete installation of the GNOME platform and desktop as defined
9892: by the GNOME project; this is based on the components distributed in
9893: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9894: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9895: official FTP server. Developer-only tools found in those
9896: directories are not installed unless required by some other
9897: component to work properly. Similarly, packages from the bindings
9898: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9899: in unless required as a dependency for an end-user component. This
9900: 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>
9901: <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>:
9902: Installs all the tools required to build a GNOME component when
9903: fetched from the CVS repository. These are required to let the
9904: <span><strong class="command">autogen.sh</strong></span> scripts work appropriately.</p></li>
9905: </ul></div>
9906: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9907: sorted in a way that eases updates: a package may depend on other
9908: packages listed before it but not on any listed after it. It is very
9909: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9910: change it to alphabetical sorting!</em></span></p>
9911: </div>
9912: <div class="sect1" lang="en">
9913: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 9914: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1 dsieger 9915: <p>Almost all GNOME applications are written in C and use a common
9916: set of tools as their build system. Things get different with the new
9917: bindings to other languages (such as Python), but the following will
9918: give you a general idea on the minimum required tools:</p>
9919: <div class="itemizedlist"><ul type="disc">
9920: <li>
9921: <p>Almost all GNOME applications use the GNU Autotools as their
9922: build system. As a general rule you will need to tell this to your
9923: package:</p>
9924: <pre class="programlisting">
9925: GNU_CONFIGURE=yes
9926: USE_LIBTOOL=yes
9927: USE_TOOLS+=gmake
9928: </pre>
9929: </li>
9930: <li>
9931: <p>If the package uses pkg-config to detect dependencies, add this
9932: tool to the list of required utilities:</p>
9933: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
9934: <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
9935: the end of the build process to ensure that you did not miss to
9936: specify any dependency in your package and that the version
9937: requirements are all correct.</p>
9938: </li>
9939: <li><p>If the package uses intltool, be sure to add
9940: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9941: to handle dependencies and to force the package to use the latest
9942: available version.</p></li>
9943: <li>
9944: <p>If the package uses gtk-doc (a documentation generation
9945: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9946: tool is rather big and the distfile should come with pregenerated
9947: documentation anyway; if it does not, it is a bug that you ought to
9948: report. For such packages you should disable gtk-doc (unless it is
9949: the default):</p>
9950: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9951: <p>The default location of installed HTML files
9952: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9953: and should not be changed unless the package insists on installing
9954: them somewhere else. Otherwise programs as
9955: <span><strong class="command">devhelp</strong></span> will not be able to open them. You can
9956: do that with an entry similar to:</p>
9957: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
9958: </li>
9959: </ul></div>
9960: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9961: files under the installation prefix to maintain databases. In this
9962: context, shared means that those exact same directories and files are
9963: used among several different packages, leading to conflicts in the
9964: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9965: handle the most common cases, so you have to forget about using
9966: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9967: omitting shared files from them. If you find yourself doing those,
9968: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9969: <p>The following table lists the common situations that result in
9970: using shared directories or files. For each of them, the appropriate
9971: solution is given. After applying the solution be sure to
9972: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9973: <span><strong class="command">make print-PLIST</strong></span> and ensure it is correct.</p>
9974: <div class="table">
1.6 ! rillig 9975: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.1 dsieger 9976: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
9977: <colgroup>
9978: <col>
9979: <col>
9980: </colgroup>
9981: <thead><tr>
9982: <th>If the package...</th>
9983: <th>Then...</th>
9984: </tr></thead>
9985: <tbody>
9986: <tr>
9987: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.6 ! rillig 9988: <td>See <a href="#scrollkeeper-data-files" title="19.6.10. Packages installing scrollkeeper data files">Section 19.6.10, “Packages installing scrollkeeper data files”</a>.</td>
1.1 dsieger 9989: </tr>
9990: <tr>
9991: <td>Installs icons under the
9992: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9993: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.6 ! rillig 9994: <td>See <a href="#hicolor-theme" title="19.6.19. Packages installing hicolor theme icons">Section 19.6.19, “Packages installing hicolor theme icons”</a>.</td>
1.1 dsieger 9995: </tr>
9996: <tr>
9997: <td>Installs files under
9998: <code class="filename">share/mime/packages</code>.</td>
1.6 ! rillig 9999: <td>See <a href="#mime-database" title="19.6.14. Packages installing extensions to the MIME database">Section 19.6.14, “Packages installing extensions to the MIME database”</a>.</td>
1.1 dsieger 10000: </tr>
10001: <tr>
10002: <td>Installs <code class="filename">.desktop</code> files under
10003: <code class="filename">share/applications</code> and these include MIME
10004: information.</td>
1.6 ! rillig 10005: <td>See <a href="#desktop-files" title="19.6.20. Packages installing desktop files">Section 19.6.20, “Packages installing desktop files”</a>.</td>
1.1 dsieger 10006: </tr>
10007: </tbody>
10008: </table></div>
10009: </div>
10010: <br class="table-break">
10011: </div>
10012: <div class="sect1" lang="en">
10013: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 10014: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1 dsieger 10015: <p>When seeing GNOME as a whole, there are two kinds of
10016: updates:</p>
10017: <div class="variablelist"><dl>
10018: <dt><span class="term">Major update</span></dt>
10019: <dd>
10020: <p>Given that there is still a very long way for GNOME 3 (if it
10021: ever appears), we consider a major update one that goes from a
10022: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
10023: where <code class="literal">Y</code> is even and greater than
10024: <code class="literal">X</code>. These are hard to achieve because they
10025: introduce lots of changes in the components' code and almost all
10026: GNOME distfiles are updated to newer versions. Some of them can
10027: even break API and ABI compatibility with the previous major
10028: version series. As a result, the update needs to be done all at
10029: once to minimize breakage.</p>
10030: <p>A major update typically consists of around 80 package
10031: updates and the addition of some new ones.</p>
10032: </dd>
10033: <dt><span class="term">Minor update</span></dt>
10034: <dd>
10035: <p>We consider a minor update one that goes from a
10036: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
10037: one where <code class="literal">Y</code> is greater than
10038: <code class="literal">X</code>. These are easy to achieve because they do
10039: not update all GNOME components, can be done in an incremental way
10040: and do not break API nor ABI compatibility.</p>
10041: <p>A minor update typically consists of around 50 package
10042: updates, although the numbers here may vary a lot.</p>
10043: </dd>
10044: </dl></div>
10045: <p>In order to update the GNOME components in pkgsrc to a new stable
10046: release (either major or minor), the following steps should be
10047: followed:</p>
10048: <div class="orderedlist"><ol type="1">
10049: <li>
10050: <p>Get a list of all the tarballs that form the new release by
10051: using the following commands. These will leave the full list of the
10052: components's distfiles into the <code class="filename">list.txt</code>
10053: file:</p>
10054: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
10055: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
10056: awk '{ print $9 }' >list.txt</code></strong>
10057: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
10058: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
10059: awk '{ print $9 }' >>list.txt</code></strong></pre>
10060: </li>
10061: <li><p>Open each meta package's <code class="filename">Makefile</code> and
10062: bump their version to the release you are updating them to. The
10063: three meta packages should be always consistent with versioning.
10064: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
10065: in them.</p></li>
10066: <li>
10067: <p>For each meta package, update all its
10068: <code class="varname">DEPENDS</code> lines to match the latest versions as
10069: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
10070: newer version (even if found in the FTP) because the meta packages
10071: are supposed to list the exact versions that form a specific GNOME
10072: release. Exceptions are permitted here if a newer version solves a
10073: serious issue in the overall desktop experience; these typically
10074: come in the form of a revision bump in pkgsrc, not in newer versions
10075: from the developers.</p>
10076: <p>Packages not listed in the <code class="filename">list.txt</code> file
10077: should be updated to the latest version available (if found in
10078: pkgsrc). This is the case, for example, of the dependencies on the
10079: 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>
10080: </li>
10081: <li>
10082: <p>Generate a patch from the modified meta packages and extract the
10083: list of "new" lines. This will provide you an outline on what
10084: packages need to be updated in pkgsrc and in what order:</p>
10085: <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>
10086: </li>
10087: <li><p>For major desktop updates it is recommended to zap all your
10088: installed packages and start over from scratch at this point.</p></li>
10089: <li><p>Now comes the longest step by far: iterate over the contents
10090: of <code class="filename">todo.txt</code> and update the packages listed in
10091: it in order. For major desktop updates none of these should be
10092: committed until the entire set is completed because there are chances
10093: of breaking not-yet-updated packages.</p></li>
10094: <li><p>Once the packages are up to date and working, commit them to
10095: the tree one by one with appropriate log messages. At the end,
10096: commit the three meta package updates and all the corresponding
10097: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10098: <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>
10099: </ol></div>
10100: </div>
10101: <div class="sect1" lang="en">
10102: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 10103: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1 dsieger 10104: <p>GNOME is a very big component in pkgsrc which approaches 100
10105: packages. Please, it is very important that you always, always,
10106: <span class="strong"><strong>always</strong></span> feed back any portability
1.6 ! rillig 10107: fixes you do to a GNOME package to the mainstream developers (see <a href="#components.patches.feedback" title="11.3.5. Feedback to the author">Section 11.3.5, “Feedback to the author”</a>). This is the only way to get
1.1 dsieger 10108: their attention on portability issues and to ensure that future versions
10109: can be built out-of-the box on NetBSD. The less custom patches in
10110: pkgsrc, the easier further updates are. Those developers in charge of
10111: issuing major GNOME updates will be grateful if you do that.</p>
10112: <p>The most common places to report bugs are the <a href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
10113: Bugzilla</a>. Not all components use these to track bugs, but most
10114: of them do. Do not be short on your reports: always provide detailed
10115: explanations of the current failure, how it can be improved to achieve
10116: maximum portability and, if at all possible, provide a patch against CVS
10117: head. The more verbose you are, the higher chances of your patch being
10118: accepted.</p>
10119: <p>Also, please avoid using preprocessor magic to fix portability
10120: issues. While the FreeBSD GNOME people are doing a great job in porting
10121: GNOME to their operating system, the official GNOME sources are now
10122: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10123: and similar macros. This hurts portability. Please see our patching
1.6 ! rillig 10124: guidelines (<a href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, “Patching guidelines”</a>) for more
1.1 dsieger 10125: details.</p>
10126: </div>
10127: </div>
10128: </div>
10129: <div class="part" lang="en">
10130: <div class="titlepage"><div><div><h1 class="title">
10131: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
10132: <div class="partintro" lang="en">
10133: <div></div>
10134: <p>This part of the guide deals with everything
10135: from the infrastructure that is behind the interfaces described
10136: in the developer's guide. A casual package maintainer should not
10137: need anything from this part.</p>
10138: <div class="toc">
10139: <p><b>Table of Contents</b></p>
10140: <dl>
1.6 ! rillig 10141: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 10142: <dd><dl>
1.6 ! rillig 10143: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
! 10144: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
! 10145: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 10146: <dd><dl>
1.6 ! rillig 10147: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
! 10148: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 10149: </dl></dd>
1.6 ! rillig 10150: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
! 10151: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10152: <dd><dl>
1.6 ! rillig 10153: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
! 10154: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 10155: </dl></dd>
1.6 ! rillig 10156: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10157: <dd><dl>
1.6 ! rillig 10158: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
! 10159: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 10160: </dl></dd>
10161: </dl></dd>
1.6 ! rillig 10162: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 10163: <dd><dl>
1.6 ! rillig 10164: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
! 10165: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
! 10166: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 10167: <dd><dl>
1.6 ! rillig 10168: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
! 10169: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 10170: </dl></dd>
10171: </dl></dd>
1.6 ! rillig 10172: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1 dsieger 10173: <dd><dl>
1.6 ! rillig 10174: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
! 10175: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 10176: </dl></dd>
10177: </dl>
10178: </div>
10179: </div>
10180: <div class="chapter" lang="en">
10181: <div class="titlepage"><div><div><h2 class="title">
1.6 ! rillig 10182: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 10183: <div class="toc">
10184: <p><b>Table of Contents</b></p>
10185: <dl>
1.6 ! rillig 10186: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
! 10187: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
! 10188: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 10189: <dd><dl>
1.6 ! rillig 10190: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
! 10191: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 10192: </dl></dd>
1.6 ! rillig 10193: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
! 10194: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10195: <dd><dl>
1.6 ! rillig 10196: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
! 10197: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 10198: </dl></dd>
1.6 ! rillig 10199: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10200: <dd><dl>
1.6 ! rillig 10201: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
! 10202: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 10203: </dl></dd>
10204: </dl>
10205: </div>
10206: <p>The pkgsrc infrastructure consists of many small Makefile
10207: fragments. Each such fragment needs a properly specified
10208: interface. This chapter explains how such an interface looks
10209: like.</p>
10210: <div class="sect1" lang="en">
10211: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 10212: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 10213: <p>Whenever a variable is defined in the pkgsrc
10214: infrastructure, the location and the way of definition provide
10215: much information about the intended use of that variable.
10216: Additionally, more documentation may be found in a header
10217: comment or in this pkgsrc guide.</p>
10218: <p>A special file is
10219: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10220: variables that are intended to be user-defined. They are either
10221: defined using the <code class="literal">?=</code> operator or they are
10222: left undefined because defining them to anything would
10223: effectively mean “<span class="quote">yes</span>”. All these variables may be
10224: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10225: file.</p>
10226: <p>Outside this file, the following conventions apply:
10227: Variables that are defined using the <code class="literal">?=</code>
10228: operator may be overridden by a package.</p>
10229: <p>Variables that are defined using the <code class="literal">=</code>
10230: operator may be used read-only at run-time.</p>
10231: <p>Variables whose name starts with an underscore must not be
10232: accessed outside the pkgsrc infrastructure at all. They may
10233: change without further notice.</p>
10234: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
10235: <h3 class="title">Note</h3>
10236: <p>These conventions are currently not applied
10237: consistently to the complete pkgsrc
10238: infrastructure.</p>
10239: </div>
10240: </div>
10241: <div class="sect1" lang="en">
10242: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 10243: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 10244: <p>All variables that contain lists of things should default
10245: to being empty. Two examples that do not follow this rule are
10246: <code class="varname">USE_LANGUAGES</code> and
10247: <code class="varname">DISTFILES</code>. These variables cannot simply be
10248: modified using the <code class="literal">+=</code> operator in package
10249: <code class="filename">Makefile</code>s (or other files included by
10250: them), since there is no guarantee whether the variable is
10251: already set or not, and what its value is. In the case of
10252: <code class="varname">DISTFILES</code>, the packages “<span class="quote">know</span>”
10253: the default value and just define it as in the following
10254: example.</p>
10255: <pre class="programlisting">
10256: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10257: </pre>
10258: <p>Because of the selection of this default value, the same
10259: value appears in many package Makefiles. Similarly for
10260: <code class="varname">USE_LANGUAGES</code>, but in this case the default
10261: value (“<span class="quote"><code class="literal">c</code></span>”) is so short that it
10262: doesn't stand out. Nevertheless it is mentioned in many
10263: files.</p>
10264: </div>
10265: <div class="sect1" lang="en">
10266: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 10267: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.1 dsieger 10268: <div class="sect2" lang="en">
10269: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 10270: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1 dsieger 10271: <p>Variable evaluation takes place either at load time or at
10272: runtime, depending on the context in which they occur. The
10273: contexts where variables are evaluated at load time are:</p>
10274: <div class="itemizedlist"><ul type="disc">
10275: <li><p>The right hand side of the <code class="literal">:=</code>
10276: and <code class="literal">!=</code> operators,</p></li>
10277: <li><p>Make directives like <code class="literal">.if</code> or
10278: <code class="literal">.for</code>,</p></li>
10279: <li><p>Dependency lines.</p></li>
10280: </ul></div>
10281: <p>A special exception are references to the iteration
10282: variables of <code class="literal">.for</code> loops, which are expanded
10283: inline, no matter in which context they appear.</p>
10284: <p>As the values of variables may change during load time,
10285: care must be taken not to evaluate them by accident. Typical
10286: examples for variables that should not be evaluated at load time
10287: are <code class="varname">DEPENDS</code> and
10288: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10289: clear, here is an example:</p>
10290: <pre class="programlisting">
10291: CONFIGURE_ARGS= # none
10292: CFLAGS= -O
10293: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
10294:
10295: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
10296:
10297: CFLAGS+= -Wall
10298: </pre>
10299: <p>This code shows how the use of the <code class="literal">:=</code>
10300: operator can quickly lead to unexpected results. The first
10301: paragraph is fairly common code. The second paragraph evaluates
10302: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10303: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10304: <code class="literal">-Wall</code> is appended to the
10305: <code class="varname">CFLAGS</code>, but this addition will not appear in
10306: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10307: paragraphs from above typically occur in completely unrelated
10308: files.</p>
10309: </div>
10310: <div class="sect2" lang="en">
10311: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 10312: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1 dsieger 10313: <p>After all the files have been loaded, the values of the
10314: variables cannot be changed anymore. Variables that are used in
10315: the shell commands are expanded at this point.</p>
10316: </div>
10317: </div>
10318: <div class="sect1" lang="en">
10319: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 10320: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 10321: <p>There are many ways in which the definition and use of a
10322: variable can be restricted in order to detect bugs and
10323: violations of the (mostly unwritten) policies. See the
10324: <code class="literal">pkglint</code> developer's documentation for further
10325: details.</p>
10326: </div>
10327: <div class="sect1" lang="en">
10328: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 10329: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 10330: <p>Most of the <code class="filename">.mk</code> files fall into one
10331: of the following classes. Cases where a file falls into more
10332: than one class should be avoided as it often leads to subtle
10333: bugs.</p>
10334: <div class="sect2" lang="en">
10335: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 10336: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 10337: <p>In a traditional imperative programming language some of
10338: the <code class="filename">.mk</code> files could be described as
1.6 ! rillig 10339: procedures. They take some input parameters and—after
! 10340: inclusion—provide a result in output parameters. Since all
1.1 dsieger 10341: variables in <code class="filename">Makefile</code>s have global scope
10342: care must be taken not to use parameter names that have already
10343: another meaning. For example, <code class="varname">PKGNAME</code> is a
10344: bad choice for a parameter name.</p>
10345: <p>Procedures are completely evaluated at preprocessing time.
10346: That is, when calling a procedure all input parameters must be
10347: completely resolvable. For example,
10348: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10349: parameter since it is very likely that further text will be
10350: added after calling the procedure, which would effectively apply
10351: the procedure to only a part of the variable. Also, references
10352: to other variables wit will be modified after calling the
10353: procedure.</p>
10354: <p>A procedure can declare its output parameters either as
10355: suitable for use in preprocessing directives or as only
10356: available at runtime. The latter alternative is for variables
10357: that contain references to other runtime variables.</p>
10358: <p>Procedures shall be written such that it is possible to
10359: call the procedure more than once. That is, the file must not
10360: contain multiple-inclusion guards.</p>
10361: <p>Examples for procedures are
10362: <code class="filename">mk/bsd.options.mk</code> and
10363: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10364: that the parameters are evaluated at load time, they should be
10365: assigned using the <code class="literal">:=</code> operator, which should
10366: be used only for this purpose.</p>
10367: </div>
10368: <div class="sect2" lang="en">
10369: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 10370: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 10371: <p>Action files take some input parameters and may define
10372: runtime variables. They shall not define loadtime variables.
10373: There are action files that are included implicitly by the
10374: pkgsrc infrastructure, while other must be included
10375: explicitly.</p>
10376: <p>An example for action files is
10377: <code class="filename">mk/subst.mk</code>.</p>
10378: </div>
10379: </div>
10380: <div class="sect1" lang="en">
10381: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 10382: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10383: <p>Package <code class="filename">Makefile</code>s usually consist of
10384: a set of variable definitions, and include the file
10385: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10386: Before that, they may also include various other
10387: <code class="filename">*.mk</code> files if they need to query the
10388: availability of certain features like the type of compiler or
10389: the X11 implementation. Due to the heavy use of preprocessor
10390: directives like <code class="literal">.if</code> and
10391: <code class="literal">.for</code>, the order in which the files are loaded
10392: matters.</p>
10393: <p>This section describes at which point the various files
10394: are loaded and gives reasons for that order.</p>
10395: <div class="sect2" lang="en">
10396: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 10397: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10398: </h3></div></div></div>
10399: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10400: is to define some essential variables like
10401: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10402: <code class="varname">MACHINE_ARCH</code>.</p>
10403: <p>Then, the user settings are loaded from the file specified
1.4 rillig 10404: in <code class="varname">MAKECONF</code>, which is usually <a href="#mk.conf"><code class="filename">mk.conf</code></a>.
10405: After that, those variables
1.1 dsieger 10406: that have not been overridden by the user are loaded from
10407: <code class="filename">mk/defaults/mk.conf</code>.</p>
10408: <p>After the user settings, the system settings and platform
10409: settings are loaded, which may override the user
10410: settings.</p>
10411: <p>Then, the tool definitions are loaded. The tool wrappers
10412: are not yet in effect. This only happens when building a
10413: package, so the proper variables must be used instead of the
10414: direct tool names.</p>
10415: <p>As the last steps, some essential variables from the
10416: wrapper and the package system flavor are loaded, as well as the
10417: variables that have been cached in earlier phases of a package
10418: build.</p>
10419: </div>
10420: <div class="sect2" lang="en">
10421: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 10422: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10423: </h3></div></div></div>
10424: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10425: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10426: loaded, which fill default values for those variables that have
10427: not been defined by the package. These variables may later
10428: be used even in unrelated files.</p>
10429: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10430: provides the target <code class="literal">error-check</code> that is added
10431: as a special dependency to all other targets that use
10432: <code class="varname">DELAYED_ERROR_MSG</code> or
10433: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10434: <p>Then, the package-specific hacks from
10435: <code class="filename">hacks.mk</code> are included.</p>
10436: <p>Then, various other files follow. Most of them don't have
10437: any dependencies on what they need to have included before or
10438: after them, though some do.</p>
10439: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10440: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10441: restricts the use of these variables to all the files that have
10442: been included before. Appearances in later files will be
10443: silently ignored.</p>
10444: <p>Then, the files for the main targets are included, in the
10445: order of later execution, though the actual order should not
10446: matter.</p>
10447: <p>At last, some more files are included that don't set any
10448: interesting variables but rather just define make targets to be
10449: executed.</p>
10450: </div>
10451: </div>
10452: </div>
10453: <div class="chapter" lang="en">
10454: <div class="titlepage"><div><div><h2 class="title">
1.6 ! rillig 10455: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1 dsieger 10456: <div class="toc">
10457: <p><b>Table of Contents</b></p>
10458: <dl>
1.6 ! rillig 10459: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
! 10460: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
! 10461: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 10462: <dd><dl>
1.6 ! rillig 10463: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
! 10464: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 10465: </dl></dd>
10466: </dl>
10467: </div>
10468: <p>The pkgsrc infrastructure consists of a large codebase,
10469: and there are many corners where every little bit of a file is
10470: well thought out, making pkgsrc likely to fail as soon as
10471: anything is changed near those parts. To prevent most changes
10472: from breaking anything, a suite of regression tests should go
10473: along with every important part of the pkgsrc infrastructure.
10474: This chapter describes how regression tests work in pkgsrc and
10475: how you can add new tests.</p>
10476: <div class="sect1" lang="en">
10477: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 10478: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.1 dsieger 10479: <p></p>
10480: </div>
10481: <div class="sect1" lang="en">
10482: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 10483: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.1 dsieger 10484: <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
10485: provides the <span><strong class="command">pkg_regress</strong></span> command. Then you
10486: can simply run that command, which will run all tests in the
10487: <code class="filename">regress</code> category.</p>
10488: </div>
10489: <div class="sect1" lang="en">
10490: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 10491: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.1 dsieger 10492: <p>Every directory in the <code class="filename">regress</code>
10493: category that contains a file called <code class="filename">spec</code>
10494: is considered a regression test. This file is a shell program
10495: that is included by the <span><strong class="command">pkg_regress</strong></span> command.
10496: The following functions can be overridden to suit your
10497: needs.</p>
10498: <div class="sect2" lang="en">
10499: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 10500: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.1 dsieger 10501: <p>These functions do not take any parameters. They are all
10502: called in “<span class="quote">set -e</span>” mode, so you should be careful
10503: to check the exitcodes of any commands you run in the
10504: test.</p>
10505: <div class="variablelist"><dl>
10506: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10507: <dd><p>This function prepares the environment for the
10508: test. By default it does nothing.</p></dd>
10509: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10510: <dd><p>This function runs the actual test. By default,
10511: it calls <code class="varname">TEST_MAKE</code> with the arguments
10512: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10513: error messages into the file
10514: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10515: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10516: <dd><p>This function is run after the test and is
10517: typically used to compare the actual output from the one that is
10518: expected. It can make use of the various helper functions from
10519: the next section.</p></dd>
10520: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10521: <dd><p>This function cleans everything up after the
10522: test has been run. By default it does nothing.</p></dd>
10523: </dl></div>
10524: </div>
10525: <div class="sect2" lang="en">
10526: <div class="titlepage"><div><div><h3 class="title">
1.6 ! rillig 10527: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.1 dsieger 10528: <div class="variablelist"><dl>
10529: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10530: <dd><p>This function compares the exitcode of the
10531: <span><strong class="command">do_test()</strong></span> function with its first parameter.
10532: If they differ, the test will fail.</p></dd>
10533: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10534: <dd><p>This function checks for each of its parameters
10535: if the output from <span><strong class="command">do_test()</strong></span> matches the
10536: extended regular expression. If it does not, the test will
10537: fail.</p></dd>
10538: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10539: <dd><p>This function checks for each of its parameters
10540: if the output from <span><strong class="command">do_test()</strong></span> does
10541: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10542: If any of the regular expressions matches, the test will
10543: fail.</p></dd>
10544: </dl></div>
10545: </div>
10546: </div>
10547: </div>
10548: <div class="chapter" lang="en">
10549: <div class="titlepage"><div><div><h2 class="title">
1.6 ! rillig 10550: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 10551: <div class="toc">
10552: <p><b>Table of Contents</b></p>
10553: <dl>
1.6 ! rillig 10554: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
! 10555: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 10556: </dl>
10557: </div>
10558: <p>The pkgsrc system has already been ported to many
10559: operating systems, hardware architectures and compilers. This
10560: chapter explains the necessary steps to make pkgsrc even more
10561: portable.</p>
10562: <div class="sect1" lang="en">
10563: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 10564: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10565: <p>To port pkgsrc to a new operating system (called
10566: <code class="literal">MyOS</code> in this example), you need to touch the
10567: following files:</p>
10568: <div class="variablelist"><dl>
10569: <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>
10570: <dd><p>This file contains some basic definitions, for
10571: example the name of the C
10572: compiler.</p></dd>
10573: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10574: <dd><p>Insert code that defines the variables
10575: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10576: <code class="varname">LOWER_OS_VERSION</code>,
10577: <code class="varname">LOWER_VENDOR</code>,
10578: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10579: <code class="varname">APPEND_ELF</code>, and the other variables that
10580: appear in this file.</p></dd>
10581: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10582: <dd><p>This file contains the platform-specific
10583: definitions that are used by pkgsrc. Start by copying one of the
10584: other files and edit it to your
10585: needs.</p></dd>
10586: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
10587: <dd><p>This file contains a list of directories,
10588: together with their permission bits and ownership. These
10589: directories will be created automatically with every package
10590: that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
10591: be removed.</p></dd>
10592: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
10593: <dd><p>Just copy one of the pre-existing x11.dist files
10594: to your
10595: <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10596: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
10597: <dd><p>On some operating systems, the tools that are
10598: provided with the base system are not good enough for pkgsrc.
10599: For example, there are many versions of <a 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
10600: narrow limit on the line length they can process. Therefore
10601: pkgsrc brings its own tools, which can be enabled
10602: here.</p></dd>
10603: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10604: <dd><p>This file defines the paths to all the tools
10605: that are needed by one or the other package in pkgsrc, as well
10606: as by pkgsrc itself. Find out where these tools are on your
10607: platform and add them.</p></dd>
10608: </dl></div>
10609: <p>Now, you should be able to build some basic packages, like
10610: <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>
10611: </div>
10612: <div class="sect1" lang="en">
10613: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 ! rillig 10614: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.1 dsieger 10615: <p>TODO</p>
10616: </div>
10617: </div>
10618: </div>
10619: <div class="appendix" lang="en">
10620: <div class="titlepage"><div><div><h2 class="title">
10621: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
10622: <div class="toc">
10623: <p><b>Table of Contents</b></p>
10624: <dl>
10625: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10626: <dd><dl>
10627: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10628: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10629: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
10630: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span></a></span></dt>
10631: </dl></dd>
10632: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10633: </dl>
10634: </div>
10635: <p>We checked to find a piece of software that wasn't in the packages
10636: collection, and picked GNU bison. Quite why someone would want to have
10637: <span><strong class="command">bison</strong></span> when Berkeley <span><strong class="command">yacc</strong></span> is already
10638: present in the tree is beyond us, but it's useful for the purposes of
10639: this exercise.</p>
10640: <div class="sect1" lang="en">
10641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10642: <a name="example-files"></a>A.1. files</h2></div></div></div>
10643: <div class="sect2" lang="en">
10644: <div class="titlepage"><div><div><h3 class="title">
10645: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10646: <pre class="programlisting">
10647: # $NetBSD$
10648: #
10649:
10650: DISTNAME= bison-1.25
10651: CATEGORIES= devel
10652: MASTER_SITES= ${MASTER_SITE_GNU}
10653:
10654: MAINTAINER= thorpej@NetBSD.org
10655: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10656: COMMENT= GNU yacc clone
10657:
10658: GNU_CONFIGURE= yes
10659: INFO_FILES= bison.info
10660:
10661: .include "../../mk/bsd.pkg.mk"
10662: </pre>
10663: </div>
10664: <div class="sect2" lang="en">
10665: <div class="titlepage"><div><div><h3 class="title">
10666: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10667: <pre class="programlisting">
10668: GNU version of yacc. Can make re-entrant parsers, and numerous other
10669: improvements. Why you would want this when Berkeley <a 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
10670: of the NetBSD source tree is beyond me.
10671: </pre>
10672: </div>
10673: <div class="sect2" lang="en">
10674: <div class="titlepage"><div><div><h3 class="title">
10675: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10676: <pre class="programlisting">
10677: @comment $NetBSD$
10678: bin/bison
10679: man/man1/bison.1.gz
10680: share/bison.simple
10681: share/bison.hairy
10682: </pre>
10683: </div>
10684: <div class="sect2" lang="en">
10685: <div class="titlepage"><div><div><h3 class="title">
10686: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span>
10687: </h3></div></div></div>
10688: <p>The NetBSD package system comes with
10689: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
10690: which helps to check the contents of these
10691: files. After installation it is quite easy to use, just change to the
10692: directory of the package you wish to examine and execute
10693: <span><strong class="command">pkglint</strong></span>:</p>
10694: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10695: looks fine.</pre>
10696: <p>Depending on the supplied command line arguments (see pkglint(1)),
10697: more checks will be performed. Use e.g. <span><strong class="command">pkglint -Call
10698: -Wall</strong></span> for a very thorough check.</p>
10699: </div>
10700: </div>
10701: <div class="sect1" lang="en">
10702: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10703: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10704: <p>Create the directory where the package lives,
10705: plus any auxiliary directories:</p>
10706: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10707: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10708: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10709: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10710: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.6 ! rillig 10711: <code class="filename">PLIST</code> (see <a href="#components" title="Chapter 11. Package components - files, directories and contents">Chapter 11, <i>Package components - files, directories and contents</i></a>)
1.1 dsieger 10712: then continue with fetching the distfile:</p>
10713: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10714: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10715: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10716: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10717: ftp: Error retrieving file: 500 Internal error
10718:
10719: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10720: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10721: ftp: Error retrieving file: 500 Internal error
10722:
10723: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10724: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10725: Successfully retrieved file.</pre>
10726: <p>Generate the checksum of the distfile into
10727: <code class="filename">distinfo</code>:</p>
10728: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
10729: <p>Now compile:</p>
10730: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10731: >> Checksum OK for bison-1.25.tar.gz.
10732: ===> Extracting for bison-1.25
10733: ===> Patching for bison-1.25
10734: ===> Ignoring empty patch directory
10735: ===> Configuring for bison-1.25
10736: creating cache ./config.cache
10737: checking for gcc... cc
10738: checking whether we are using GNU C... yes
10739: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10740: checking how to run the C preprocessor... cc -E
10741: checking for minix/config.h... no
10742: checking for POSIXized ISC... no
10743: checking whether cross-compiling... no
10744: checking for ANSI C header files... yes
10745: checking for string.h... yes
10746: checking for stdlib.h... yes
10747: checking for memory.h... yes
10748: checking for working const... yes
10749: checking for working alloca.h... no
10750: checking for alloca... yes
10751: checking for strerror... yes
10752: updating cache ./config.cache
10753: creating ./config.status
10754: creating Makefile
10755: ===> Building for bison-1.25
10756: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g LR0.c
10757: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g allocate.c
10758: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g closure.c
10759: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g conflicts.c
10760: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g derives.c
10761: 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
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 getargs.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 gram.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 lalr.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 lex.c
10766: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g main.c
10767: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g nullable.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 output.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 print.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 reader.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 reduce.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 symtab.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 warshall.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 version.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 getopt.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 getopt1.c
10777: 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
10778: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10779: rm -f bison.s1
10780: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10781: <p>Everything seems OK, so install the files:</p>
10782: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10783: >> Checksum OK for bison-1.25.tar.gz.
10784: ===> Installing for bison-1.25
10785: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10786: rm -f /usr/pkg/bin/bison
10787: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10788: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10789: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10790: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10791: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10792: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10793: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10794: ===> Registering installation for bison-1.25</pre>
10795: <p>You can now use bison, and also - if you decide so - remove it with
10796: <span><strong class="command">pkg_delete bison</strong></span>. Should you decide that you want a
10797: binary package, do this now:</p>
10798: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10799: >> Checksum OK for bison-1.25.tar.gz.
10800: ===> Building package for bison-1.25
10801: Creating package bison-1.25.tgz
10802: Registering depends:.
10803: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10804: <p>Now that you don't need the source and object files
10805: any more, clean up:</p>
10806: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10807: ===> Cleaning for bison-1.25</pre>
10808: </div>
10809: </div>
10810: <div class="appendix" lang="en">
10811: <div class="titlepage"><div><div><h2 class="title">
10812: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
10813: <div class="toc">
10814: <p><b>Table of Contents</b></p>
10815: <dl>
10816: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10817: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10818: </dl>
10819: </div>
10820: <div class="sect1" lang="en">
10821: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10822: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10823: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10824: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10825: => figlet221.tar.gz doesn't seem to exist on this system.
10826: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10827: => [172219 bytes]
10828: Connected to ftp.plig.net.
10829: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10830: 331 Guest login ok, send your complete e-mail address as password.
10831: 230-You are user #5 of 500 simultaneous users allowed.
10832: 230-
10833: 230- ___ _ _ _
10834: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10835: 230- | _| _| . |_| . | | | . |_| . | _| . |
10836: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10837: 230- |_| |_| |___| |___|
10838: 230-
10839: 230-** Welcome to ftp.plig.org **
10840: 230-
10841: 230-Please note that all transfers from this FTP site are logged. If you
10842: 230-do not like this, please disconnect now.
10843: 230-
10844: 230-This arhive is available via
10845: 230-
10846: 230-HTTP: http://ftp.plig.org/
10847: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10848: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10849: 230-
10850: 230-Please email comments, bug reports and requests for packages to be
10851: 230-mirrored to ftp-admin@plig.org.
10852: 230-
10853: 230-
10854: 230 Logged in anonymously.
10855: Remote system type is UNIX.
10856: Using binary mode to transfer files.
10857: 200 Type okay.
10858: 250 "/pub" is new cwd.
10859: 250-"/pub/figlet" is new cwd.
10860: 250-
10861: 250-Welcome to the figlet archive at ftp.figlet.org
10862: 250-
10863: 250- ftp://ftp.figlet.org/pub/figlet/
10864: 250-
10865: 250-The official FIGlet web page is:
10866: 250- http://www.figlet.org/
10867: 250-
10868: 250-If you have questions, please mailto:info@figlet.org. If you want to
10869: 250-contribute a font or something else, you can email us.
10870: 250
10871: 250 "/pub/figlet/program" is new cwd.
10872: 250 "/pub/figlet/program/unix" is new cwd.
10873: local: figlet221.tar.gz remote: figlet221.tar.gz
10874: 502 Unimplemented command.
10875: 227 Entering Passive Mode (195,40,6,41,246,104)
10876: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10877: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10878: 226 Transfer completed.
10879: 172219 bytes received in 00:02 (75.99 KB/s)
10880: 221 Goodbye.
10881: => Checksum OK for figlet221.tar.gz.
10882: ===> Extracting for figlet-2.2.1nb2
10883: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10884: ===> Patching for figlet-2.2.1nb2
10885: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10886: ===> Overriding tools for figlet-2.2.1nb2
10887: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10888: ===> Configuring for figlet-2.2.1nb2
10889: ===> Building for figlet-2.2.1nb2
10890: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10891: chmod a+x figlet
10892: gcc -O2 -o chkfont chkfont.c
10893: => Unwrapping files-to-be-installed.
10894: <code class="prompt">#</code>
10895: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10896: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10897: ===> Installing for figlet-2.2.1nb2
10898: install -d -o root -g wheel -m 755 /usr/pkg/bin
10899: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10900: mkdir -p /usr/pkg/share/figlet
10901: cp figlet /usr/pkg/bin
10902: cp chkfont /usr/pkg/bin
10903: chmod 555 figlist showfigfonts
10904: cp figlist /usr/pkg/bin
10905: cp showfigfonts /usr/pkg/bin
10906: cp fonts/*.flf /usr/pkg/share/figlet
10907: cp fonts/*.flc /usr/pkg/share/figlet
10908: cp figlet.6 /usr/pkg/man/man6
10909: ===> Registering installation for figlet-2.2.1nb2
10910: <code class="prompt">#</code></pre>
10911: </div>
10912: <div class="sect1" lang="en">
10913: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10914: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10915: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10916: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10917: ===> Packaging figlet-2.2.1nb2
10918: ===> Building binary package for figlet-2.2.1nb2
10919: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10920: Using SrcDir value of /usr/pkg
10921: Registering depends:.
10922: <code class="prompt">#</code></pre>
10923: </div>
10924: </div>
10925: <div class="appendix" lang="en">
10926: <div class="titlepage"><div><div><h2 class="title">
10927: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
10928: <div class="toc">
10929: <p><b>Table of Contents</b></p>
10930: <dl>
10931: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
10932: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10933: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
10934: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
1.3 rillig 10935: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages</code>: Binary packages</a></span></dt>
1.1 dsieger 10936: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
10937: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
10938: source packages</a></span></dt>
10939: </dl>
10940: </div>
10941: <p>As in other big projects, the directory layout of pkgsrc
10942: is quite complex for newbies. This chapter explains where you
10943: find things on the FTP server. The base directory on
10944: <code class="filename">ftp.NetBSD.org</code> is <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
10945: On other servers it may be different, but inside this directory,
10946: everything should look the same, no matter on which server you
10947: are. This directory contains some subdirectories, which are
10948: explained below.</p>
10949: <div class="sect1" lang="en">
10950: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10951: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
10952: <p>For those who only want to manage binary packages on
10953: systems other than NetBSD, we provide the package management
10954: tools in a separate, small tar file.</p>
10955: </div>
10956: <div class="sect1" lang="en">
10957: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10958: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
10959: <p>The directory <code class="filename">distfiles</code> contains lots
10960: of archive files from all pkgsrc packages, which are mirrored
10961: here. The subdirectories are called after their package names
10962: and are used when the distributed files have names that don't
10963: explicitly contain a version number or are otherwise too generic
10964: (for example <code class="filename">release.tar.gz</code>).</p>
10965: </div>
10966: <div class="sect1" lang="en">
10967: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10968: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
10969: <p>This directory is currently not in use.</p>
10970: </div>
10971: <div class="sect1" lang="en">
10972: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10973: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
10974: <p>This directory contains things that individual pkgsrc
10975: developers find worth publishing.</p>
10976: </div>
10977: <div class="sect1" lang="en">
10978: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.3 rillig 10979: <a name="ftp-packages"></a>C.5. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
10980: <p>This directory contains binary packages for the various
10981: platforms that are supported by pkgsrc.
10982: 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>
10983: <div class="itemizedlist"><ul type="disc">
10984: <li><p><code class="varname">OPSYS</code> is the name of the operating system for which the packages have been built,</p></li>
10985: <li><p><code class="varname">ARCH</code> is the hardware architecture,</p></li>
10986: <li><p><code class="varname">OSVERSION</code> is the version of the operating system,</p></li>
10987: <li><p><code class="varname">TAG</code> is either <code class="literal">200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code> for a stable branch, or <code class="literal">head</code> for packages built from the HEAD branch.</p></li>
10988: </ul></div>
10989: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10990: can quickly click through the directories on the
10991: server and find the best binary packages for their machines. Since they
10992: usually know the operating system and the hardware architecture, OPSYS
10993: and ARCH are placed first. After these choices, they can select the
10994: best combination of OSVERSION and TAG together, since it is usually the
10995: case that packages stay compatible between different version of the
10996: operating system.</p>
10997: <p>In each of these directories, there is a
10998: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 10999: <code class="filename">All</code> which contains all binary packages.
11000: Besides that, there are various category directories that
11001: contain symbolic links to the real binary packages.</p>
11002: </div>
11003: <div class="sect1" lang="en">
11004: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11005: <a name="ftp-source"></a>C.6. <code class="filename">current</code>,
11006: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
11007: source packages</h2></div></div></div>
11008: <p>These directories contain the “<span class="quote">real</span>” pkgsrc,
11009: that is the files that define how to create binary packages from
11010: source archives.</p>
11011: <p>The directory <code class="filename">pkgsrc</code> contains a
11012: snapshot of the CVS repository, which is updated regularly. The
11013: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
11014: directory, ready to be downloaded as a whole.</p>
11015: <p>In the directories for the quarterly branches, there is an
11016: additional file called
11017: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
11018: which contains the state of pkgsrc when it was branched.</p>
11019: </div>
11020: </div>
11021: <div class="appendix" lang="en">
11022: <div class="titlepage"><div><div><h2 class="title">
11023: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
11024: <div class="toc">
11025: <p><b>Table of Contents</b></p>
11026: <dl>
11027: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
11028: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
11029: </dl>
11030: </div>
11031: <p>This section contains information on editing the pkgsrc
11032: guide itself.</p>
11033: <div class="sect1" lang="en">
11034: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11035: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
11036: <p>The pkgsrc guide's source code is stored in
11037: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
11038: are created from it:</p>
11039: <div class="itemizedlist"><ul type="disc">
11040: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
11041: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.2 rillig 11042: <li><p><a href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
11043: <li><p><a href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.1 dsieger 11044: The PDF version of the pkgsrc guide.</p></li>
1.2 rillig 11045: <li><p><a href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.1 dsieger 11046: PostScript version of the pkgsrc guide.</p></li>
11047: </ul></div>
11048: </div>
11049: <div class="sect1" lang="en">
11050: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11051: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
11052: <p>The procedure to edit the pkgsrc guide is:</p>
11053: <div class="procedure"><ol type="1">
11054: <li><p>Make sure you have the packages needed to
11055: regenerate the pkgsrc guide (and other XML-based NetBSD
11056: 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
11057: 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
11058: PostScript and PDF versions. You will need both packages
11059: installed, to make sure documentation is consistent across all
11060: formats.</p></li>
11061: <li><p>Run <span><strong class="command">cd doc/guide</strong></span> to get to the
11062: right directory. All further steps will take place
11063: here.</p></li>
11064: <li><p>Edit the XML file(s) in
11065: <code class="filename">files/</code>.</p></li>
11066: <li><p>Run <span><strong class="command">bmake</strong></span> to check the pkgsrc
11067: guide for valid XML and to build the final output files. If you
11068: get any errors at this stage, you can just edit the files, as
11069: there are only symbolic links in the working directory, pointing
11070: to the files in <code class="filename">files/</code>.</p></li>
11071: <li><p><span><strong class="command">(cd files && cvs
11072: commit)</strong></span></p></li>
11073: <li><p>Run <span><strong class="command">bmake clean && bmake</strong></span> to
11074: regenerate the output files with the proper RCS
11075: Ids.</p></li>
11076: <li>
11077: <p>Run <span><strong class="command">bmake regen</strong></span> to install and
11078: commit the files in both <code class="filename">pkgsrc/doc</code> and
11079: <code class="filename">htdocs</code>.</p>
11080: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11081: <h3 class="title">Note</h3>
11082: <p>If you have added, removed or renamed some chapters,
11083: you need to synchronize them using <span><strong class="command">cvs add</strong></span> or
11084: <span><strong class="command">cvs delete</strong></span> in the htdocs
11085: directory.</p>
11086: </div>
11087: </li>
11088: </ol></div>
11089: </div>
11090: </div>
11091: </div></body>
11092: </html>
CVSweb <webmaster@jp.NetBSD.org>