Imported Upstream version 3.2.0
[debian/amanda] / man / amrecover.8
index 7fdf97f2249442c156a34fda2987a89977c17862..90bb0b01f368ff1a6f3bec681ee4ed34764a0424 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 "AMRECOVER" 8 "" "" ""
-.SH NAME
-amrecover \- AMANDA index database browser
-.SH "SYNOPSIS"
+'\" t
+.\"     Title: amrecover
+.\"    Author: Alan M. McIvor <alan@kauri.auck.irl.cri.nz>
+.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
+.\"      Date: 10/18/2010
+.\"    Manual: System Administration Commands
+.\"    Source: Amanda 3.2.0
+.\"  Language: English
+.\"
+.TH "AMRECOVER" "8" "10/18/2010" "Amanda 3\&.2\&.0" "System Administration Commands"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
 .ad l
-.hy 0
-.HP 10
-\fBamrecover\fR [[\-C]\ \fIconfig\fR] [\-s\ \fIindex\-server\fR] [\-t\ \fItape\-server\fR] [\-d\ \fItape\-device\fR]
-.ad
-.hy
-
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.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] [\-h\ \fIhostname\fR] [\-o\ \fIconfigoption\fR]...
 .SH "DESCRIPTION"
-
 .PP
-\fBAmrecover\fR browses the database of \fBAMANDA\fR index files to determine which tapes contain files to recover\&. Furthermore, it is able to recover files\&.
-
+\fBAmrecover\fR
+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 from the root of the backed up filesystem, or use \fBlcd\fR to move into that directory, otherwise a directory tree that resembles the backed up filesystem will be created in the current directory\&. See the examples below for details\&.
-
+In order to restore files in place, you must invoke
+\fBamrecover\fR
+from the root of the backed up filesystem, or use
+\fBlcd\fR
+to move into that directory, otherwise a directory tree that resembles the backed up filesystem will be created in the current directory\&. See the examples below for details\&.
 .PP
-See the \fBamanda\fR(8) man page for more details about \fBAMANDA\fR\&.
-
+Amrecover will read the
+\fBamanda\-client\&.conf\fR
+file and the
+\fIconfig\fR\fB/amanda\-client\&.conf\fR
+file\&. If no configuration name is supplied on the command line, Amrecover will try the compiled\-in default configuration ,usually
+\fBDailySet1\fR\&.
+.PP
+See the
+\fBamanda\fR(8)
+man page for more details about Amanda\&.
 .SH "OPTIONS"
-
-.RS
-.Sh "Note"
-The listed defaults map to the values you ran the configure\-script with\&.
+.if n \{\
+.sp
+.\}
+.RS 4
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+\fBNote\fR
+.ps -1
+.br
+.PP
+The Default values are those set at compile\-time\&. Use
+\fBamrestore\fR
+to recover client\-encrypted or client\-custom\-compressed tapes\&.
+.sp .5v
 .RE
-
-.TP
+.PP
 \fB[ \-C ] config\fR
-\fBAMANDA\fR configuration (default: daily)\&.
-
-.TP
+.RS 4
+Amanda configuration\&.
+.RE
+.PP
 \fB\-s index\-server\fR
-Host that runs the index daemon (default: oops)\&.
-
-.TP
+.RS 4
+Host that runs the index daemon\&.
+.RE
+.PP
 \fB\-t tape\-server\fR
-Host that runs the tape server daemon (default: 192\&.168\&.0\&.10)\&.
-
-.TP
+.RS 4
+Host that runs the tape server daemon\&.
+.RE
+.PP
 \fB\-d tape\-device\fR
-Tape device to use on the tape server host (default: /dev/nst0)\&.
-
+.RS 4
+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\'s hostname\&.
+.RE
+.PP
+\fB\-o\fR \fIclientconfigoption\fR
+.RS 4
+See the "\fBCONFIGURATION OVERRIDE\fR" section in
+\fBamanda\fR(8)\&.
+.RE
 .SH "COMMANDS"
-
 .PP
