swift 08/05/20 18:44:03 Modified: gentoolkit.xml Log: Coding style
Revision Changes Path 1.31 xml/htdocs/doc/en/gentoolkit.xml file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/gentoolkit.xml?rev=1.31&view=markup plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/gentoolkit.xml?rev=1.31&content-type=text/plain diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/gentoolkit.xml?r1=1.30&r2=1.31 Index: gentoolkit.xml =================================================================== RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/gentoolkit.xml,v retrieving revision 1.30 retrieving revision 1.31 diff -u -r1.30 -r1.31 --- gentoolkit.xml 26 Jun 2007 04:14:39 -0000 1.30 +++ gentoolkit.xml 20 May 2008 18:44:03 -0000 1.31 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/gentoolkit.xml,v 1.30 2007/06/26 04:14:39 nightmorph Exp $ --> +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/gentoolkit.xml,v 1.31 2008/05/20 18:44:03 swift Exp $ --> <!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> <guide link="/doc/en/gentoolkit.xml"> @@ -59,16 +59,16 @@ As of now, there are two versions of gentoolkit: <c>app-portage/gentoolkit</c> and <c>app-portage/gentoolkit-dev</c>. While the former contains administration scripts, the latter contains scripts specific to help development on Gentoo. -If you are a developer, you can have your scripts included into -<c>gentoolkit-dev</c> by contacting the Gentoolkit maintainer. This document -discusses gentoolkit only. +If you are a developer, you can have your scripts included into +<c>gentoolkit-dev</c> by contacting the Gentoolkit maintainer. This document +discusses gentoolkit only. </note> <p> Gentoolkit contains a whole bunch of useful tools to help manage your packages -and keep track of what is going on in your system. Most users -- particularly -those who update systems often -- will benefit from having gentoolkit -installed. +and keep track of what is going on in your system. Most users +-- particularly those who update systems often -- will benefit from +having gentoolkit installed. </p> </body> @@ -138,7 +138,7 @@ <body> <p> -<c>equery</c> also provides the functionality of finding the package that a +<c>equery</c> also provides the functionality of finding the package that a file came from, using <c>belongs</c> command (or just <c>b</c>). </p> @@ -149,8 +149,8 @@ </pre> <p> -By using the <c>-f</c> option, you may search for packages with files -matching any regular expression. The <c>-e</c> option is useful for +By using the <c>-f</c> option, you may search for packages with files +matching any regular expression. The <c>-e</c> option is useful for terminating your search immediately when a match is found. </p> @@ -161,8 +161,8 @@ <body> <p> -Sometimes it is useful to check a package's integrity. <c>equery</c> can -verify md5 sums as well as timestamps to indicate when a package might +Sometimes it is useful to check a package's integrity. <c>equery</c> can +verify md5 sums as well as timestamps to indicate when a package might have been corrupted, replaced, or removed. </p> @@ -185,7 +185,7 @@ <p> <c>equery</c> is able to list all direct dependencies matching a package. -The function we should use to do this is <c>depends</c> and it's as easy as: +The function we should use to do this is <c>depends</c> and it's as easy as: </p> <pre caption="Looking for packages depending on pygtk"> @@ -205,8 +205,8 @@ <body> <p> -<c>equery</c> is capable of giving us a dependency graph for a specified -package. The dependency graph gives a listing of all the packages that have +<c>equery</c> is capable of giving us a dependency graph for a specified +package. The dependency graph gives a listing of all the packages that have direct and indirect dependencies on the package in question. </p> @@ -231,11 +231,11 @@ </pre> <p> -For example, while glibc is a direct dependency for cdrtools,linux-headers -are an indirect dependency. Note that the output also includes information -about virtual packages. In the example above, <c>cdrtools</c> is actually -written to require virtual/libc, not sys-libs/glibc, but on the given -system in the example sys-libs/glibc provides virtual/libc. +For example, while glibc is a direct dependency for cdrtools,linux-headers +are an indirect dependency. Note that the output also includes information +about virtual packages. In the example above, <c>cdrtools</c> is actually +written to require virtual/libc, not sys-libs/glibc, but on the given +system in the example sys-libs/glibc provides virtual/libc. </p> </body> @@ -245,7 +245,7 @@ <body> <p> -<c>equery</c> can list the files that belong to an installed ebuild. If I +<c>equery</c> can list the files that belong to an installed ebuild. If I don't know the files that Gentoolkit has installed on the system, I will use <c>equery</c> to show them. </p> @@ -280,7 +280,7 @@ </pre> <p> -The command <c>files</c> of <c>equery</c> provide some options to modify +The command <c>files</c> of <c>equery</c> provide some options to modify the output. You can look them all up in the <c>equery</c> man page. </p> @@ -291,7 +291,7 @@ <body> <p> -If you want to find which packages on your system that make use of a specific +If you want to find which packages on your system that make use of a specific USE flag, <c>equery</c> has the function <c>hasuse</c>: </p> @@ -310,7 +310,7 @@ <body> <p> -<c>equery</c> has a power feature to list packages belonging to our system, +<c>equery</c> has a power feature to list packages belonging to our system, portage or even an overlay. Let's try this: </p> @@ -322,11 +322,11 @@ </pre> <p> -The standard query will search our installed packages for the name given. -If found, the following info will be displayed: the package location between -the first square brackets (I for Installed packages, P for Portage, O for -Overlay), the possible masks between the second (~ by keyword, - by arch or -M hard masked), then the category and complete name and last of all, the slot +The standard query will search our installed packages for the name given. +If found, the following info will be displayed: the package location between +the first square brackets (I for Installed packages, P for Portage, O for +Overlay), the possible masks between the second (~ by keyword, - by arch or +M hard masked), then the category and complete name and last of all, the slot in which the package is stored. </p> @@ -374,7 +374,7 @@ </pre> <p> -As you can see, <c>equery</c> prints the total space used in kilobytes and +As you can see, <c>equery</c> prints the total space used in kilobytes and also lists the total number of files the package has. </p> @@ -385,8 +385,8 @@ <body> <p> -<c>equery</c> can be used to give us information about what USE flags -are being used by a specific package. It also tells us what our current USE +<c>equery</c> can be used to give us information about what USE flags +are being used by a specific package. It also tells us what our current USE flags are for a package and also what USE flags are available for the package. </p> @@ -446,7 +446,7 @@ <p> <c>euse</c> is a tool to see, set and unset USE flags at various places. For more information on USE flags, please refer to the <uri -link="/doc/en/handbook/handbook-x86.xml?part=2&chap=2">USE Flags</uri>. +link="/doc/en/handbook/handbook-x86.xml?part=2&chap=2">USE Flags</uri>. Please see <c>euse -h</c> for complete help and all options. </p> @@ -457,15 +457,15 @@ <body> <p> -The <c>euse -a</c> command reads the current active USE flags and displays +The <c>euse -a</c> command reads the current active USE flags and displays them. </p> <note> -There are 5 "columns" that <c>euse</c> now uses to show whether a -flag is set/unset and where all the flag has been set. The columns are as -follows -- +/-, set in the Environment, set in make.Conf, set in make.Defaults, -and set in make.Globals. The output looks like [+ECDG]. +There are 5 "columns" that <c>euse</c> now uses to show whether a +flag is set/unset and where all the flag has been set. The columns are as +follows -- +/-, set in the Environment, set in make.Conf, set in make.Defaults, +and set in make.Globals. The output looks like [+ECDG]. </note> <pre caption="Viewing all active USE flags"> @@ -563,9 +563,9 @@ </pre> <p> -Similarly you can use the <c>euse -a -g</c> command to only view active global -USE flags. The <c>euse -a -l</c> command does the same for active local USE -flags.<c>-g</c> & <c>-l</c> are suboptions to <c>euse</c> and need an +Similarly you can use the <c>euse -a -g</c> command to only view active global +USE flags. The <c>euse -a -l</c> command does the same for active local USE +flags.<c>-g</c> & <c>-l</c> are suboptions to <c>euse</c> and need an option before them (like <c>-a</c>) to function correctly. </p> @@ -583,15 +583,15 @@ </pre> <p> -We can also use <c>euse</c> to set or unset use flags. The commands used for -this are <c>euse -E flagname</c> (enable a flag) and <c>euse -D flagname</c> +We can also use <c>euse</c> to set or unset use flags. The commands used for +this are <c>euse -E flagname</c> (enable a flag) and <c>euse -D flagname</c> (disable a flag). </p> <warn> -Do not use the <c>euse -E</c> or <c>euse -D</c> commands by themselves (without -a flag). It will set/unset ALL USE flags in <c>/etc/make.conf</c>. Although a -backup is kept at <path>/etc/make.conf.euse_backup</path>, please be careful +Do not use the <c>euse -E</c> or <c>euse -D</c> commands by themselves (without +a flag). It will set/unset ALL USE flags in <c>/etc/make.conf</c>. Although a +backup is kept at <path>/etc/make.conf.euse_backup</path>, please be careful while using <c>euse -E</c> or <c>euse -D</c>. </warn> @@ -691,21 +691,21 @@ All prepared. Starting rebuild... emerge --oneshot --nodeps -p =app-cdr/k3b-0.11.14 =app-office/koffice-1.3.2 =app-office/lyx-1.3.4 \ =app-office/passepartout-0.2 =dev-lang/lua-5.0.2 =dev-ruby/fxruby-1.0.29 =media-libs/libao-0.8.5 \ - =media-libs/xine-lib-1_rc5-r3 =media-video/avidemux-2.0.26 =net-libs/loudmouth-0.16 + =media-libs/xine-lib-1_rc5-r3 =media-video/avidemux-2.0.26 =net-libs/loudmouth-0.16 These are the packages that I would merge, in order: Calculating dependencies ...done! -[ebuild R ] app-cdr/k3b-0.11.14 -[ebuild R ] app-office/koffice-1.3.2 -[ebuild R ] app-office/lyx-1.3.4 -[ebuild R ] app-office/passepartout-0.2 -[ebuild R ] dev-lang/lua-5.0.2 -[ebuild R ] dev-ruby/fxruby-1.0.29 -[ebuild R ] media-libs/libao-0.8.5 -[ebuild R ] media-libs/xine-lib-1_rc5-r3 -[ebuild R ] media-video/avidemux-2.0.26 -[ebuild R ] net-libs/loudmouth-0.16 +[ebuild R ] app-cdr/k3b-0.11.14 +[ebuild R ] app-office/koffice-1.3.2 +[ebuild R ] app-office/lyx-1.3.4 +[ebuild R ] app-office/passepartout-0.2 +[ebuild R ] dev-lang/lua-5.0.2 +[ebuild R ] dev-ruby/fxruby-1.0.29 +[ebuild R ] media-libs/libao-0.8.5 +[ebuild R ] media-libs/xine-lib-1_rc5-r3 +[ebuild R ] media-video/avidemux-2.0.26 +[ebuild R ] net-libs/loudmouth-0.16 Now you can remove -p (or --pretend) from arguments and re-run revdep-rebuild. </pre> @@ -761,7 +761,8 @@ <pre caption="Using eread"> $ <i>eread</i> -This is a list of portage log items. Choose a number to view that file or type q to quit. +This is a list of portage log items. Choose a number to view that file or type +q to quit. 1) app-portage:gentoolkit-0.2.4_pre2:20070320-000256.log 2) app-portage:gentoolkit-0.2.4_pre2:20070320-000258.log -- [email protected] mailing list
