aboutsummaryrefslogtreecommitdiff
path: root/doc/beam-module.5in
diff options
context:
space:
mode:
Diffstat (limited to 'doc/beam-module.5in')
-rw-r--r--doc/beam-module.5in30
1 files changed, 15 insertions, 15 deletions
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

Return to:

Send suggestions and report system problems to the System administrator.