-\fBAmrecover\fR connects to the index server and then presents a command line prompt\&. Usage is similar to an ftp client\&. The GNU readline library is used to provide command line history and editing if it was built in to \fBamrecover\fR\&.
-
+\fBAmrecover\fR
+connects to the index server and then presents a command line prompt\&. Usage is similar to an ftp client\&. The GNU readline library is used to provide command line history and editing if it was built in to
+\fBamrecover\fR\&.
+.PP
+The purpose of browsing the database is to build up a
+\fIrestore list\fR
+of files to be extracted from the backup system\&. The following commands are available:
 .PP
-The purpose of browsing the database is to build up a \fBrestore list\fR of files to be extracted from the backup system\&. The following commands are available:
-
-.TP
 \fBsethost hostname\fR
+.RS 4
 Specifies which host to look at backup files for (default: the local host)\&.
-
-.TP
-\fBsetdate YYYY\-MM\-DD\fR
-Set the date (default: today)\&. File listing commands only return information on backup images for this day, for the day before with the next lower dump level, and so on, until the most recent level 0 backup on or before the specified date is encountered\&.
-
+.RE
+.PP
+\fBsetdate YYYY\-MM\-DD\-HH\-MM[\-SS] | YYYY\-MM\-DD\fR
+.RS 4
+Set the restore time (default: now)\&. File listing commands only return information on backup images for this day, for the day before with the next lower dump level, and so on, until the most recent level 0 backup on or before the specified date is encountered\&.
+.sp
 For example, if:
-
-
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
-
 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
-
 .fi
-then if 1997\-07\-08 is the requested date, files from the following days would be used:
-
-
+.if n \{\
+.RE
+.\}
+.sp
+then the command
+\fBsetdate 1997\-07\-08\-00\fR
+would yield files from the following days:
+.sp
+.if n \{\
+.RS 4
+.\}
 .nf
-
 1997\-07\-08 (the latest level 2 backup)
 1997\-07\-05 (the latest level 1 backup)
 1997\-07\-01 (the latest level 0 backup)
-
 .fi
+.if n \{\
+.RE
+.\}
+.sp
 Only the most recent version of a file will be presented\&.
-
+.sp
 The following abbreviated date specifications are accepted:
-
-.RS
-
-.TP
+.PP
 \fB\-\-MM\-DD\fR
+.RS 4
 dates in the current year
-
-.TP
+.RE
+.PP
 \fB\-\-\-DD\fR
+.RS 4
 dates in the current month of the current year
-
 .RE
-.IP
-
-.TP
-\fBsetdisk diskname mountpoint\fR
-Specifies which disk to consider (default: the disk holding the working directory where \fBamrecover\fR is started)\&. It can only be set after the host is set with \fBsethost\fR\&. \fBDiskname\fR is the device name specified in the \fBamanda\&.conf\fR or \fBdisklist\fR configuration file\&. The disk must be local to the host\&. If \fBmountpoint\fR is not specified, all pathnames will be relative to the (unknown) mount point instead of full pathnames\&.
-
-.TP
-\fBlistdisk [diskdevice]\fR
-List all \fBdiskname\fR
-
-.TP
-\fBsettape [[server]:][tapedev|default]\fR
-Specifies the host to use as the tape server, and which of its tape devices to use\&. If the server is omitted, but the colon is not, the server name reverts to 192\&.168\&.0\&.10, the configure\-time default\&. If the tape device is omitted, it remains unchanged\&. To use the default tape device selected by the tape server, the word \fBdefault\fR must be specified\&. If no argument is specified, or the argument is an empty string, no changes occur, and the current settings are displayed\&.
-
-If you want amrecover to use your changer, the \fBtapedev\fR must be equal to the amrecover_changer setting on the server\&.
-
-If you need to change the protocol (tape:, rait:, file:, null:) then you must specify the hostname\&.
-
+.RE
+.PP
+\fBsetdisk\fR \fIdiskname\fR [\fImountpoint\fR]
+.RS 4
+Specifies which disk to consider (default: the disk holding the working directory where
+\fBamrecover\fR
+is started)\&. It can only be set after the host is set with
+\fBsethost\fR\&.
+\fIDiskname\fR
+is the device name specified in the
+\fIamanda\&.conf\fR
+or
+\fBdisklist\fR(5)\&. The disk must be local to the host\&. If
+\fImountpoint\fR
+is not specified, all pathnames will be relative to the (unknown) mount point instead of full pathnames\&.
+.RE
+.PP
+\fBlisthost\fR [\fIdiskdevice\fR]
+.RS 4
+List all
+\fBhost\fR
+.RE
+.PP
+\fBlistdisk\fR [\fIdiskdevice\fR]
+.RS 4
+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
+\fBamrecover\-changer\fR
+setting on the server\&.
+.sp
+Since device names contain colons, you must always specify the hostname\&.
 .nf
