1 files changed, 87 insertions, 0 deletions
diff --git a/doc/beam-s3.1in b/doc/beam-s3.1in
new file mode 100644
index 0000000..1779a9a
--- /dev/null
+++ b/doc/beam-s3.1in
@@ -0,0 +1,87 @@
+.\" 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-S3 1 "May 28, 2012" "BBE" "BBE User Reference"
+.SH NAME
+beam-s3 \- manage a backup s3 bucket
+.SH SYNOPSIS
+.B beam s3
+mount
+
+.B beam s3
+umount
+
+.B beam s3
+status
+
+.B beam s3
+[\fB\-h\fR] [\fB\-\-help\fR] [\fB\-V\fR] [\fB\-\-version\fR]
+.SH DESCRIPTION
+The
+.B beam-s3
+command mounts or unmounts the \fBs3\fR bucket configured by the
+.B backup_bucket_name
+variable in
+.BR beam.conf (5).
+.SH ARGUMENTS
+.TP
+.B mount
+Mount the bucket.
+.TP
+.BR umount , unmount
+Unmount the bucket.
+.TP
+.B status
+Show bucket status.
+.SH OPTIONS
+For consistency with other programs, the following options are understood:
+.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/common.sh
+A library of common
+.B beam
+functions.
+.TP
+.BR @LIBDIR@/beam/s3.sh
+The
+.B s3
+support library.
+.SH "SEE ALSO"
+.BR beam (1),
+.BR beam-backup (1),
+.BR beam-restore (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:
+