.\" This file is part of BEAM -*- nroff -*-
.\" Copyright (C) 2012 Sergey Poznyakoff
.\"
.\" BEAM is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3, or (at your option)
.\" any later version.
.\"
.\" BEAM is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with BEAM.  If not, see <http://www.gnu.org/licenses/>.
.\"
.TH BEAM\-CLEANER 1 "October 24, 2012" "BEAM" "BEAM User Reference"
.SH NAME
beam\-cleaner \- clean up old backup files.
.SH SYNOPSIS
.B beam\-cleaner
[\fB\-s\fR \fISUF\fR] [\fB\-r\fR \fIN\fs] [\fB\-vn\fR] \
 [\fB\-\-suffix\fR \fISUF\fR] [\fB\-\-retain\fR \fIN\fR] \
 [\fB\-\-verbose\fR] [\fB\-\-dry\-run\fR] \fBDIR\fR

.B beam\-cleaner
[\fB\-h\fR] [\fB\-\-help\fR]
.SH DESCRIPTION
.B Beam\-cleaner
is an auxiliary utility run by
.BR beam\-backup (1)
to remove outdated backup or snapshot files from
.BR DIR .
The tool measures file creation dates in weeks, from the beginning of
year and relies on file naming convention described in
.BR beam\-backup (1)
to determine them.
.PP
It deletes those files which are older than \fBN\fR weeks (\fBN\fR being
supplied with the
.B \-\-retain
option).
.PP
Any files with names not matching the
.BR beam\-backup (1)
naming scheme are ignored.
.SH OPTIONS
.TP
\fB\-s\fR, \fB\-\-suffix\fR \fISUF\fR
Consider only file names ending in \fBSUF\fR.
.TP
\fB\-r\fR, \fB\-\-retain\fR \fIN\fS
Retain \fIN\fR last weeks of backups (default 3).
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Verbosely list what is being done.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
Do nothing, print what would have been done.
.TP
\fB\-h\fR, \fB\-\-help\fR
Print a terse help list.
.SH "SEE ALSO"
.BR beam (1),
.BR beam\-backup (1),
.BR beam.conf (5).
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
Report bugs to <@PACKAGE_BUGREPORT@>.
.\" Local variables:
.\" eval: (add-hook 'write-file-hooks 'time-stamp)
.\" time-stamp-start: ".TH [A-Z_][A-Z0-9_\\-]* [0-9] \""
.\" time-stamp-format: "%:B %:d, %:y"
.\" time-stamp-end: "\""
.\" time-stamp-line-limit: 20
.\" end: