Imported Upstream version 3.3.2
[debian/amanda] / man / amrecover.8
index 4a1139234570eeda1696ea0ca7bf03138ddb5318..c52e7659fd767bf0a417a78046b63992c7738245 100644 (file)
+'\" t
 .\"     Title: amrecover
 .\"    Author: Alan M. McIvor <alan@kauri.auck.irl.cri.nz>
-.\" 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: 07/25/2012
 .\"    Manual: System Administration Commands
-.\"    Source: Amanda 2.6.1
+.\"    Source: Amanda 3.3.2
 .\"  Language: English
 .\"
-.TH "AMRECOVER" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
+.TH "AMRECOVER" "8" "07/25/2012" "Amanda 3\&.3\&.2" "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"
-amrecover \- \fIAmanda\fR index database browser
-.SH "Synopsis"
-.fam C
+.SH "NAME"
+amrecover \- Amanda index database browser
+.SH "SYNOPSIS"
 .HP \w'\fBamrecover\fR\ 'u
-\fBamrecover\fR [\-C\ \fIconfig\fR] [\-s\ \fIindex\-server\fR] [\-t\ \fItape\-server\fR] [\-d\ \fItape\-device\fR] [\-o\ \fIconfigoption\fR]...
-.fam
+\fBamrecover\fR [\-s\ \fIindex\-server\fR] [\-t\ \fItape\-server\fR] [\-d\ \fItape\-device\fR] [\-h\ \fIhostname\fR] [\fB\-o\fR\ \fIconfigoption\fR...] [\-C\ \fIconfig\fR]
 .SH "DESCRIPTION"
 .PP
 \fBAmrecover\fR
-browses the database of
-\fIAmanda\fR
-index files to determine which tapes contain files to recover\&. Furthermore, it is able to recover files\&.
+browses the database of Amanda index files to determine which tapes contain files to recover\&. Furthermore, it is able to recover files\&.
 .PP
 In order to restore files in place, you must invoke
 \fBamrecover\fR
@@ -195,14 +52,12 @@ file\&. If no configuration name is supplied on the command line, Amrecover will
 .PP
 See the
 \fBamanda\fR(8)
-man page for more details about
-\fIAmanda\fR\&.
+man page for more details about Amanda\&.
 .SH "OPTIONS"
 .if n \{\
 .sp
 .\}
 .RS 4
-.BM yellow
 .it 1 an-trap
 .nr an-no-space-flag 1
 .nr an-break-flag 1
@@ -216,13 +71,11 @@ The Default values are those set at compile\-time\&. Use
 \fBamrestore\fR
 to recover client\-encrypted or client\-custom\-compressed tapes\&.
 .sp .5v
-.EM yellow
 .RE
 .PP
 \fB[ \-C ] config\fR
 .RS 4
-\fIAmanda\fR
-configuration\&.
+Amanda configuration\&.
 .RE
 .PP
 \fB\-s index\-server\fR
@@ -240,11 +93,23 @@ Host that runs the tape server daemon\&.
 Tape device to use on the tape server host\&.
 .RE
 .PP
