lintian doesn't like orphan packages with uploaders...
[debian/amanda] / man / amfetchdump.8
index 4d333869a165693a29fdeb938fa0ede0e519527a..10fe5eb48f477e3555c0094319df494437996794 100644 (file)
-.\"Generated by db2man.xsl. Don't modify this, modify the source.
-.de Sh \" Subsection
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
-.TH "AMFETCHDUMP" 8 "" "" ""
+'\" t
+.\"     Title: amfetchdump
+.\"    Author: John Stange <building@nap.edu>
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 01/10/2013
+.\"    Manual: System Administration Commands
+.\"    Source: Amanda 3.3.3
+.\"  Language: English
+.\"
+.TH "AMFETCHDUMP" "8" "01/10/2013" "Amanda 3\&.3\&.3" "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] [-i \fIlogfile\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] [\-\-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
-\fBhostname\fR,
-\fBdiskname\fR,
-\fBdatestamp\fR, and
-\fBlevel\fR
-dump pattern-matching works as in
-\fBamrestore\fR(8), with the added requirement that at minimum a
-\fBhostname\fR
-must be specified when not in inventory mode.
+\fIhostname\fR,
+\fIdiskname\fR,
+\fIdatestamp\fR, and
+\fIlevel\fR
+dump specifications are further described in
+\fBamanda-match\fR(7)\&. Note that at minimum a
+\fIhostname\fR
+must be specified\&.
 .PP
 Unless
-\fB-p\fR
+\fB\-p\fR
 is used, backup images are extracted to files in the current directory named:
 .PP
-\fBhostname.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"
-.TP
-\fB-p\fR
+.PP
+\fB\-p\fR
+.RS 4
 Pipe exactly one complete dump file to
-\fBstdout\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).
-.TP
-\fB-d\fR \fIdevice\fR
-Restore from this tape device instead of the default.
-.TP
-\fB-O\fR \fIdirectory\fR
-Output restored files to this directory, instead of to the current working directory.
-.TP
-\fB-c\fR
-Compress output, fastest method available.
-.TP
-\fB-C\fR
-Compress output, smallest file size method available.
-.TP
-\fB-l\fR
-Leave dumps in the compressed/uncompressed state in which they were found on tape. By default,
-\fBamfetchdump\fR
-will automatically uncompress when restoring.
-.TP
-\fB-a\fR
-Assume that all tapes are already available, via tape changer or otherwise, instead of prompting the operator to ensure that all tapes are loaded.
-.TP
-\fB-i\fR \fIfilename\fR
-Generate an inventory of all dumps "seen" on the tapes we search, for later use as a log.
-.TP
-\fB-w\fR
-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.
+\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_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
+.RS 4
+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\&.
+.RE
+.PP
+\fB\-C\fR
+.RS 4
+Compress output, smallest file size method available\&.
+.RE
+.PP
+\fB\-\-decompress\fR
+.RS 4
+Always do the decompression, this is the default\&.
+.RE
+.PP
+\fB\-\-no\-decompress\fR
+.RS 4
+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\-\-extract\fR
+.RS 4
+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
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.br
-\fBNote\fR
-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.
-.TP
-\fB-n\fR
-Do not reassemble split dump files at all, just restore each piece as an individual file.
-.TP
-\fB-s\fR
-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.
-.TP
-\fB-b\fR \fIblocksize\fR
-Force a particular block size when reading from tapes. This value will usually be autodetected, and should not normally need to be set.
-.TP
-\fB-o\fR \fIconfigoption\fR
-See the "\fBCONFIGURATION OVERWRITE\fR" section in
-\fBamanda\fR(8).
+Warning: All files in that directory can be removed\&.
+.RE
+.PP
+\fB\-\-data\-path\fR amanda|directtcp
+.RS 4
+The data path to use with
+\fB\-\-extract\fR, the default is to use the fatest data path\&.
+.RE
+.PP
+\fB\-\-application\-property\fR \fINAME=VALUE\fR
+.RS 4
+Application property to send to the application with
+\fB\-\-extract\&.\fR
+.RE
+.PP
+\fB\-l\fR
+.RS 4
+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)\&.
+.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
+Here\*(Aqs a simple case, restoring all known dumps of the host vanya to the current working directory\&.
 .nf
-
 $ amfetchdump SetA vanya
-
-.fi
-.sp
-.PP
-A more likely scenario involves restoring a particular dump from a particular date. We'll pipe this one to
-\fBGNU-tar\fR
-as well, to automatically extract the dump.
-.sp
-.nf
-
-$ amfetchdump -p SetA vanya /home 20051020 | gtar -xvpf -
-
-.fi
-.sp
-.PP
-In a situation where all of our dump logs have been wiped out, we could also use amfetchdump to inventory our tapes and recreate an imitation of those logs, which we'll send to
-\fBstdout\fR
-for casual perusal.
-.sp
-.nf
-
-$ amfetchdump -i - SetA
-
 .fi
-.sp
-
 .PP
-Note that you can specify a restore while in inventory mode, and
-\fBamfetchdump\fR
-will continue searching for more dumps from this host even after successfully restoring a dump, inventorying all the while. If your backup searcher has been trashed, this is a handy way to recover what you have.
-.sp
+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
-
-$ amfetchdump -i /var/amanda/log SetA backupserver
-
+$ amfetchdump \-p SetA vanya /home 20051020 | gtar \-xvpf \-
 .fi
-.sp
-
 .SH "CAVEATS"
-\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
+.PP
+\fBAmfetchdump\fR
+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)
-
+\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