1 .TH prtwash 1 "June 15, 2021" "prtwash 0.9" ""
2 .SH NAME
3 \fBprtwash \fP- a script to clean the port dirs in CRUX.
4 \fB
5 .SH SYNOPSIS
6 .nf
7 .fam C
8 \fBprtwash\fP [-p] [-s] [-d] [-t] [-a] <path> [<path> ...]
9 .fam T
10 .fi
11 .SH DESCRIPTION
12 \fBprtwash\fP is a bash script to clean the port tree of a CRUX
13 distribution. You can clean a single or multiple directories
14 or the entire port tree. With the given options it is possible to
15 choose what kind of files the program should delete.
16 A test mode is provided.
17 .PP
18 \fBprtwash\fP was inspired by Martin Opel's prtsweep script.
19 .SH OPTIONS
20 By default prtwash will NOT delete the following items
21 in a port directory:
22 .IP \(bu 3
23 The Pkgfile
24 .IP \(bu 3
25 The sources (as stated in the Pkgfile)
26 .IP \(bu 3
27 The built package
28 .IP \(bu 3
29 The .signature, .footprint, .32bit and .nostrip files
30 .IP \(bu 3
31 Additional files: README, FAQ, pre-install, post-install
32 .PP
33 All items not included in the previous list WILL be deleted
34 (e.g.: the 'work' dir of pkgmk, if present).
35 .PP
36 You can choose to delete some of the above passing the proper
37 option:
38 .TP
39 .B
40 -p
41 also removes the built package
42 .TP
43 .B
44 -s
45 also removes the sources
46 .TP
47 .B
48 -d
49 also remove the additional files: .signature, .footprint, .32bit
50 README, FAQ, pre/post-install
51 .TP
52 .B
53 -t
54 test mode: displays the target files without deleting
55 .TP
56 .B
57 -a
58 run in automatic mode: takes the port dirs from the
59 /etc/prt-get.conf file and do a recursive cleaning.
60 .PP
61 Misc options
62 .TP
63 .B
64 -h
65 Display usage information
66 .TP
67 .B
68 -v
69 Display version
70 .SH ENVIRONMENT
71 In automatic mode, \fBprtwash\fP gets a list of repositories from
72 /etc/prt-get.conf, and for each repository descends into the
73 individual port directories to read the associated Pkgfiles.
74 After reading the Pkgfile in light of any custom settings from
75 /etc/pkgmk.conf, \fBprtwash\fP will know the source filenames,
76 the package filename, and where those files are likely to be found.
77 .PP
78 If the directories potentially cluttered by pkgmk builds are shared
79 among many ports, e.g., by setting a nonempty PKGMK_SOURCE_DIR with
80 no reference to the port name, then \fBprtwash\fP will pause and
81 ask the user to confirm the wash. This gives users the chance to
82 consider whether a different tool like \fBprtsweep\fP is better
83 suited to the task they want performed.
84 .PP
85 If the directories potentially cluttered by pkgmk builds are
86 defined dynamically by port name (or unset), then \fBprtwash\fP
87 in automatic mode will proceed without user intervention.
88 .SH EXAMPLES
89 .TP
90 .B
91 \fBprtwash\fP -a -t
92 does a default wash action on the entire port tree;
93 doesn't really delete the files
94 .TP
95 .B
96 \fBprtwash\fP -a -p -s
97 now we're getting serious: removes all downoaded files
98 and built packages from the entire port tree
99 .TP
100 .B
101 \fBprtwash\fP -a -p -s -d
102 same as the above, but also
103 removes .signature, .footprint, README, etc
104 .TP
105 .B
106 \fBprtwash\fP -p -s /usr/ports/contrib/sitecopy
107 removes all downoaded files
108 and built packages from the sitecopy directory
109 .TP
110 .B
111 \fBprtwash\fP /usr/ports/contrib/*
112 does a default wash action on the contrib port tree
113 .SH AUTHORS
114 Simone Rota <sip at varlock dot com>, John McQuah <jmcquah at disroot dot org>
115 .SH SEE ALSO
116 \fBprtsweep\fP(1)
|
