diff options
author | rpaulo <rpaulo@pkgsrc.org> | 2005-07-27 21:29:50 +0000 |
---|---|---|
committer | rpaulo <rpaulo@pkgsrc.org> | 2005-07-27 21:29:50 +0000 |
commit | 7dfe09661d93d39c82d263f62f38688ad8ae3c74 (patch) | |
tree | 9a683a9a15954ba1cf2693b014d15bc87c177988 | |
parent | 18756d8f744fdc60d1cfacc7ce851c84e51fb575 (diff) | |
download | pkgsrc-7dfe09661d93d39c82d263f62f38688ad8ae3c74.tar.gz |
Replace <pkg> by <filename role="pkg"> as discussed on netbsd-docs@.
ok hubertf@
-rw-r--r-- | doc/guide/files/binary.xml | 26 | ||||
-rw-r--r-- | doc/guide/files/build.xml | 13 | ||||
-rw-r--r-- | doc/guide/files/buildlink.xml | 16 | ||||
-rw-r--r-- | doc/guide/files/components.xml | 25 | ||||
-rw-r--r-- | doc/guide/files/debug.xml | 12 | ||||
-rw-r--r-- | doc/guide/files/examples.xml | 5 | ||||
-rw-r--r-- | doc/guide/files/faq.xml | 122 | ||||
-rw-r--r-- | doc/guide/files/fixes.xml | 58 | ||||
-rw-r--r-- | doc/guide/files/introduction.xml | 14 | ||||
-rw-r--r-- | doc/guide/files/makefile.xml | 4 | ||||
-rw-r--r-- | doc/guide/files/pkginstall.xml | 11 | ||||
-rw-r--r-- | doc/guide/files/platforms.xml | 5 | ||||
-rw-r--r-- | doc/guide/files/plist.xml | 7 | ||||
-rw-r--r-- | doc/guide/files/using.xml | 8 |
14 files changed, 185 insertions, 141 deletions
diff --git a/doc/guide/files/binary.xml b/doc/guide/files/binary.xml index 3548464b8d4..2d8a47a699f 100644 --- a/doc/guide/files/binary.xml +++ b/doc/guide/files/binary.xml @@ -1,4 +1,4 @@ -<!-- $NetBSD: binary.xml,v 1.13 2005/05/24 12:14:42 wiz Exp $ --> +<!-- $NetBSD: binary.xml,v 1.14 2005/07/27 21:29:50 rpaulo Exp $ --> <chapter id="binary"> <title>Creating binary packages</title> @@ -31,7 +31,8 @@ it. Binary packages are created by default in <filename>/usr/pkgsrc/packages</filename>, in the form of a gzipped tar file. See <xref linkend="logs.package"/> for a - continuation of the above <pkg>misc/figlet</pkg> example.</para> + continuation of the above <filename + role="pkg">misc/figlet</filename> example.</para> <para> See <xref linkend="submit"/> for information on how to submit @@ -316,7 +317,8 @@ fi</programlisting> </step> <step> - <para><filename>/etc/resolv.conf</filename> (for <pkg>security/smtpd</pkg> and mail):</para> + <para><filename>/etc/resolv.conf</filename> (for <filename + role="pkg">security/smtpd</filename> and mail):</para> <screen>&rprompt; <userinput>cp /etc/resolv.conf /usr/sandbox/etc</userinput></screen> </step> @@ -328,14 +330,16 @@ fi</programlisting> </step> <step> - <para><filename>/etc/localtime</filename> (for <pkg>security/smtpd</pkg>):</para> + <para><filename>/etc/localtime</filename> (for <filename + role="pkg">security/smtpd</filename>):</para> <screen>&rprompt; <userinput>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</userinput></screen> </step> <step> - <para><filename>/usr/src</filename> (system sources, for <pkg>sysutils/aperture</pkg>, - <pkg>net/ppp-mppe</pkg>):</para> + <para><filename>/usr/src</filename> (system sources, for <filename + role="pkg">sysutils/aperture</filename>, + <filename role="pkg">net/ppp-mppe</filename>):</para> <screen>&rprompt; <userinput>ln -s ../disk1/cvs .</userinput> &rprompt; <userinput>ln -s cvs/src-2.0 src</userinput></screen> @@ -562,11 +566,11 @@ nbftp% <userinput>chmod 755 .</userinput> </screen> 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 - <pkg>pkgtools/cdpack</pkg> package provides a simple tool for - creating the ISO 9660 images. <command>cdpack</command> 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. + <filename role="pkg">pkgtools/cdpack</filename> package provides + a simple tool for creating the ISO 9660 images. + <command>cdpack</command> 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. </para> <sect2 id="cdpack-example"> diff --git a/doc/guide/files/build.xml b/doc/guide/files/build.xml index 3a1965e1fb7..635b5e5494a 100644 --- a/doc/guide/files/build.xml +++ b/doc/guide/files/build.xml @@ -1,4 +1,4 @@ -<!-- $NetBSD: build.xml,v 1.8 2005/06/01 20:58:16 wiz Exp $ --> +<!-- $NetBSD: build.xml,v 1.9 2005/07/27 21:29:50 rpaulo Exp $ --> <chapter id="build"> <title>The build process</title> @@ -78,7 +78,8 @@ <emphasis>both</emphasis> <filename>${X11BASE}</filename> and <filename>${LOCALBASE}</filename>. To force installation of all X11 packages in <varname>LOCALBASE</varname>, the - <pkg>pkgtools/xpkgwedge</pkg> package is enabled by default.</para> + <filename role="pkg">pkgtools/xpkgwedge</filename> package + is enabled by default.</para> </listitem> <listitem> @@ -258,7 +259,7 @@ CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE} \ configure script's name can be set in <varname>CONFIGURE_SCRIPT</varname> if it differs from the default <quote>configure</quote>. Here's an example from - the <pkg>sysutils/top</pkg> package:</para> + the <filename role="pkg">sysutils/top</filename> package:</para> <programlisting>HAS_CONFIGURE= yes CONFIGURE_SCRIPT= Configure @@ -535,8 +536,10 @@ make build</programlisting> <listitem> <para>This target generates a <filename>README.html</filename> file, which - can be viewed using a browser such as <pkg>www/mozilla</pkg> or - <pkg>www/links</pkg>. The generated files contain references to any + can be viewed using a browser such as + <filename role="pkg">www/mozilla</filename> or + <filename role="pkg">www/links</filename>. + The generated files contain references to any packages which are in the <varname>PACKAGES</varname> directory on the local host. The generated files can be made to refer to URLs based on <varname>FTP_PKG_URL_HOST</varname> and diff --git a/doc/guide/files/buildlink.xml b/doc/guide/files/buildlink.xml index 109385efcec..740d34913b3 100644 --- a/doc/guide/files/buildlink.xml +++ b/doc/guide/files/buildlink.xml @@ -1,4 +1,4 @@ -<!-- $NetBSD: buildlink.xml,v 1.5 2005/06/03 16:05:30 reed Exp $ --> +<!-- $NetBSD: buildlink.xml,v 1.6 2005/07/27 21:29:50 rpaulo Exp $ --> <chapter id="buildlink"> <title>Buildlink methodology</title> @@ -90,7 +90,8 @@ <listitem> <para><filename>curses.buildlink3.mk</filename> If the system comes with neither Curses nor NCurses, this will take care - to install the <pkg>devel/ncurses</pkg> package.</para> + to install the <filename + role="pkg">devel/ncurses</filename> package.</para> </listitem> <listitem> @@ -103,8 +104,9 @@ <listitem> <para><filename>motif.buildlink3.mk</filename> checks for a system-provided - Motif installation or adds a dependency on <pkg>x11/lesstif</pkg> or - <pkg>x11/openmotif</pkg>;</para> + Motif installation or adds a dependency on <filename + role="pkg">x11/lesstif</filename> or + <filename role="pkg">x11/openmotif</filename>;</para> </listitem> <listitem> @@ -122,7 +124,8 @@ <listitem> <para><filename>pthread.buildlink3.mk</filename> uses the value of <varname>PTHREAD_OPTS</varname> and checks for native pthreads or adds - a dependency on <pkg>devel/pth</pkg> as needed;</para> + a dependency on <filename + role="pkg">devel/pth</filename> as needed;</para> </listitem> <listitem> @@ -150,7 +153,8 @@ headers and libraries that it needs in turn.</para> <para> To generate an initial <filename>buildlink3.mk</filename> - file for further editing, Rene Hexel's <pkg>pkgtools/createbuildlink</pkg> + file for further editing, Rene Hexel's <filename + role="pkg">pkgtools/createbuildlink</filename> package is highly recommended. For most packages, the following command will generate a good starting point for <filename>buildlink3.mk</filename> files:</para> diff --git a/doc/guide/files/components.xml b/doc/guide/files/components.xml index b86d0d4be59..724aece1d02 100644 --- a/doc/guide/files/components.xml +++ b/doc/guide/files/components.xml @@ -1,4 +1,4 @@ -<!-- $NetBSD: components.xml,v 1.8 2005/05/24 12:14:42 wiz Exp $ --> +<!-- $NetBSD: components.xml,v 1.9 2005/07/27 21:29:50 rpaulo Exp $ --> <chapter id="components"> <?dbhtml filename="components.html"?> <title>Package components - files, directories and contents</title> @@ -187,15 +187,17 @@ converters games mbone print x11</programlisting> The digest algorithm used was, at one stage, md5, but that was felt lacking compared to sha1, and so sha1 is now the default algorithm. The distfile size is also generated and stored in new distinfo files. - The <pkg>pkgtools/digest</pkg> utility calculates all of the digests - in the distinfo file, and it provides various different algorithms. - At the current time, the algorithms provided are: + The <filename role="pkg">pkgtools/digest</filename> utility + calculates all of the digests in the distinfo file, and it provides + various different algorithms. At the current time, the algorithms + provided are: <emphasis>md5</emphasis>, <emphasis>rmd160</emphasis>, <emphasis>sha1</emphasis>, <emphasis>sha256</emphasis>, <emphasis>sha384</emphasis> and <emphasis>sha512</emphasis>.</para> <para>Some packages have different sets of distfiles on a per architecture - basis, for example <pkg>www/navigator</pkg>). These are kept in the + basis, for example <filename + role="pkg">www/navigator</filename>). These are kept in the same distinfo file and care should be taken when upgrading such a package to ensure distfile information is not lost.</para> @@ -236,7 +238,8 @@ converters games mbone print x11</programlisting> get stored in the patch files, as these will cause problems when later checked into the &os; CVS tree. Use the <command>pkgdiff</command> from the - <pkg>pkgtools/pkgdiff</pkg> package to avoid these problems.</para> + <filename role="pkg">pkgtools/pkgdiff</filename> package to avoid + these problems.</para> <para>For even more automation, we recommend using <command>mkpatches</command> from the same package to make a whole set of patches. You just have to backup files @@ -361,8 +364,8 @@ converters games mbone print x11</programlisting> <para> If a package doesn't create a subdirectory for itself (like GNU software does, for instance), but extracts itself in the current directory, you should set <varname>WRKSRC</varname> - accordingly, e.g. <pkg>editors/sam</pkg> again, but the quick - answer is: </para> + accordingly, e.g. <filename role="pkg">editors/sam</filename> + again, but the quick answer is: </para> <programlisting>WRKSRC= ${WRKDIR}</programlisting> @@ -371,8 +374,10 @@ converters games mbone print x11</programlisting> package doesn't create a subdir with the name of <varname>DISTNAME</varname> but some different name, set <varname>WRKSRC</varname> to point to the proper name in - <filename>${WRKDIR}</filename>. See <pkg>lang/tcl</pkg> and - <pkg>x11/tk</pkg> for examples, and here is another one: </para> + <filename>${WRKDIR}</filename>. See <filename + role="pkg">lang/tcl</filename> and + <filename role="pkg">x11/tk</filename> for examples, and here is + another one: </para> <programlisting>WRKSRC= ${WRKDIR}/${DISTNAME}/unix</programlisting> diff --git a/doc/guide/files/debug.xml b/doc/guide/files/debug.xml index 9181f2c6648..d1a557072ec 100644 --- a/doc/guide/files/debug.xml +++ b/doc/guide/files/debug.xml @@ -1,4 +1,4 @@ -<!-- $NetBSD: debug.xml,v 1.1.1.1 2004/10/21 14:27:38 grant Exp $ --> +<!-- $NetBSD: debug.xml,v 1.2 2005/07/27 21:29:50 rpaulo Exp $ --> <chapter id="debug"> <title>Debugging</title> @@ -15,8 +15,8 @@ </listitem> <listitem> - <para>Install <pkg>pkgtools/url2pkg</pkg>, create a directory - for a new package, change into it, then run + <para>Install <filename role="pkg">pkgtools/url2pkg</filename>, + create a directory for a new package, change into it, then run <command>url2pkg</command>:</para> <screen>&cprompt; <userinput>mkdir /usr/pkgsrc/<replaceable>category</replaceable>/<replaceable>examplepkg</replaceable></userinput> @@ -58,7 +58,8 @@ shouldn't be, especially during the build phase. <command>mkpatches</command>, <command>patchdiff</command> and <command>pkgvi</command> are - from the <pkg>pkgtools/pkgdiff</pkg> package. </para> + from the <filename role="pkg">pkgtools/pkgdiff</filename> + package. </para> </listitem> <listitem> @@ -116,7 +117,8 @@ </listitem> <listitem> - <para>Run <command>pkglint</command> from <pkg>pkgtools/pkglint</pkg>, + <para>Run <command>pkglint</command> from + <filename role="pkg">pkgtools/pkglint</filename>, and fix the problems it reports:</para> <screen>&rprompt; <userinput>pkglint</userinput></screen> diff --git a/doc/guide/files/examples.xml b/doc/guide/files/examples.xml index 09b34ed8667..cbcdc216897 100644 --- a/doc/guide/files/examples.xml +++ b/doc/guide/files/examples.xml @@ -1,4 +1,4 @@ -<!-- $NetBSD: examples.xml,v 1.5 2005/05/24 12:14:42 wiz Exp $ --> +<!-- $NetBSD: examples.xml,v 1.6 2005/07/27 21:29:50 rpaulo Exp $ --> <appendix id="examples"> <title>A simple example package: bison</title> @@ -53,7 +53,8 @@ share/bison.hairy</programlisting> <sect2 id="checking-package-with-pkglint"> <title>Checking a package with <command>pkglint</command></title> - <para>The NetBSD package system comes with <pkg>pkgtools/pkglint</pkg> + <para>The NetBSD package system comes with + <filename role="pkg">pkgtools/pkglint</filename> which helps to check the contents of these files. After installation it is quite easy to use, just change to the directory of the package you wish to examine and execute diff --git a/doc/guide/files/faq.xml b/doc/guide/files/faq.xml index 4785cdc45e8..f83ece27410 100644 --- a/doc/guide/files/faq.xml +++ b/doc/guide/files/faq.xml @@ -1,4 +1,4 @@ -<!-- $NetBSD: faq.xml,v 1.13 2005/06/03 12:27:48 jmmv Exp $ --> +<!-- $NetBSD: faq.xml,v 1.14 2005/07/27 21:29:50 rpaulo Exp $ --> <chapter id="faq"> <?dbhtml filename="faq.html"?> <title>Frequently Asked Questions</title> @@ -81,8 +81,8 @@ with each package.</para> <itemizedlist> <listitem> - <para><pkg>pkgtools/x11-links</pkg>: Symlinks for use by - buildlink.</para> + <para><filename role="pkg">pkgtools/x11-links</filename>: + Symlinks for use by buildlink.</para> </listitem> </itemizedlist> @@ -92,25 +92,26 @@ with each package.</para> <itemizedlist> <listitem> - <para><pkg>pkgtools/digest</pkg>: Calculates various kinds of - checksums (including SHA1).</para> + <para><filename role="pkg">pkgtools/digest</filename>: + Calculates various kinds of checksums (including SHA1).</para> </listitem> <listitem> - <para><pkg>pkgtools/libnbcompat</pkg>: Compatibility library for - pkgsrc tools.</para> + <para><filename role="pkg">pkgtools/libnbcompat</filename>: + Compatibility library for pkgsrc tools.</para> </listitem> <listitem> - <para><pkg>pkgtools/mtree</pkg>: Installed on non-BSD systems due to - lack of native mtree. + <para><filename role="pkg">pkgtools/mtree</filename>: Installed on + non-BSD systems due to lack of native mtree. </para> </listitem> <listitem> - <para><pkg>pkgtools/pkg_install</pkg>: Up-to-date replacement for - <filename>/usr/sbin/pkg_install</filename>, or for use on operating - systems where pkg_install is not present.</para> + <para><filename role="pkg">pkgtools/pkg_install</filename>: + Up-to-date replacement for + <filename>/usr/sbin/pkg_install</filename>, or for use on operating + systems where pkg_install is not present.</para> </listitem> </itemizedlist> @@ -120,26 +121,28 @@ with each package.</para> <itemizedlist> <listitem> - <para><pkg>pkgtools/pkg_tarup</pkg>: Create a binary package from an - already-installed package. Used by <command>make replace</command> to - save the old package.</para> + <para><filename role="pkg">pkgtools/pkg_tarup</filename>: + Create a binary package from an + already-installed package. Used by <command>make replace</command> to + save the old package.</para> </listitem> <listitem> - <para><pkg>pkgtools/dfdisk</pkg>: Adds extra functionality to pkgsrc, - allowing it to fetch distfiles from multiple locations. It currently - supports the following methods: multiple CD-ROMs and network FTP/HTTP - connections.</para> + <para><filename role="pkg">pkgtools/dfdisk</filename>: + Adds extra functionality to pkgsrc, allowing it to fetch distfiles + from multiple locations. It currently supports the following + methods: multiple CD-ROMs and network FTP/HTTP connections.</para> </listitem> <listitem> - <para><pkg>pkgtools/xpkgwedge</pkg>: Put X11 packages someplace else - (enabled by default).</para> + <para><filename role="pkg">pkgtools/xpkgwedge</filename>: Put X11 + packages someplace else (enabled by default).</para> </listitem> <listitem> - <para><pkg>devel/cpuflags</pkg>: Determine the best compiler flags - to optimise code for your current CPU and compiler.</para> + <para><filename role="pkg">devel/cpuflags</filename>: Determine the + best compiler flags to optimise code for your current CPU and + compiler.</para> </listitem> </itemizedlist> @@ -150,29 +153,32 @@ etc:</para> <itemizedlist> <listitem> - <para><pkg>pkgtools/pkg_chk</pkg>: Reports on packages whose installed - versions do not match the latest pkgsrc entries.</para> + <para><filename role="pkg">pkgtools/pkg_chk</filename>: Reports on + packages whose installed versions do not match the latest pkgsrc + entries.</para> </listitem> <listitem> - <para><pkg>pkgtools/pkgdep</pkg>: Makes dependency graphs of packages, - to aid in choosing a strategy for updating.</para> + <para><filename role="pkg">pkgtools/pkgdep</filename>: Makes + dependency graphs of packages, to aid in choosing a strategy for + updating.</para> </listitem> <listitem> - <para><pkg>pkgtools/pkgdepgraph</pkg>: Makes graphs from the output of - <pkg>pkgtools/pkgdep</pkg> (uses graphviz).</para> + <para><filename role="pkg">pkgtools/pkgdepgraph</filename>: Makes + graphs from the output of <filename + role="pkg">pkgtools/pkgdep</filename> (uses graphviz).</para> </listitem> <listitem> - <para><pkg>pkgtools/pkglint</pkg>: The pkglint(1) program checks a - pkgsrc entry for errors, lintpkgsrc(1) does various checks on the - complete pkgsrc system.</para> + <para><filename role="pkg">pkgtools/pkglint</filename>: The + pkglint(1) program checks a pkgsrc entry for errors, lintpkgsrc(1) + does various checks on the complete pkgsrc system.</para> </listitem> <listitem> - <para><pkg>pkgtools/pkgsurvey</pkg>: Report what packages you have - installed.</para> + <para><filename role="pkg">pkgtools/pkgsurvey</filename>: Report what + packages you have installed.</para> </listitem> </itemizedlist> @@ -182,19 +188,20 @@ etc:</para> <itemizedlist> <listitem> - <para><pkg>pkgtools/pkgdiff</pkg>: Automate making and maintaining - patches for a package (includes pkgdiff, pkgvi, mkpatches, - etc.).</para> + <para><filename role="pkg">pkgtools/pkgdiff</filename>: Automate + making and maintaining patches for a package (includes pkgdiff, + pkgvi, mkpatches, etc.).</para> </listitem> <listitem> - <para><pkg>pkgtools/rpm2pkg</pkg>, <pkg>pkgtools/url2pkg</pkg>: Aids in - converting to pkgsrc.</para> + <para><filename role="pkg">pkgtools/rpm2pkg</filename>, + <filename role="pkg">pkgtools/url2pkg</filename>: Aids in + converting to pkgsrc.</para> </listitem> <listitem> - <para><pkg>pkgtools/gensolpkg</pkg>: Convert pkgsrc to a Solaris - package.</para> + <para><filename role="pkg">pkgtools/gensolpkg</filename>: Convert + pkgsrc to a Solaris package.</para> </listitem> </itemizedlist> @@ -205,18 +212,18 @@ utilities)</para> <itemizedlist> <listitem> - <para><pkg>pkgtools/pkgconflict</pkg>: Find packages that conflict but - aren't marked as such.</para> + <para><filename role="pkg">pkgtools/pkgconflict</filename>: Find + packages that conflict but aren't marked as such.</para> </listitem> <listitem> - <para><pkg>pkgtools/pkg_comp</pkg>: Build packages in a chrooted - area.</para> + <para><filename role="pkg">pkgtools/pkg_comp</filename>: Build + packages in a chrooted area.</para> </listitem> <listitem> - <para><pkg>pkgtools/libkver</pkg>: Spoof kernel version for chrooted - cross builds.</para> + <para><filename role="pkg">pkgtools/libkver</filename>: Spoof + kernel version for chrooted cross builds.</para> </listitem> </itemizedlist> @@ -405,14 +412,15 @@ by running:</para> <title>What does <quote>Don't know how to make /usr/share/tmac/tmac.andoc</quote> mean?</title> -<para>When compiling the <pkg>pkgtools/pkg_install</pkg> package, you -get the error from make that it doesn't know how to make +<para>When compiling the <filename role="pkg">pkgtools/pkg_install</filename> +package, you get the error from make that it doesn't know how to make <filename>/usr/share/tmac/tmac.andoc</filename>? This indicates that you don't have installed the <quote>text</quote> set (nroff, ...) from the NetBSD base distribution on your machine. It is recommended to do that to format manpages.</para> -<para>In the case of the <pkg>pkgtools/pkg_install</pkg> package, you +<para>In the case of the <filename + role="pkg">pkgtools/pkg_install</filename> package, you can get away with setting <varname>NOMAN=YES</varname> either in the environment or in <filename>/etc/mk.conf</filename>.</para> @@ -446,8 +454,8 @@ the one that corresponds to your release (determine via <command>uname password for each required package installed. To avoid this, the sudo package can be used, which does password caching over a limited time. To use it, install sudo (either as binary package or from -<pkg>security/sudo</pkg>) and then put the following into your -<filename>/etc/mk.conf</filename>:</para> +<filename role="pkg">security/sudo</filename>) and then put the following +into your <filename>/etc/mk.conf</filename>:</para> <programlisting>.if exists(${LOCALBASE}/bin/sudo) SU_CMD=${LOCALBASE}/bin/sudo /bin/sh -c @@ -495,8 +503,9 @@ attackers. In an effort to lessen the exposure, the NetBSD packages team maintains a database of known-exploits to packages which have at one time been included in pkgsrc. The database can be downloaded automatically, and a security audit of all packages installed on a system can take place. To -do this, install the <pkg>security/audit-packages</pkg> package. It has -two components:</para> +do this, install the <filename + role="pkg">security/audit-packages</filename> package. It has two +components:</para> <orderedlist> @@ -520,8 +529,9 @@ two components:</para> </orderedlist> -<para>Use of the <pkg>security/audit-packages</pkg> package is strongly -recommended! After <quote>audit-packages</quote> is installed, please read +<para>Use of the <filename role="pkg">security/audit-packages</filename> +package is strongly recommended! After +<quote>audit-packages</quote> is installed, please read the package's message, which you can get by running <userinput>pkg_info -D audit-package</userinput>.</para> diff --git a/doc/guide/files/fixes.xml b/doc/guide/files/fixes.xml index b48e8766f40..c893be2f6b4 100644 --- a/doc/guide/files/fixes.xml +++ b/doc/guide/files/fixes.xml @@ -1,4 +1,4 @@ -<!-- $NetBSD: fixes.xml,v 1.26 2005/07/27 14:40:46 gdt Exp $ --> +<!-- $NetBSD: fixes.xml,v 1.27 2005/07/27 21:29:50 rpaulo Exp $ --> <chapter id="fixes"> <?dbhtml filename="fixes.html"?> <title>Notes on fixes for packages</title> @@ -40,8 +40,8 @@ Using <varname>CFLAGS=</varname> (i.e. without the <quote>+</quote>) may lead to problems with packages that need to add their own flags. Also, you may want to take a look at - the <pkg>devel/cpuflags</pkg> package if you're interested in - optimization for the current CPU.</para> + the <filename role="pkg">devel/cpuflags</filename> package if + you're interested in optimization for the current CPU.</para> </sect2> <sect2 id="where-to-install-documentation"> @@ -173,8 +173,8 @@ again there is no <filename>buildlink3.mk</filename> file available, this is specified using the <varname>DEPENDS</varname> definition. An example of this - is the <pkg>print/lyx</pkg> package, which uses the xpm - library, version 3.4j to build:</para> + is the <filename role="pkg">print/lyx</filename> package, + which uses the xpm library, version 3.4j to build:</para> <programlisting>DEPENDS+= xpm-3.4j:../../graphics/xpm</programlisting> @@ -250,9 +250,9 @@ correctly and if there's no <filename>buildlink3.mk</filename> file, this is specified using the <varname>DEPENDS</varname> variable. The - <pkg>print/lyx</pkg> package needs to be able to execute the - latex binary from the teTeX package when it runs, and that - is specified:</para> + <filename role="pkg">print/lyx</filename> package needs to + be able to execute the latex binary from the teTeX package + when it runs, and that is specified:</para> <programlisting>DEPENDS+= teTeX-[0-9]*:../../print/teTeX</programlisting> @@ -263,8 +263,9 @@ <para>If your package needs files from another package to build, see the first part of the <quote>do-configure</quote> target - <pkg>print/ghostscript5</pkg> package (it relies on the jpeg - sources being present in source form during the build):</para> + <filename role="pkg">print/ghostscript5</filename> package + (it relies on the jpeg sources being present in source form + during the build):</para> <programlisting>if [ ! -e ${_PKGSRCDIR}/graphics/jpeg/${WRKDIR:T}/jpeg-6b ]; then \ cd ${_PKGSRCDIR}/../../graphics/jpeg && ${MAKE} extract; \ @@ -282,10 +283,10 @@ and <varname>BUILD_USES_GETTEXT_M4</varname> definitions, which are provided as convenience definitions. The former works out whether &man.msgfmt.1; is part of the base system, and, if it isn't, - installs the <pkg>devel/gettext</pkg> package. The latter adds - a build dependency on either an installed version of an older - gettext package, or if it isn't, installs the - <pkg>devel/gettext-m4</pkg> package.</para> + installs the <filename role="pkg">devel/gettext</filename> package. + The latter adds a build dependency on either an installed + version of an older gettext package, or if it isn't, installs the + <filename role="pkg">devel/gettext-m4</filename> package.</para> </sect2> @@ -301,7 +302,8 @@ space separated list of packages (including version string) your package conflicts with.</para> - <para>For example <pkg>x11/Xaw3d</pkg> and <pkg>x11/Xaw-Xpm</pkg> + <para>For example <filename role="pkg">x11/Xaw3d</filename> + and <filename role="pkg">x11/Xaw-Xpm</filename> install provide the same shared library, thus you set in <filename>pkgsrc/x11/Xaw3d/Makefile</filename>:</para> @@ -460,7 +462,8 @@ ${INSTALL_DATA_DIR} ${PREFIX}/dir2</programlisting> fetch</command> will call <filename>files/getsite.sh</filename> with the name of each file to download as an argument, expecting it to output the URL of the directory from which to download - it. <pkg>graphics/ns-cult3d</pkg> is an example of this usage. + it. <filename role="pkg">graphics/ns-cult3d</filename> is an + example of this usage. </para> <para>If the download can't be automated, because the user must @@ -472,12 +475,14 @@ ${INSTALL_DATA_DIR} ${PREFIX}/dir2</programlisting> shell commands, not just a message. (Generally, it executes <varname>${ECHO}</varname>). As of this writing, the following packages use this: - <pkg>cad/simian</pkg>, <pkg>devel/ipv6socket</pkg>, - <pkg>emulators/vmware-module</pkg>, - <pkg>fonts/acroread-jpnfont</pkg>, - <pkg>multimedia/realplayer</pkg>, - <pkg>sysutils/storage-manager</pkg>, - <pkg>www/ap-aolserver</pkg>, <pkg>www/openacs</pkg>. Try to be + <filename role="pkg">cad/simian</filename>, + <filename role="pkg">devel/ipv6socket</filename>, + <filename role="pkg">emulators/vmware-module</filename>, + <filename role="pkg">fonts/acroread-jpnfont</filename>, + <filename role="pkg">multimedia/realplayer</filename>, + <filename role="pkg">sysutils/storage-manager</filename>, + <filename role="pkg">www/ap-aolserver</filename>, + <filename role="pkg">www/openacs</filename>. Try to be consistent with them.</para> </sect2> @@ -521,7 +526,8 @@ ${INSTALL_DATA_DIR} ${PREFIX}/dir2</programlisting> 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 <pkg>devel/libtool</pkg> pkg + at your hand to test things. The + <filename role="pkg">devel/libtool</filename> pkg can help here, as it just <quote>knows</quote> how to build both static and dynamic libraries from a set of source files, thus being platform independent.</para> @@ -860,7 +866,8 @@ pre-configure: done by placing the license in <filename>pkgsrc/licenses</filename> and setting the <varname>LICENSE</varname> variable to a string identifying - the license, e.g. in <pkg>graphics/xv</pkg>: </para> + the license, e.g. in + <filename role="pkg">graphics/xv</filename>: </para> <programlisting>LICENSE= xv-license</programlisting> @@ -1035,7 +1042,8 @@ pre-configure: default, a minimum version of 3.12 is required. If the system does not provide a <command>makeinfo</command> command or if it does not match the required minimum, a build dependency on the - <pkg>devel/gtexinfo</pkg> package will be added automatically. + <filename role="pkg">devel/gtexinfo</filename> package will + be added automatically. </para> <para>The build and installation process of the software provided diff --git a/doc/guide/files/introduction.xml b/doc/guide/files/introduction.xml index 1cbf031eadf..cfc25e1cc14 100644 --- a/doc/guide/files/introduction.xml +++ b/doc/guide/files/introduction.xml @@ -1,4 +1,4 @@ -<!-- $NetBSD: introduction.xml,v 1.5 2005/05/24 12:14:42 wiz Exp $ --> +<!-- $NetBSD: introduction.xml,v 1.6 2005/07/27 21:29:50 rpaulo Exp $ --> <chapter id="introduction"> <title>Introduction</title> @@ -26,19 +26,23 @@ <itemizedlist> <listitem> - <para><pkg>www/apache</pkg> - The Apache web server</para> + <para><filename role="pkg">www/apache</filename> - The Apache + web server</para> </listitem> <listitem> - <para><pkg>www/mozilla</pkg> - The Mozilla web browser</para> + <para><filename role="pkg">www/mozilla</filename> - The Mozilla + web browser</para> </listitem> <listitem> - <para><pkg>meta-pkgs/gnome</pkg> - The GNOME Desktop Environment</para> + <para><filename role="pkg">meta-pkgs/gnome</filename> - The GNOME + Desktop Environment</para> </listitem> <listitem> - <para><pkg>meta-pkgs/kde3</pkg> - The K Desktop Environment</para> + <para><filename role="pkg">meta-pkgs/kde3</filename> - The K + Desktop Environment</para> </listitem> </itemizedlist> diff --git a/doc/guide/files/makefile.xml b/doc/guide/files/makefile.xml index 1b1e63d7045..d0922385090 100644 --- a/doc/guide/files/makefile.xml +++ b/doc/guide/files/makefile.xml @@ -1,4 +1,4 @@ -<!-- $NetBSD: makefile.xml,v 1.16 2005/05/24 12:14:42 wiz Exp $ --> +<!-- $NetBSD: makefile.xml,v 1.17 2005/07/27 21:29:50 rpaulo Exp $ --> <!-- based on: pkgsrc/bootstrap/bmake/for.c 1.1.1.1 @@ -318,7 +318,7 @@ for_test: </programlisting> <para>For a more complex code snippet and a workaround, see the - package <pkg>regress/make-quoting</pkg>, testcase + package <filename role="pkg">regress/make-quoting</filename>, testcase <varname>bug1</varname>.</para> </sect2> diff --git a/doc/guide/files/pkginstall.xml b/doc/guide/files/pkginstall.xml index ffa66be2035..cc0d4babbf1 100644 --- a/doc/guide/files/pkginstall.xml +++ b/doc/guide/files/pkginstall.xml @@ -1,4 +1,4 @@ -<!-- $NetBSD: pkginstall.xml,v 1.3 2005/06/03 13:05:20 jmmv Exp $ --> +<!-- $NetBSD: pkginstall.xml,v 1.4 2005/07/27 21:29:50 rpaulo Exp $ --> <chapter id="pkginstall"> <?dbhtml filename="pkginstall.html"?> <title>The pkginstall framework</title> @@ -200,7 +200,8 @@ set based upon the following variables:</para> customizable).</para> <para>As an example, consider the Apache package, - <pkg>www/apache2</pkg>, which places its configuration files under the + <filename role="pkg">www/apache2</filename>, which places its + configuration files under the <filename>httpd/</filename> subdirectory of <varname>PKG_SYSCONFBASE</varname>. This should be set in the package Makefile.</para> @@ -301,7 +302,7 @@ during the package installation to update what is in <varname>CONF_FILES</varname> and <varname>CONF_FILES_PERMS</varname> are used. Check out <xref linkend="files-outside-prefix" /> for information about their syntax and their purpose. Here is an example, taken from the -<pkg>mail/mutt</pkg> package:</para> +<filename role="pkg">mail/mutt</filename> package:</para> <programlisting>EGDIR= ${PREFIX}/share/doc/mutt/samples CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc</programlisting> @@ -346,7 +347,7 @@ to:</para> <listitem> <para>Store the script inside <filename>${FILESDIR}</filename>, with the <literal>.sh</literal> suffix appended. Considering the - <pkg>print/cups</pkg> package as an example, it has a + <filename role="pkg">print/cups</filename> package as an example, it has a <filename>cupsd.sh</filename> in its files directory.</para> </listitem> @@ -454,7 +455,7 @@ accomplish this task.</para> <para>When a package provides a shell interpreter, it has to set the <varname>PKG_SHELL</varname> variable to its absolute file name. This will add some hooks to the installation scripts to handle it. Consider the -following example, taken from <pkg>shells/zsh</pkg>:</para> +following example, taken from <filename role="pkg">shells/zsh</filename>:</para> <programlisting>USE_PKGINSTALL= YES PKG_SHELL= ${PREFIX}/bin/zsh</programlisting> diff --git a/doc/guide/files/platforms.xml b/doc/guide/files/platforms.xml index 21bb8dc2e9e..e58d041211c 100644 --- a/doc/guide/files/platforms.xml +++ b/doc/guide/files/platforms.xml @@ -1,4 +1,4 @@ -<!-- $NetBSD: platforms.xml,v 1.11 2005/05/24 12:14:42 wiz Exp $ --> +<!-- $NetBSD: platforms.xml,v 1.12 2005/07/27 21:29:50 rpaulo Exp $ --> <chapter id="platforms"> <title>Using pkgsrc on systems other than &os;</title> @@ -482,7 +482,8 @@ for building all packages.</para> <para>It is recommended that an external gcc be used only for bootstrapping, - then either build gcc from <pkg>lang/gcc</pkg> or install a binary gcc + then either build gcc from + <filename role="pkg">lang/gcc</filename> or install a binary gcc package, then remove gcc used during bootstrapping.</para> <para>Binary packages of gcc can be found through <ulink diff --git a/doc/guide/files/plist.xml b/doc/guide/files/plist.xml index 2a063bfa598..86ae145db12 100644 --- a/doc/guide/files/plist.xml +++ b/doc/guide/files/plist.xml @@ -1,4 +1,4 @@ -<!-- $NetBSD: plist.xml,v 1.6 2005/05/31 16:55:19 wiz Exp $ --> +<!-- $NetBSD: plist.xml,v 1.7 2005/07/27 21:29:51 rpaulo Exp $ --> <chapter id="plist"> <title>PLIST issues</title> @@ -247,8 +247,9 @@ <listitem> <para> If the packages have a common dependency, the directory can be removed in that. For example, see - <pkg>textproc/scrollkeeper</pkg>, which removes the shared - directory <filename>share/omf</filename>. </para> + <filename role="pkg">textproc/scrollkeeper</filename>, which + removes the shared directory + <filename>share/omf</filename>. </para> </listitem> <listitem> diff --git a/doc/guide/files/using.xml b/doc/guide/files/using.xml index 8a06bda66b5..4a0885a4636 100644 --- a/doc/guide/files/using.xml +++ b/doc/guide/files/using.xml @@ -1,4 +1,4 @@ -<!-- $NetBSD: using.xml,v 1.10 2005/05/24 12:14:42 wiz Exp $ --> +<!-- $NetBSD: using.xml,v 1.11 2005/07/27 21:29:51 rpaulo Exp $ --> <chapter id="using"> <?dbhtml filename="using.html"?> <title>Using pkgsrc</title> @@ -65,9 +65,9 @@ moved, since removing them could cause missing dependencies. To use these packages, add the <filename>vulnerable</filename> directory to your <varname>PKG_PATH</varname>. However, you should run - <pkg>security/audit-packages</pkg> regularly, and especially after - installing new packages, and verify that the vulnerabilities are - acceptable for your configuration. An example + <filename role="pkg">security/audit-packages</filename> regularly, + and especially after installing new packages, and verify that the + vulnerabilities are acceptable for your configuration. An example <varname>PKG_PATH</varname> would be: <filename>ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All;ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/vulnerable</filename> Please note that semicolon (';') is a shell meta-character, so |