diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/.gitignore | 4 | ||||
| -rw-r--r-- | doc/Makefile.am | 5 | ||||
| -rw-r--r-- | doc/beam-backup.1in | 4 | ||||
| -rw-r--r-- | doc/beam-cleaner.1in | 77 | ||||
| -rw-r--r-- | doc/beam-restore.1in | 4 | ||||
| -rw-r--r-- | doc/beam-s3.1in | 4 | ||||
| -rw-r--r-- | doc/beam.conf.5in | 10 |
7 files changed, 94 insertions, 14 deletions
diff --git a/doc/.gitignore b/doc/.gitignore index 772d3c8..b46e6f4 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -1,3 +1,5 @@ beam-backup.1 beam-restore.1 -backup.conf.5 +beam-cleanup.1 +beam-s3.1 +beam.conf.5 diff --git a/doc/Makefile.am b/doc/Makefile.am index 6396bd1..8619450 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,12 +1,13 @@ if COND_S3MOUNT S3=beam-s3.1 endif -man_MANS = beam.1 beam.conf.5 beam-backup.1 beam-restore.1 $(S3) +man_MANS = beam.1 beam.conf.5 beam-backup.1 beam-restore.1 beam-cleaner.1 $(S3) beam.1: beam.1in Makefile beam-backup.1: beam-backup.1in Makefile beam.conf.5: beam.conf.5in Makefile beam-restore.1: beam-restore.1in Makefile beam-s3.1: beam-s3.1in Makefile +beam-cleanup.1: beam-cleanup.1in Makefile EXTRA_DIST=beam.1in beam-backup.1in beam-restore.1in beam.conf.5in beam-s3.1in -CLEANFILES=beam.1 beam.conf.5 beam-backup.1 beam-restore.1 beam-s3.1 +CLEANFILES=beam.1 beam.conf.5 beam-backup.1 beam-restore.1 beam-s3.1 beam-cleanup.1 include $(top_srcdir)/Make.rules diff --git a/doc/beam-backup.1in b/doc/beam-backup.1in index 5ddb39a..162c522 100644 --- a/doc/beam-backup.1in +++ b/doc/beam-backup.1in @@ -14,7 +14,7 @@ .\" 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-BACKUP 1 "May 29, 2012" "BEAM" "BEAM User Reference" +.TH BEAM-BACKUP 1 "June 1, 2012" "BEAM" "BEAM User Reference" .SH NAME beam-backup \- create a back up. .SH SYNOPSIS @@ -206,7 +206,7 @@ Sergey Poznyakoff 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-start: ".TH [A-Z_][A-Z0-9_-]* [0-9] \"" .\" time-stamp-format: "%:B %:d, %:y" .\" time-stamp-end: "\"" .\" time-stamp-line-limit: 20 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: diff --git a/doc/beam-restore.1in b/doc/beam-restore.1in index 0152df5..348462a 100644 --- a/doc/beam-restore.1in +++ b/doc/beam-restore.1in @@ -14,7 +14,7 @@ .\" 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-RESTORE 1 "May 29, 2012" "BEAM" "BEAM User Reference" +.TH BEAM-RESTORE 1 "June 1, 2012" "BEAM" "BEAM User Reference" .SH NAME beam-restore \- restore file system from a backup. .SH SYNOPSIS @@ -130,7 +130,7 @@ Sergey Poznyakoff 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-start: ".TH [A-Z_][A-Z0-9_-]* [0-9] \"" .\" time-stamp-format: "%:B %:d, %:y" .\" time-stamp-end: "\"" .\" time-stamp-line-limit: 20 diff --git a/doc/beam-s3.1in b/doc/beam-s3.1in index 1779a9a..0b03a1d 100644 --- a/doc/beam-s3.1in +++ b/doc/beam-s3.1in @@ -14,7 +14,7 @@ .\" 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-S3 1 "May 28, 2012" "BBE" "BBE User Reference" +.TH BEAM-S3 1 "June 1, 2012" "BBE" "BBE User Reference" .SH NAME beam-s3 \- manage a backup s3 bucket .SH SYNOPSIS @@ -79,7 +79,7 @@ Sergey Poznyakoff 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-start: ".TH [A-Z_][A-Z0-9_-]* [0-9] \"" .\" time-stamp-format: "%:B %:d, %:y" .\" time-stamp-end: "\"" .\" time-stamp-line-limit: 20 diff --git a/doc/beam.conf.5in b/doc/beam.conf.5in index 0c38cb8..10e47e8 100644 --- a/doc/beam.conf.5in +++ b/doc/beam.conf.5in @@ -350,17 +350,17 @@ Defines the mailer program. The default is .sp .SH HOOKS Two special variables, called hooks, allow you to supply arbitrary -procedures to be run before and after backup. +commands to be run before and after backup. .TP .B prologue_hook -This variable contains a whitespace-separated list of the commands to -be invoked before starting backup (or restore). The commands are +This variable contains a whitespace-separated list of commands to +be invoked before starting backup (or restore). These commands are started in order of their appearance in the list and are called without arguments. By default, this variable is empty. .TP .B epilogue_hook -This variable contains a whitespace-separated list of the commands to -be invoked after the backup (or restore) has finished. The commands are +This variable contains a whitespace-separated list of commands to +be invoked after the backup (or restore) has finished. These commands are started in order of their appearance in the list and are called without arguments. By default, this variable is empty. .SH EXAMPLES |