diff options
Diffstat (limited to 'prtwash.1')
| -rw-r--r-- | prtwash.1 | 37 |
1 files changed, 27 insertions, 10 deletions
@@ -1,7 +1,6 @@ -." Text automatically generated by txt2man-1.4.7 -.TH prtwash 1 "October 15, 2020" "prtwash 0.8" "" +.TH prtwash 1 "June 15, 2021" "prtwash 0.9" "" .SH NAME -\fBprtwash \fP- a script to clean the port dirs in CRUX Linux. +\fBprtwash \fP- a script to clean the port dirs in CRUX. \fB .SH SYNOPSIS .nf @@ -10,15 +9,15 @@ .fam T .fi .SH DESCRIPTION -\fBprtwash\fP is a bash script to clean the port tree of the CRUX -Linux distribution. You can clean a single or multiple directories +\fBprtwash\fP is a bash script to clean the port tree of a CRUX +distribution. You can clean a single or multiple directories or the entire port tree. With the given options it is possible to choose what kind of files the program should delete. A test mode is provided. .PP \fBprtwash\fP was inspired by Martin Opel's prtsweep script. .SH OPTIONS -By default prtsweep will NOT delete the following items +By default prtwash will NOT delete the following items in a port directory: .IP \(bu 3 The Pkgfile @@ -32,7 +31,7 @@ The .signature, .footprint, .32bit and .nostrip files Additional files: README, FAQ, pre-install, post-install .PP All items not included in the previous list WILL be deleted -(ie: the 'work' dir of pkgmk, if present). +(e.g.: the 'work' dir of pkgmk, if present). .PP You can choose to delete some of the above passing the proper option: @@ -68,12 +67,30 @@ Display usage information .B -v Display version +.SH ENVIRONMENT +In automatic mode, \fBprtwash\fP gets a list of repositories from +/etc/prt-get.conf, and for each repository descends into the +individual port directories to read the associated Pkgfiles. +After reading the Pkgfile in light of any custom settings from +/etc/pkgmk.conf, \fBprtwash\fP will know the source filenames, +the package filename, and where those files are likely to be found. +.PP +If the directories potentially cluttered by pkgmk builds are shared +among many ports, e.g., by setting a nonempty PKGMK_SOURCE_DIR with +no reference to the port name, then \fBprtwash\fP will pause and +ask the user to confirm the wash. This gives users the chance to +consider whether a different tool like \fBprtsweep\fP is better +suited to the task they want performed. +.PP +If the directories potentially cluttered by pkgmk builds are +defined dynamically by port name (or unset), then \fBprtwash\fP +in automatic mode will proceed without user intervention. .SH EXAMPLES .TP .B \fBprtwash\fP -a -t does a default wash action on the entire port tree; -donsn't really delete the files +doesn't really delete the files .TP .B \fBprtwash\fP -a -p -s @@ -82,7 +99,7 @@ and built packages from the entire port tree .TP .B \fBprtwash\fP -a -p -s -d -same as tha above, but also +same as the above, but also removes .signature, .footprint, README, etc .TP .B @@ -94,6 +111,6 @@ and built packages from the sitecopy directory \fBprtwash\fP /usr/ports/contrib/* does a default wash action on the contrib port tree .SH AUTHORS -Simone Rota <sip@varlock.com> +Simone Rota <sip at varlock dot com>, John McQuah <jmcquah at disroot dot org> .SH SEE ALSO \fBprtsweep\fP(1) |