-
 settape 192\&.168\&.0\&.10:file:/file1
 .fi
 You can change the tape device when amrecover ask you to load the tape:
 .nf
-
 Load tape DMP014 now
 Continue? [Y/n/t]: t
 Tape device: server2:/dev/nst2
 Continue? [Y/n/t]: Y
 Using tape /dev/nst2 from server server2\&.
 .fi
-
-.TP
-\fBsetmode mode\fR
-Set the extraction mode for Samba shares\&. If \fBmode\fR is \fBsmb\fR, shares are sent to the Samba server to be restored back onto the PC\&. If \fBmode\fR is \fBtar\fR, they are extracted on the local machine the same way tar volumes are extracted\&.
-
-.TP
+.RE
+.PP
+\fBsetmode\fR \fImode\fR
+.RS 4
+Set the extraction mode for Samba shares\&. If
+\fImode\fR
+is
+\fBsmb\fR, shares are sent to the Samba server to be restored back onto the PC\&. If
+\fImode\fR
+is
+\fBtar\fR, they are extracted on the local machine the same way tar volumes are extracted\&.
+.RE
+.PP
 \fBmode\fR
+.RS 4
 Displays the extracting mode for Samba shares\&.
-
-.TP
+.RE
+.PP
 \fBhistory\fR
+.RS 4
 Show the backup history of the current host and disk\&. Dates, levels, tapes and file position on tape of each backup are displayed\&.
-
-.TP
+.RE
+.PP
 \fBpwd\fR
+.RS 4
 Display the name of the current backup working directory\&.
-
-.TP
-\fBcd dir\fR
-Change the backup working directory to \fBdir\&.\fR If the mount point was specified with \fBsetdisk\fR, this can be a full pathname or it can be relative to the current backup working directory\&. If the mount point was not specified, paths are relative to the mount point if they start with "/", otherwise they are relative to the current backup working directory\&. The \fBdir\fR can be a shell style wildcards\&.
-
-.TP
-\fBcdx dir\fR
-Like the \fBcd\fR command but allow regular expression\&.
-
-.TP
+.RE
+.PP
+\fBcd\fR \fIdir\fR
+.RS 4
+Change the backup working directory to
+\fIdir\&.\fR
+If the mount point was specified with
+\fBsetdisk\fR, this can be a full pathname or it can be relative to the current backup working directory\&. If the mount point was not specified, paths are relative to the mount point if they start with "/", otherwise they are relative to the current backup working directory\&. The
+\fIdir\fR
+can be a shell style wildcards\&.
+.RE
+.PP
+\fBcdx\fR \fIdir\fR
+.RS 4
+Like the
+\fBcd\fR
+command but allow regular expression\&.
+.RE
+.PP
 \fBlpwd\fR
-Display the \fBamrecover\fR working directory\&. Files will be restored under this directory, relative to the backed up filesystem\&.
-
-.TP
-\fBlcd path\fR
-Change the \fBamrecover\fR working directory to \fBpath\fR\&.
-
-.TP
+.RS 4
+Display the
+\fBamrecover\fR
+working directory\&. Files will be restored under this directory, relative to the backed up filesystem\&.
+.RE
+.PP
+\fBlcd\fR \fIpath\fR
+.RS 4
+Change the
+\fBamrecover\fR
+working directory to
+\fIpath\fR\&.
+.RE
+.PP
 \fBls\fR
