From: Paul Varner Date: Thu, 6 Jan 2011 14:35:09 +0000 (-0600) Subject: man page formatting cleanup. X-Git-Tag: gentoolkit-0.3.0~36 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=8d925c18b9694bff63eae4238eeac342a4589314;p=gentoolkit.git man page formatting cleanup. Loaded man pages into manedit and resaved. This has the effect of cleaning up the formatting, mainly properly escaping '-' characters. --- diff --git a/man/analyse.1 b/man/analyse.1 index 76044b8..b8db3e8 100644 --- a/man/analyse.1 +++ b/man/analyse.1 @@ -1,48 +1,48 @@ -.TH "ANALYSE" "22" "Febuary 2010" "GENTOOLKIT" +.TH "ANALYSE" "22" "Febuary 2010" "GENTOOLKIT" "" .SH "NAME" analyse \- Gentoo Installed Package Analysis Tool .SH "SYNOPSIS" -.BI "analyse " "[global-options] " "module " "[local-options]" "TARGET" +.BI "analyse " "[global\-options] " "module " "[local\-options]" "TARGET" .SH "DESCRIPTION" .B Analyse Is a collection of modules for analysing the state of installed Gentoo packages for USE flags or keywords used for installation, and their current masking status. -.br +.br It can also optionally (re)generate new /etc/portage/package.* files. .br -.br +.br .B CAUTION: This is beta software and is not yet feature complete. Some features, options or its name may change in the future. Any files that it generates are saved to your home directory and will not harm your system without effort on your part. -.br +.br .SH "GLOBAL OPTIONS" .HP .B \-h, \-\-help -.br +.br Output a help message. .HP .B \-q, \-\-quiet -.br +.br Be less verbose where possible. In some modules, this option can increase the output speed. .HP -.B \-C, \-\-no-color -.br +.B \-C, \-\-no\-color +.br Do not colorize output. .HP .B \-N, \-\-no\-pipe -.br +.br Turn off automatic pipe detection. Use this option if you do not want .B analyse To detect if the output is being directed to the screen or to another program and adjust color and verbosity accordingly. .HP .B \-V, \-\-version -.br +.br Display \fBGentoolkit\fP's version. Please include this in all bug reports. (see .B BUGS below) @@ -56,7 +56,7 @@ and \fImodule\fP is the long name. You can view the .B help message for a specific module by using -.BR "-h" ", " "--help " +.BR "\-h" ", " "\-\-help " as either a global option (after .B analyse and before the module name) or as a local option (after the module name). @@ -66,139 +66,139 @@ and before the module name) or as a local option (after the module name). Report on all installed packages for \fITARGET\fP. .P -.IR "TARGET" ":" +.I R "TARGET" ":" .HP .B use -.br +.br Will analyse the installed with USE flags for output results. .HP .B pkguse -.br +.br Will analyse the USE flags information from the installed pkg's 'PKGUSE' file which contains only flags settings from /etc/portage/package.use at the time of installation. .HP .B keywords -.br +.br Will analyse the recorded keywords for output results. .HP .B unmask -.br +.br Will analyse the installed packages and portage trees for pkgs that require unmasking and report them. -.br +.br .P -.IR "LOCAL OPTIONS" ":" +.I R "LOCAL OPTIONS" ":" .HP .B \-u, \-\-unset -.br +.br Will also include any USE flags used that were not enabled for some packages. .HP .B \-v, \-\-verebose -.br +.br Gives more detail about the results found and the current task being performed. .P -.IR "EXAMPLES" ":" +.I R "EXAMPLES" ":" .EX .HP -analyse a --verbose --unset use +analyse a \-\-verbose \-\-unset use .EE -.br -Report on all use flags used to install the packages. (--unset) Include in the report all flags +.br +Report on all use flags used to install the packages. (\-\-unset) Include in the report all flags that have been used but also were not set enabled for some packages. -(--verbose) Also list the packages that used the USE flag setting. +(\-\-verbose) Also list the packages that used the USE flag setting. The report will break down the useage and report the USE flag up to 3 times indicating its -setting {"+","-"," "= unset} prepended to the flag name. +setting {"+","\-"," "= unset} prepended to the flag name. It will also color the output, red = Disabled, blue = Enabled, plain text = unset -.br +.br .SS .BI "rebuild (r) [OPTIONS] TARGET" Create a list all packages for \fITARGET\fP settings that are needed for other than the default settings. -.IR "TARGET" ":" +.I R "TARGET" ":" .HP .B use -.br +.br Will analyse the USE flags for output results. .HP .B keywords -.br +.br Will analyse the keywords for output results. .HP .B unmask -.br +.br Will analyse the installed packages and portage trees for pkgs that require unmasking and produce output/a new /etc/portage/package.unmask file. .P -.IR "LOCAL OPTIONS" ":" +.I R "LOCAL OPTIONS" ":" .HP .B \-a, \-\-all -.br +.br Create files/output for all TARGET(s) found to need it. (not Implemented yet) .HP .B \-e, \-\-excact -.br +.br Will prepend the pkg with = as well as use the version information for the entries. -.br -eg.: =CAT/PKG-VER flag1 flag2 +.br +eg.: =CAT/PKG\-VER flag1 flag2 .HP .B \-p, \-\-pretend -.br +.br Sends the output to the screen instead of a file. .HP .B \-v, \-\-verebose -.br +.br Gives more detail about the results found and the current task being performed. .P -.IR "EXAMPLES" ":" +.I R "EXAMPLES" ":" .EX .HP -analyse rebuild -p use +analyse rebuild \-p use .EE -.br +.br Analyse the installed packages database and current system USE flag settings and output the results in the form of: -.br +.br -.br +.br .EX -CAT/PKG -flag1 -flag2 flag3 flag4... +CAT/PKG \-flag1 \-flag2 flag3 flag4... .SS .BI "clean (c) [OPTIONS] TARGET" Clean all packages for \fITARGET\fP settings that are found with obsolete settings for the current settings and pkg ebuild. (not Implemented yet) -.IR "TARGET" ":" +.I R "TARGET" ":" .HP .B use -.br +.br Will analyse the USE flags and /etc/portage/package.use file(s) for entries that are redundant or no longer used by the pkg. .HP .B keywords -.br +.br Will analyse the keywords and /etc/portage/package.keywords file(s) for entries that are no longer needed. .HP .B unmask -.br +.br Will analyse the installed packages, /etc/portage/package.unmask file(s) and portage trees for pkgs that no longer require unmasking. .P -.IR "LOCAL OPTIONS" ":" +.I R "LOCAL OPTIONS" ":" .HP .B \-a, \-\-all -.br +.br Clean files/output for all TARGET(s) found to need it. (not Implemented yet) .HP .B \-p, \-\-pretend -.br +.br Sends the output to the screen instead of a file. .HP .B \-v, \-\-verebose -.br +.br Gives more detail about the results found and the current task being performed. @@ -206,5 +206,5 @@ Gives more detail about the results found and the current task being performed. Submit bug reports to http://bugs.gentoo.org. .SH "AUTHORS" -.br +.br Brian Dolbec , 2010 diff --git a/man/eclean.1 b/man/eclean.1 index 651cc71..3177cb9 100644 --- a/man/eclean.1 +++ b/man/eclean.1 @@ -1,20 +1,20 @@ -.TH "eclean" "1" "0.4.1" "gentoolkit" +.TH "eclean" "1" "0.4.1" "gentoolkit" "" .SH "NAME" eclean \- A cleaning tool for Gentoo distfiles and binary packages. .SH "SYNOPSIS" -.LP +.LP .B eclean \fR[\fIglobal\-options\fR] ... <\fIactions\fR> \fR[\fIaction\-options\fR] ... -.LP +.LP .B eclean\-dist \fR[\fIglobal\-options, distfiles\-options\fR] ... -.LP +.LP .B eclean\-pkg \fR[\fIglobal\-options, packages\-options\fR] ... -.LP -.B eclean(-dist,-pkg) \fR[\fI\-\-help, \-\-version\fR] +.LP +.B eclean(\-dist,\-pkg) \fR[\fI\-\-help, \-\-version\fR] .SH "DESCRIPTION" \fBeclean\fP is small tool to remove obsolete portage sources files and binary packages. Used on a regular basis, it prevents your DISTDIR and PKGDIR directories to infinitely grow, while not deleting files which may still be useful. -.PP +.PP By default, eclean will protect all distfiles or binary packages corresponding to some ebuilds available in the Portage tree. This is the safest mode, since it will protect whatever may still be useful, for instance to downgrade a package without downloading @@ -22,7 +22,7 @@ its sources for the second time, or to reinstall a package you unmerge by mistak without recompiling it. Sure, it's also a mode in which your DISTDIR and PKGDIR will stay rather big (although still not growing infinitely). For the 'distfiles', this mode is also quite slow because it requiries some access to the whole Portage tree. -.PP +.PP If you use the \-\-destructive option, eclean will only protect files corresponding to some currently installed package (taking their exact version into account). It will save much more space, while still preserving sources files around for minor revision @@ -30,82 +30,82 @@ bumps, and binaries for reinstallation of corrupted packages. But it won't keep for less usual operations like downgrading or reinstalling an unmerged package. This is also the fastest execution mode (big difference for distfiles), and the one used by most other cleaning scripts around like yacleaner (at least in its version 0.3). -.PP +.PP Somewhere in the middle, adding the \-\-package\-names option when using \-\-destructive will protect files corresponding to all existing versions of installed packages. It will allow easy downgrading without recompilation or redownloading in case of trouble, but won't protect you against package uninstallation. -.PP +.PP In addition to this main modes, some options allow to declare a few special cases file protection rules: .IP o -\-\-time-limit is useful to protect files which are more recent than a given amount of time. +\-\-time\-limit is useful to protect files which are more recent than a given amount of time. .IP o -\-\-size-limit (for distfiles only) is useful if you want to protect files bigger than a given size. +\-\-size\-limit (for distfiles only) is useful if you want to protect files bigger than a given size. .IP o -\-\-fetch-restricted (for distfiles only) is useful to protect manually downloaded files. +\-\-fetch\-restricted (for distfiles only) is useful to protect manually downloaded files. But it's also very slow (again, it's a reading of the whole Portage tree data)... .IP o Finally, you can list some categories or package names to protect in exclusion files (see \fBEXCLUSION FILES\fP below). .SH "PARAMETERS" .SS "Global options" -.TP +.TP \fB\-C, \-\-nocolor\fP turn off colors on output -.TP +.TP \fB\-d, \-\-destructive\fP only keep the minimum for a reinstallation -.TP +.TP \fB\-e, \-\-exclude\-file=\fP path to the exclusion file \fB\fP is the absolute path to the exclusion file you want to use. When this option is not used, default paths are /etc/eclean/{packages,distfiles}.exclude (if they exist). Use /dev/null if you have such a file at it standard location and you want to temporary ignore it. -.TP +.TP \fB\-i, \-\-interactive\fP ask confirmation before deleting -.TP +.TP \fB\-n, \-\-package\-names\fP protect all versions (\-\-destructive only) -.TP +.TP \fB\-p, \-\-pretend\fP only display what would be cleaned -.TP +.TP \fB\-q, \-\-quiet\fP be as quiet as possible, only display errors -.TP -\fB\-t, \-\-time-limit=