117 lines
3.1 KiB
Groff
117 lines
3.1 KiB
Groff
.TH prtwash 1 "June 15, 2021" "prtwash 0.9" ""
|
|
.SH NAME
|
|
\fBprtwash \fP- a script to clean the port dirs in CRUX.
|
|
\fB
|
|
.SH SYNOPSIS
|
|
.nf
|
|
.fam C
|
|
\fBprtwash\fP [-p] [-s] [-d] [-t] [-a] <path> [<path> ...]
|
|
.fam T
|
|
.fi
|
|
.SH DESCRIPTION
|
|
\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 prtwash will NOT delete the following items
|
|
in a port directory:
|
|
.IP \(bu 3
|
|
The Pkgfile
|
|
.IP \(bu 3
|
|
The sources (as stated in the Pkgfile)
|
|
.IP \(bu 3
|
|
The built package
|
|
.IP \(bu 3
|
|
The .signature, .footprint, .32bit and .nostrip files
|
|
.IP \(bu 3
|
|
Additional files: README, FAQ, pre-install, post-install
|
|
.PP
|
|
All items not included in the previous list WILL be deleted
|
|
(e.g.: the 'work' dir of pkgmk, if present).
|
|
.PP
|
|
You can choose to delete some of the above passing the proper
|
|
option:
|
|
.TP
|
|
.B
|
|
-p
|
|
also removes the built package
|
|
.TP
|
|
.B
|
|
-s
|
|
also removes the sources
|
|
.TP
|
|
.B
|
|
-d
|
|
also remove the additional files: .signature, .footprint, .32bit
|
|
README, FAQ, pre/post-install
|
|
.TP
|
|
.B
|
|
-t
|
|
test mode: displays the target files without deleting
|
|
.TP
|
|
.B
|
|
-a
|
|
run in automatic mode: takes the port dirs from the
|
|
/etc/prt-get.conf file and do a recursive cleaning.
|
|
.PP
|
|
Misc options
|
|
.TP
|
|
.B
|
|
-h
|
|
Display usage information
|
|
.TP
|
|
.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;
|
|
doesn't really delete the files
|
|
.TP
|
|
.B
|
|
\fBprtwash\fP -a -p -s
|
|
now we're getting serious: removes all downoaded files
|
|
and built packages from the entire port tree
|
|
.TP
|
|
.B
|
|
\fBprtwash\fP -a -p -s -d
|
|
same as the above, but also
|
|
removes .signature, .footprint, README, etc
|
|
.TP
|
|
.B
|
|
\fBprtwash\fP -p -s /usr/ports/contrib/sitecopy
|
|
removes all downoaded files
|
|
and built packages from the sitecopy directory
|
|
.TP
|
|
.B
|
|
\fBprtwash\fP /usr/ports/contrib/*
|
|
does a default wash action on the contrib port tree
|
|
.SH AUTHORS
|
|
Simone Rota <sip at varlock dot com>, John McQuah <jmcquah at disroot dot org>
|
|
.SH SEE ALSO
|
|
\fBprtsweep\fP(1)
|