neysx 05/05/17 20:13:38 Modified: xml/htdocs/doc/en/handbook hb-working-portage.xml Log: #92900: tell user where to find installed package doc
Revision Changes Path 1.52 +54 -2 xml/htdocs/doc/en/handbook/hb-working-portage.xml file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/handbook/hb-working-portage.xml?rev=1.52&content-type=text/x-cvsweb-markup&cvsroot=gentoo plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/handbook/hb-working-portage.xml?rev=1.52&content-type=text/plain&cvsroot=gentoo diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/handbook/hb-working-portage.xml.diff?r1=1.51&r2=1.52&cvsroot=gentoo Index: hb-working-portage.xml =================================================================== RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-working-portage.xml,v retrieving revision 1.51 retrieving revision 1.52 diff -u -r1.51 -r1.52 --- hb-working-portage.xml 17 May 2005 14:39:26 -0000 1.51 +++ hb-working-portage.xml 17 May 2005 20:13:38 -0000 1.52 @@ -4,11 +4,11 @@ <!-- The content of this document is licensed under the CC-BY-SA license --> <!-- See http://creativecommons.org/licenses/by-sa/2.0 --> -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-working-portage.xml,v 1.51 2005/05/17 14:39:26 neysx Exp $ --> +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-working-portage.xml,v 1.52 2005/05/17 20:13:38 neysx Exp $ --> <sections> -<version>1.46</version> +<version>1.47</version> <date>2005-05-17</date> <section> @@ -180,6 +180,58 @@ </body> </subsection> <subsection> +<title>Finding Installed Package Documentation</title> +<body> + +<p> +Many packages come with their own documentation. Sometimes, the <c>doc</c> USE +flag determines whether the package documentation should be installed or not. +You can check the existence of a <c>doc</c> USE flag with the <c>emerge -vp +<package name></c> command. +</p> + +<pre caption="Checking the existence of a doc USE flag"> +<comment>(alsa-lib is just an example, of course.)</comment> +# <i>emerge -vp alsa-lib</i> +[ebuild N ] media-libs/alsa-lib-1.0.9_rc3 +doc -jack 674 kB +</pre> + +<p> +You can enable or disable the <c>doc</c> USE flag either globally in the +<path>/etc/make.conf</path> file or per package in the +<path>/etc/portage/package.use</path> file. The <uri +link="?part=2&chap=2">USE Flags</uri> chapter covers this aspect in detail. +</p> + +<p> +Once the package installed, its documentation is generally found in a +subdirectory named after the package under the <path>/usr/share/doc</path> +directory. You can also list all installed files with the <c>equery</c> tool +which is part of the <c>app-portage/gentoolkit</c> <uri +link="/doc/en/gentoolkit.xml">package</uri>. +</p> + +<pre caption="Locating package documentation"> +# <i>ls -l /usr/share/doc/alsa-lib-1.0.9_rc3</i> +total 28 +-rw-r--r-- 1 root root 669 May 17 21:54 ChangeLog.gz +-rw-r--r-- 1 root root 9373 May 17 21:54 COPYING.gz +drwxr-xr-x 2 root root 8560 May 17 21:54 html +-rw-r--r-- 1 root root 196 May 17 21:54 TODO.gz + +<comment>(Alternatively, use equery to locate interesting files:)</comment> +# <i>equery files alsa-lib | less</i> +media-libs/alsa-lib-1.0.9_rc3 +* Contents of media-libs/alsa-lib-1.0.9_rc3: +/usr +/usr/bin +/usr/bin/alsalisp + <<output truncated>> +</pre> + +</body> +</subsection> +<subsection> <title>Removing Software</title> <body> -- [email protected] mailing list
