.TH "eclean" "1" "0.1" "gentoolkit-0.???"
.SH "NAME"
eclean \- A cleaning tool for Gentoo distfiles and binary packages.
.SH "SYNOPSIS"
.B eclean \fR[\fIoptions\fR] [\fIactions\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, but will always keep files that may still be useful.
.SH "PARAMETERS"
.SS "Options"
.TP
\fB\-C, \-\-nocolor\fP		turn off colors on output
.TP
\fB\-i, \-\-interactive\fP	ask confirmation before deleting
.TP
\fB\-p, \-\-pretend\fP		only display what would be cleaned
.TP
\fB\-q, \-\-quiet\fP		be as quiet as possible, only display errors
.TP
\fB\-h, \-\-help\fP		display the help screen
.TP
\fB\-V, \-\-version\fP		display version informations
.SS "Actions"
.TP
\fBdistfiles\fR
Clean files from /usr/portage/distfiles (or whatever else is your DISTDIR in /etc/make.conf).  
The candidate for cleaning are files that are no more required by any ebuild in the portage
tree or your portage overlays.  This policy prevent an infinite growth of this directory but 
ensure that you can still cancel a package update or unmerge without redownloading its sources.
.TP
\fBpackages\fR
Clean files from /usr/portage/packages (or whatever else is your PKGDIR in /etc/make.conf).
The candidate for cleaning are binary packages that have no more a corresponding ebuild in the
portage tree or your portage overlays.  This is particularly useful if you have enabled the
"buildpkg" FEATURES flag in your /etc/make.conf.
.SH "EXAMPLES"
.TP
Clean distfiles only, with per file confirmation prompt:
.B # eclean \-i distfiles
.TP
Check which binary packages could be removed, with a no-color display:
.B # eclean \-Cp packages
.TP
From a crontab, silently clean both distfiles and binary packages every sunday at 1am:
.B 0 1 * * sun \ \ eclean \-q distfiles packages
.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. 
.SH "AUTHORS"
Thomas de Grenier de Latour <degrenier@easyconnect.fr>, April 2004
.SH "SEE ALSO"
The Gentoo forum thread that gave it birth:
.br
http://forums.gentoo.org/viewtopic.php?t=3011
.TP