diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2012-07-14 22:09:59 +0300 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2012-07-14 22:13:40 +0300 |
commit | f0de8b85bf7fde9d0214428330c31056c30528c5 (patch) | |
tree | fbe97ec37676bc54060f88938d0a24ab8dd013e0 /doc/beam-list.1in | |
parent | 35212ddd3ceb7d3b20957b9ce6786f4ddd716bbe (diff) | |
download | beam-f0de8b85bf7fde9d0214428330c31056c30528c5.tar.gz beam-f0de8b85bf7fde9d0214428330c31056c30528c5.tar.bz2 |
Update the docs.
* beam.conf: Set PATH
* doc/.gitignore: Add new generated files.
* doc/Makefile.am: Build and install beam-list.1 and
beam-module.5.
* doc/beam-backup.1in: Update.
* doc/beam-list.1in: New file.
* doc/beam-module.5in: New file.
* doc/beam-restore.1in: Update.
* doc/beam.1in: Update.
* .gitignore: Update.
Diffstat (limited to 'doc/beam-list.1in')
-rw-r--r-- | doc/beam-list.1in | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/doc/beam-list.1in b/doc/beam-list.1in new file mode 100644 index 0000000..7acb95a --- /dev/null +++ b/doc/beam-list.1in @@ -0,0 +1,74 @@ +.\" 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-LIST 1 "July 14, 2012" "BEAM" "BEAM User Reference" +.SH NAME +beam-list \- list items included in backup +.SH SYNOPSIS +.B beam list +[\fB\-l\fR] [\fB\-\-number\fR] + +.B beam list +[\fB\-h\fR] [\fB\-\-help\fR] + +.B beam list +[\fB\-V\fR] [\fB\-\-version\fR] +.SH DESCRIPTION +The command +.B beam list +produces a list of items included in the backup. +.SH OPTIONS +.TP +.BR \-l , \-\-number +Produce a numbered list. +.TP +\fB\-h\fR, \fB\-\-help\fR +Display a short help summary. +.TP +\fB\-V\fR, \fB\-\-version\fR +Display program version. +.SH FILES +.TP +.BR @SYSCONFDIR@/beam.conf +Default configuration file. +.TP +.BR @LIBDIR@/beam +Backup module directory. Whenever a beam item of type \fBT\fR is +requested, \fBbeam\fR will attempt to load from this directory a +file named \fBT.sh\fR. This file provides methods and definitions +necessary to handle that particular item type. +.TP +.BR @LIBDIR@/beam/common.sh +Settings and definitions shared between this command, +.BR beam-backup (1) +and +.BR beam-restore (1). +.SH "SEE ALSO" +.BR beam (1), +.BR beam-restore (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: |