feb59a83c6713b678ab9ea3dbcb1fe811cae04f5
[openafs.git] / doc / man-pages / pod8 / bos_prune.pod
1 =head1 NAME
2
3 bos_prune - Removes obsolete files from /usr/afs/bin and /usr/afs/logs
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<bos prune> S<<< B<-server> <I<machine name>> >>> [B<-bak>] [B<-old>] [B<-core>]
11     [B<-all>] S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
12     [B<-help>]
13
14 B<bos p> S<<< B<-s> <I<machine name>> >>> [B<-b>] [B<-o>] [B<-co>] [B<-a>]
15     S<<< [B<-ce> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-h>]
16
17 =for html
18 </div>
19
20 =head1 DESCRIPTION
21
22 The B<bos prune> command removes files from the local disk of the server
23 machine named by the B<-server> argument, as specified by one or more of
24 the following flags provided on the command line:
25
26 =over 4
27
28 =item *
29
30 The B<-bak> flag removes all files from the F</usr/afs/bin> directory that
31 have a C<.BAK> extension.
32
33 =item *
34
35 The B<-old> flag removes all files from the F</usr/afs/bin> directory that
36 have a C<.OLD> extension.
37
38 =item *
39
40 The B<-core> flag removes all files from the F</usr/afs/logs> directory
41 that have a C<core.> prefix.
42
43 =item *
44
45 The B<-all> flag removes all three types of files at once.
46
47 =back
48
49 (If none of these flags are included, the command appears to succeed, but
50 removes no files at all.)
51
52 To display the timestamp on the current, C<.BAK>, and C<.OLD> versions of
53 one or more files, use the B<bos getdate> command.
54
55 =head1 OPTIONS
56
57 =over 4
58
59 =item B<-server> <I<machine name>>
60
61 Indicates the server machine from which to remove files. Identify the
62 machine by IP address or its host name (either fully-qualified or
63 abbreviated unambiguously). For details, see L<bos(8)>.
64
65 =item B<-bak>
66
67 Removes all files from the F</usr/afs/bin> directory that have a C<.BAK>
68 extension. Do not combine this flag and the B<-all> flag.
69
70 =item B<-old>
71
72 Removes all files from the F</usr/afs/bin> directory that have a C<.OLD>
73 extension. Do not combine this flag and the B<-all> flag.
74
75 =item B<-core>
76
77 Removes all files from the F</usr/afs/logs> directory that have a C<core.>
78 prefix. Do not combine this flag and the B<-all> flag.
79
80 =item B<-all>
81
82 Combines the effect of the B<-bak>, B<-old>, and B<-core> flags. Do not
83 combine this flag with any of those three.
84
85 =item B<-cell> <I<cell name>>
86
87 Names the cell in which to run the command. Do not combine this argument
88 with the B<-localauth> flag. For more details, see L<bos(8)>.
89
90 =item B<-noauth>
91
92 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
93 combine this flag with the B<-localauth> flag. For more details, see
94 L<bos(8)>.
95
96 =item B<-localauth>
97
98 Constructs a server ticket using a key from the local
99 F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
100 ticket to the BOS Server during mutual authentication. Do not combine this
101 flag with the B<-cell> or B<-noauth> options. For more details, see
102 L<bos(8)>.
103
104 =item B<-help>
105
106 Prints the online help for this command. All other valid options are
107 ignored.
108
109 =back
110
111 =head1 EXAMPLES
112
113 The following example removes all files from the F</usr/afs/bin> directory
114 on the machine C<fs3.example.com> that have a C<.BAK> or C<.OLD> extension.
115
116    % bos prune -server fs3.example.com -bak -old
117
118 The following example removes all files from the F</usr/afs/bin> directory
119 on the machine C<db2.example.com> that have a C<.BAK> or C<.OLD> extension,
120 and all files from the F</usr/afs/logs> directory that have a C<core.>
121 prefix.
122
123    % bos prune -server db2.example.com -all
124
125 =head1 PRIVILEGE REQUIRED
126
127 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
128 machine named by the B<-server> argument, or must be logged onto a server
129 machine as the local superuser C<root> if the B<-localauth> flag is
130 included.
131
132 The B<bos prune> command cannot be run against servers which are in
133 restricted mode.
134
135 =head1 SEE ALSO
136
137 L<KeyFile(5)>,
138 L<UserList(5)>,
139 L<bos(8)>,
140 L<bos_getdate(8)>
141
142 =head1 COPYRIGHT
143
144 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
145
146 This documentation is covered by the IBM Public License Version 1.0.  It was
147 converted from HTML to POD by software written by Chas Williams and Russ
148 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.