diff options
| author | reed <reed@pkgsrc.org> | 2005-09-20 06:37:21 +0000 |
|---|---|---|
| committer | reed <reed@pkgsrc.org> | 2005-09-20 06:37:21 +0000 |
| commit | bcc867cbc17027f87991acd94964528a40ac5c52 (patch) | |
| tree | e0b9a18c11722a4124345cbdf4259ac6d1e34930 | |
| parent | c27b2ad8020463af6c16f7031778adf3abc6362e (diff) | |
| download | pkgsrc-bcc867cbc17027f87991acd94964528a40ac5c52.tar.gz | |
Regenerate.
Various changes to pkgsrc guide since this was last generated
in early August.
| -rw-r--r-- | doc/pkgsrc.html | 384 | ||||
| -rw-r--r-- | doc/pkgsrc.txt | 326 |
2 files changed, 378 insertions, 332 deletions
diff --git a/doc/pkgsrc.html b/doc/pkgsrc.html index a5358b8cb2e..a65f328920e 100644 --- a/doc/pkgsrc.html +++ b/doc/pkgsrc.html @@ -139,7 +139,7 @@ alink="#0000FF"> pkgsrc</a></span></dt> <dt><span class="sect1"><a href= - "#platform-specific-notes">3.2. Platform specific + "#platform-specific-notes">3.2. Platform-specific notes</a></span></dt> <dd> @@ -285,7 +285,7 @@ alink="#0000FF"> <dt><span class="sect2"><a href= "#setting-up-a-sandbox">6.3.6. Setting up a - sandbox for chroot'ed builds</a></span></dt> + sandbox for chrooted builds</a></span></dt> <dt><span class="sect2"><a href= "#building-a-partial-set">6.3.7. Building a @@ -503,8 +503,8 @@ alink="#0000FF"> Variable substitution in PLIST</a></span></dt> <dt><span class="sect1"><a href= - "#manpage-compression">10.5. - Manpage-compression</a></span></dt> + "#manpage-compression">10.5. Man + page-compression</a></span></dt> <dt><span class="sect1"><a href= "#using-PLIST_SRC">10.6. Changing PLIST source with @@ -512,7 +512,7 @@ alink="#0000FF"> "varname">PLIST_SRC</code></a></span></dt> <dt><span class="sect1"><a href= - "#platform-specific-plist">10.7. Platform specific + "#platform-specific-plist">10.7. Platform-specific and differing PLISTs</a></span></dt> <dt><span class="sect1"><a href= @@ -611,7 +611,7 @@ alink="#0000FF"> <dt><span class="sect2"><a href= "#conf-files-configure">12.2.2. Telling the - software were configuration files + software where configuration files are</a></span></dt> <dt><span class="sect2"><a href= @@ -1011,8 +1011,8 @@ alink="#0000FF"> </div> </div> - <p>There is a lot of software freely available for Unix - based systems, which usually runs on NetBSD and other + <p>There is a lot of software freely available for + Unix-based systems, which usually runs on NetBSD and other Unix-flavoured systems, too, sometimes with some modifications. The NetBSD Packages Collection (pkgsrc) incorporates any such changes necessary to make that @@ -1277,7 +1277,7 @@ alink="#0000FF"> <dd> <p>The piece of software to be installed which will - be constructed from all the files in the Distfile by + be constructed from all the files in the distfile by the actions defined in the corresponding package.</p> </dd> </dl> @@ -1345,7 +1345,7 @@ alink="#0000FF"> pkgsrc</a></span></dt> <dt><span class="sect1"><a href= - "#platform-specific-notes">3.2. Platform specific + "#platform-specific-notes">3.2. Platform-specific notes</a></span></dt> <dd> @@ -1490,7 +1490,7 @@ alink="#0000FF"> <dt><span class="sect2"><a href= "#setting-up-a-sandbox">6.3.6. Setting up a - sandbox for chroot'ed builds</a></span></dt> + sandbox for chrooted builds</a></span></dt> <dt><span class="sect2"><a href= "#building-a-partial-set">6.3.7. Building a @@ -1732,7 +1732,7 @@ release=pkgsrc pkgsrc</a></span></dt> <dt><span class="sect1"><a href= - "#platform-specific-notes">3.2. Platform specific + "#platform-specific-notes">3.2. Platform-specific notes</a></span></dt> <dd> @@ -1854,6 +1854,19 @@ release=pkgsrc up-to-date list of these can be found on <a href= "http://www.pkgsrc.org/" target= "_top">www.pkgsrc.org</a>.</p> + + <div class="note" style= + "margin-left: 0.5in; margin-right: 0.5in;"> + <h3 class="title">Note</h3> + + <p>The bootstrap installs a <span><strong class= + "command">bmake</strong></span> tool. Use this + <span><strong class="command">bmake</strong></span> + when building via pkgsrc. For examples in this guide, + use <span><strong class="command">bmake</strong></span> + instead of “<span class= + "quote">make</span>”.</p> + </div> </div> <div class="sect1" lang="en" xml:lang="en"> @@ -1862,8 +1875,8 @@ release=pkgsrc <div> <h2 class="title" style="clear: both"><a name= "platform-specific-notes" id= - "platform-specific-notes"></a>3.2. Platform - specific notes</h2> + "platform-specific-notes"></a>3.2. Platform-specific + notes</h2> </div> </div> </div> @@ -1912,7 +1925,7 @@ release=pkgsrc <h3 class="title">Note</h3> <p>You cannot use a HFS+ file system for pkgsrc, - because pkgsrc currently requires the filesystem to + because pkgsrc currently requires the file system to be case-sensitive, and HFS+ is not.</p> </div> @@ -2081,7 +2094,7 @@ release=pkgsrc </div> </div> - <p>Interix is a POSIX compatible subsystem for the + <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel, providing a Unix-like environment with a tighter kernel integration than available with Cygwin. It is part of the Windows Services for Unix @@ -2180,8 +2193,8 @@ release=pkgsrc </li> <li> - <p>To enable case-sensitivity for the - filesystem, run REGEDIT.EXE, and change the + <p>To enable case-sensitivity for the file + system, run REGEDIT.EXE, and change the following registry key:</p> <p> @@ -2304,8 +2317,8 @@ interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi: from a different host, please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory, as it appears that IRIX linker occasionally - runs into issues when trying to link over a network - mounted filesystem.</p> + runs into issues when trying to link over a + network-mounted file system.</p> <p>The bootstrapping process should set all the right options for programs such as imake(1), but you may want @@ -2481,8 +2494,8 @@ ICCBASE=/opt/icc program uses <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= "filename">/etc/mk.conf</code> as well. You can - work around this by enclosing all the pkgsrc - specific parts of the file with:</p> + work around this by enclosing all the + pkgsrc-specific parts of the file with:</p> <pre class="programlisting"> .ifdef BSD_PKG_MK # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here @@ -2612,7 +2625,7 @@ ICCBASE=/opt/icc <code class="varname">CXX</code> and optionally, <code class="varname">CPP</code> in <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= - "filename">/etc/mk.conf</code>, eg.</p> + "filename">/etc/mk.conf</code>, e.g.:</p> <pre class="programlisting"> CC= cc CXX= CC @@ -2620,7 +2633,7 @@ CPP= /usr/ccs/lib/cpp </pre> <p>You may also want to build 64-bit binaries, - eg.</p> + e.g.:</p> <pre class="programlisting"> CFLAGS= -xtarget=ultra -xarch=v9 </pre> @@ -2630,7 +2643,7 @@ CFLAGS= -xtarget=ultra -xarch=v9 <code class="varname">PATH</code>. This includes <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= - "filename">/usr/ccs/{bin,lib}</code> and eg. + "filename">/usr/ccs/{bin,lib}</code> and e.g. <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= "filename">/usr/pkg/{bin,sbin}</code>.</p> @@ -2747,11 +2760,11 @@ CFLAGS= -xtarget=ultra -xarch=v9 "http://www.w3.org/TR/xhtml1/transitional" class= "filename">/usr/pkgsrc/packages</code>).</p> - <p>This same directory layout applies for CDROM + <p>This same directory layout applies for CD-ROM distributions, only that the directory may be rooted somewhere else, probably somewhere below <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= - "filename">/cdrom</code>. Please consult your CDROMs + "filename">/cdrom</code>. Please consult your CD-ROMs documentation for the exact location.</p> </div> @@ -2767,7 +2780,7 @@ CFLAGS= -xtarget=ultra -xarch=v9 </div> </div> - <p>If you have the files on a CDROM or downloaded them + <p>If you have the files on a CD-ROM or downloaded them to your hard disk, you can install them with the following command (be sure to <span><strong class= "command">su</strong></span> to root first):</p> @@ -2792,7 +2805,7 @@ CFLAGS= -xtarget=ultra -xarch=v9 <p>To save some typing, you can set the <code class= "varname">PKG_PATH</code> environment variable to a - semicolon separated list of paths (including remote + semicolon-separated list of paths (including remote URLs); trailing slashes are not allowed.</p> <p>Additionally to the <code xmlns= @@ -2811,12 +2824,11 @@ CFLAGS= -xtarget=ultra -xarch=v9 "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/security/audit-packages/README.html" target="_top"><code xmlns="" class= "filename">security/audit-packages</code></a> - regularly, and especially after installing new - packages, and verify that the vulnerabilities are - acceptable for your configuration. An example - <code class="varname">PKG_PATH</code> would be: - <code xmlns="http://www.w3.org/TR/xhtml1/transitional" - class= + regularly, especially after installing new packages, + and verify that the vulnerabilities are acceptable for + your configuration. An example <code class= + "varname">PKG_PATH</code> would be: <code xmlns= + "http://www.w3.org/TR/xhtml1/transitional" class= "filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All;ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/vulnerable</code> Please note that semicolon (';') is a shell meta-character, so you'll probably have to quote @@ -2886,7 +2898,7 @@ CFLAGS= -xtarget=ultra -xarch=v9 “<span class="quote">comp</span>” and the “<span class="quote">text</span>” distribution sets must be installed. If you want to - build X11 related packages the “<span class= + build X11-related packages the “<span class= "quote">xbase</span>” and “<span class= "quote">xcomp</span>” distribution sets are required, too.</p> @@ -2949,8 +2961,21 @@ CFLAGS= -xtarget=ultra -xarch=v9 <p>Assuming that the distfile has been fetched (see previous section), become root and change into the - relevant directory and running <span><strong class= - "command">make</strong></span>. For example, type</p> + relevant directory and run <span><strong class= + "command">make</strong></span>.</p> + + <div class="note" style= + "margin-left: 0.5in; margin-right: 0.5in;"> + <h3 class="title">Note</h3> + + <p>If using bootstrap or pkgsrc on a non-NetBSD + system, use the pkgsrc <span><strong class= + "command">bmake</strong></span> command instead of + “<span class="quote">make</span>” in the + examples in this guide.</p> + </div> + + <p>For example, type</p> <pre class="screen"> <code class="prompt">%</code> <strong class= "userinput"><code>cd misc/figlet</code></strong> @@ -2991,7 +3016,7 @@ CFLAGS= -xtarget=ultra -xarch=v9 "varname">LOCALBASE=/usr/local</code> in your environment. Please note that you should use a directory which is dedicated to packages and not shared - with other programs (ie, do not try and use + with other programs (i.e., do not try and use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try to add any of your own files or directories (such as <code xmlns= @@ -3098,7 +3123,7 @@ CFLAGS= -xtarget=ultra -xarch=v9 "filename">pkgsrc/mk/defaults/mk.conf</code> for more details.</p> - <p>A final word of warning: If you setup a system that + <p>A final word of warning: If you set up a system that has a non-standard setting for <code class= "varname">LOCALBASE</code>, be sure to set that before any packages are installed, as you can not use several @@ -3250,11 +3275,11 @@ CFLAGS= -xtarget=ultra -xarch=v9 </div> </div> - <p>In this section you can find some variables that apply - all pkgsrc packages. The preferred method of setting them - is by setting them in <code xmlns= - "http://www.w3.org/TR/xhtml1/transitional" class= - "filename">/etc/mk.conf</code>.</p> + <p>In this section, you can find some variables that + apply to all pkgsrc packages. The preferred method of + setting these variables is by setting them in + <code xmlns="http://www.w3.org/TR/xhtml1/transitional" + class="filename">/etc/mk.conf</code>.</p> <div class="itemizedlist"> <ul type="disc"> @@ -3606,7 +3631,7 @@ CFLAGS= -xtarget=ultra -xarch=v9 <dt><span class="sect2"><a href= "#setting-up-a-sandbox">6.3.6. Setting up a sandbox - for chroot'ed builds</a></span></dt> + for chrooted builds</a></span></dt> <dt><span class="sect2"><a href= "#building-a-partial-set">6.3.7. Building a partial @@ -3650,7 +3675,7 @@ CFLAGS= -xtarget=ultra -xarch=v9 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 + "refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build the same package on a group of hosts and wasting CPU time. It also provides a simple means for others to install your package, should you distribute @@ -3818,7 +3843,7 @@ _ACCEPTABLE= yes </div> <p>It is possible to configure the bulk build to - perform certain site specific tasks at the end of the + perform certain site-specific tasks at the end of the pre-build stage. If the file <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= "filename">pre-build.local</code> exists in @@ -4056,7 +4081,7 @@ fi <div> <h3 class="title"><a name="setting-up-a-sandbox" id="setting-up-a-sandbox"></a>6.3.6. Setting - up a sandbox for chroot'ed builds</h3> + up a sandbox for chrooted builds</h3> </div> </div> </div> @@ -4249,7 +4274,7 @@ fi </ol> </div> - <p>When the chroot sandbox is setup, you can start the + <p>When the chroot sandbox is set up, you can start the build with the following steps:</p> <pre class="screen"> <code class="prompt">#</code> <strong class= @@ -4284,7 +4309,7 @@ fi "http://www.w3.org/TR/xhtml1/transitional" class= "filename">pkgsrc/mk/bulk/build</code> script may be used to build a subset of the packages contained in - pkgsrc. By setting defining <code class= + pkgsrc. By setting <code class= "varname">SPECIFIC_PKGS</code> in <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= "filename">/etc/mk.conf</code>, the variables</p> @@ -4361,7 +4386,7 @@ fi RSYNC_DST=$CVS_USER@ftp.NetBSD.org:/pub/NetBSD/packages/pkgsrc-200xQy/NetBSD-a.b.c/arch/upload </pre> - <p>Please use appropviate values for "pkgsrc-200xQy", + <p>Please use appropriate values for "pkgsrc-200xQy", "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org is different from <code class= "varname">CVS_USER</code>, write your login directly @@ -4391,7 +4416,7 @@ nbftp% <strong class= "filename">/pub/pkgsrc</code>.</p> <p>Before uploading the binary pkgs, ssh authentication - needs to be set up. This example shows how to setup + needs to be set up. This example shows how to set up temporary keys for the root account <span class= "emphasis"><em>inside the sandbox</em></span> (assuming that no keys should be present there usually):</p> @@ -4495,8 +4520,8 @@ nbftp% <strong class="userinput"><code>chmod 755 .</code></strong> simple tool for creating the ISO 9660 images. <span><strong class="command">cdpack</strong></span> arranges the packages on the CD-ROMs in a way that keeps - all the dependencies for given package on the same CD as - that package.</p> + all the dependencies for a given package on the same CD + as that package.</p> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> @@ -4510,7 +4535,7 @@ nbftp% <strong class="userinput"><code>chmod 755 .</code></strong> </div> <p>Complete documentation for cdpack is found in the - cdpack(1) manpage. The following short example assumes + cdpack(1) man page. The following short example assumes that the binary packages are left in <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= "filename">/usr/pkgsrc/packages/All</code> and that @@ -4963,7 +4988,7 @@ nbftp% <strong class="userinput"><code>chmod 755 .</code></strong> </ul> </div> - <p>Utilities for people maintaining pkgsrc (or more + <p>Utilities for people maintaining pkgsrc (or: more obscure pkg utilities)</p> <div class="itemizedlist"> @@ -4971,16 +4996,6 @@ nbftp% <strong class="userinput"><code>chmod 755 .</code></strong> <li> <p><a xmlns= "http://www.w3.org/TR/xhtml1/transitional" href= - "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/pkgconflict/README.html" - target="_top"><code xmlns="" class= - "filename">pkgtools/pkgconflict</code></a>: Find - packages that conflict but aren't marked as - such.</p> - </li> - - <li> - <p><a xmlns= - "http://www.w3.org/TR/xhtml1/transitional" href= "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code xmlns="" class= "filename">pkgtools/pkg_comp</code></a>: Build @@ -5054,7 +5069,7 @@ nbftp% <strong class="userinput"><code>chmod 755 .</code></strong> </div> </div> - <p>By default resuming transfers in pkgsrc is disabled, + <p>By default, resuming transfers in pkgsrc is disabled, but you can enable this feature by adding the option <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into <code xmlns= @@ -5154,7 +5169,7 @@ X11_TYPE=xorg allow direct connections to Internet hosts (i.e. non-NAT), you may specify the relevant proxy hosts. This is done using an environment variable in the form of a - URL e.g. in Amdahl, the machine “<span class= + URL, e.g. in Amdahl, the machine “<span class= "quote">orpheus.amdahl.com</span>” is one of the firewalls, and it uses port 80 as the proxy port number. So the proxy environment variables are:</p> @@ -5239,7 +5254,7 @@ http_proxy=http://orpheus.amdahl.com:80/ <p>The answer here is to do a <span><strong class= "command">make fetch-list</strong></span> in <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= - "filename">/usr/pkgsrc</code> or one of it's + "filename">/usr/pkgsrc</code> or one of its subdirectories, carry the resulting list to your machine at work/school and use it there. If you don't have a NetBSD-compatible <a href= @@ -5315,7 +5330,7 @@ http_proxy=http://orpheus.amdahl.com:80/ indicates that you don't have installed the “<span class="quote">text</span>” set (nroff, ...) from the NetBSD base distribution on your machine. - It is recommended to do that to format manpages.</p> + It is recommended to do that to format man pages.</p> <p>In the case of the <a xmlns= "http://www.w3.org/TR/xhtml1/transitional" href= @@ -5344,8 +5359,8 @@ http_proxy=http://orpheus.amdahl.com:80/ <p>You didn't install the compiler set, <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= "filename">comp.tgz</code>, when you installed your - NetBSD machine. Please get it and install it, by - extracting it in <code xmlns= + NetBSD machine. Please get and install it, by extracting + it in <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= "filename">/</code>:</p> <pre class="screen"> @@ -5438,7 +5453,7 @@ SU_CMD=${LOCALBASE}/bin/sudo /bin/sh -c like to modify, that is, the contents of <code class= "varname">PKGBASE</code>.</p> - <p>Note that, after changing these settings, you must + <p>Note that after changing these settings, you must rebuild and reinstall any affected packages.</p> </div> @@ -5639,8 +5654,8 @@ SU_CMD=${LOCALBASE}/bin/sudo /bin/sh -c Variable substitution in PLIST</a></span></dt> <dt><span class="sect1"><a href= - "#manpage-compression">10.5. - Manpage-compression</a></span></dt> + "#manpage-compression">10.5. Man + page-compression</a></span></dt> <dt><span class="sect1"><a href= "#using-PLIST_SRC">10.6. Changing PLIST source with @@ -5648,7 +5663,7 @@ SU_CMD=${LOCALBASE}/bin/sudo /bin/sh -c "varname">PLIST_SRC</code></a></span></dt> <dt><span class="sect1"><a href= - "#platform-specific-plist">10.7. Platform specific + "#platform-specific-plist">10.7. Platform-specific and differing PLISTs</a></span></dt> <dt><span class="sect1"><a href= @@ -5744,7 +5759,7 @@ SU_CMD=${LOCALBASE}/bin/sudo /bin/sh -c <dt><span class="sect2"><a href= "#conf-files-configure">12.2.2. Telling the - software were configuration files + software where configuration files are</a></span></dt> <dt><span class="sect2"><a href= @@ -6212,10 +6227,10 @@ converters games mbone print x11 "varname">DISTFILES</code> or multiple <code class= "varname">PATCHFILES</code> from different sites, set <code class="varname">SITES_foo</code> to a - list of URI's where file “<span class= + list of URIs where file “<span class= "quote">foo</span>” may be found. “<span class="quote">foo</span>” - includes the suffix, e.g.</p> + includes the suffix, e.g.:</p> <pre class="programlisting"> DISTFILES= ${DISTNAME}${EXTRACT_SUFX} DISTFILES+= foo-file.tar.gz @@ -6256,7 +6271,7 @@ SITES_foo-file.tar.gz=http://www.somewhere.com/somehow/ \ <div class="itemizedlist"> <ul type="disc"> <li> - <p><code class="varname">PATCHFILES</code> Name(s) + <p><code class="varname">PATCHFILES:</code> Name(s) of additional files that contain distribution patches. There is no default. pkgsrc will look for them at <code class="varname">PATCH_SITES</code>. @@ -6342,8 +6357,8 @@ SITES_foo-file.tar.gz=http://www.somewhere.com/somehow/ \ <ul type="disc"> <li> <p>Add <code class="varname">MANCOMPRESSED</code> - if manpages are installed in compressed form by the - package; see comment in <code xmlns= + if man pages are installed in compressed form by + the package; see comment in <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= "filename">bsd.pkg.mk</code>.</p> </li> @@ -6469,7 +6484,7 @@ SITES_foo-file.tar.gz=http://www.somewhere.com/somehow/ \ force patches to apply with fuzz you can set <code class= "varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, do not put changes for more than one file into a single - patch-file, as this will make future modifications more + patch file, as this will make future modifications more difficult.</p> <p>Similar, a file should be patched at most once, not @@ -6532,8 +6547,8 @@ SITES_foo-file.tar.gz=http://www.somewhere.com/somehow/ \ structure as pkgsrc, and patches are expected to be stored inside these dirs (also known as <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= - "filename">$LOCALPATCHES/$PKGPATH</code>). For example if - you want to keep a private patch for <code xmlns= + "filename">$LOCALPATCHES/$PKGPATH</code>). For example, + if you want to keep a private patch for <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= "filename">pkgsrc/graphics/png</code>, keep it in <code xmlns="http://www.w3.org/TR/xhtml1/transitional" @@ -6691,8 +6706,8 @@ MESSAGE_SUBST+= SOMEVAR="somevalue" </div> <p>When you type <span><strong class= - "command">make</strong></span> the distribution files are - unpacked into the directory denoted by <code class= + "command">make</strong></span>, the distribution files + are unpacked into the directory denoted by <code class= "varname">WRKDIR</code>. It can be removed by running <span><strong class="command">make clean</strong></span>. Besides the sources, this directory is also used to keep @@ -6896,7 +6911,7 @@ WRKSRC= ${WRKDIR}/${DISTNAME}/unix newline, and any whitespace immediately behind the newline are replaced with a single space. A backspace character and an immediately following hash character are - replaced with a single hash character. Otherwise the + replaced with a single hash character. Otherwise, the backslash is passed as is. In a variable assignment, any hash character that is not preceded by a backslash starts a comment that continues upto the end of the logical @@ -6913,7 +6928,7 @@ WRKSRC= ${WRKDIR}/${DISTNAME}/unix evaluated when it is part of the right side of the ``:='' or the ``!='' operator, or directly before executing a shell command which the variable is part of. In all other - cases <a href= + 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 @@ -6923,8 +6938,8 @@ WRKSRC= ${WRKDIR}/${DISTNAME}/unix <p>Some of the modifiers split the string into words and then operate on the words, others operate on the string - as a whole. When a string is splitted into words, it is - splitted as you would expect it from <a href= + as a whole. When a string is split into words, it is + split as you would expect 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> @@ -6941,7 +6956,7 @@ WRKSRC= ${WRKDIR}/${DISTNAME}/unix <ul type="disc"> <li> <p><span class="emphasis"><em>Strings</em></span> - can contain arbitrary characters. Nevertheless you + can contain arbitrary characters. Nevertheless, you should restrict yourself to only using printable characters. Examples are <code class= "varname">PREFIX</code> and <code class= @@ -6952,7 +6967,7 @@ WRKSRC= ${WRKDIR}/${DISTNAME}/unix <p><span class="emphasis"><em>Internal lists</em></span> are lists that are never exported to any shell command. Their elements are separated - by whitespace. Therefore the elements themselves + by whitespace. Therefore, the elements themselves cannot have embedded whitespace. Any other characters are allowed. Internal lists can be used in <span><strong class= @@ -7140,13 +7155,13 @@ all: <span class="citerefentry"><span class= "refentrytitle">echo</span>(1)</span></a> command. As long as you can guarantee that your input does not - start with a dash this form is appropriate.</p> + start with a dash, this form is appropriate.</p> <p>Example 5 handles even the case of a leading dash correctly.</p> <p>The <code class="varname">EXT_LIST</code> does not - need to be quoted because the quoting has already be + need to be quoted because the quoting has already been done when adding elements to the list.</p> <p>As internal lists shall not be passed to the shell, @@ -7174,7 +7189,7 @@ all: <p>Whenever you use the value of a list, think about what happens to leading or trailing whitespace. If the list is a well-formed shell - expression you can apply the <code class= + expression, you can apply the <code class= "varname">:M*</code> modifier to strip leading and trailing whitespace from each word. The <code class="varname">:M</code> operator first @@ -7186,7 +7201,7 @@ all: adding a variable like <code class= "varname">CPPFLAGS</code> to <code class= "varname">CONFIGURE_ARGS</code>. If the configure - script invokes other configure scripts it strips + script invokes other configure scripts, it strips the leading and trailing whitespace from the variable and then passes it to the other configure scripts. But these configure scripts @@ -7228,7 +7243,7 @@ all: </li> <li> - <p>Whenever a variable can be empty the + <p>Whenever a variable can be empty, the <code class="varname">:Q</code> operator can have surprising results. Here are two completely different cases which can be solved with the same @@ -7344,15 +7359,15 @@ for_test: Variable substitution in PLIST</a></span></dt> <dt><span class="sect1"><a href= - "#manpage-compression">10.5. - Manpage-compression</a></span></dt> + "#manpage-compression">10.5. Man + page-compression</a></span></dt> <dt><span class="sect1"><a href= "#using-PLIST_SRC">10.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt> <dt><span class="sect1"><a href= - "#platform-specific-plist">10.7. Platform specific and + "#platform-specific-plist">10.7. Platform-specific and differing PLISTs</a></span></dt> <dt><span class="sect1"><a href= @@ -7372,9 +7387,9 @@ for_test: <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> manpage for - a full list. This chapter addresses some issues that need - attention when dealing with the <code xmlns= + "refentrytitle">pkg_create</span>(1)</span></a> man page + for a full list. This chapter addresses some issues that + need attention when dealing with the <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= "filename">PLIST</code> file (or files, see below!).</p> @@ -7496,7 +7511,7 @@ for_test: <p>Some packages like emacs and perl embed information about which architecture they were built on into the pathnames where they install - their file. To handle this case, PLIST will be + their files. To handle this case, PLIST will be preprocessed before actually used, and the symbol “<span class="quote"><code class= "varname">${MACHINE_ARCH}</code></span>” will @@ -7505,7 +7520,7 @@ for_test: is done if the string <code class= "varname">${MACHINE_GNU_ARCH}</code> is embedded in PLIST somewhere - use this on packages that have - GNU autoconf created configure scripts.</p> + GNU autoconf-created configure scripts.</p> <div class="note" style= "margin-left: 0.5in; margin-right: 0.5in;"> @@ -7606,12 +7621,13 @@ PLIST_SUBST+= SOMEVAR="somevalue" <div> <h2 class="title" style="clear: both"><a name= "manpage-compression" id= - "manpage-compression"></a>10.5. Manpage-compression</h2> + "manpage-compression"></a>10.5. Man + page-compression</h2> </div> </div> </div> - <p>Manpages should be installed in compressed form if + <p>Man pages should be installed in compressed form if <code class="varname">MANZ</code> is set (in <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= "filename">bsd.own.mk</code>), and uncompressed @@ -7619,7 +7635,7 @@ PLIST_SUBST+= SOMEVAR="somevalue" "http://www.w3.org/TR/xhtml1/transitional" class= "filename">PLIST</code> file, the suffix “<span class="quote">.gz</span>” is - appended/removed automatically for manpages according to + appended/removed automatically for man pages according to <code class="varname">MANZ</code> and <code class= "varname">MANCOMPRESSED</code> being set or not, see above for details. This modification of the <code xmlns= @@ -7660,8 +7676,8 @@ PLIST_SUBST+= SOMEVAR="somevalue" <div> <h2 class="title" style="clear: both"><a name= "platform-specific-plist" id= - "platform-specific-plist"></a>10.7. Platform - specific and differing PLISTs</h2> + "platform-specific-plist"></a>10.7. Platform-specific + and differing PLISTs</h2> </div> </div> </div> @@ -7792,7 +7808,7 @@ PLIST_SUBST+= SOMEVAR="somevalue" print-PLIST</strong></span>, you should get the right (commented out) lines.</p> - <p>Note that, even if your package is using <code xmlns= + <p>Note that even if your package is using <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= "filename">$X11BASE</code>, it must not depend on the *-x11-dirs packages. Just specify the name without that @@ -7968,6 +7984,15 @@ DEPENDS+= foo>=1.1.0:../../category/foo .include "../../category/foo/buildlink3.mk" </pre> + <p>The buildlink3.mk files usually define the required + dependencies. If you need a newer version of the + dependency when using buildlink3.mk files, then you can + define it in your Makefile; for example:</p> + <pre class="programlisting"> +BUILDLINK_DEPENDS.foo+= foo>=1.1.0 +.include "../../category/foo/buildlink3.mk" +</pre> + <p>There are several <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= "filename">buildlink3.mk</code> files in <code xmlns= @@ -7990,7 +8015,7 @@ DEPENDS+= foo>=1.1.0:../../category/foo <li> <p><code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= - "filename">curses.buildlink3.mk</code> If the + "filename">curses.buildlink3.mk</code>: If the system comes with neither Curses nor NCurses, this will take care to install the <a xmlns= "http://www.w3.org/TR/xhtml1/transitional" href= @@ -8022,7 +8047,7 @@ DEPENDS+= foo>=1.1.0:../../category/foo "http://www.w3.org/TR/xhtml1/transitional" href= "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/x11/openmotif/README.html" target="_top"><code xmlns="" class= - "filename">x11/openmotif</code></a>;</p> + "filename">x11/openmotif</code></a>.</p> </li> <li> @@ -8030,7 +8055,7 @@ DEPENDS+= foo>=1.1.0:../../category/foo "http://www.w3.org/TR/xhtml1/transitional" class= "filename">ossaudio.buildlink3.mk</code> defines several variables that may be used by packages that - use the Open Sound System (OSS) API;</p> + use the Open Sound System (OSS) API.</p> </li> <li> @@ -8051,7 +8076,7 @@ DEPENDS+= foo>=1.1.0:../../category/foo "http://www.w3.org/TR/xhtml1/transitional" href= "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/devel/pth/README.html" target="_top"><code xmlns="" class= - "filename">devel/pth</code></a> as needed;</p> + "filename">devel/pth</code></a> as needed.</p> </li> <li> @@ -8217,7 +8242,7 @@ BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH:S/+$//} "replaceable"><code>pkg</code></em></code> is the location of the <em class= "replaceable"><code>pkg</code></em> pkgsrc - directory;</p> + directory.</p> </li> <li> @@ -8407,7 +8432,7 @@ BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH:S/+$//} <li> <p>if the sonames (major number of the library version) of any installed shared libraries - change;</p> + change.</p> </li> <li> @@ -8736,7 +8761,7 @@ CHECK_BUILTIN.foo?= no <dt><span class="sect2"><a href= "#conf-files-configure">12.2.2. Telling the - software were configuration files + software where configuration files are</a></span></dt> <dt><span class="sect2"><a href= @@ -8811,7 +8836,7 @@ CHECK_BUILTIN.foo?= no </div> <p>The following sections inspect each of the above points - in detail. Note that, in order to use any of the described + in detail. Note that in order to use any of the described functionalities, you must add the following to your package's <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= @@ -8864,13 +8889,13 @@ USE_PKGINSTALL=YES during installation time by using the installation scripts. These scripts can run arbitrary commands, so they have the potential to create and manage files - anywhere in the filesystem. Here is where pkginstall + anywhere in the file system. Here is where pkginstall comes into play: it provides generic scripts to abstract the manipulation of such files and directories based on variables set in the package's <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= "filename">Makefile</code>. The rest of this section - describes which these variables are.</p> + describes these variables.</p> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> @@ -8884,7 +8909,8 @@ USE_PKGINSTALL=YES </div> <p>The following variables can be set to request the - creation of directories anywhere in the filesystem:</p> + creation of directories anywhere in the file + system:</p> <div class="itemizedlist"> <ul type="disc"> @@ -9058,8 +9084,8 @@ SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} variable only makes sense in the package's <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= - "filename">Makefile</code> (i.e., it is not user - customizable).</p> + "filename">Makefile</code> (i.e., it is not + user-customizable).</p> <p>As an example, consider the Apache package, <a xmlns= @@ -9149,7 +9175,7 @@ SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} <div> <h3 class="title"><a name="conf-files-configure" id="conf-files-configure"></a>12.2.2. Telling the - software were configuration files are</h3> + software where configuration files are</h3> </div> </div> </div> @@ -9160,7 +9186,7 @@ SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} you will have to patch the package Makefiles to achieve it. If you are lucky, though, it may be as easy as passing an extra flag to the configuration script; this - is the case of GNU Autoconf generated files:</p> + is the case of GNU Autoconf- generated files:</p> <pre class="programlisting"> CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR} </pre> @@ -9547,8 +9573,8 @@ PKG_SHELL= ${PREFIX}/bin/zsh <pre class="programlisting"> PKG_OPTIONS_VAR= PKG_OPTIONS.wibble PKG_SUPPORTED_OPTIONS= wibble-foo ldap -PKG_OPTIONAL_GROUPS= database -PKG_GROUP.database= mysql pgsql +PKG_OPTIONS_OPTIONAL_GROUPS= database +PKG_OPTIONS_GROUP.database= mysql pgsql PKG_SUGGESTED_OPTIONS= wibble-foo PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo @@ -9724,7 +9750,7 @@ CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap} "varname">PKG_SUPPORTED_OPTIONS</code>, <code class= "varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> - are defined (as can happen with platform specific options + are defined (as can happen with platform-specific options if none of them is supported on the current platform), <code class="varname">PKG_OPTIONS</code> is set to the empty list and the package is otherwise treated as not @@ -9867,8 +9893,8 @@ CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap} </li> <li> - <p>X11 based are special in that they may be - installed in either <code class= + <p>X11-based packages are special in that they may + be installed in either <code class= "varname">X11BASE</code> or <code class= "varname">LOCALBASE</code>.</p> @@ -10099,12 +10125,13 @@ ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS} "http://www.w3.org/TR/xhtml1/transitional" class= "filename">.gz</code>; see the definition of the various <code class="varname">DECOMPRESS_CMD</code> - variables <code xmlns= + variables in <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= - "filename">bsd.pkg.mk</code> for a complete list). - Here's an example on how to use the other variables - for a program that comes with a compressed shell - archive whose name ends in <code xmlns= + "filename">bsd.pkg.extract.mk</code> for a complete + list). Here's an example on how to use the other + variables for a program that comes with a + compressed shell archive whose name ends in + <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= "filename">.msg.gz</code>:</p> <pre class="programlisting"> @@ -10387,7 +10414,7 @@ make build call <span><strong class="command">make clean</strong></span> or otherwise remove the list of dependent packages in <code class= - "varname">WRKDIR</code>. Otherwise you lose the + "varname">WRKDIR</code>. Otherwise, you lose the ability to automatically update the current package along with the dependent packages you have installed.</p> @@ -10500,14 +10527,14 @@ make build package tree (e.g., if you used <code class= "varname">NOCLEAN</code>).</p> - <p>If you unsure about whether your tree is clean - you can either perform a <span><strong class= - "command">make clean</strong></span> at the top of - the tree, or use the following sequence of commands - from the directory of the package you want to - update (<span class= - "emphasis"><em>before</em></span> running + <p>If you are unsure about whether your tree is + clean, you can either perform a <span><strong class="command">make + clean</strong></span> at the top of the tree, or + use the following sequence of commands from the + directory of the package you want to update + (<span class="emphasis"><em>before</em></span> + running <span><strong class="command">make update</strong></span> for the first time, otherwise you lose all the packages you wanted to update!):</p> @@ -10741,13 +10768,13 @@ make build <p>Used to do bulk builds. If an appropriate binary package already exists, no action is taken. If not, this target will compile, install and package it - (and it's depends, if <code class= + (and its depends, if <code class= "varname">PKG_DEPENDS</code> is set properly. See <a href="#binary.configuration" title= "6.3.1. Configuration">Section 6.3.1, - “Configuration”</a>. After creating the - binary package, the sources, the just-installed - package and it's required packages are removed, + “Configuration”</a>). After creating + the binary package, the sources, the just-installed + package and its required packages are removed, preserving free disk space.</p> <p><span class="emphasis"><em>Beware that this @@ -10759,17 +10786,17 @@ make build <dd> <p>Used during bulk-installs to install required - packages. If an upto-date binary package is + packages. If an up-to-date binary package is available, 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, <span><strong class="command">make bulk-package</strong></span> will be executed, but - the installed binary not be removed.</p> + the installed binary won't be removed.</p> <p>A binary package is considered - “<span class="quote">upto-date</span>” + “<span class="quote">up-to-date</span>” to be installed via <a href= "http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"> <span class="citerefentry"><span class= @@ -11027,7 +11054,7 @@ make build "http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"> <span class="citerefentry"><span class= "refentrytitle">make</span>(1)</span></a> expands a - variable as it is used, but evaluates preprocessor like + variable as it is used, but evaluates preprocessor-like statements (.if, .ifdef and .ifndef) as they are read. So, to use any variable (which may be set in <code xmlns="http://www.w3.org/TR/xhtml1/transitional" @@ -11037,7 +11064,7 @@ make build "filename">/etc/mk.conf</code> must be included before that .if* statement.</p> - <p>Rather than have a number of ad-hoc ways of + <p>Rather than having a number of ad-hoc ways of including <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= "filename">/etc/mk.conf</code>, should it exist, or @@ -11058,7 +11085,7 @@ make build <p>If you wish to set the <code class= "varname">CFLAGS</code> variable in <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= - "filename">/etc/mk.conf</code> please make sure to + "filename">/etc/mk.conf</code>, please make sure to use:</p> <pre class="programlisting"> CFLAGS+= -your -flags @@ -11192,7 +11219,8 @@ CFLAGS+= -your -flags present - and there are various ways of expressing this dependency. pkgsrc supports the <code class= "varname">BUILD_DEPENDS</code> and <code class= - "varname">DEPENDS</code> definitions, as well as + "varname">DEPENDS</code> definitions, the <code class= + "varname">USE_TOOLS</code> definition, as well as dependencies via <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= "filename">buildlink3.mk</code>, which is the preferred @@ -11449,11 +11477,11 @@ pre-clean: another package in our pkgsrc tree.</p> <p>In this case you can set <code class= - "varname">CONFLICTS</code> to a space separated list of + "varname">CONFLICTS</code> to a space-separated list of packages (including version string) your package conflicts with.</p> - <p>For example <a xmlns= + <p>For example, <a xmlns= "http://www.w3.org/TR/xhtml1/transitional" href= "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/x11/Xaw3d/README.html" target="_top"><code xmlns="" class= @@ -11461,8 +11489,8 @@ pre-clean: "http://www.w3.org/TR/xhtml1/transitional" href= "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/x11/Xaw-Xpm/README.html" target="_top"><code xmlns="" class= - "filename">x11/Xaw-Xpm</code></a> install provide the - same shared library, thus you set in <code xmlns= + "filename">x11/Xaw-Xpm</code></a> install the same + shared library, thus you set in <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= "filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p> <pre class="programlisting"> @@ -11600,7 +11628,7 @@ CONFLICTS= Xaw3d-[0-9]* being enabled. Common symptoms are gcc internal errors or never finishing compiling a file.</p> - <p>Typically a workaround involves testing the + <p>Typically, a workaround involves testing the <code class="varname">MACHINE_ARCH</code> and compiler version, disabling optimisation for that file/<code class="varname">MACHINE_ARCH</code>/compiler @@ -11644,7 +11672,7 @@ CONFLICTS= Xaw3d-[0-9]* <p>When a new release of the package is released, the <code class="varname">PKGREVISION</code> should be - removed. e.g. on a new minor release of the above + removed, e.g. on a new minor release of the above package, things should be like:</p> <pre class="programlisting"> DISTNAME= foo-17.43 @@ -11861,7 +11889,7 @@ ${INSTALL_DATA_DIR} ${PREFIX}/dir2 as it just “<span class= "quote">knows</span>” how to build both static and dynamic libraries from a set of source files, thus - being platform independent.</p> + being platform-independent.</p> <p>Here's how to use libtool in a pkg in seven simple steps:</p> @@ -12097,10 +12125,10 @@ ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib installed, then use <code class= "varname">SHLIBTOOL_OVERRIDE</code> instead.</p> - <p>If your package makes use of the platform - independent library for loading dynamic shared objects, - that comes with libtool (libltdl), you should include - devel/libltdl/buildlink3.mk.</p> + <p>If your package makes use of the + platform-independent library for loading dynamic shared + objects, that comes with libtool (libltdl), you should + include devel/libltdl/buildlink3.mk.</p> <p>Some packages use libtool incorrectly so that the package may not work or build in some circumstances. @@ -12251,7 +12279,7 @@ pre-configure: <p>Please use the “<span class= "quote">__NetBSD__</span>” definition sparingly - it should only apply to features of NetBSD that are not - present in other 4.4-lite derived BSDs.</p> + present in other 4.4-lite-derived BSDs.</p> </div> </div> @@ -12307,7 +12335,7 @@ pre-configure: of an interactive stage which will be needed, and this should be set in the package's <code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= - "filename">Makefile</code>. e.g.</p> + "filename">Makefile</code>, e.g.:</p> <pre class="programlisting"> INTERACTIVE_STAGE= build </pre> @@ -12639,7 +12667,7 @@ PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist the appropriate <span><strong class= "command">makeinfo</strong></span> command.</p> - <p>To achieve this goal the pkgsrc infrastructure + <p>To achieve this goal, the pkgsrc infrastructure creates overriding scripts for the <span><strong class= "command">install-info</strong></span> and <span><strong class="command">makeinfo</strong></span> @@ -12850,7 +12878,7 @@ PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist </div> </div> - <p>If a package installs gtk2 immodules or loaders, you + <p>If a package installs GTK2 immodules or loaders, you need to take some extra steps to get them registered in the GTK2 database properly:</p> @@ -12880,7 +12908,7 @@ PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist </li> <li> - <p>Patch the package to not touch any of the gtk2 + <p>Patch the package to not touch any of the GTK2 databases directly. These are:</p> <div class="itemizedlist"> @@ -13027,7 +13055,7 @@ PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist "http://www.w3.org/TR/xhtml1/transitional" class= "filename">share/mime/packages</code>. The former are handled automatically by the - update-mime-database program, but the later are + update-mime-database program, but the latter are package-dependent and must be removed by the package that installed them in the first place.</p> @@ -13843,7 +13871,7 @@ looks fine. </pre> <p>Depending on the supplied command line arguments (see - pkglint(1)) more verbose checks will be performed. Use + pkglint(1)), more verbose checks will be performed. Use e.g. <span><strong class="command">pkglint -v</strong></span> for a very verbose check.</p> </div> @@ -14366,10 +14394,10 @@ Registering depends:. re-generate the pkgsrc guide (and other XML-based NetBSD documentation) installed. These are “<span class="quote">netbsd-doc</span>” - for creating the ASCII- and HTML-version, and + for creating the ASCII and HTML versions, and “<span class= - "quote">netbsd-doc-print</span>”for the - PostScript- and PDF version. You will need both + "quote">netbsd-doc-print</span>” for the + PostScript and PDF versions. You will need both packages installed, to make sure documentation is consistent across all formats. The packages can be found in <code xmlns= diff --git a/doc/pkgsrc.txt b/doc/pkgsrc.txt index 18d979b9921..b11e015ebc0 100644 --- a/doc/pkgsrc.txt +++ b/doc/pkgsrc.txt @@ -44,7 +44,7 @@ I. The pkgsrc user's guide 3. Using pkgsrc on systems other than NetBSD 3.1. Bootstrapping pkgsrc - 3.2. Platform specific notes + 3.2. Platform-specific notes 3.2.1. Darwin (Mac OS X) 3.2.2. FreeBSD @@ -87,7 +87,7 @@ I. The pkgsrc user's guide 6.3.3. Operation 6.3.4. What it does 6.3.5. Disk space requirements - 6.3.6. Setting up a sandbox for chroot'ed builds + 6.3.6. Setting up a sandbox for chrooted builds 6.3.7. Building a partial set of packages 6.3.8. Uploading results of a bulk build @@ -146,9 +146,9 @@ II. The pkgsrc developer's guide 10.2. Semi-automatic PLIST generation 10.3. Tweaking output of make print-PLIST 10.4. Variable substitution in PLIST - 10.5. Manpage-compression + 10.5. Man page-compression 10.6. Changing PLIST source with PLIST_SRC - 10.7. Platform specific and differing PLISTs + 10.7. Platform-specific and differing PLISTs 10.8. Sharing directories between packages 11. Buildlink methodology @@ -174,7 +174,7 @@ II. The pkgsrc developer's guide 12.2. Configuration files 12.2.1. How PKG_SYSCONFDIR is set - 12.2.2. Telling the software were configuration files are + 12.2.2. Telling the software where configuration files are 12.2.3. Patching installations 12.2.4. Disabling handling of configuration files @@ -293,7 +293,7 @@ Table of Contents 1.1. Introduction -There is a lot of software freely available for Unix based systems, which +There is a lot of software freely available for Unix-based systems, which usually runs on NetBSD and other Unix-flavoured systems, too, sometimes with some modifications. The NetBSD Packages Collection (pkgsrc) incorporates any such changes necessary to make that software run, and makes the installation @@ -407,7 +407,7 @@ Precompiled/binary package Program The piece of software to be installed which will be constructed from all - the files in the Distfile by the actions defined in the corresponding + the files in the distfile by the actions defined in the corresponding package. 1.4. Typography @@ -430,7 +430,7 @@ Table of Contents 3. Using pkgsrc on systems other than NetBSD 3.1. Bootstrapping pkgsrc - 3.2. Platform specific notes + 3.2. Platform-specific notes 3.2.1. Darwin (Mac OS X) 3.2.2. FreeBSD @@ -473,7 +473,7 @@ Table of Contents 6.3.3. Operation 6.3.4. What it does 6.3.5. Disk space requirements - 6.3.6. Setting up a sandbox for chroot'ed builds + 6.3.6. Setting up a sandbox for chrooted builds 6.3.7. Building a partial set of packages 6.3.8. Uploading results of a bulk build @@ -551,7 +551,7 @@ Chapter 3. Using pkgsrc on systems other than NetBSD Table of Contents 3.1. Bootstrapping pkgsrc -3.2. Platform specific notes +3.2. Platform-specific notes 3.2.1. Darwin (Mac OS X) 3.2.2. FreeBSD @@ -604,7 +604,12 @@ Binary packages for the pkgsrc tools and an initial set of packages is available for supported platforms. An up-to-date list of these can be found on www.pkgsrc.org. -3.2. Platform specific notes +Note + +The bootstrap installs a bmake tool. Use this bmake when building via pkgsrc. +For examples in this guide, use bmake instead of "make". + +3.2. Platform-specific notes Here are some platform-specific notes you should be aware of. @@ -627,7 +632,7 @@ manually mount a disk image. Note You cannot use a HFS+ file system for pkgsrc, because pkgsrc currently requires -the filesystem to be case-sensitive, and HFS+ is not. +the file system to be case-sensitive, and HFS+ is not. 3.2.1.1. Using a disk image @@ -698,7 +703,7 @@ with the FreeBSD userland tools. There are several steps: 3.2.3. Interix -Interix is a POSIX compatible subsystem for the Windows NT kernel, providing a +Interix is a POSIX-compatible subsystem for the Windows NT kernel, providing a Unix-like environment with a tighter kernel integration than available with Cygwin. It is part of the Windows Services for Unix package, available for free for any licensed copy of Windows 2000, XP (not including XP Home), or 2003. SFU @@ -744,7 +749,7 @@ pkgsrc, note the following things. Services for UNIX, then click Change. In the installer, choose Add or Remove, then uncheck Utilities->UNIX Perl. - * To enable case-sensitivity for the filesystem, run REGEDIT.EXE, and change + * To enable case-sensitivity for the file system, run REGEDIT.EXE, and change the following registry key: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel @@ -805,8 +810,8 @@ compiler.defaults! If you have the actual pkgsrc tree mounted via NFS from a different host, please make sure to set WRKOBJDIR to a local directory, as it appears that IRIX -linker occasionally runs into issues when trying to link over a network mounted -filesystem. +linker occasionally runs into issues when trying to link over a network-mounted +file system. The bootstrapping process should set all the right options for programs such as imake(1), but you may want to set some options depending on your local setup. @@ -892,7 +897,7 @@ with the OpenBSD userland tools. There are several steps: 3. An example /etc/mk.conf file will be placed in /etc/mk.conf.example file when you use the bootstrap script. OpenBSD's make program uses /etc/mk.conf - as well. You can work around this by enclosing all the pkgsrc specific + as well. You can work around this by enclosing all the pkgsrc-specific parts of the file with: .ifdef BSD_PKG_MK @@ -946,18 +951,19 @@ You will need at least the following packages installed (from WorkShop 5.0) * SPROlang - Sun WorkShop Compilers common components -You should set CC, CXX and optionally, CPP in /etc/mk.conf, eg. +You should set CC, CXX and optionally, CPP in /etc/mk.conf, e.g.: CC= cc CXX= CC CPP= /usr/ccs/lib/cpp -You may also want to build 64-bit binaries, eg. +You may also want to build 64-bit binaries, e.g.: CFLAGS= -xtarget=ultra -xarch=v9 Whichever compiler you use, please ensure the compiler tools and your $prefix -are in your PATH. This includes /usr/ccs/{bin,lib} and eg. /usr/pkg/{bin,sbin}. +are in your PATH. This includes /usr/ccs/{bin,lib} and e.g. /usr/pkg/ +{bin,sbin}. Chapter 4. Using pkgsrc @@ -991,13 +997,13 @@ subdirectory All which includes the actual binaries in .tgz files. The category subdirectories use symbolic links to those files (this is the same directory layout as in /usr/pkgsrc/packages). -This same directory layout applies for CDROM distributions, only that the +This same directory layout applies for CD-ROM distributions, only that the directory may be rooted somewhere else, probably somewhere below /cdrom. Please -consult your CDROMs documentation for the exact location. +consult your CD-ROMs documentation for the exact location. 4.1.2. How to use binary packages -If you have the files on a CDROM or downloaded them to your hard disk, you can +If you have the files on a CD-ROM or downloaded them to your hard disk, you can install them with the following command (be sure to su to root first): # pkg_add /path/to/package.tgz @@ -1012,19 +1018,18 @@ Note that any prerequisite packages needed to run the package in question will be installed, too, assuming they are present where you install from. To save some typing, you can set the PKG_PATH environment variable to a -semicolon separated list of paths (including remote URLs); trailing slashes are +semicolon-separated list of paths (including remote URLs); trailing slashes are not allowed. Additionally to the All directory there exists a vulnerable directory to which binary packages with known vulnerabilities are moved, since removing them could cause missing dependencies. To use these packages, add the vulnerable directory to your PKG_PATH. However, you should run security/audit-packages regularly, -and especially after installing new packages, and verify that the -vulnerabilities are acceptable for your configuration. An example PKG_PATH -would be: ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All;ftp:/ -/ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/vulnerable Please note -that semicolon (';') is a shell meta-character, so you'll probably have to -quote it. +especially after installing new packages, and verify that the vulnerabilities +are acceptable for your configuration. An example PKG_PATH would be: ftp:// +ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All;ftp://ftp.NetBSD.org/ +pub/NetBSD/packages/<OSVERSION>/<ARCH>/vulnerable Please note that semicolon +(';') is a shell meta-character, so you'll probably have to quote it. After you've installed packages, be sure to have /usr/pkg/bin and /usr/pkg/sbin in your PATH so you can actually start the just installed program. @@ -1045,7 +1050,7 @@ packages. 4.2.1. Requirements To build packages from source on a NetBSD system the "comp" and the "text" -distribution sets must be installed. If you want to build X11 related packages +distribution sets must be installed. If you want to build X11-related packages the "xbase" and "xcomp" distribution sets are required, too. 4.2.2. Fetching distfiles @@ -1070,7 +1075,14 @@ distfiles into /usr/pkgsrc/distfiles. 4.2.3. How to build and install Assuming that the distfile has been fetched (see previous section), become root -and change into the relevant directory and running make. For example, type +and change into the relevant directory and run make. + +Note + +If using bootstrap or pkgsrc on a non-NetBSD system, use the pkgsrc bmake +command instead of "make" in the examples in this guide. + +For example, type % cd misc/figlet % make @@ -1092,7 +1104,7 @@ pkg. Should this not conform to your tastes, set the LOCALBASE variable in your environment, and it will use that value as the root of your packages tree. So, to use /usr/local, set LOCALBASE=/usr/local in your environment. Please note that you should use a directory which is dedicated to packages and not shared -with other programs (ie, do not try and use LOCALBASE=/usr). Also, you should +with other programs (i.e., do not try and use LOCALBASE=/usr). Also, you should not try to add any of your own files or directories (such as src/, obj/, or pkgsrc/) below the LOCALBASE tree. This is to prevent possible conflicts between programs and other files installed by the package system and whatever @@ -1136,7 +1148,7 @@ BINPKG_SITES, which defaults to ftp.NetBSD.org. Any flags that should be added to pkg_add(1) can be put into BIN_INSTALL_FLAGS. See pkgsrc/mk/defaults/mk.conf for more details. -A final word of warning: If you setup a system that has a non-standard setting +A final word of warning: If you set up a system that has a non-standard setting for LOCALBASE, be sure to set that before any packages are installed, as you can not use several directories for the same purpose. Doing so will result in pkgsrc not being able to properly detect your installed packages, and fail @@ -1187,8 +1199,9 @@ Table of Contents 5.1. General configuration -In this section you can find some variables that apply all pkgsrc packages. The -preferred method of setting them is by setting them in /etc/mk.conf. +In this section, you can find some variables that apply to all pkgsrc packages. +The preferred method of setting these variables is by setting them in /etc/ +mk.conf. * LOCALBASE: Where packages will be installed. The default is /usr/pkg. Do not mix binary packages with different LOCALBASEs! @@ -1320,7 +1333,7 @@ Table of Contents 6.3.3. Operation 6.3.4. What it does 6.3.5. Disk space requirements - 6.3.6. Setting up a sandbox for chroot'ed builds + 6.3.6. Setting up a sandbox for chrooted builds 6.3.7. Building a partial set of packages 6.3.8. Uploading results of a bulk build @@ -1331,7 +1344,7 @@ Table of Contents 6.1. Building a single binary package Once you have built and installed a package, you can create a binary package -which can be installed on another system with pkg_add(1) This saves having to +which can be installed on another system with pkg_add(1). This saves having to build the same package on a group of hosts and wasting CPU time. It also provides a simple means for others to install your package, should you distribute it. @@ -1393,7 +1406,7 @@ update. 6.3.1.3. pre-build.local -It is possible to configure the bulk build to perform certain site specific +It is possible to configure the bulk build to perform certain site-specific tasks at the end of the pre-build stage. If the file pre-build.local exists in /usr/pkgsrc/mk/bulk, it will be executed (as a sh(1) script) at the end of the usual pre-build stage. An example use of pre-build.local is to have the line: @@ -1489,7 +1502,7 @@ demand to disk space. Afterwards, if the package is needed again, it will be installed via pkg_add(1) instead of building again, so there are no cycles wasted by recompiling. -6.3.6. Setting up a sandbox for chroot'ed builds +6.3.6. Setting up a sandbox for chrooted builds If you don't want all the packages nuked from a machine (rendering it useless for anything but pkg compiling), there is the possibility of doing the package @@ -1559,7 +1572,7 @@ src/etc, be sure the following items are present and properly configured: 13. If you have set CVS_USER in build.conf, make sure that account exists and can do a cvs ${CVS_FLAGS} update properly! -When the chroot sandbox is setup, you can start the build with the following +When the chroot sandbox is set up, you can start the build with the following steps: # cd /usr/sandbox/usr/pkgsrc @@ -1574,7 +1587,7 @@ from). In addition to building a complete set of all packages in pkgsrc, the pkgsrc/mk /bulk/build script may be used to build a subset of the packages contained in -pkgsrc. By setting defining SPECIFIC_PKGS in /etc/mk.conf, the variables +pkgsrc. By setting SPECIFIC_PKGS in /etc/mk.conf, the variables * SITE_SPECIFIC_PKGS @@ -1611,7 +1624,7 @@ file, i.e. adjust it to something like one of the following: RSYNC_DST=$CVS_USER@ftp.NetBSD.org:/pub/NetBSD/packages/pkgsrc-200xQy/NetBSD-a.b.c/arch/upload -Please use appropviate values for "pkgsrc-200xQy", "NetBSD-a.b.c" and "arch" +Please use appropriate values for "pkgsrc-200xQy", "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org is different from CVS_USER, write your login directly into the variable, e.g. my local account is "feyrer", but for my login "hubertf", I use: @@ -1628,7 +1641,7 @@ NetBSD operating system. Binary packages for other operating systems should go into /pub/pkgsrc. Before uploading the binary pkgs, ssh authentication needs to be set up. This -example shows how to setup temporary keys for the root account inside the +example shows how to set up temporary keys for the root account inside the sandbox (assuming that no keys should be present there usually): # chroot /usr/sandbox @@ -1676,11 +1689,11 @@ After your pkgsrc bulk-build has completed, you may wish to create a CD-ROM set of the resulting binary packages to assist in installing packages on other machines. The pkgtools/cdpack package provides a simple tool for creating the ISO 9660 images. cdpack arranges the packages on the CD-ROMs in a way that -keeps all the dependencies for given package on the same CD as that package. +keeps all the dependencies for a given package on the same CD as that package. 6.4.1. Example of cdpack -Complete documentation for cdpack is found in the cdpack(1) manpage. The +Complete documentation for cdpack is found in the cdpack(1) man page. The following short example assumes that the binary packages are left in /usr/ pkgsrc/packages/All and that sufficient disk space exists in /u2 to hold the ISO 9660 images. @@ -1819,10 +1832,7 @@ Utilities for people maintaining or creating individual packages: * pkgtools/gensolpkg: Convert pkgsrc to a Solaris package. -Utilities for people maintaining pkgsrc (or more obscure pkg utilities) - - * pkgtools/pkgconflict: Find packages that conflict but aren't marked as - such. +Utilities for people maintaining pkgsrc (or: more obscure pkg utilities) * pkgtools/pkg_comp: Build packages in a chrooted area. @@ -1848,7 +1858,7 @@ the script, as well as some others that allow finer tuning of the tree layout. 7.5. How to resume transfers when fetching distfiles? -By default resuming transfers in pkgsrc is disabled, but you can enable this +By default, resuming transfers in pkgsrc is disabled, but you can enable this feature by adding the option PKG_RESUME_TRANSFERS=YES into /etc/mk.conf. If, during a fetch step, an incomplete distfile is found, pkgsrc will try to resume it. @@ -1885,7 +1895,7 @@ X11_TYPE=xorg If you are sitting behind a firewall which does not allow direct connections to Internet hosts (i.e. non-NAT), you may specify the relevant proxy hosts. This -is done using an environment variable in the form of a URL e.g. in Amdahl, the +is done using an environment variable in the form of a URL, e.g. in Amdahl, the machine "orpheus.amdahl.com" is one of the firewalls, and it uses port 80 as the proxy port number. So the proxy environment variables are: @@ -1915,7 +1925,7 @@ You would like to download all the distfiles in a single batch from work or university, where you can't run a make fetch. There is an archive of distfiles on ftp.NetBSD.org, but downloading the entire directory may not be appropriate. -The answer here is to do a make fetch-list in /usr/pkgsrc or one of it's +The answer here is to do a make fetch-list in /usr/pkgsrc or one of its subdirectories, carry the resulting list to your machine at work/school and use it there. If you don't have a NetBSD-compatible ftp(1) (like lukemftp) at work, don't forget to set FETCH_CMD to something that fetches a URL: @@ -1949,7 +1959,7 @@ everything by running: When compiling the pkgtools/pkg_install package, you get the error from make that it doesn't know how to make /usr/share/tmac/tmac.andoc? This indicates that you don't have installed the "text" set (nroff, ...) from the NetBSD base -distribution on your machine. It is recommended to do that to format manpages. +distribution on your machine. It is recommended to do that to format man pages. In the case of the pkgtools/pkg_install package, you can get away with setting NOMAN=YES either in the environment or in /etc/mk.conf. @@ -1957,7 +1967,7 @@ NOMAN=YES either in the environment or in /etc/mk.conf. 7.12. What does "Could not find bsd.own.mk" mean? You didn't install the compiler set, comp.tgz, when you installed your NetBSD -machine. Please get it and install it, by extracting it in /: +machine. Please get and install it, by extracting it in /: # cd / # tar --unlink -zxvpf .../comp.tgz @@ -1995,7 +2005,7 @@ PKG_SYSCONFDIR.${PKG_SYSCONFVAR} variable. PKG_SYSCONFVAR's value usually matches the name of the package you would like to modify, that is, the contents of PKGBASE. -Note that, after changing these settings, you must rebuild and reinstall any +Note that after changing these settings, you must rebuild and reinstall any affected packages. 7.15. Automated security checks @@ -2058,9 +2068,9 @@ Table of Contents 10.2. Semi-automatic PLIST generation 10.3. Tweaking output of make print-PLIST 10.4. Variable substitution in PLIST - 10.5. Manpage-compression + 10.5. Man page-compression 10.6. Changing PLIST source with PLIST_SRC - 10.7. Platform specific and differing PLISTs + 10.7. Platform-specific and differing PLISTs 10.8. Sharing directories between packages 11. Buildlink methodology @@ -2086,7 +2096,7 @@ Table of Contents 12.2. Configuration files 12.2.1. How PKG_SYSCONFDIR is set - 12.2.2. Telling the software were configuration files are + 12.2.2. Telling the software where configuration files are 12.2.3. Patching installations 12.2.4. Disabling handling of configuration files @@ -2260,8 +2270,8 @@ exactly in the order given here. Note the trailing slash after the subdirectory name. If the package has multiple DISTFILES or multiple PATCHFILES from different - sites, set SITES_foo to a list of URI's where file "foo" may be found. - "foo" includes the suffix, e.g. + sites, set SITES_foo to a list of URIs where file "foo" may be found. "foo" + includes the suffix, e.g.: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} DISTFILES+= foo-file.tar.gz @@ -2281,7 +2291,7 @@ exactly in the order given here. The second section contains information about separately downloaded patches, if any. - * PATCHFILES Name(s) of additional files that contain distribution patches. + * PATCHFILES: Name(s) of additional files that contain distribution patches. There is no default. pkgsrc will look for them at PATCH_SITES. They will automatically be uncompressed before patching if the names end with .gz or .Z. @@ -2313,7 +2323,7 @@ Other variables that affect the build: Please pay attention to the following gotchas: - * Add MANCOMPRESSED if manpages are installed in compressed form by the + * Add MANCOMPRESSED if man pages are installed in compressed form by the package; see comment in bsd.pkg.mk. * Replace /usr/local with "${PREFIX}" in all files (see patches, below). @@ -2357,7 +2367,7 @@ patch-aa is applied before patch-ab, etc. The patch-* files should be in diff -bu format, and apply without a fuzz to avoid problems. (To force patches to apply with fuzz you can set PATCH_FUZZ_FACTOR=-F2). Furthermore, do not put changes for more than one file -into a single patch-file, as this will make future modifications more +into a single patch file, as this will make future modifications more difficult. Similar, a file should be patched at most once, not several times by several @@ -2392,10 +2402,10 @@ If it is desired to store any patches that should not be committed into pkgsrc, they can be kept outside the pkgsrc tree in the $LOCALPATCHES directory. The directory tree there is expected to have the same "category/package" structure as pkgsrc, and patches are expected to be stored inside these dirs (also known -as $LOCALPATCHES/$PKGPATH). For example if you want to keep a private patch for -pkgsrc/graphics/png, keep it in $LOCALPATCHES/graphics/png/mypatch. All files -in the named directory are expected to be patch files, and they are applied -after pkgsrc patches are applied. +as $LOCALPATCHES/$PKGPATH). For example, if you want to keep a private patch +for pkgsrc/graphics/png, keep it in $LOCALPATCHES/graphics/png/mypatch. All +files in the named directory are expected to be patch files, and they are +applied after pkgsrc patches are applied. 8.4. Other mandatory files @@ -2446,7 +2456,7 @@ MESSAGE 8.6. work* -When you type make the distribution files are unpacked into the directory +When you type make, the distribution files are unpacked into the directory denoted by WRKDIR. It can be removed by running make clean. Besides the sources, this directory is also used to keep various timestamp files. The directory gets removed completely on clean. The default is ${.CURDIR}/work or $ @@ -2518,7 +2528,7 @@ the backslash character ``\'' are handled specially. If a backslash is followed by a newline, any whitespace immediately in front of the backslash, the backslash, the newline, and any whitespace immediately behind the newline are replaced with a single space. A backspace character and an immediately -following hash character are replaced with a single hash character. Otherwise +following hash character are replaced with a single hash character. Otherwise, the backslash is passed as is. In a variable assignment, any hash character that is not preceded by a backslash starts a comment that continues upto the end of the logical line. @@ -2530,13 +2540,13 @@ BACKSLASH!=echo "\\". So far for defining variables. The other thing you can do with variables is evaluating them. A variable is evaluated when it is part of the right side of the ``:='' or the ``!='' operator, or directly before executing a shell command -which the variable is part of. In all other cases make(1) performs lazy +which the variable is part of. In all other cases, make(1) performs lazy evaluation, that is, variables are not evaluated until there's no other way. The ``modifiers'' mentioned in the man page also evaluate the variable. Some of the modifiers split the string into words and then operate on the -words, others operate on the string as a whole. When a string is splitted into -words, it is splitted as you would expect it from sh(1). +words, others operate on the string as a whole. When a string is split into +words, it is split as you would expect it from sh(1). No rule without exception?the .for loop does not follow the shell quoting rules but splits at sequences of whitespace. @@ -2544,12 +2554,12 @@ but splits at sequences of whitespace. There are several types of variables that should be handled differently. Strings and two types of lists. - * Strings can contain arbitrary characters. Nevertheless you should restrict + * Strings can contain arbitrary characters. Nevertheless, you should restrict yourself to only using printable characters. Examples are PREFIX and COMMENT. * Internal lists are lists that are never exported to any shell command. - Their elements are separated by whitespace. Therefore the elements + Their elements are separated by whitespace. Therefore, the elements themselves cannot have embedded whitespace. Any other characters are allowed. Internal lists can be used in .for loops. Examples are DEPENDS and BUILD_DEPENDS. @@ -2632,13 +2642,13 @@ depending on the implementation of the echo(1) command. Example 4 handles correctly every string that does not start with a dash. In that case, the result depends on the implementation of the echo(1) command. As -long as you can guarantee that your input does not start with a dash this form +long as you can guarantee that your input does not start with a dash, this form is appropriate. Example 5 handles even the case of a leading dash correctly. -The EXT_LIST does not need to be quoted because the quoting has already be done -when adding elements to the list. +The EXT_LIST does not need to be quoted because the quoting has already been +done when adding elements to the list. As internal lists shall not be passed to the shell, there is no example for it. @@ -2648,13 +2658,13 @@ There are many possible sources of wrongly quoted variables. This section lists some of the commonly known ones. * Whenever you use the value of a list, think about what happens to leading - or trailing whitespace. If the list is a well-formed shell expression you + or trailing whitespace. If the list is a well-formed shell expression, you can apply the :M* modifier to strip leading and trailing whitespace from each word. The :M operator first splits its argument according to the rules of the shell, and then creates a new list consisting of all words that match the shell glob expression *, that is: all. One class of situations where this is needed is when adding a variable like CPPFLAGS to - CONFIGURE_ARGS. If the configure script invokes other configure scripts it + CONFIGURE_ARGS. If the configure script invokes other configure scripts, it strips the leading and trailing whitespace from the variable and then passes it to the other configure scripts. But these configure scripts expect the (child) CPPFLAGS variable to be the same as the parent CPPFLAGS. @@ -2680,7 +2690,7 @@ some of the commonly known ones. quoting to each variable that is used as a C string literal. You cannot use the :Q operator for it, as this operator only works for the shell. - * Whenever a variable can be empty the :Q operator can have surprising + * Whenever a variable can be empty, the :Q operator can have surprising results. Here are two completely different cases which can be solved with the same trick. @@ -2729,14 +2739,14 @@ Table of Contents 10.2. Semi-automatic PLIST generation 10.3. Tweaking output of make print-PLIST 10.4. Variable substitution in PLIST -10.5. Manpage-compression +10.5. Man page-compression 10.6. Changing PLIST source with PLIST_SRC -10.7. Platform specific and differing PLISTs +10.7. Platform-specific and differing PLISTs 10.8. Sharing directories between packages The PLIST file contains a package's "packing list", i.e. a list of files that belong to the package (relative to the ${PREFIX} directory it's been installed -in) plus some additional statements - see the pkg_create(1) manpage for a full +in) plus some additional statements - see the pkg_create(1) man page for a full list. This chapter addresses some issues that need attention when dealing with the PLIST file (or files, see below!). @@ -2786,11 +2796,11 @@ ${MACHINE_ARCH}, ${MACHINE_GNU_ARCH} Some packages like emacs and perl embed information about which architecture they were built on into the pathnames where they install their - file. To handle this case, PLIST will be preprocessed before actually used, - and the symbol "${MACHINE_ARCH}" will be replaced by what uname -p gives. - The same is done if the string ${MACHINE_GNU_ARCH} is embedded in PLIST - somewhere - use this on packages that have GNU autoconf created configure - scripts. + files. To handle this case, PLIST will be preprocessed before actually + used, and the symbol "${MACHINE_ARCH}" will be replaced by what uname -p + gives. The same is done if the string ${MACHINE_GNU_ARCH} is embedded in + PLIST somewhere - use this on packages that have GNU autoconf-created + configure scripts. Legacy note @@ -2826,13 +2836,13 @@ PLIST_SUBST+= SOMEVAR="somevalue" This replaces all occurrences of "${SOMEVAR}" in the PLIST with "somevalue". -10.5. Manpage-compression +10.5. Man page-compression -Manpages should be installed in compressed form if MANZ is set (in bsd.own.mk), -and uncompressed otherwise. To handle this in the PLIST file, the suffix ".gz" -is appended/removed automatically for manpages according to MANZ and -MANCOMPRESSED being set or not, see above for details. This modification of the -PLIST file is done on a copy of it, not PLIST itself. +Man pages should be installed in compressed form if MANZ is set (in +bsd.own.mk), and uncompressed otherwise. To handle this in the PLIST file, the +suffix ".gz" is appended/removed automatically for man pages according to MANZ +and MANCOMPRESSED being set or not, see above for details. This modification of +the PLIST file is done on a copy of it, not PLIST itself. 10.6. Changing PLIST source with PLIST_SRC @@ -2840,7 +2850,7 @@ To use one or more files as source for the PLIST used in generating the binary package, set the variable PLIST_SRC to the names of that file(s). The files are later concatenated using cat(1), and order of things is important. -10.7. Platform specific and differing PLISTs +10.7. Platform-specific and differing PLISTs Some packages decide to install a different set of files based on the operating system being used. These differences can be automatically handled by using the @@ -2902,7 +2912,7 @@ have the following line in it: After regenerating the PLIST using make print-PLIST, you should get the right (commented out) lines. -Note that, even if your package is using $X11BASE, it must not depend on the +Note that even if your package is using $X11BASE, it must not depend on the *-x11-dirs packages. Just specify the name without that part and pkgsrc (in particular, mk/dirs.mk) will take care of it. @@ -2966,13 +2976,20 @@ with .include "../../category/foo/buildlink3.mk" +The buildlink3.mk files usually define the required dependencies. If you need a +newer version of the dependency when using buildlink3.mk files, then you can +define it in your Makefile; for example: + +BUILDLINK_DEPENDS.foo+= foo>=1.1.0 +.include "../../category/foo/buildlink3.mk" + There are several buildlink3.mk files in pkgsrc/mk that handle special package issues: * bdb.buildlink3.mk chooses either the native or a pkgsrc Berkeley DB implementation based on the values of BDB_ACCEPTED and BDB_DEFAULT. - * curses.buildlink3.mk If the system comes with neither Curses nor NCurses, + * curses.buildlink3.mk: If the system comes with neither Curses nor NCurses, this will take care to install the devel/ncurses package. * krb5.buildlink3.mk uses the value of KRB5_ACCEPTED to choose between adding @@ -2980,16 +2997,16 @@ issues: implementation. * motif.buildlink3.mk checks for a system-provided Motif installation or adds - a dependency on x11/lesstif or x11/openmotif; + a dependency on x11/lesstif or x11/openmotif. * ossaudio.buildlink3.mk defines several variables that may be used by - packages that use the Open Sound System (OSS) API; + packages that use the Open Sound System (OSS) API. * pgsql.buildlink3.mk will accept either Postgres 7.3 or 7.4, whichever is found installed. See the file for more information. * pthread.buildlink3.mk uses the value of PTHREAD_OPTS and checks for native - pthreads or adds a dependency on devel/pth as needed; + pthreads or adds a dependency on devel/pth as needed. * xaw.buildlink3.mk uses the value of XAW_TYPE to choose a particular Athena widgets library. @@ -3060,7 +3077,7 @@ dependency on pkg is added. Several important variables are set in the section: first version of the package that had the last change in the major number of a shared library or that had a major API change. - * BUILDLINK_PKGSRCDIR.pkg is the location of the pkg pkgsrc directory; + * BUILDLINK_PKGSRCDIR.pkg is the location of the pkg pkgsrc directory. * BUILDLINK_DEPMETHOD.pkg (not shown above) controls whether we use BUILD_DEPENDS or DEPENDS to add the dependency on pkg. The build dependency @@ -3113,7 +3130,7 @@ There are two situations that require increasing the dependency listed in BUILDLINK_DEPENDS.pkg after a package update: 1. if the sonames (major number of the library version) of any installed - shared libraries change; + shared libraries change. 2. if the API or interface to the header files change. @@ -3251,7 +3268,7 @@ Table of Contents 12.2. Configuration files 12.2.1. How PKG_SYSCONFDIR is set - 12.2.2. Telling the software were configuration files are + 12.2.2. Telling the software where configuration files are 12.2.3. Patching installations 12.2.4. Disabling handling of configuration files @@ -3279,9 +3296,9 @@ are: * Registration of system shells. -The following sections inspect each of the above points in detail. Note that, -in order to use any of the described functionalities, you must add the -following to your package's Makefile: +The following sections inspect each of the above points in detail. Note that in +order to use any of the described functionalities, you must add the following +to your package's Makefile: USE_PKGINSTALL=YES @@ -3304,16 +3321,15 @@ ${PKG_SYSCONFDIR}. The only way to achieve this is to create such files during installation time by using the installation scripts. These scripts can run arbitrary commands, so -they have the potential to create and manage files anywhere in the filesystem. +they have the potential to create and manage files anywhere in the file system. Here is where pkginstall comes into play: it provides generic scripts to abstract the manipulation of such files and directories based on variables set -in the package's Makefile. The rest of this section describes which these -variables are. +in the package's Makefile. The rest of this section describes these variables. 12.1.1. Directory manipulation The following variables can be set to request the creation of directories -anywhere in the filesystem: +anywhere in the file system: * MAKE_DIRS and OWN_DIRS contain a list of directories that should be created and should attempt to be destroyed by the installation scripts. The @@ -3385,7 +3401,7 @@ shall be installed. Its contents are set based upon the following variables: * PKG_SYSCONFSUBDIR: A subdirectory of PKG_SYSCONFBASE under which the configuration files for the package being built shall be installed. The definition of this variable only makes sense in the package's Makefile - (i.e., it is not user customizable). + (i.e., it is not user-customizable). As an example, consider the Apache package, www/apache2, which places its configuration files under the httpd/ subdirectory of PKG_SYSCONFBASE. This @@ -3415,13 +3431,13 @@ basically the following: It is worth mentioning that ${PKG_SYSCONFDIR} is automatically added to OWN_DIRS. See Section 12.1.1, "Directory manipulation" what this means. -12.2.2. Telling the software were configuration files are +12.2.2. Telling the software where configuration files are Given that pkgsrc (and users!) expect configuration files to be in a known place, you need to teach each package where it shall install its files. In some cases you will have to patch the package Makefiles to achieve it. If you are lucky, though, it may be as easy as passing an extra flag to the configuration -script; this is the case of GNU Autoconf generated files: +script; this is the case of GNU Autoconf- generated files: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR} @@ -3574,8 +3590,8 @@ e.g. options.mk, that is included by the main package Makefile. PKG_OPTIONS_VAR= PKG_OPTIONS.wibble PKG_SUPPORTED_OPTIONS= wibble-foo ldap -PKG_OPTIONAL_GROUPS= database -PKG_GROUP.database= mysql pgsql +PKG_OPTIONS_OPTIONAL_GROUPS= database +PKG_OPTIONS_GROUP.database= mysql pgsql PKG_SUGGESTED_OPTIONS= wibble-foo PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo @@ -3666,7 +3682,7 @@ options, use PKG_SUGGESTED_OPTIONS. PKG_OPTIONS_VAR must be defined before including bsd.options.mk. If none of PKG_SUPPORTED_OPTIONS, PKG_OPTIONS_OPTIONAL_GROUPS, and -PKG_OPTIONS_REQUIRED_GROUPS are defined (as can happen with platform specific +PKG_OPTIONS_REQUIRED_GROUPS are defined (as can happen with platform-specific options if none of them is supported on the current platform), PKG_OPTIONS is set to the empty list and the package is otherwise treated as not using the options framework. @@ -3730,8 +3746,8 @@ When choosing which of these variables to use, follow the following rules: installed. When looking for standard X11 includes (not those installed by a pkg), use "${X11BASE}". - * X11 based are special in that they may be installed in either X11BASE or - LOCALBASE. + * X11-based packages are special in that they may be installed in either + X11BASE or LOCALBASE. Usually, X11 packages should be installed under LOCALBASE whenever possible. Note that you will need to include ../../mk/x11.buildlink3.mk in @@ -3821,9 +3837,9 @@ extract EXTRACT_AFTER_ARGS. In the former case, pkgsrc knows how to extract a number of suffixes (.tar.gz, .tgz, .tar.gz2, .tbz, .tar.Z, .tar, .shar.gz, .shar.bz2, .shar.Z, .shar, .Z, .bz2 and .gz; see the definition of the - various DECOMPRESS_CMD variables bsd.pkg.mk for a complete list). Here's an - example on how to use the other variables for a program that comes with a - compressed shell archive whose name ends in .msg.gz: + various DECOMPRESS_CMD variables in bsd.pkg.extract.mk for a complete + list). Here's an example on how to use the other variables for a program + that comes with a compressed shell archive whose name ends in .msg.gz: EXTRACT_SUFX= .msg.gz EXTRACT_CMD= zcat @@ -3952,7 +3968,7 @@ update You can use the "update" target to resume package updating in case a previous make update was interrupted for some reason. However, in this case, make sure you don't call make clean or otherwise remove the list of - dependent packages in WRKDIR. Otherwise you lose the ability to + dependent packages in WRKDIR. Otherwise, you lose the ability to automatically update the current package along with the dependent packages you have installed. @@ -4002,8 +4018,8 @@ clean-update before the first time you run make update and only if you have a dirty package tree (e.g., if you used NOCLEAN). - If you unsure about whether your tree is clean you can either perform a - make clean at the top of the tree, or use the following sequence of + If you are unsure about whether your tree is clean, you can either perform + a make clean at the top of the tree, or use the following sequence of commands from the directory of the package you want to update (before running make update for the first time, otherwise you lose all the packages you wanted to update!): @@ -4108,21 +4124,21 @@ bulk-package Used to do bulk builds. If an appropriate binary package already exists, no action is taken. If not, this target will compile, install and package it - (and it's depends, if PKG_DEPENDS is set properly. See Section 6.3.1, - "Configuration". After creating the binary package, the sources, the - just-installed package and it's required packages are removed, preserving + (and its depends, if PKG_DEPENDS is set properly. See Section 6.3.1, + "Configuration"). After creating the binary package, the sources, the + just-installed package and its required packages are removed, preserving free disk space. Beware that this target may deinstall all packages installed on a system! bulk-install - Used during bulk-installs to install required packages. If an upto-date + Used during bulk-installs to install required packages. If an up-to-date binary package is available, it will be installed via pkg_add(1). If not, - make bulk-package will be executed, but the installed binary not be + make bulk-package will be executed, but the installed binary won't be removed. - A binary package is considered "upto-date" to be installed via pkg_add(1) + A binary package is considered "up-to-date" to be installed via pkg_add(1) if: * None of the package's files (Makefile, ...) were modified since it was @@ -4193,11 +4209,11 @@ Table of Contents The problem with package-defined variables that can be overridden via MAKECONF or /etc/mk.conf is that make(1) expands a variable as it is used, but evaluates -preprocessor like statements (.if, .ifdef and .ifndef) as they are read. So, to +preprocessor-like statements (.if, .ifdef and .ifndef) as they are read. So, to use any variable (which may be set in /etc/mk.conf) in one of the .if* statements, the file /etc/mk.conf must be included before that .if* statement. -Rather than have a number of ad-hoc ways of including /etc/mk.conf, should it +Rather than having a number of ad-hoc ways of including /etc/mk.conf, should it exist, or MAKECONF, should it exist, include the pkgsrc/mk/bsd.prefs.mk file in the package Makefile before any preprocessor-like .if, .ifdef, or .ifndef statements: @@ -4208,7 +4224,8 @@ statements: ... .endif -If you wish to set the CFLAGS variable in /etc/mk.conf please make sure to use: +If you wish to set the CFLAGS variable in /etc/mk.conf, please make sure to +use: CFLAGS+= -your -flags @@ -4265,9 +4282,10 @@ prevent users from generating binary packages! Your package may depend on some other package being present - and there are various ways of expressing this dependency. pkgsrc supports the BUILD_DEPENDS -and DEPENDS definitions, as well as dependencies via buildlink3.mk, which is -the preferred way to handle dependencies, and which uses the variables named -above. See Chapter 11, Buildlink methodology for more information. +and DEPENDS definitions, the USE_TOOLS definition, as well as dependencies via +buildlink3.mk, which is the preferred way to handle dependencies, and which +uses the variables named above. See Chapter 11, Buildlink methodology for more +information. The basic difference between the two variables is as follows: The DEPENDS definition registers that pre-requisite in the binary package so it will be @@ -4391,11 +4409,11 @@ Your package may conflict with other packages a user might already have installed on his system, e.g. if your package installs the same set of files like another package in our pkgsrc tree. -In this case you can set CONFLICTS to a space separated list of packages +In this case you can set CONFLICTS to a space-separated list of packages (including version string) your package conflicts with. -For example x11/Xaw3d and x11/Xaw-Xpm install provide the same shared library, -thus you set in pkgsrc/x11/Xaw3d/Makefile: +For example, x11/Xaw3d and x11/Xaw-Xpm install the same shared library, thus +you set in pkgsrc/x11/Xaw3d/Makefile: CONFLICTS= Xaw-Xpm-[0-9]* @@ -4454,7 +4472,7 @@ compiler version and architecture and almost always relation to optimisation being enabled. Common symptoms are gcc internal errors or never finishing compiling a file. -Typically a workaround involves testing the MACHINE_ARCH and compiler version, +Typically, a workaround involves testing the MACHINE_ARCH and compiler version, disabling optimisation for that file/MACHINE_ARCH/compiler combination, and documenting it in pkgsrc/doc/HACKS. See that file for a number of examples! @@ -4471,7 +4489,7 @@ PKGREVISION=1 (2, ...). The "nb" is treated like a "." by the pkg tools. e.g. will result in a PKGNAME of "foo-17.42nb9". When a new release of the package is released, the PKGREVISION should be -removed. e.g. on a new minor release of the above package, things should be +removed, e.g. on a new minor release of the above package, things should be like: DISTNAME= foo-17.43 @@ -4537,8 +4555,8 @@ at all. To accompany this, varying commands and options have to be passed to the compiler, linker, etc. to get the Right Thing, which can be pretty annoying especially if you don't have all the machines at your hand to test things. The devel/libtool pkg can help here, as it just "knows" how to build both static -and dynamic libraries from a set of source files, thus being platform -independent. +and dynamic libraries from a set of source files, thus being +platform-independent. Here's how to use libtool in a pkg in seven simple steps: @@ -4638,7 +4656,7 @@ appropriate. If you do not need *.a static libraries built and installed, then use SHLIBTOOL_OVERRIDE instead. -If your package makes use of the platform independent library for loading +If your package makes use of the platform-independent library for loading dynamic shared objects, that comes with libtool (libltdl), you should include devel/libltdl/buildlink3.mk. @@ -4716,7 +4734,7 @@ using this conditional: #endif Please use the "__NetBSD__" definition sparingly - it should only apply to -features of NetBSD that are not present in other 4.4-lite derived BSDs. +features of NetBSD that are not present in other 4.4-lite-derived BSDs. 15.5. Package specific actions @@ -4735,7 +4753,7 @@ number of ways: The INTERACTIVE_STAGE definition is provided to notify the pkgsrc mechanism of an interactive stage which will be needed, and this should be set in the -package's Makefile. e.g. +package's Makefile, e.g.: INTERACTIVE_STAGE= build @@ -4883,7 +4901,7 @@ should not use the install-info command as the registration of info files is the task of the package INSTALL script, and it must use the appropriate makeinfo command. -To achieve this goal the pkgsrc infrastructure creates overriding scripts for +To achieve this goal, the pkgsrc infrastructure creates overriding scripts for the install-info and makeinfo commands in a directory listed early in PATH. The script overriding install-info has no effect except the logging of a @@ -4952,7 +4970,7 @@ to find them. 15.5.11. Packages installing GTK2 modules -If a package installs gtk2 immodules or loaders, you need to take some extra +If a package installs GTK2 immodules or loaders, you need to take some extra steps to get them registered in the GTK2 database properly: 1. Include ../../x11/gtk2/modules.mk instead of its buildlink3.mk file. This @@ -4963,7 +4981,7 @@ steps to get them registered in the GTK2 database properly: 3. Set GTK2_LOADERS=YES if your package installs GTK2 loaders. - 4. Patch the package to not touch any of the gtk2 databases directly. These + 4. Patch the package to not touch any of the GTK2 databases directly. These are: * libdata/gtk-2.0/gdk-pixbuf.loaders @@ -5013,7 +5031,7 @@ ensure that the database is kept consistent with respect to these new files: 2. Check the PLIST and remove any entries under the share/mime directory, except for files saved under share/mime/packages. The former are handled - automatically by the update-mime-database program, but the later are + automatically by the update-mime-database program, but the latter are package-dependent and must be removed by the package that installed them in the first place. @@ -5334,7 +5352,7 @@ change to the directory of the package you wish to examine and execute pkglint: $ pkglint looks fine. -Depending on the supplied command line arguments (see pkglint(1)) more verbose +Depending on the supplied command line arguments (see pkglint(1)), more verbose checks will be performed. Use e.g. pkglint -v for a very verbose check. A.2. Steps for building, installing, packaging @@ -5674,8 +5692,8 @@ The procedure to edit the pkgsrc guide is: * Make sure you have the packages needed to re-generate the pkgsrc guide (and other XML-based NetBSD documentation) installed. These are "netbsd-doc" for - creating the ASCII- and HTML-version, and "netbsd-doc-print"for the - PostScript- and PDF version. You will need both packages installed, to make + creating the ASCII and HTML versions, and "netbsd-doc-print" for the + PostScript and PDF versions. You will need both packages installed, to make sure documentation is consistent across all formats. The packages can be found in pkgsrc/meta-pkgs/netbsd-doc and pkgsrc/meta-pkgs/netbsd-doc-print. |