Imported Upstream version 3.3.2
[debian/amanda] / man / amfetchdump.8
index a2a3bc0e25372e42613e374e5f3dbb6378b1f4ee..b039c3721341e161409da6112d2b6743007ab17f 100644 (file)
+'\" t
 .\"     Title: amfetchdump
-.\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
-.\"      Date: 05/14/2008
-.\"    Manual: 
-.\"    Source: 
+.\"    Author: John Stange <building@nap.edu>
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 07/25/2012
+.\"    Manual: System Administration Commands
+.\"    Source: Amanda 3.3.2
+.\"  Language: English
 .\"
-.TH "AMFETCHDUMP" "8" "05/14/2008" "" ""
+.TH "AMFETCHDUMP" "8" "07/25/2012" "Amanda 3\&.3\&.2" "System Administration Commands"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
 .ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
 .SH "NAME"
-amfetchdump - extract backup images from multiple Amanda tapes.
+amfetchdump \- extract backup images from multiple Amanda tapes\&.
 .SH "SYNOPSIS"
-.HP 12
-\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]...
+.HP \w'\fBamfetchdump\fR\ 'u
+\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] [\-\-decrypt | \-\-no\-decrypt | \-\-server\-decrypt | \-\-client\-decrypt] [\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
-\fIhostname\.diskname\.datestamp\.dumplevel\fR
+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
 \fB\-p\fR
 .RS 4
 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)\.
+\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\-h\fR
+.RS 4
+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\fR
+\fB\-d\fR \fIdevice_or_changer\fR
 .RS 4
-Restore from this tape device instead of the default\.
+Restore from this device or changer instead of the default, prompting for each volume\&.
 .RE
 .PP
 \fB\-O\fR \fIdirectory\fR
 .RS 4
-Output restored files to this directory, instead of to the current working directory\.
+Output restored files to this directory, instead of to the current working directory\&.
 .RE
 .PP
 \fB\-c\fR
 .RS 4
-Compress output, fastest method available\.
+Compress output, fastest method available\&.
 .RE
 .PP
 \fB\-C\fR
 .RS 4
-Compress output, smallest file size 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\-w\fR
+\fB\-\-server\-decompress\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\.
-.sp
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.br
-Note
-This requires at least double the size of your dump in free disk space, in order to build the final assembled dumpfile\.
-
-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\.
+Do the decompression only if the compression was done on the server\&.
 .RE
 .PP
-\fB\-n\fR
+\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
-Do not reassemble split dump files at all, just restore each piece as an individual file\.
+Always do the decryption, this is the default\&.
 .RE
 .PP
-\fB\-s\fR
+\fB\-\-no\-decrypt\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\.
+Never do the decryption\&.
 .RE
 .PP
-\fB\-b\fR \fIblocksize\fR
+\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\-l\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\.
+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\-a\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\&.
+.RE
+.PP
+\fB\-n\fR
+.RS 4
+Do not reassemble split dump files at all, just restore each piece as an individual file\&.
 .RE
 .PP
 \fB\-o\fR \fIconfigoption\fR
 .RS 4
 See the "\fBCONFIGURATION OVERRIDE\fR" section in
-\fBamanda\fR(8)\.
+\fBamanda\fR(8)\&.
 .RE
 .SH "EXAMPLES"
 .PP
 All the examples here assume your configuration is called
-\fISetA\fR\.
+\fISetA\fR\&.
 .PP
-Here\'s a simple case, restoring all known dumps of the host vanya to the current working directory\.
-.sp
-.RS 4
+Here\*(Aqs a simple case, restoring all known dumps of the host vanya to the current working directory\&.
 .nf
 $ amfetchdump SetA vanya
 .fi
-.RE
 .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\.
-.sp
-.RS 4
+as well, to automatically extract the dump\&.
 .nf
 $ amfetchdump \-p SetA vanya /home 20051020 | gtar \-xvpf \-
 .fi
-.RE
-.sp
 .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)
-instead\.
-.SH "AUTHOR"
-.PP
-John Stange,
-<building@nap\.edu>, National Academies Press
-.PP
-Ian Turner,
-<ian@zmanda\.com>: XML\-conversion
+instead\&.
 .SH "SEE ALSO"
 .PP
 \fBamanda\fR(8),
+\fBamanda-match\fR(7),
 \fBamadmin\fR(8),
-\fBamrestore\fR(8),
-\fBtar\fR(1),
-\fBrestore\fR(8),
-\fI\%http://wiki.zmanda.com\fR
+\fBamrestore\fR(8)
+.PP
+The Amanda Wiki:
+: http://wiki.zmanda.com/
+.SH "AUTHORS"
+.PP
+\fBJohn Stange\fR <\&building@nap\&.edu\&>
+.RS 4
+National Academies Press
+.RE
+.PP
+\fBIan Turner\fR <\&ian@zmanda\&.com\&>
+.RS 4
+Zmanda, Inc\&. (http://www\&.zmanda\&.com)
+.RE