+\fB\-h hostname\fR
+.RS 4
+Hostname to begin restoring; defaults to the system\*(Aqs hostname\&.
+.RE
+.PP
 \fB\-o\fR \fIclientconfigoption\fR
 .RS 4
 See the "\fBCONFIGURATION OVERRIDE\fR" section in
 \fBamanda\fR(8)\&.
 .RE
+.SH "AUTH"
+.PP
+The default
+\fBauth\fR
+is \*(AqBSDTCP\*(Aq, you can set a different auth in the
+\fBamanda\-client\&.conf\fR
+file or by specifying the \*(Aq\-oauth=bsd\*(Aq command line argument\&.
 .SH "COMMANDS"
 .PP
 \fBAmrecover\fR
@@ -269,25 +134,11 @@ For example, if:
 .if n \{\
 .RS 4
 .\}
-.fam C
-.ps -1
 .nf
-.if t \{\
-.sp -1
-.\}
-.BB lightgray adjust-for-leading-newline
-.sp -1
-
 1996\-07\-01 was a level 0 backup
 1996\-07\-02 through 1996\-07\-05 were level 1 backups
 1996\-07\-06 through 1997\-07\-08 were level 2 backups
-.EB lightgray adjust-for-leading-newline
-.if t \{\
-.sp 1
-.\}
 .fi
-.fam
-.ps +1
 .if n \{\
 .RE
 .\}
@@ -299,25 +150,11 @@ would yield files from the following days:
 .if n \{\
 .RS 4
 .\}
-.fam C
-.ps -1
 .nf
-.if t \{\
-.sp -1
-.\}
-.BB lightgray adjust-for-leading-newline
-.sp -1
-
 1997\-07\-08 (the latest level 2 backup)
 1997\-07\-05 (the latest level 1 backup)
 1997\-07\-01 (the latest level 0 backup)
-.EB lightgray adjust-for-leading-newline
-.if t \{\
-.sp 1
-.\}
 .fi
-.fam
-.ps +1
 .if n \{\
 .RE
 .\}
@@ -364,13 +201,36 @@ List all
 \fBdiskname\fR
 .RE
 .PP
+\fBlistproperty\fR
+.RS 4
+List all
+\fBproperty\fR
+.RE
+.PP
+\fBsetproperty\fR [\fBappend\fR] [\fBpriority\fR] \fIname\fR [\fIvalue\fR \&.\&.\&.]
+.RS 4
+Set the property
+\fIname\fR
+to the value
+\fIvalue\fR\&. The
+\fBappend\fR
+keyword appends the
+\fIvalue\fR
+to the values already set for this property\&. Without
+\fIvalue\fR, the property is unset\&. The
+\fBpriority\fR
+keyword is unused, it is present for ease of copy/paste from application definition\&.
+.RE
+.PP
 \fBsetdevice\fR [[\-h \fItape\-server\fR] \fItapedev\fR]
 .RS 4
 Specifies the host to use as the tape server, and which of its tape devices to use\&. If the server is omitted, the server name reverts to the configure\-time default\&. If the tape device is omitted, the default is used\&.
 .sp
 If you want amrecover to use your changer, the
 \fItapedev\fR
-must be equal to the amrecover_changer setting on the server\&.
+must be equal to the
+\fBamrecover\-changer\fR
+setting on the server\&.
 .sp
 Since device names contain colons, you must always specify the hostname\&.
 .nf
@@ -397,6 +257,13 @@ is
 \fBtar\fR, they are extracted on the local machine the same way tar volumes are extracted\&.
 .RE
 .PP
+\fBsettranslate\fR [\fBon\fR|\fBoff\fR]
+.RS 4
+Default: on\&. Translate escaped octal value (\*(Aq\e000\*(Aq) in the index file to their corespondig characters, it improve the interface if amrecover is run in the same charset as the filename\&. Set it to
+\fBoff\fR
+if the charset of some filename is not compatible with the amrecover charset\&.
+.RE
+.PP
 \fBmode\fR
 .RS 4
 Displays the extracting mode for Samba shares\&.
@@ -473,9 +340,7 @@ Delete the specified files or directories from the restore list\&. Each item may
 .PP
 \fBlist\fR \fIfile\fR
 .RS 4
-Display the contents of the restore list\&. If a file name is specified, the restore list is written to that file\&. This can be used to manually extract the files from the
-\fIAmanda\fR
-tapes with
+Display the contents of the restore list\&. If a file name is specified, the restore list is written to that file\&. This can be used to manually extract the files from the Amanda tapes with
 \fBamrestore\fR\&.
 .RE
 .PP
@@ -518,12 +383,12 @@ file\&.
 syslog\&.7: No such file or directory
 # amrecover MyConfig
 AMRECOVER Version 2\&.4\&.2\&. Contacting server on oops \&.\&.\&.
-220 oops \fIAmanda\fR index server (2\&.4\&.2) ready\&.
+220 oops Amanda index server (2\&.4\&.2) ready\&.
 Setting restore date to today (1997\-12\-09)
 200 Working date set to 1997\-12\-09\&.
 200 Config set to MyConfig\&.
 200 Dump host set to this\-host\&.some\&.org\&.
-$CWD \'/var/log\' is on disk \'/var\' mounted at \'/var\'\&.
+$CWD \*(Aq/var/log\*(Aq is on disk \*(Aq/var\*(Aq mounted at \*(Aq/var\*(Aq\&.
 200 Disk set to /var\&.
 /var/log
 WARNING: not on root of selected filesystem, check man\-page!
@@ -557,7 +422,7 @@ Continue? [Y/n]: y
 
 Load tape DMP014 now
 Continue? [Y/n/t]: y
-set owner/mode for \'\&.\'? [yn] n
+set owner/mode for \*(Aq\&.\*(Aq? [yn] n
 amrecover> quit
 200 Good bye\&.
 # ls \-l syslog\&.7
@@ -668,9 +533,11 @@ If set, $AMANDA_TAPE_SERVER will be used as tape\-server\&. The value will take
 \fBamanda-client.conf\fR(5),
 \fBamrestore\fR(8),
 \fBamfetchdump\fR(8),
-\fBreadline\fR(3),
-: http://wiki.zmanda.com
-.SH "Authors"
+\fBreadline\fR(3)
+.PP
+The Amanda Wiki:
+: http://wiki.zmanda.com/
+.SH "AUTHORS"
 .PP
 \fBAlan M\&. McIvor\fR <\&alan@kauri\&.auck\&.irl\&.cri\&.nz\&>
 .PP