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