--- xml/htdocs/doc/en/handbook/hb-working-portage.xml 2005/05/17 14:39:26 1.51 +++ xml/htdocs/doc/en/handbook/hb-working-portage.xml 2005/05/17 20:13:38 1.52 @@ -4,11 +4,11 @@ - + -1.46 +1.47 2005-05-17
@@ -178,6 +178,58 @@ + + +Finding Installed Package Documentation + + +

+Many packages come with their own documentation. Sometimes, the doc USE +flag determines whether the package documentation should be installed or not. +You can check the existence of a doc USE flag with the emerge -vp +<package name> command. +

+ +
+(alsa-lib is just an example, of course.)
+# emerge -vp alsa-lib
+[ebuild  N    ] media-libs/alsa-lib-1.0.9_rc3  +doc -jack 674 kB
+
+ +

+You can enable or disable the doc USE flag either globally in the +/etc/make.conf file or per package in the +/etc/portage/package.use file. The USE Flags chapter covers this aspect in detail. +

+ +

+Once the package installed, its documentation is generally found in a +subdirectory named after the package under the /usr/share/doc +directory. You can also list all installed files with the equery tool +which is part of the app-portage/gentoolkit package. +

+ +
+# ls -l /usr/share/doc/alsa-lib-1.0.9_rc3
+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
+
+(Alternatively, use equery to locate interesting files:)
+# equery files alsa-lib | less
+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>>
+
+ + Removing Software