-List the contents of the current backup working directory\&. See the description of the \fBsetdate\fR command for how the view of the directory is built up\&. The backup date is shown for each file\&.
-
-.TP
-\fBadd item1 item2 \&.\&.\&.\fR
+.RS 4
+List the contents of the current backup working directory\&. See the description of the
+\fBsetdate\fR
+command for how the view of the directory is built up\&. The backup date is shown for each file\&.
+.RE
+.PP
+\fBadd\fR \fIitem1 item2 \&.\&.\&.\fR
+.RS 4
 Add the specified files or directories to the restore list\&. Each item may have shell style wildcards\&.
-
-.TP
-\fBaddx item1 item2 \&.\&.\&.\fR
+.RE
+.PP
+\fBaddx\fR \fIitem1 item2 \&.\&.\&.\fR
+.RS 4
 Add the specified files or directories to the restore list\&. Each item may be a regular expression\&.
-
-.TP
-\fBdelete item1 item2 \&.\&.\&.\fR
+.RE
+.PP
+\fBdelete\fR \fIitem1 item2 \&.\&.\&.\fR
+.RS 4
 Delete the specified files or directories from the restore list\&. Each item may have shell style wildcards\&.
-
-.TP
-\fBdeletex item1 item2 \&.\&.\&.\fR
+.RE
+.PP
+\fBdeletex\fR \fIitem1 item2 \&.\&.\&.\fR
+.RS 4
 Delete the specified files or directories from the restore list\&. Each item may be a regular expression\&.
-
-.TP
-\fBlist file\fR
-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 \fBAMANDA\fR tapes with \fBamrestore\fR\&.
-
-.TP
+.RE
+.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 Amanda tapes with
+\fBamrestore\fR\&.
+.RE
+.PP
 \fBclear\fR
+.RS 4
 Clear the restore list\&.
-
-.TP
+.RE
+.PP
 \fBquit\fR
+.RS 4
 Close the connection to the index server and exit\&.
-
-.TP
+.RE
+.PP
 \fBexit\fR
+.RS 4
 Close the connection to the index server and exit\&.
-
-.TP
+.RE
+.PP
 \fBextract\fR
-Start the extract sequence (see the examples below)\&. Make sure the local working directory is the root of the backed up filesystem, or another directory that will behave like that\&. Use \fBlpwd\fR to display the local working directory, and \fBlcd\fR to change it\&.
-
-.TP
+.RS 4
+Start the extract sequence (see the examples below)\&. Make sure the local working directory is the root of the backed up filesystem, or another directory that will behave like that\&. Use
+\fBlpwd\fR
+to display the local working directory, and
+\fBlcd\fR
+to change it\&.
+.RE
+.PP
 \fBhelp\fR
+.RS 4
 Display a brief list of these commands\&.
-
+.RE
 .SH "EXAMPLES"
-
 .PP
-The following shows the recovery of an old \fBsyslog\fR file\&.
+The following shows the recovery of an old
+\fIsyslog\fR
+file\&.
 .nf
-
 # cd /var/log
 # ls \-l syslog\&.7
 syslog\&.7: No such file or directory
-# amrecover
+# amrecover MyConfig
 AMRECOVER Version 2\&.4\&.2\&. Contacting server on oops \&.\&.\&.
-220 oops \fBAMANDA\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 daily\&.
+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 \'/var/log\' is on disk \'/var\' mounted at \'/var\'\&.
 200 Disk set to /var\&.
 /var/log
 WARNING: not on root of selected filesystem, check man\-page!
@@ -271,18 +399,18 @@ Continue? [Y/n]: y
 
 Load tape DMP014 now
 Continue? [Y/n/t]: y
-set owner/mode for '\&.'? [yn] n
+set owner/mode for \'\&.\'? [yn] n
 amrecover> quit
 200 Good bye\&.
 # ls \-l syslog\&.7
 total 26
 \-rw\-r\-\-r\-\-   1 root     other      12678 Oct 14 16:36 syslog\&.7
 .fi
