+'\" t
.\" Title: amrestore
.\" Author: James da Silva <jds@amanda.org>
-.\" 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 "AMRESTORE" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
+.TH "AMRESTORE" "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"
-amrestore \- extract backup images from an \fIAmanda\fR tape
-.SH "Synopsis"
-.fam C
+.SH "NAME"
+amrestore \- low\-level data\-extraction from Amanda volumes
+.SH "SYNOPSIS"
.HP \w'\fBamrestore\fR\ 'u
-\fBamrestore\fR [\-r | \-c | \-C] [\-b | \fIblocksize\fR] [\-f | \fIfileno\fR] [\-l | \fIlabel\fR] [\-p] [\-h] \fItapedevice\fR|\ \fIholdingfile\fR [\fIhostname\fR [\fIdiskname\fR [\fIdatestamp\fR [\fIhostname\fR [\fIdiskname\fR [\fIdatestamp\fR | \&.\&.\&.]]]]]]
-.fam
+\fBamrestore\fR [\-\-config\ \fIconfig\fR] [\-r | \-c | \-C] [\-b\ \fIblocksize\fR] [\-f\ \fIfilenum\fR] [\-l\ \fIlabel\fR] [\-p] [\-h] [\-\-exact\-match] [\fB\-o\fR\ \fIconfigoption\fR...] [{\fIchangerspec\fR} | {[\-\-holding]\ \fIholdingfile\fR}] [\fIhostname\fR\ [\ \fIdiskname\fR\ [\ \fIdatestamp\fR\ [\ \fIhostname\fR\ [\ \fIdiskname\fR\ [\ \fIdatestamp\fR\ \&.\&.\&.\ ]\ ]\ ]\ ]\ ]]
+.PP
+Note that this is the only Amanda command which does not take a configuration name as its first argument\&.
.SH "DESCRIPTION"
.PP
-\fBAmrestore\fR
-extracts backup images from the tape mounted on
-\fItapedevice\fR
-or from the holding disk file
-\fIholdingfile\fR
-that match
-\fIhostname\fR,
-\fIdiskname\fR
-and
-\fIdatestamp\fR
-patterns given on the command line\&. The tape or holding file must be in a format written by the
-\fBamdump\fR
-or
-\fBamflush\fR
-program\&.
+\fIAmrestore\fR
+is a very low\-level tool for extracting data from Amanda volumes\&. It does not consult any catalog information or other metadata, basing its operations only on the headers found on the volume\&. This makes it an appropriate tool for bare\-metal restores of an Amanda server, or other situations where the catalog is not available\&.
.PP
-If
-\fIdiskname\fR
-is not specified, all backups on the tape for the previous
-\fIhostname\fR
-are candidates\&. If
-\fIdatestamp\fR
-is not specified, all backups on the tape for the previous
-\fIhostname\fR
+See
+\fBamfetchdump\fR(8)
and
-\fIdiskname\fR
-are candidates\&. If no
-\fIhostname\fR,
-\fIdiskname\fR
-or
-\fIdatestamp\fR
-are specified, every backup on the tape is a candidate\&.
+\fBamrecover\fR(8)
+for higher\-level recoveries\&.
.PP
-\fIHostname\fR
-and
-\fIdiskname\fR
-are special expressions described in the "HOST & DISK EXPRESSION" section of
-\fBamanda\fR(8)\&.
-\fIDatestamp\fR
-are special expression described in the "DATESTAMP EXPRESSION" section of
-\fBamanda\fR(8)\&. For example, if
-\fIdiskname\fR
-is "rz[23]a", it would match disks
-\fBrz2a\fR
-and
-\fBrz3a\fR\&.
+The tool does not reassemble split dumps, but can uncompress compressed dumps\&. Note that decompression may fail for split parts after the first\&. If this occurs, extract the parts without decompressing, concatenate them, and decompress the result\&.
+.PP
+Data is restored from the current volume in
+\fIchangerspec\fR, or from the holding file
+\fIholdingfile\fR\&. In most cases,
+\fIchangerspec\fR
+will name a particular device, e\&.g\&.,
+tape:/dev/nst0
+or
+s3:mybucket/tape\-1\&.
.PP
-\fIDatestamp\fR
-is useful if
-\fBamflush\fR
-writes multiple backup runs to a single tape\&.
+Only dumps matching the dump specification beginning with
+\fIhostname\fR
+are extracted\&. If no specification is given, every file on the volume (or the entire holdingfile) is restored\&. See the "DUMP SPECIFICATIONS" section of
+\fBamanda-match\fR(7)
+for more information\&.
.PP
Unless
\fB\-p\fR
is used, candidate backup images are extracted to files in the current directory named:
-.PP
-\fIhostname\&.diskname\&.datestamp\&.dumplevel\fR
-.PP
-Amrestore doesn\'t use a changer, it restore from the tape already loaded in the
-\fItapedevice\&.\fR
+hostname\&.diskname\&.datestamp\&.dumplevel
.SH "OPTIONS"
.PP
-\fB\-b\fR
+\fB\-b \fR\fB\fIblocksize\fR\fR
.RS 4
-Set the blocksize used to read the tape or holding file\&. All holding files must be read with a blocksize of 32 KBytes\&.
-\fBAmrestore\fR
-should normally be able to determine the blocksize for tapes on its own and not need this parameter\&.
+Use the given blocksize to read the volume\&. The default is defined by the device\&.
.RE
.PP
-The default is 32 KBytes\&.
-.PP
-\fB\-f\fR
+\fB\-f \fR\fB\fIfilenum\fR\fR
.RS 4
-Do a rewind followed by a fsf <fileno> before trying to restore an image\&.
+Seek to file
+\fIfilenum\fR
+before beginning the restore operation\&.
.RE
.PP
-\fB\-l\fR
+\fB\-l \fR\fB\fIlabel\fR\fR
.RS 4
-Check if we restoring from the tape with the right
-\fIlabel\fR
+Check that the volume has label
+\fIlabel\fR\&.
.RE
.PP
\fB\-p\fR
.RS 4
-Pipe output\&. The first matching backup image is sent to standard output, which is normally a pipe to
-\fBrestore\fR
-or
-\fBtar\fR, then
-\fBamrestore\fR
-quits\&. It may be run again to continue selecting backups to process\&. Make sure you specify the no\-rewind
-\fItapedevice\fR
-when doing this\&.
+Pipe the first matching file to standard output\&. This is typically used in a shell pipeline to send the data to a process like
+\fBtar\fR
+for extraction\&.
.RE
.PP
-Note:
-\fBrestore\fR
-may report "short read" errors when reading from a pipe\&. Most versions of
-\fBrestore\fR
-support a blocking factor option to let you set the read block size, and you should set it to 2\&. See the example below\&.
-.PP
-\fB\-c\fR
+\fB\-c\fR, \fB\-C\fR
.RS 4
-Compress output using the fastest method the compression program provides\&.
-\fBAmrestore\fR
-normally writes output files in a format understood by
-\fBrestore\fR
-or
-\fBtar\fR, even if the backups on the tape are compressed\&. With the
-\fB\-c\fR
-or
-\fB\-C\fR
-option,
+If the file is not already compressed, compress it using the fastest (\fB\-c\fR) or best (\fB\-C\fR) compression algorithm\&. Note that
\fBamrestore\fR
-writes all files in compressed format, even if the backups on the tape are not compressed\&. Output file names will have a
-\fB\&.Z\fR
-or
-\fB\&.gz\fR
-extension depending on whether
-\fBcompress\fR
-or
-\fBgzip\fR
-is the preferred compression program\&. This option is useful when the current directory disk is small\&.
+will not re\-compress an already\-compressed file\&. Without either of these options,
+\fBamrestore\fR
+will automatically uncompress any compressed files\&. This option is useful when the destination disk is small\&.
.RE
.PP
-\fB\-C\fR
+\fB\-h\fR
.RS 4
-Compress output using the best method the compression program provides (may be very CPU intensive)\&. See the notes above about the
-\fB\-c\fR
-option\&.
+Include 32k headers on all output files, similar to a holding file\&. This header can be read by another application or utility (see
+\fBAmanda::Header\fR) during the next phase of processing\&.
.RE
.PP
\fB\-r\fR
.RS 4
-Raw output\&. Backup images are output exactly as they are on the tape, including the
-\fBamdump\fR
-headers\&. Output file names will have a
-\fB\&.RAW\fR
-extension\&. This option is only useful for debugging and other strange circumstances\&.
+Output raw files\&. This is similar to
+\fB\-h\fR, but also disables any automatic decompression\&. Output file names will have a
+\&.RAW
+extension\&.
.RE
.PP
-\fB\-h\fR
+\fB\-\-exact\-match\fR
.RS 4
-Header output\&. The tape header block is output at the beginning of each file\&. This is like
-\fB\-r\fR
-except
-\fB\-c\fR
-or
-\fB\-C\fR
-may also be used to compress the result\&.
-\fBAmrecover\fR
-uses the header to determine the restore program to use\&.
+The host and disk are parsed as exact values
.RE
.PP
-If a header is written (\-r or \-h), only 32 KBytes are output regardless of the tape blocksize\&. This makes the resulting image usable as a holding file\&.
-.PP
-\fB\-o\fR \fIconfigoption\fR
+\fB\-o \fR\fB\fIconfigoption\fR\fR
.RS 4
-See the "\fBCONFIGURATION OVERRIDE\fR" section in
+See the "CONFIGURATION OVERRIDE" section in
\fBamanda\fR(8)\&.
.RE
.SH "EXAMPLES"
\fIrz3g\fR
from host
\fIseine\fR, to restore particular files\&. Note the use of the
-\fBb\fR
+\fIb\fR
option to
-\fBrestore\fR, which causes it to read in units of two 512\-byte blocks (1 Kbyte) at a time\&. This helps keep it from complaining about short reads\&.
-.sp
-.if n \{\
-.RS 4
-.\}
-.fam C
-.ps -1
+\fIrestore\fR, which causes it to read in units of two 512\-byte blocks (1 Kbyte) at a time\&. This helps keep it from complaining about short reads\&.
.nf
-.if t \{\
-.sp -1
-.\}
-.BB lightgray adjust-for-leading-newline
-.sp -1
-
-% amrestore \-p /dev/nrmt9 seine rz3g | restore \-ivbf 2 \-
-.EB lightgray adjust-for-leading-newline
-.if t \{\
-.sp 1
-.\}
+ amrestore \-p /dev/nrmt9 seine rz3g | tar \-xv
.fi
-.fam
-.ps +1
-.if n \{\
-.RE
-.\}
.PP
The next example extracts all backup images for host
-\fIseine\fR\&. This is the usual way to extract all data for a host after a disk crash\&.
-.sp
-.if n \{\
-.RS 4
-.\}
-.fam C
-.ps -1
+\fIseine\fR\&. This is a typical way to extract all data for a host after a disk crash\&.
.nf
-.if t \{\
-.sp -1
-.\}
-.BB lightgray adjust-for-leading-newline
-.sp -1
-
-% amrestore /dev/nrmt9 seine
-.EB lightgray adjust-for-leading-newline
-.if t \{\
-.sp 1
-.\}
+ amrestore /dev/nrmt9 seine
.fi
-.fam
-.ps +1
-.if n \{\
-.RE
-.\}
.PP
If the backup datestamp in the above example is
-\FC19910125\F[]
+20070125
and
\fIseine\fR
has level 0 backups of disks
and
\fIrz1g\fR
on the tape, these files will be created in the current directory:
-.sp
-.if n \{\
-.RS 4
-.\}
-.fam C
-.ps -1
.nf
-.if t \{\
-.sp -1
-.\}
-.BB lightgray adjust-for-leading-newline
-.sp -1
-
-seine\&.rz1a\&.19910125\&.0
-seine\&.rz1g\&.19910125\&.0
-.EB lightgray adjust-for-leading-newline
-.if t \{\
-.sp 1
-.\}
+ seine\&.rz1a\&.19910125\&.0
+ seine\&.rz1g\&.19910125\&.0
.fi
-.fam
-.ps +1
-.if n \{\
-.RE
-.\}
.PP
You may also use
\fBamrestore\fR
to extract a backup image from a holding disk file that has not yet been flushed to tape:
-.sp
-.if n \{\
-.RS 4
-.\}
-.fam C
-.ps -1
-.nf
-.if t \{\
-.sp -1
-.\}
-.BB lightgray adjust-for-leading-newline
-.sp -1
-
-% amrestore \-p /amanda/20001119/seine\&.rz1a\&.2 | restore \-ivbf 2 \-
-.EB lightgray adjust-for-leading-newline
-.if t \{\
-.sp 1
-.\}
-.fi
-.fam
-.ps +1
-.if n \{\
-.RE
-.\}
-.PP
-\fBAmrestore\fR
-may be used to generate a listing of images on a tape:
-.sp
-.if n \{\
-.RS 4
-.\}
-.fam C
-.ps -1
.nf
-.if t \{\
-.sp -1
-.\}
-.BB lightgray adjust-for-leading-newline
-.sp -1
-
-% mt \-f /dev/nrmt9 rewind
-% amrestore \-p /dev/nrmt9 no\-such\-host > /dev/null
-.EB lightgray adjust-for-leading-newline
-.if t \{\
-.sp 1
-.\}
+ amrestore \-p /amanda/20001119/seine\&.rz1a\&.2 | tar \-xv
.fi
-.fam
-.ps +1
-.if n \{\
-.RE
-.\}
-.PP
-This asks
-\fBamrestore\fR
-to find images for host
-\fBno\-such\-host\fR\&. It will not find any entries that match, but along the way will report each image it skips\&.
.SH "CAVEATS"
.PP
\fBGNU\-tar\fR
-must be used to restore files from backup images created with the GNUTAR dumptype\&. Vendor tar programs sometimes fail to read GNU tar images\&.
+must be used to restore files from backup images created with the GNUTAR dumptype\&. Vendor tar programs sometimes fail to read GNU Tar images\&.
.SH "SEE ALSO"
.PP
\fBamanda\fR(8),
-\fBamdump\fR(8),
-\fBamflush\fR(8),
-\fBtar\fR(1),
-\fBrestore\fR(8),
-: http://wiki.zmanda.com
-.SH "Authors"
+\fBamanda-match\fR(7),
+\fBamfetchdump\fR(8),
+\fBamrecover\fR(8)
+.PP
+The Amanda Wiki:
+: http://wiki.zmanda.com/
+.SH "AUTHORS"
.PP
\fBJames da Silva\fR <\&jds@amanda\&.org\&>
.PP
\fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>
+.PP
+\fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
+.RS 4
+Zmanda, Inc\&. (http://www\&.zmanda\&.com)
+.RE
projects / debian / amanda / blobdiff