lintian doesn't like orphan packages with uploaders...
[debian/amanda] / man / amfetchdump.8
index af28b2e34b619d943c6ab534903e8e5b73964b37..10fe5eb48f477e3555c0094319df494437996794 100644 (file)
+'\" t
 .\"     Title: amfetchdump
 .\"    Author: John Stange <building@nap.edu>
-.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
-.\"      Date: 01/22/2009
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 01/10/2013
 .\"    Manual: System Administration Commands
-.\"    Source: Amanda 2.6.1
+.\"    Source: Amanda 3.3.3
 .\"  Language: English
 .\"
-.TH "AMFETCHDUMP" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
+.TH "AMFETCHDUMP" "8" "01/10/2013" "Amanda 3\&.3\&.3" "System Administration Commands"
 .\" -----------------------------------------------------------------
-.\" * (re)Define some macros
+.\" * Define some portability stuff
 .\" -----------------------------------------------------------------
 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" toupper - uppercase a string (locale-aware)
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de toupper
-.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
-\\$*
-.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" SH-xref - format a cross-reference to an SH section
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de SH-xref
-.ie n \{\
-.\}
-.toupper \\$*
-.el \{\
-\\$*
-.\}
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" SH - level-one heading that works better for non-TTY output
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de1 SH
-.\" put an extra blank line of space above the head in non-TTY output
-.if t \{\
-.sp 1
-.\}
-.sp \\n[PD]u
-.nr an-level 1
-.set-an-margin
-.nr an-prevailing-indent \\n[IN]
-.fi
-.in \\n[an-margin]u
-.ti 0
-.HTML-TAG ".NH \\n[an-level]"
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-\." make the size of the head bigger
-.ps +3
-.ft B
-.ne (2v + 1u)
-.ie n \{\
-.\" if n (TTY output), use uppercase
-.toupper \\$*
-.\}
-.el \{\
-.nr an-break-flag 0
-.\" if not n (not TTY), use normal case (not uppercase)
-\\$1
-.in \\n[an-margin]u
-.ti 0
-.\" if not n (not TTY), put a border/line under subheading
-.sp -.6
-\l'\n(.lu'
-.\}
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" SS - level-two heading that works better for non-TTY output
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de1 SS
-.sp \\n[PD]u
-.nr an-level 1
-.set-an-margin
-.nr an-prevailing-indent \\n[IN]
-.fi
-.in \\n[IN]u
-.ti \\n[SN]u
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.ps \\n[PS-SS]u
-\." make the size of the head bigger
-.ps +2
-.ft B
-.ne (2v + 1u)
-.if \\n[.$] \&\\$*
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" BB/BE - put background/screen (filled box) around block of text
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de BB
-.if t \{\
-.sp -.5
-.br
-.in +2n
-.ll -2n
-.gcolor red
-.di BX
-.\}
-..
-.de EB
-.if t \{\
-.if "\\$2"adjust-for-leading-newline" \{\
-.sp -1
-.\}
-.br
-.di
-.in
-.ll
-.gcolor
-.nr BW \\n(.lu-\\n(.i
-.nr BH \\n(dn+.5v
-.ne \\n(BHu+.5v
-.ie "\\$2"adjust-for-leading-newline" \{\
-\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
-.\}
-.el \{\
-\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
-.\}
-.in 0
-.sp -.5v
-.nf
-.BX
-.in
-.sp .5v
-.fi
-.\}
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" BM/EM - put colored marker in margin next to block of text
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de BM
-.if t \{\
-.br
-.ll -2n
-.gcolor red
-.di BX
-.\}
-..
-.de EM
-.if t \{\
-.br
-.di
-.ll
-.gcolor
-.nr BH \\n(dn
-.ne \\n(BHu
-\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
-.in 0
-.nf
-.BX
-.in
-.fi
-.\}
-..
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
 .\" -----------------------------------------------------------------
 .\" * MAIN CONTENT STARTS HERE *
 .\" -----------------------------------------------------------------
-.SH "Name"
-amfetchdump \- extract backup images from multiple \fIAmanda\fR tapes\&.
-.SH "Synopsis"
-.fam C
+.SH "NAME"
+amfetchdump \- extract backup images from multiple Amanda tapes\&.
+.SH "SYNOPSIS"
 .HP \w'\fBamfetchdump\fR\ 'u
-\fBamfetchdump\fR [\-pcClawns] [\-d\ \fIdevice\fR] [\-O\ \fIdirectory\fR] [\-b\ \fIblocksize\fR] \fIconfig\fR \fIhostname\fR [\fIdisk\fR\ [\ \fIdate\fR\ [\ \fIlevel\fR\ [\ \fIhostname\fR\ [\&.\&.\&.]\ ]\ ]\ ]] [\-o\ \fIconfigoption\fR]...
-.fam
+\fBamfetchdump\fR [\-c | \-C | \-l] [\-p | \-n] [\-a] [\-O\ \fIdirectory\fR] [\-d\ \fIdevice\fR] [\-h | \-\-header\-file\ \fIfilename\fR | \-\-header\-fd\ \fIfd\fR] [\-\-decompress | \-\-no\-decompress | \-\-server\-decompress | \-\-client\-decompress] [\-\-extract\ \-\-directory\fI\ directory\fR\ [\-\-data\-path\fI\ amanda|directtcp\fR]\ [\-\-application\-property\ \fINAME=VALUE\fR]*] [\-\-decrypt | \-\-no\-decrypt | \-\-server\-decrypt | \-\-client\-decrypt] [\-\-exact_match] [\fB\-o\fR\ \fIconfigoption\fR...] \fIconfig\fR \fIhostname\fR [\fIdisk\fR\ [\ \fIdate\fR\ [\ \fIlevel\fR\ [\ \fIhostname\fR\ [\&.\&.\&.]\ ]\ ]\ ]]
 .SH "DESCRIPTION"
 .PP
 \fBAmfetchdump\fR
-pulls one or more matching dumps from tape or from the holding disk, handling the reassembly of multi\-tape split dump files as well as any tape autochanger operations\&.
+pulls one or more matching dumps from tape or from the holding disk, handling the reassembly of multi\-tape split dump files as well as any tape autochanger operations\&. The dump are by default decompressed and decrypted\&.
 .PP
-It will automatically use the logs created by
-\fBamdump\fR(8)
-to locate available dumps on tape, in the same way that the
+It will automatically use the Amanda catalog to locate available dumps on tape, in the same way that the
 \fBfind\fR
 feature of
 \fBamadmin\fR(8)
-lists available dumps\&. If these logs are unavailable, it can search tape\-by\-tape to find what it needs, and can generate new logs to serve as an emergency tape inventory\&.
+lists available dumps\&.
 .PP
 The
 \fIhostname\fR,
 \fIdiskname\fR,
 \fIdatestamp\fR, and
 \fIlevel\fR
-dump pattern\-matching works as in
-\fBamrestore\fR(8), with the added requirement that at minimum a
+dump specifications are further described in
+\fBamanda-match\fR(7)\&. Note that at minimum a
 \fIhostname\fR
-must be specified when not in inventory mode\&.
+must be specified\&.
 .PP
 Unless
 \fB\-p\fR
 is used, backup images are extracted to files in the current directory named:
 .PP
+If a changer error occurs, or the
+\fB\-d\fR
+option is given, then amfetchdump prompts for each required volume\&.
+.PP
 \fIhostname\&.diskname\&.datestamp\&.dumplevel\fR
 .SH "OPTIONS"
 .PP
@@ -209,9 +70,24 @@ Pipe exactly one complete dump file to
 \fIstdout\fR, instead of writing the file to disk\&. This will restore only the first matching dumpfile (where "first" is determined by the dump log search facility)\&.
 .RE
 .PP
-\fB\-d\fR \fIdevice\fR
+\fB\-h\fR
 .RS 4
-Restore from this tape device instead of the default\&.
+Output the amanda header as a 32K block to same output as the image\&.
+.RE
+.PP
+\fB\-\-header\-fd\fR \fIfd\fR
+.RS 4
+Output the amanda header to the numbered file descriptor\&.
+.RE
+.PP
+\fB\-\-header\-file\fR \fIfilename\fR
+.RS 4
+Output the amanda header to the filename\&.
+.RE
+.PP
+\fB\-d\fR \fIdevice_or_changer\fR
+.RS 4
+Restore from this device or changer instead of the default, prompting for each volume\&.
 .RE
 .PP
 \fB\-O\fR \fIdirectory\fR
@@ -229,56 +105,94 @@ Compress output, fastest method available\&.
 Compress output, smallest file size method available\&.
 .RE
 .PP
-\fB\-l\fR
+\fB\-\-decompress\fR
 .RS 4
-Leave dumps in the compressed/uncompressed state in which they were found on tape\&. By default,
-\fBamfetchdump\fR
-will automatically uncompress when restoring\&.
+Always do the decompression, this is the default\&.
 .RE
 .PP
-\fB\-a\fR
+\fB\-\-no\-decompress\fR
 .RS 4
-Assume that all tapes are already available, via tape changer or otherwise, instead of prompting the operator to ensure that all tapes are loaded\&.
+Never do the decompression\&.
+.RE
+.PP
+\fB\-\-server\-decompress\fR
+.RS 4
+Do the decompression only if the compression was done on the server\&.
+.RE
+.PP
+\fB\-\-client\-decompress\fR
+.RS 4
+Do the decompression only if the compression was done on the client\&.
+.RE
+.PP
+\fB\-\-decrypt\fR
+.RS 4
+Always do the decryption, this is the default\&.
+.RE
+.PP
+\fB\-\-no\-decrypt\fR
+.RS 4
+Never do the decryption\&.
+.RE
+.PP
+\fB\-\-server\-decrypt\fR
+.RS 4
+Do the decryption only if the encryption was done on the server\&.
+.RE
+.PP
+\fB\-\-client\-decrypt\fR
+.RS 4
+Do the decryption only if the encryption was done on the client\&.
+.RE
+.PP
+\fB\-\-exact\-match\fR
+.RS 4
+The host and disk are parsed as exact values
 .RE
 .PP
-\fB\-w\fR
+\fB\-\-extract\fR
 .RS 4
-Wait to put split dumps together until all chunks have been restored\&. Normally,
-\fBamfetchdump\fR
-will attempt to read pieces of a split file from tape in order, so that it can assemble them simply by appending each file to the first\&. This option disables the appending behavior, and instead restores each piece as an individual file and reassembles them only after all have been restored\&.
-.if n \{\
+Extract the backup on the server in the
+\fIdirectory\fR
+directory\&.
+.RE
+.PP
+\fB\-\-directory\fR \fIdirectory\fR
+.RS 4
+Where to extract the backup with the
+\fB\-\-extract\fR
+option\&.
 .sp
-.\}
+Warning: All files in that directory can be removed\&.
+.RE
+.PP
+\fB\-\-data\-path\fR amanda|directtcp
 .RS 4
-.BM yellow
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.br
-.ps +1
-\fBNote\fR
-.ps -1
-.br
-This requires at least double the size of your dump in free disk space, in order to build the final assembled dumpfile\&.
-.sp .5v
-.EM yellow
+The data path to use with
+\fB\-\-extract\fR, the default is to use the fatest data path\&.
 .RE
-This behavior is implicitly invoked in circumstances where knowing the location of all dumps on tape in advance is not possible, such as when you are restoring without log files\&.
+.PP
+\fB\-\-application\-property\fR \fINAME=VALUE\fR
+.RS 4
+Application property to send to the application with
+\fB\-\-extract\&.\fR
 .RE
 .PP
-\fB\-n\fR
+\fB\-l\fR
 .RS 4
-Do not reassemble split dump files at all, just restore each piece as an individual file\&.
+Leave dumps in the compressed/uncompressed and encrypted/unencrypted state in which they were found on tape\&. It is a synonym for
+\fB\-\-no\-decompression\fR
+\fB\-\-no\-decryption\fR
 .RE
 .PP
-\fB\-s\fR
+\fB\-a\fR
 .RS 4
-Do not fast\-forward straight to needed files on tape\&. This will slow down most restores substantially\&. Only use this option if your tape drive does not properly support the fast\-forward operation\&.
+Assume that all tapes are already available, via tape changer or otherwise, instead of prompting the operator to ensure that all tapes are loaded\&.
 .RE
 .PP
-\fB\-b\fR \fIblocksize\fR
+\fB\-n\fR
 .RS 4
-Force a particular block size when reading from tapes\&. This value will usually be autodetected, and should not normally need to be set\&.
+Do not reassemble split dump files at all, just restore each piece as an individual file\&.
 .RE
 .PP
 \fB\-o\fR \fIconfigoption\fR
@@ -291,12 +205,12 @@ See the "\fBCONFIGURATION OVERRIDE\fR" section in
 All the examples here assume your configuration is called
 \fISetA\fR\&.
 .PP
-Here\'s a simple case, restoring all known dumps of the host vanya to the current working directory\&.
+Here\*(Aqs a simple case, restoring all known dumps of the host vanya to the current working directory\&.
 .nf
 $ amfetchdump SetA vanya
 .fi
 .PP
-A more likely scenario involves restoring a particular dump from a particular date\&. We\'ll pipe this one to
+A more likely scenario involves restoring a particular dump from a particular date\&. We\*(Aqll pipe this one to
 \fBGNU\-tar\fR
 as well, to automatically extract the dump\&.
 .nf
@@ -305,7 +219,7 @@ $ amfetchdump \-p SetA vanya /home 20051020 | gtar \-xvpf \-
 .SH "CAVEATS"
 .PP
 \fBAmfetchdump\fR
-is dependent on accessing your server\'s config, tape changer, and (normally) dump logs\&. As such, it\'s not necessarily the most useful tool when those have all been wiped out and you desperately need to pull things from your tape\&. Pains have been taken to make it as capable as possible, but for seriously minimialist restores, look to
+is dependent on accessing your server\*(Aqs config, tape changer, and (normally) dump logs\&. As such, it\*(Aqs not necessarily the most useful tool when those have all been wiped out and you desperately need to pull things from your tape\&. Pains have been taken to make it as capable as possible, but for seriously minimialist restores, look to
 \fBamrestore\fR(8)
 or
 \fBdd\fR(8)
@@ -313,12 +227,13 @@ instead\&.
 .SH "SEE ALSO"
 .PP
 \fBamanda\fR(8),
+\fBamanda-match\fR(7),
 \fBamadmin\fR(8),
-\fBamrestore\fR(8),
-\fBtar\fR(1),
-\fBrestore\fR(8),
-: http://wiki.zmanda.com
-.SH "Authors"
+\fBamrestore\fR(8)
+.PP
+The Amanda Wiki:
+: http://wiki.zmanda.com/
+.SH "AUTHORS"
 .PP
 \fBJohn Stange\fR <\&building@nap\&.edu\&>
 .RS 4
@@ -327,5 +242,5 @@ National Academies Press
 .PP
 \fBIan Turner\fR <\&ian@zmanda\&.com\&>
 .RS 4
-Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])
+Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 .RE