.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "BOS_PRUNE 8"
.TH BOS_PRUNE 8 2024-03-20 OpenAFS "AFS Command Reference"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
bos_prune \- Removes obsolete files from /usr/lib/openafs and /var/log/openafs
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBbos prune\fR \fB\-server\fR\ <\fImachine\ name\fR> [\fB\-bak\fR] [\fB\-old\fR] [\fB\-core\fR]
    [\fB\-all\fR] [\fB\-cell\fR\ <\fIcell\ name\fR>] [\fB\-noauth\fR] [\fB\-localauth\fR]
    [\fB\-help\fR]
.PP
\&\fBbos p\fR \fB\-s\fR\ <\fImachine\ name\fR> [\fB\-b\fR] [\fB\-o\fR] [\fB\-co\fR] [\fB\-a\fR]
    [\fB\-ce\fR\ <\fIcell\ name\fR>] [\fB\-n\fR] [\fB\-l\fR] [\fB\-h\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBbos prune\fR command removes files from the local disk of the server
machine named by the \fB\-server\fR argument, as specified by one or more of
the following flags provided on the command line:
.IP \(bu 4
The \fB\-bak\fR flag removes all files from the \fI/usr/lib/openafs\fR directory that
have a \f(CW\*(C`.BAK\*(C'\fR extension.
.IP \(bu 4
The \fB\-old\fR flag removes all files from the \fI/usr/lib/openafs\fR directory that
have a \f(CW\*(C`.OLD\*(C'\fR extension.
.IP \(bu 4
The \fB\-core\fR flag removes all files from the \fI/var/log/openafs\fR directory
that have a \f(CW\*(C`core.\*(C'\fR prefix.
.IP \(bu 4
The \fB\-all\fR flag removes all three types of files at once.
.PP
(If none of these flags are included, the command appears to succeed, but
removes no files at all.)
.PP
To display the timestamp on the current, \f(CW\*(C`.BAK\*(C'\fR, and \f(CW\*(C`.OLD\*(C'\fR versions of
one or more files, use the \fBbos getdate\fR command.
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-server\fR <\fImachine name\fR>" 4
.IX Item "-server <machine name>"
Indicates the server machine from which to remove files. Identify the
machine by IP address or its host name (either fully-qualified or
abbreviated unambiguously). For details, see \fBbos\fR\|(8).
.IP \fB\-bak\fR 4
.IX Item "-bak"
Removes all files from the \fI/usr/lib/openafs\fR directory that have a \f(CW\*(C`.BAK\*(C'\fR
extension. Do not combine this flag and the \fB\-all\fR flag.
.IP \fB\-old\fR 4
.IX Item "-old"
Removes all files from the \fI/usr/lib/openafs\fR directory that have a \f(CW\*(C`.OLD\*(C'\fR
extension. Do not combine this flag and the \fB\-all\fR flag.
.IP \fB\-core\fR 4
.IX Item "-core"
Removes all files from the \fI/var/log/openafs\fR directory that have a \f(CW\*(C`core.\*(C'\fR
prefix. Do not combine this flag and the \fB\-all\fR flag.
.IP \fB\-all\fR 4
.IX Item "-all"
Combines the effect of the \fB\-bak\fR, \fB\-old\fR, and \fB\-core\fR flags. Do not
combine this flag with any of those three.
.IP "\fB\-cell\fR <\fIcell name\fR>" 4
.IX Item "-cell <cell name>"
Names the cell in which to run the command. Do not combine this argument
with the \fB\-localauth\fR flag. For more details, see \fBbos\fR\|(8).
.IP \fB\-noauth\fR 4
.IX Item "-noauth"
Assigns the unprivileged identity \f(CW\*(C`anonymous\*(C'\fR to the issuer. Do not
combine this flag with the \fB\-localauth\fR flag. For more details, see
\&\fBbos\fR\|(8).
.IP \fB\-localauth\fR 4
.IX Item "-localauth"
Constructs a server ticket using a key from the local
\&\fI/etc/openafs/server/KeyFile\fR or \fI/etc/openafs/server/KeyFileExt\fR file.
The \fBbos\fR command interpreter presents the
ticket to the BOS Server during mutual authentication. Do not combine this
flag with the \fB\-cell\fR or \fB\-noauth\fR options. For more details, see
\&\fBbos\fR\|(8).
.IP \fB\-help\fR 4
.IX Item "-help"
Prints the online help for this command. All other valid options are
ignored.
.SH EXAMPLES
.IX Header "EXAMPLES"
The following example removes all files from the \fI/usr/lib/openafs\fR directory
on the machine \f(CW\*(C`fs3.example.com\*(C'\fR that have a \f(CW\*(C`.BAK\*(C'\fR or \f(CW\*(C`.OLD\*(C'\fR extension.
.PP
.Vb 1
\&   % bos prune \-server fs3.example.com \-bak \-old
.Ve
.PP
The following example removes all files from the \fI/usr/lib/openafs\fR directory
on the machine \f(CW\*(C`db2.example.com\*(C'\fR that have a \f(CW\*(C`.BAK\*(C'\fR or \f(CW\*(C`.OLD\*(C'\fR extension,
and all files from the \fI/var/log/openafs\fR directory that have a \f(CW\*(C`core.\*(C'\fR
prefix.
.PP
.Vb 1
\&   % bos prune \-server db2.example.com \-all
.Ve
.SH "PRIVILEGE REQUIRED"
.IX Header "PRIVILEGE REQUIRED"
The issuer must be listed in the \fI/etc/openafs/server/UserList\fR file on the
machine named by the \fB\-server\fR argument, or must be logged onto a server
machine as the local superuser \f(CW\*(C`root\*(C'\fR if the \fB\-localauth\fR flag is
included.
.PP
The \fBbos prune\fR command cannot be run against servers which are in
restricted mode.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBKeyFile\fR\|(5),
\&\fBKeyFileExt\fR\|(5),
\&\fBUserList\fR\|(5),
\&\fBbos\fR\|(8),
\&\fBbos_getdate\fR\|(8)
.SH COPYRIGHT
.IX Header "COPYRIGHT"
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
.PP
This documentation is covered by the IBM Public License Version 1.0.  It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.