aboutsummaryrefslogtreecommitdiff
path: root/doc/beam-cleaner.1in
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2012-06-01 17:38:44 +0300
committerSergey Poznyakoff <gray@gnu.org.ua>2012-06-01 18:55:50 +0300
commit1f1bc59f5347d162fc87cc09364fc4bcdad6d593 (patch)
tree092968b545576e6663fd442a1e5767580fb8db74 /doc/beam-cleaner.1in
parent2878881412e0f73c5f98ca4fe728ba8deca9087f (diff)
downloadbeam-1f1bc59f5347d162fc87cc09364fc4bcdad6d593.tar.gz
beam-1f1bc59f5347d162fc87cc09364fc4bcdad6d593.tar.bz2
Improve docs.
* NEWS: Update. * README: Rewrite. Provide enough documentation for startup. * doc/beam-cleaner.1in: New file. * doc/Makefile.am: Build and install beam-cleaner.1. * doc/beam-backup.1in: Fix the time-stamp-start variable. * doc/beam-restore.1in: Likewise. * doc/beam-s3.1in: Likewise. * doc/beam.conf.5in: Likewise. * backup.in: Mark with sh magic. * beam.in: Likewise. * lib/beam/common.in: Likewise. * lib/beam/fs.sh: Likewise. * lib/beam/mysql.sh: Likewise. * lib/beam/postgres.sh: Likewise. * lib/beam/s3.sh: Likewise. * restore.in: Likewise. * s3.in: Likewise.
Diffstat (limited to 'doc/beam-cleaner.1in')
-rw-r--r--doc/beam-cleaner.1in77
1 files changed, 77 insertions, 0 deletions
diff --git a/doc/beam-cleaner.1in b/doc/beam-cleaner.1in
new file mode 100644
index 0000000..ee3365d
--- /dev/null
+++ b/doc/beam-cleaner.1in
@@ -0,0 +1,77 @@
+.\" 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 "June 1, 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:

Return to:

Send suggestions and report system problems to the System administrator.