Merge from genscripts r447: brian.dolbec

Update the eclean manpage with the additional options.
Fix a few grammar mistakes.
Add a section explaining the new deprecated pkg reporting.

svn path=/trunk/gentoolkit/; revision=800

diff --git a/man/eclean.1 b/man/eclean.1
index 19fb7092f7467bff8d037c2ea471bf68bc766693..651cc7164c5a4b0e07e41c1520b7c315d67c82f1 100644 (file)
--- a/man/eclean.1
+++ b/man/eclean.1
@@ -21,7 +21,7 @@ whatever may still be useful, for instance to downgrade a package without downlo
 its sources for the second time, or to reinstall a package you unmerge by mistake
 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 quit slow mode because it requiries some access to the whole Portage tree.
+mode is also quite slow because it requiries some access to the whole Portage tree.
 .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
@@ -76,6 +76,8 @@ Units are: y (years), m (months), w (weeks), d (days) and h (hours).
 .TP
 \fB\-h, \-\-help\fP                 display the help screen
 .TP
+\fB\-v, \-\-verbose\fP              display more verbose messages during processing
+.TP
 \fB\-V, \-\-version\fP              display version informations
 .SS "Actions"
 .TP
@@ -126,9 +128,16 @@ if a line contains a package name with an exclamation mark in front ("!sys\-apps
 then this package will be excluded from protection.  This is only useful if the category 
 itself was protected.
 .IP o
-for distfiles protection, a line can also a filename to protect. This is useful if you have
-there some files which are not registered by the ebuilds, like OpenOffice.org i18n files
-("helpcontent_33_unix.tgz" for instance).
+for distfiles protection, a line can also be a filename to protect. This is useful if you have
+some files which are not registered by the ebuilds, like OpenOffice.org i18n files
+("helpcontent_33_unix.tgz" for instance).  Another example are sources you want to protect
+that do not have an ebuild in the tree or any currently installed overlays.
+.IP o
+eclean will also inform you of any deprecated installed packages that are on your system as well
+as if it was able to locate the source filename(s) in order to protect them.  If you want to protect
+all installed distfile sources, run elcelan in pretend mode first.  Then check which sources it was
+not able to find the filename(s) for and add entries for them in the distfiles.exclude file before
+running eclean again.
 .LP
 By default, if it exists, /etc/eclean/packages.exclude (resp. distfiles.exclude) will be use
 when action is "packages" (resp. "distfiles").  This can be overide with the \-\-exclude\-file
@@ -156,9 +165,14 @@ From a crontab, silently clean packages in the safest mode, and then distfiles i
 mode but protecting files less than a week old, every sunday at 1am:
 .br
 .B 0 1 * * sun \ \ eclean \-C \-q packages ; eclean \-C \-q \-d \-t1w distfiles
+.SH "NOTE"
+.TP
+While running and searching distfiles for cleaning, elcean will report any deprecated packages
+it finds installed on your system.  Those sources may not be protected if the SRC_URI is not recorded
+in the installed package database.  The SRC_URI is no longer recorded by recent portage/pkgcore versions.
 .".SH "BUGS"
 .".TP
-."The policy used to decide wether a distfile can be removed or not relies on the SRC_URI variables ."of ebuilds.  It means that if an ebuild uses files that are not part of its SRC_URI, eclean will ."probably remove them.  This are ebuilds bugs, please report them as such on ."http://bugs.gentoo.org. 
+."The policy used to decide if a distfile can be removed or not relies on the SRC_URI variables ."of ebuilds.  It means that if an ebuild uses files that are not part of its SRC_URI, eclean will ."probably remove them.  This are ebuilds bugs, please report them as such on ."http://bugs.gentoo.org. 
 .".TP
 ."In safest mode (default, without the \-\-destructive option), this script can be very slow.  There
 ."is not much to do about it without hacking outside of the portage API.
@@ -171,3 +185,7 @@ The bug report requesting eclean inclusion in gentoolkit:
 .B http://bugs.gentoo.org/show_bug.cgi?id=33877
 .SH "AUTHORS"
 Thomas de Grenier de Latour (tgl) <degrenier@easyconnect.fr>
+.br
+modular re-write by:
+.br
+Brian Dolbec (dol-sen) <brian.dolbec@gmail.com>