-
 .PP
-If you do not want to overwrite existing files, create a subdirectory to run \fBamrecover\fR from and then move the restored files afterward\&.
+If you do not want to overwrite existing files, create a subdirectory to run
+\fBamrecover\fR
+from and then move the restored files afterward\&.
 .nf
-
 # cd /var
 # (umask 077 ; mkdir \&.restore)
 # cd \&.restore
@@ -307,11 +435,15 @@ amrecover> quit
 # cd \&.\&.
 # rm \-fr \&.restore
 .fi
-
 .PP
-If you need to run \fBamrestore\fR by hand instead of letting \fBamrecover\fR control it, use the \fBlist\fR command after browsing to display the needed tapes\&.
+If you need to run
+\fBamrestore\fR
+by hand instead of letting
+\fBamrecover\fR
+control it, use the
+\fBlist\fR
+command after browsing to display the needed tapes\&.
 .nf
-
 # cd /var/log
 # amrecover
 AMRECOVER Version 2\&.4\&.2\&. Contacting server on oops \&.\&.\&.
@@ -330,20 +462,19 @@ TAPE DMP015 LEVEL 1 DATE 1997\-12\-09
         /log/syslog
 amrecover> quit 
 .fi
-
 .PP
-The \fBhistory\fR command shows each tape that has a backup of the current disk along with the date of the backup, the level, the tape label and the file position on the tape\&. All active tapes are listed, not just back to the most recent full dump\&.
-
+The
+\fBhistory\fR
+command shows each tape that has a backup of the current disk along with the date of the backup, the level, the tape label and the file position on the tape\&. All active tapes are listed, not just back to the most recent full dump\&.
 .PP
 Tape file position zero is a label\&. The first backup image is in file position one\&.
 .nf
-
 # cd /var/log
 # amrecover
 AMRECOVER Version 2\&.4\&.2\&. Contacting server on oops \&.\&.\&.
 \&.\&.\&.
 amrecover> history
-200\- Dump history for config "daily" host "this\-host\&.some\&.org" disk "/var"
+200\- Dump history for config "MyConfig" host "this\-host\&.some\&.org" disk "/var"
 201\- 1997\-12\-09 1 DMP015 9
 201\- 1997\-12\-08 1 DMP014 11
 201\- 1997\-12\-07 0 DMP013 22
@@ -357,22 +488,34 @@ amrecover> history
 \&.\&.\&.
 amrecover> quit 
 .fi
-
 .SH "ENVIRONMENT"
-
 .PP
-\fBPAGER\fR   The \fBls\fR and \fBlist\fR commands will use $PAGER to display the file lists\&. Defaults to \fBmore\fR if PAGER is not set\&.
-
-.SH "AUTHOR"
-
+\fBPAGER\fR
+The
+\fBls\fR
+and
+\fBlist\fR
+commands will use $PAGER to display the file lists\&. Defaults to
+\fImore\fR
+if PAGER is not set\&.
 .PP
-Alan M\&. McIvor <alan@kauri\&.auck\&.irl\&.cri\&.nz> : Original text
-
+\fBAMANDA_SERVER\fR
+If set, $AMANDA_SERVER will be used as index\-server\&. The value will take precedence over the compiled default, but will be overridden by the \-s switch\&.
 .PP
-Stefan G\&. Weichinger, <sgw@amanda\&.org>, maintainer of the \fBAMANDA\fR\-documentation: XML\-conversion
-
+\fBAMANDA_TAPE_SERVER\fR
+If set, $AMANDA_TAPE_SERVER will be used as tape\-server\&. The value will take precedence over the compiled default, but will be overridden by the \-t switch\&.
 .SH "SEE ALSO"
-
 .PP
-\fBamanda\fR(8), \fBamrestore\fR(8), \fBreadline\fR(3)
-
+\fBamanda\fR(8),
+\fBamanda-client.conf\fR(5),
+\fBamrestore\fR(8),
+\fBamfetchdump\fR(8),
+\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
+\fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>