summaryrefslogtreecommitdiffabout
path: root/doc/beam-s3.1in
blob: 68dc66b854ef6378b8988ca5836ccf19da562113 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
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 "October 24, 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:

Return to:

Send suggestions and report system problems to the System administrator.