PageRenderTime 6ms CodeModel.GetById 2ms app.highlight 1ms RepoModel.GetById 1ms app.codeStats 0ms

/man/backup-manager-upload.8

http://github.com/sukria/Backup-Manager
Unknown | 234 lines | 234 code | 0 blank | 0 comment | 0 complexity | 058f529c0b549bb832651d4002c489aa MD5 | raw file
  1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
  2.\"
  3.\" Standard preamble:
  4.\" ========================================================================
  5.de Sh \" Subsection heading
  6.br
  7.if t .Sp
  8.ne 5
  9.PP
 10\fB\\$1\fR
 11.PP
 12..
 13.de Sp \" Vertical space (when we can't use .PP)
 14.if t .sp .5v
 15.if n .sp
 16..
 17.de Vb \" Begin verbatim text
 18.ft CW
 19.nf
 20.ne \\$1
 21..
 22.de Ve \" End verbatim text
 23.ft R
 24.fi
 25..
 26.\" Set up some character translations and predefined strings.  \*(-- will
 27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
 28.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
 29.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
 30.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
 31.\" nothing in troff, for use with C<>.
 32.tr \(*W-
 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 34.ie n \{\
 35.    ds -- \(*W-
 36.    ds PI pi
 37.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
 38.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
 39.    ds L" ""
 40.    ds R" ""
 41.    ds C` ""
 42.    ds C' ""
 43'br\}
 44.el\{\
 45.    ds -- \|\(em\|
 46.    ds PI \(*p
 47.    ds L" ``
 48.    ds R" ''
 49'br\}
 50.\"
 51.\" Escape single quotes in literal strings from groff's Unicode transform.
 52.ie \n(.g .ds Aq \(aq
 53.el       .ds Aq '
 54.\"
 55.\" If the F register is turned on, we'll generate index entries on stderr for
 56.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
 57.\" entries marked with X<> in POD.  Of course, you'll have to process the
 58.\" output yourself in some meaningful fashion.
 59.ie \nF \{\
 60.    de IX
 61.    tm Index:\\$1\t\\n%\t"\\$2"
 62..
 63.    nr % 0
 64.    rr F
 65.\}
 66.el \{\
 67.    de IX
 68..
 69.\}
 70.\"
 71.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 72.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 73.    \" fudge factors for nroff and troff
 74.if n \{\
 75.    ds #H 0
 76.    ds #V .8m
 77.    ds #F .3m
 78.    ds #[ \f1
 79.    ds #] \fP
 80.\}
 81.if t \{\
 82.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
 83.    ds #V .6m
 84.    ds #F 0
 85.    ds #[ \&
 86.    ds #] \&
 87.\}
 88.    \" simple accents for nroff and troff
 89.if n \{\
 90.    ds ' \&
 91.    ds ` \&
 92.    ds ^ \&
 93.    ds , \&
 94.    ds ~ ~
 95.    ds /
 96.\}
 97.if t \{\
 98.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 99.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
104.\}
105.    \" troff and (daisy-wheel) nroff accents
106.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113.ds ae a\h'-(\w'a'u*4/10)'e
114.ds Ae A\h'-(\w'A'u*4/10)'E
115.    \" corrections for vroff
116.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118.    \" for low resolution devices (crt and lpr)
119.if \n(.H>23 .if \n(.V>19 \
120\{\
121.    ds : e
122.    ds 8 ss
123.    ds o a
124.    ds d- d\h'-1'\(ga
125.    ds D- D\h'-1'\(hy
126.    ds th \o'bp'
127.    ds Th \o'LP'
128.    ds ae ae
129.    ds Ae AE
130.\}
131.rm #[ #] #H #V #F C
132.\" ========================================================================
133.\"
134.IX Title "BACKUP-MANAGER-UPLOAD 8"
135.TH BACKUP-MANAGER-UPLOAD 8 "2009-02-01" "perl v5.10.0" "backup-manager-upload"
136.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents.
138.if n .ad l
139.nh
140.SH "NAME"
141backup\-manager\-upload \- Multiprotocol uploader for backup\-manager.
142.SH "SYNOPSIS"
143.IX Header "SYNOPSIS"
144backup-manager-upload [options] date
145.SH "DESCRIPTION"
146.IX Header "DESCRIPTION"
147\&\fBbackup-manager-upload\fR will upload all the archives generated on the given 
148date to the specified host with either ftp or scp.
149It's also possible to use this program for uploading data to an Amazon S3 account.
150Some metadates are available like \*(L"today\*(R" or \*(L"yesterday\*(R".
151.SH "REQUIRED ARGS"
152.IX Header "REQUIRED ARGS"
153.IP "\fB\-\-mode=\fR\fItransfer-mode\fR" 4
154.IX Item "--mode=transfer-mode"
155Select the transfer mode to use : ftp, scp, or s3.
156.IP "\fB\-\-host=\fR\fIhostname1,hostname2,...,hostnameN\fR" 4
157.IX Item "--host=hostname1,hostname2,...,hostnameN"
158Select a list of remote hosts to connect to.
159.IP "\fB\-\-user=\fR\fIusername\fR" 4
160.IX Item "--user=username"
161Select the user to use for connection.
162.SH "OPTIONAL ARGS"
163.IX Header "OPTIONAL ARGS"
164.IP "\fB\-\-password=\fR\fIpassword\fR" 4
165.IX Item "--password=password"
166Select the ftp user's password (only needed for ftp transfers).
167.IP "\fB\-\-key=\fR\fIpath_to_private_key\fR" 4
168.IX Item "--key=path_to_private_key"
169Select the ssh private key file to use when opening the ssh session for scp transfer.
170Obviously, this is only needed for scp transfer mode.
171If you don't specify a key file, the user's default private key will be used.
172.IP "\fB\-\-directory=\fR\fIdirectory\fR" 4
173.IX Item "--directory=directory"
174Select the location on the remote host where files will be uploaded.
175Default is /backup/uploads.
176.IP "\fB\-\-bucket=\fR\fIbucket\fR" 4
177.IX Item "--bucket=bucket"
178Sets the bucket name for the Amazon S3 service backup into.
179.IP "\fB\-\-root=\fR\fIdirectory\fR" 4
180.IX Item "--root=directory"
181Select the local directory where files are.
182Default is /var/archives
183.IP "\fB\-\-gpg\-recipient=\fR\fIgpg-recipient\fR" 4
184.IX Item "--gpg-recipient=gpg-recipient"
185Select the gpg public key for encryptiong the archives when uploading
186with the method ssh-gpg. This can be a short or long key id or a
187descriptive name. The precise syntax is described in the gpg man page.
188.IP "\fB\-\-list\fR" 4
189.IX Item "--list"
190Just list the files to upload.
191.IP "\fB\-\-ftp\-purge\fR" 4
192.IX Item "--ftp-purge"
193Purge the remote directory before uploading files in \s-1FTP\s0 mode.
194.IP "\fB\-\-s3\-purge\fR" 4
195.IX Item "--s3-purge"
196Purge the remote directory before uploading files in \s-1FTP\s0 mode.
197.IP "\fB\-\-ssh\-purge\fR" 4
198.IX Item "--ssh-purge"
199Purge the remote directory before uploading files in \s-1SSH\s0 mode.
200.IP "\fB\-\-verbose\fR" 4
201.IX Item "--verbose"
202Flag to enable verbose mode.
203.IP "\fBdate\fR" 4
204.IX Item "date"
205Date pattern to select some files to upload, can be a valid date (\s-1YYYYMMDD\s0) or 'today' or 'yesterday'.
206.SH "ERROR CODES"
207.IX Header "ERROR CODES"
208If something goes wrong during an upload, backup-manager-upload will exit 
209with a non null value. In such a case every error messages are sent to 
210\&\s-1STDERR\s0.
211.PP
212Here are the possible error codes:
213.IP "bad command line (wrong arguments) : 10" 4
214.IX Item "bad command line (wrong arguments) : 10"
215.PD 0
216.IP "\s-1FTP\s0 transfer failure : 20" 4
217.IX Item "FTP transfer failure : 20"
218.IP "\s-1SCP\s0 transfer failure : 21" 4
219.IX Item "SCP transfer failure : 21"
220.IP "S3 transfer failure : 22" 4
221.IX Item "S3 transfer failure : 22"
222.IP "Unknown upload method: 23" 4
223.IX Item "Unknown upload method: 23"
224.PD
225.SH "SEE ALSO"
226.IX Header "SEE ALSO"
227\&\fIbackup\-manager\fR\|(3)
228.SH "AUTHORS"
229.IX Header "AUTHORS"
230Alexis Sukrieh \- main code and design
231.PP
232Brad Dixon \- Amazon S3 upload method
233.PP
234Jan Metzger \- ssh-gpg upload method