aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/beam-backup.1in34
-rw-r--r--doc/beam-cleaner.1in20
-rw-r--r--doc/beam-list.1in14
-rw-r--r--doc/beam-module.5in30
-rw-r--r--doc/beam-restore.1in18
-rw-r--r--doc/beam-s3.1in12
-rw-r--r--doc/beam.1in18
-rw-r--r--doc/beam.conf.5in24
8 files changed, 85 insertions, 85 deletions
diff --git a/doc/beam-backup.1in b/doc/beam-backup.1in
index 83d1ab5..be45a44 100644
--- a/doc/beam-backup.1in
+++ b/doc/beam-backup.1in
@@ -14,9 +14,9 @@
.\" 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 "July 14, 2012" "BEAM" "BEAM User Reference"
+.TH BEAM\-BACKUP 1 "October 24, 2012" "BEAM" "BEAM User Reference"
.SH NAME
-beam-backup \- create a back up.
+beam\-backup \- create a back up.
.SH SYNOPSIS
.B beam backup
[\fB\-vnN\fR] [\fB\-\-verbose\fR] [\fB\-l\fR \fIFILE\fR]\
@@ -32,7 +32,7 @@ beam-backup \- create a back up.
[\fB\-V\fR] [\fB\-\-version\fR]
.SH DESCRIPTION
The
-.B beam-backup
+.B beam\-backup
command creates full or incremental backups of file systems and other
objects described in its configuration file
.BR beam.conf .
@@ -55,7 +55,7 @@ the following pattern:
.sp
.nf
.in +2
-.BR ITEM - WEEK - ROUND - LEVEL . SUFFIX
+.BR ITEM \- WEEK \- ROUND \- LEVEL . SUFFIX
.in
.fi
.sp
@@ -172,14 +172,14 @@ and level 2 backups on Tuesdays, Thursdays and Saturdays.
.nf
.in +2
# Create one full backup weekly.
-0 3 * * sun beam backup --round 0 --level 0
+0 3 * * sun beam backup \-\-round 0 \-\-level 0
# Create incremental backups daily.
-0 3 * * mon beam backup --round 0 --level 1
-0 3 * * tue beam backup --round 0 --level 2
-0 3 * * wed beam backup --round 1 --level 1
-0 3 * * thu beam backup --round 1 --level 2
-0 3 * * fri beam backup --round 2 --level 1
-0 3 * * sat beam backup --round 2 --level 2
+0 3 * * mon beam backup \-\-round 0 \-\-level 1
+0 3 * * tue beam backup \-\-round 0 \-\-level 2
+0 3 * * wed beam backup \-\-round 1 \-\-level 1
+0 3 * * thu beam backup \-\-round 1 \-\-level 2
+0 3 * * fri beam backup \-\-round 2 \-\-level 1
+0 3 * * sat beam backup \-\-round 2 \-\-level 2
.in
.fi
.sp
@@ -196,14 +196,14 @@ necessary to handle that particular item type.
.TP
.BR @LIBDIR@/beam/common.sh
Settings and definitions shared between
-.BR beam-backup ,
-.BR beam-restore (1),
+.BR beam\-backup ,
+.BR beam\-restore (1),
and
-.BR beam-list (1).
+.BR beam\-list (1).
.SH "SEE ALSO"
.BR beam (1),
-.BR beam-restore (1),
-.BR beam-list (1),
+.BR beam\-restore (1),
+.BR beam\-list (1),
.BR beam.conf (5).
.SH AUTHORS
Sergey Poznyakoff
@@ -211,7 +211,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
index ee3365d..36f2de7 100644
--- a/doc/beam-cleaner.1in
+++ b/doc/beam-cleaner.1in
@@ -14,26 +14,26 @@
.\" 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"
+.TH BEAM\-CLEANER 1 "October 24, 2012" "BEAM" "BEAM User Reference"
.SH NAME
-beam-cleaner \- clean up old backup files.
+beam\-cleaner \- clean up old backup files.
.SH SYNOPSIS
-.B beam-cleaner
+.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
+.B beam\-cleaner
[\fB\-h\fR] [\fB\-\-help\fR]
.SH DESCRIPTION
-.B Beam-cleaner
+.B Beam\-cleaner
is an auxiliary utility run by
-.BR beam-backup (1)
+.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)
+.BR beam\-backup (1)
to determine them.
.PP
It deletes those files which are older than \fBN\fR weeks (\fBN\fR being
@@ -42,7 +42,7 @@ supplied with the
option).
.PP
Any files with names not matching the
-.BR beam-backup (1)
+.BR beam\-backup (1)
naming scheme are ignored.
.SH OPTIONS
.TP
@@ -62,7 +62,7 @@ Do nothing, print what would have been done.
Print a terse help list.
.SH "SEE ALSO"
.BR beam (1),
-.BR beam-backup (1),
+.BR beam\-backup (1),
.BR beam.conf (5).
.SH AUTHORS
Sergey Poznyakoff
@@ -70,7 +70,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-list.1in b/doc/beam-list.1in
index 7acb95a..0614e81 100644
--- a/doc/beam-list.1in
+++ b/doc/beam-list.1in
@@ -14,9 +14,9 @@
.\" 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-LIST 1 "July 14, 2012" "BEAM" "BEAM User Reference"
+.TH BEAM\-LIST 1 "October 24, 2012" "BEAM" "BEAM User Reference"
.SH NAME
-beam-list \- list items included in backup
+beam\-list \- list items included in backup
.SH SYNOPSIS
.B beam list
[\fB\-l\fR] [\fB\-\-number\fR]
@@ -53,13 +53,13 @@ necessary to handle that particular item type.
.TP
.BR @LIBDIR@/beam/common.sh
Settings and definitions shared between this command,
-.BR beam-backup (1)
+.BR beam\-backup (1)
and
-.BR beam-restore (1).
+.BR beam\-restore (1).
.SH "SEE ALSO"
.BR beam (1),
-.BR beam-restore (1),
-.BR beam-backup (1),
+.BR beam\-restore (1),
+.BR beam\-backup (1),
.BR beam.conf (5).
.SH AUTHORS
Sergey Poznyakoff
@@ -67,7 +67,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-module.5in b/doc/beam-module.5in
index f65ce52..79e3114 100644
--- a/doc/beam-module.5in
+++ b/doc/beam-module.5in
@@ -14,9 +14,9 @@
.\" 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-MODULE 5 "July 15, 2012" "BEAM" "BEAM Programmer Reference"
+.TH BEAM\-MODULE 5 "July 15, 2012" "BEAM" "BEAM Programmer Reference"
.SH NAME
-beam-module \- format of
+beam\-module \- format of
.BR beam (1)
modules
.SH DESCRIPTION
@@ -31,7 +31,7 @@ and restore from such backups. However, there are special kinds of
data that cannot be reliably backed up using this method. An example
of these are SQL databases. Simply archiving the database files while
the database engine is running is not likely to produce a reliable
-backup -- such files will most probably be in inconsistent state,
+backup \- such files will most probably be in inconsistent state,
because of eventual transactions not being finished at the time of the
backup. While stopping the database for the duration of the backup
could produce a consistent backup, it is usually not an option. The
@@ -112,8 +112,8 @@ fs_check() {
eval root=\$${1}_dir
eval files=\$${1}_files
- test -z "$root" && rc=1 && error "${1}_dir not set"
- test -z "$files" && rc=1 && error "${1}_files not set"
+ test \-z "$root" && rc=1 && error "${1}_dir not set"
+ test \-z "$files" && rc=1 && error "${1}_files not set"
return $rc
}
.in
@@ -128,7 +128,7 @@ prefixed by
This function is used by the
.B beam list
command (see
-.BR beam-list (1)).
+.BR beam\-list (1)).
The following is a simplified example from the
.B fs
@@ -159,13 +159,13 @@ module illustrates this:
fs_backup() {
local basename text root files exclude addopts s e
- basename=$1-$week-$round-$level
+ basename=$1\-$week\-$round\-$level
eval dir=\$${1}_dir files=\$${1}_files
$dry_run tar $verbose $taroptions \\
- -f $backup_archive_dir/$basename.$tar_suffix \\
- --listed=$backup_snapshot_dir/$basename.db \\
- -C $dir $files
+ \-f $backup_archive_dir/$basename.$tar_suffix \\
+ \-\-listed=$backup_snapshot_dir/$basename.db \\
+ \-C $dir $files
}
.TP
.BR \fIname\fB_restore( item )
@@ -186,7 +186,7 @@ conversion
.TP
.B round
Number of this backup round. See
-.BR beam-backup (1),
+.BR beam\-backup (1),
for a detailed discussion.
.TP
.B level
@@ -213,9 +213,9 @@ The
mode is enabled by the
.BR \-\-dry\-run " or " \-n
option to
-.BR beam-backup (1)
+.BR beam\-backup (1)
and
-.BR beam-restore (1).
+.BR beam\-restore (1).
.TP
.B verbose
In verbose mode, the value of this variable is
@@ -227,7 +227,7 @@ constructing their command lines, e.g.:
.sp
.nf
.in +2
- $dry_run tar $verbose -c -f $archive .
+ $dry_run tar $verbose \-c \-f $archive .
.in
.fi
.sp
@@ -271,7 +271,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-restore.1in b/doc/beam-restore.1in
index 59c5069..bbbfbba 100644
--- a/doc/beam-restore.1in
+++ b/doc/beam-restore.1in
@@ -14,9 +14,9 @@
.\" 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 "July 14, 2012" "BEAM" "BEAM User Reference"
+.TH BEAM\-RESTORE 1 "October 24, 2012" "BEAM" "BEAM User Reference"
.SH NAME
-beam-restore \- restore file system from a backup.
+beam\-restore \- restore file system from a backup.
.SH SYNOPSIS
.B beam restore
[\fB\-cntv\fR] [\fB\-\-confirm\fR] [\fB\-C\fR \fIDIR\fR]\
@@ -53,7 +53,7 @@ detail in the section
below.
.PP
Once the configuration loaded, the
-.B beam-restore
+.B beam\-restore
command determines which backup archives to use for restoring. Unless
being requested otherwise by the command line options, the utility
selects the most recent set of backup files.
@@ -120,14 +120,14 @@ necessary to handle that particular item type.
.TP
.BR @LIBDIR@/beam/common.sh
Settings and definitions shared between
-.BR beam-backup (1),
-.BR beam-restore ,
+.BR beam\-backup (1),
+.BR beam\-restore ,
and
-.BR beam-list (1).
+.BR beam\-list (1).
.SH "SEE ALSO"
.BR beam (1),
-.BR beam-backup (1),
-.BR beam-list (1),
+.BR beam\-backup (1),
+.BR beam\-list (1),
.BR beam.conf (5)
.SH AUTHORS
Sergey Poznyakoff
@@ -135,7 +135,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 0b03a1d..68dc66b 100644
--- a/doc/beam-s3.1in
+++ b/doc/beam-s3.1in
@@ -14,9 +14,9 @@
.\" 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 "June 1, 2012" "BBE" "BBE User Reference"
+.TH BEAM\-S3 1 "October 24, 2012" "BBE" "BBE User Reference"
.SH NAME
-beam-s3 \- manage a backup s3 bucket
+beam\-s3 \- manage a backup s3 bucket
.SH SYNOPSIS
.B beam s3
mount
@@ -31,7 +31,7 @@ status
[\fB\-h\fR] [\fB\-\-help\fR] [\fB\-V\fR] [\fB\-\-version\fR]
.SH DESCRIPTION
The
-.B beam-s3
+.B beam\-s3
command mounts or unmounts the \fBs3\fR bucket configured by the
.B backup_bucket_name
variable in
@@ -70,8 +70,8 @@ The
support library.
.SH "SEE ALSO"
.BR beam (1),
-.BR beam-backup (1),
-.BR beam-restore (1),
+.BR beam\-backup (1),
+.BR beam\-restore (1),
.BR beam.conf (5).
.SH AUTHORS
Sergey Poznyakoff
@@ -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.1in b/doc/beam.1in
index 8da0298..fc15064 100644
--- a/doc/beam.1in
+++ b/doc/beam.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 1 "July 14, 2012" "BEAM" "BEAM User Reference"
+.TH BEAM 1 "October 24, 2012" "BEAM" "BEAM User Reference"
.SH NAME
beam \- a backup manager
.SH SYNOPSIS
@@ -86,15 +86,15 @@ configuration file, backup item definitions and module system, see
.TP
.B backup
Create a backup. See
-.BR beam-backup (1).
+.BR beam\-backup (1).
.TP
.B restore
Restore files from backup. See
-.BR beam-restore (1).
+.BR beam\-restore (1).
.TP
.B list
List items included in the backup. See
-.BR beam-list (1).
+.BR beam\-list (1).
.TP
.B s3
Mount or unmount a backup s3 bucket. This command is available only
@@ -103,7 +103,7 @@ if
was configured with the
.B \-\-with-s3
option. See
-.BR beam-s3 (1).
+.BR beam\-s3 (1).
.TP
.BR help " " \fIcommand\fR
Display help page for a particular \fIcommand\fR.
@@ -128,10 +128,10 @@ If defined, this variable supplies full pathname of the configuration
file to use instead of the default
.BR @SYSCONFDIR@/beam.conf .
.SH "SEE ALSO"
-.BR beam-backup (1),
-.BR beam-restore (1),
-.BR beam-s3 (1),
-.BR beam-module (5),
+.BR beam\-backup (1),
+.BR beam\-restore (1),
+.BR beam\-s3 (1),
+.BR beam\-module (5),
.BR beam.conf (5).
.SH AUTHORS
Sergey Poznyakoff
diff --git a/doc/beam.conf.5in b/doc/beam.conf.5in
index 572db3b..c519fef 100644
--- a/doc/beam.conf.5in
+++ b/doc/beam.conf.5in
@@ -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.CONF 5 "July 15, 2012" "BEAM" "BEAM User Reference"
+.TH BEAM.CONF 5 "October 24, 2012" "BEAM" "BEAM User Reference"
.SH NAME
beam.conf \- configuration file for
.B BEAM
@@ -77,7 +77,7 @@ are retained. Empty value or zero means never delete the backups.
This variable is used by
.BR backup (1),
which calls
-.BR backup-cleaner (1)
+.BR backup\-cleaner (1)
if it is set.
.SH S3 SETUP
To keep archives in a
@@ -133,7 +133,7 @@ file names to reflect it. For example:
.sp
.nf
.in +2
-backup_tar_options="-j"
+backup_tar_options="\-j"
backup_suffix="tar.bz2"
.in
.fi
@@ -397,11 +397,11 @@ following headers are generated:
.BR From ,
.BR To ,
.BR Subject ,
-.BR X-Beam-Items ,
-.BR X-Beam-Round ,
+.BR X\-Beam\-Items ,
+.BR X\-Beam\-Round ,
and
-.BR X-Beam-Level .
-The three \fBX-\fR headers contain the backed up
+.BR X\-Beam\-Level .
+The three \fBX\-\fR headers contain the backed up
items (as set in the
.B backup_items
variable), backup round and backup level numbers, correspondingly.
@@ -419,7 +419,7 @@ Defines the mailer program and its arguments. The default is
.sp
.nf
.in +2
-/usr/sbin/sendmail -oi -t -F $backup_sender_email
+/usr/sbin/sendmail \-oi \-t \-F $backup_sender_email
.in
.fi
.sp
@@ -464,7 +464,7 @@ and the PostreSQL database
.nf
.in +2
# Request bzip2 compression:
-backup_tar_options="-j"
+backup_tar_options="\-j"
# Modify file name suffix accordingly
backup_suffix="tar.bz2"
# Write data to \fB/dev/rmt1\fR on a remote machine:
@@ -498,9 +498,9 @@ Beam Automatic Backup"
.sp
.SH "SEE ALSO"
.BR beam (1),
-.BR beam-restore (1),
-.BR beam-backup (1),
-.BR beam-cleaner (1).
+.BR beam\-restore (1),
+.BR beam\-backup (1),
+.BR beam\-cleaner (1).
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"

Return to:

Send suggestions and report system problems to the System administrator.