Imported Upstream version 2.5.1p3
[debian/amanda] / man / amrecover.8
index 40aa455c073eb4b94907f9ae05d66cc265fbc8a2..c2e9dad174fc4a0ca5594f2d9b3617a3b533ccee 100644 (file)
@@ -1,34 +1,25 @@
-.\"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 "" "" ""
+.\"     Title: amrecover
+.\"    Author: 
+.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
+.\"      Date: 02/07/2007
+.\"    Manual: 
+.\"    Source: 
+.\"
+.TH "AMRECOVER" "8" "02/07/2007" "" ""
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
 .SH "NAME"
-amrecover - Amanda index database browser
+amrecover \- Amanda index database browser
 .SH "SYNOPSIS"
 .HP 10
-\fBamrecover\fR [[-C] \fIconfig\fR] [-s \fIindex-server\fR] [-t \fItape-server\fR] [-d \fItape-device\fR] [-o \fIclientconfigoption\fR]*
-
+\fBamrecover\fR [\-C\ \fIconfig\fR] [\-s\ \fIindex\-server\fR] [\-t\ \fItape\-server\fR] [\-d\ \fItape\-device\fR] [\-o\ \fIconfigoption\fR]...
 .SH "DESCRIPTION"
 .PP
 \fBAmrecover\fR
 browses the database of
-\fBAmanda\fR
+\fIAmanda\fR
 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
@@ -38,15 +29,15 @@ from the root of the backed up filesystem, or use
 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
 Amrecover will read the
-\fBamanda-client.conf\fR
+\fBamanda\-client.conf\fR
 file and the
-\fIconfig\fR\fB/amanda-client.conf\fR
+\fIconfig\fR\fB/amanda\-client.conf\fR
 file.
 .PP
 See the
 \fBamanda\fR(8)
 man page for more details about
-\fBAmanda\fR.
+\fIAmanda\fR.
 .SH "OPTIONS"
 .sp
 .it 1 an-trap
@@ -54,25 +45,37 @@ man page for more details about
 .nr an-break-flag 1
 .br
 \fBNote\fR
-The Default values are those set at compile-time.
-Use \fBamrestore\fR to recover client-encrypted or
-client-custom-compressed tapes..TP
-\fB[ -C ] config\fR
-\fBAmanda\fR
+.PP
+The Default values are those set at compile\-time. Use
+\fBamrestore\fR
+to recover client\-encrypted or client\-custom\-compressed tapes.
+.PP
+\fB[ \-C ] config\fR
+.RS 4
+\fIAmanda\fR
 configuration.
-.TP
-\fB-s index-server\fR
+.RE
+.PP
+\fB\-s index\-server\fR
+.RS 4
 Host that runs the index daemon.
-.TP
-\fB-t tape-server\fR
+.RE
+.PP
+\fB\-t tape\-server\fR
+.RS 4
 Host that runs the tape server daemon.
-.TP
-\fB-d tape-device\fR
+.RE
+.PP
+\fB\-d tape\-device\fR
+.RS 4
 Tape device to use on the tape server host.
-.TP
-\fB-o\fR \fIclientconfigoption\fR
+.RE
+.PP
+\fB\-o\fR \fIclientconfigoption\fR
+.RS 4
 See the "\fBCONFIGURATION OVERWRITE\fR" section in
 \fBamanda\fR(8).
+.RE
 .SH "COMMANDS"
 .PP
 \fBAmrecover\fR
@@ -80,212 +83,271 @@ connects to the index server and then presents a command line prompt. Usage is s
 \fBamrecover\fR.
 .PP
 The purpose of browsing the database is to build up a
-\fBrestore list\fR
+\fIrestore list\fR
 of files to be extracted from the backup system. The following commands are available:
-.TP
+.PP
 \fBsethost hostname\fR
+.RS 4
 Specifies which host to look at backup files for (default: the local host).
-.TP
-\fBsetdate YYYY-MM-DD-HH-MM[-SS] | YYYY-MM-DD\fR
+.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
+.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
-
+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
+.RE
 .sp
 then the command
-\fBsetdate 1997-07-08-00\fR
+\fBsetdate 1997\-07\-08\-00\fR
 would yield files from the following days:
 .sp
+.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)
-
+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
+.RE
 .sp
 Only the most recent version of a file will be presented.
 .sp
 The following abbreviated date specifications are accepted:
-.RS
-.TP
-\fB--MM-DD\fR
+.RS 4
+.PP
+\fB\-\-MM\-DD\fR
+.RS 4
 dates in the current year
-.TP
-\fB---DD\fR
+.RE
+.PP
+\fB\-\-\-DD\fR
+.RS 4
 dates in the current month of the current year
 .RE
-.TP
-\fBsetdisk \fIdiskname\fR [\fImountpoint\fR]\fR
+.RE
+.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.
-\fBDiskname\fR
+\fIDiskname\fR
 is the device name specified in the
-\fBamanda.conf\fR
+\fIamanda.conf\fR
 or
-\fBdisklist\fR
+\fIdisklist\fR
 configuration file. The disk must be local to the host. If
-\fBmountpoint\fR
+\fImountpoint\fR
 is not specified, all pathnames will be relative to the (unknown) mount point instead of full pathnames.
-.TP
-\fBlisthost [diskdevice]\fR
+.RE
+.PP
+\fBlisthost \fR[\fIdiskdevice\fR]
+.RS 4
 List all
 \fBhost\fR
-.TP
-\fBlistdisk [diskdevice]\fR
+.RE
+.PP
+\fBlistdisk \fR[\fIdiskdevice\fR]
+.RS 4
 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 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
+.RE
+.PP
+\fBsettape \fR[[\fIserver\fR]:][\fItapedev\fR|\fIdefault\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, but the colon is not, the server name reverts to 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
+\fIdefault\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.
 .sp
 If you want amrecover to use your changer, the
-\fBtapedev\fR
+\fItapedev\fR
 must be equal to the amrecover_changer setting on the server.
 .sp
 If you need to change the protocol (tape:, rait:, file:, null:) then you must specify the hostname.
+.sp
+.RS 4
 .nf
-
 settape 192.168.0.10:file:/file1
 .fi
+.RE
 You can change the tape device when amrecover ask you to load the tape:
+.sp
+.RS 4
 .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
+.RE
+.RE
+.PP
+\fBsetmode \fR\fImode\fR
+.RS 4
 Set the extraction mode for Samba shares. If
-\fBmode\fR
+\fImode\fR
 is
 \fBsmb\fR, shares are sent to the Samba server to be restored back onto the PC. If
-\fBmode\fR
+\fImode\fR
 is
 \fBtar\fR, they are extracted on the local machine the same way tar volumes are extracted.
-.TP
+.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
+.RE
+.PP
 \fBcd dir\fR
+.RS 4
 Change the backup working directory to
-\fBdir.\fR
+\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
-\fBdir\fR
+\fIdir\fR
 can be a shell style wildcards.
-.TP
-\fBcdx dir\fR
+.RE
+.PP
+\fBcdx \fR\fIdir\fR
+.RS 4
 Like the
 \fBcd\fR
 command but allow regular expression.
-.TP
+.RE
+.PP
 \fBlpwd\fR
+.RS 4
 Display the
 \fBamrecover\fR
 working directory. Files will be restored under this directory, relative to the backed up filesystem.
-.TP
-\fBlcd path\fR
+.RE
+.PP
+\fBlcd \fR\fIpath\fR
+.RS 4
 Change the
 \fBamrecover\fR
 working directory to
-\fBpath\fR.
-.TP
+\fIpath\fR.
+.RE
+.PP
 \fBls\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.
-.TP
-\fBadd item1 item2 ...\fR
+.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
+.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
-\fBAmanda\fR
+\fIAmanda\fR
 tapes with
 \fBamrestore\fR.
-.TP
+.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
+.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.
-.TP
+.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
+\fIsyslog\fR
 file.
+.sp
+.RS 4
 .nf
-
 # cd /var/log
-# ls -l syslog.7
+# ls \-l syslog.7
 syslog.7: No such file or directory
 # amrecover
 AMRECOVER Version 2.4.2. Contacting server on oops ...
-220 oops \fBAmanda\fR index server (2.4.2) ready.
-Setting restore date to today (1997-12-09)
-200 Working date set to 1997-12-09.
+220 oops \fIAmanda\fR 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 Dump host set to this-host.some.org.
+200 Dump host set to this\-host.some.org.
 $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!
+WARNING: not on root of selected filesystem, check man\-page!
 amrecover> ls
-1997-12-09 daemon.log
-1997-12-09 syslog
-1997-12-08 authlog
-1997-12-08 sysidconfig.log
-1997-12-08 syslog.0
-1997-12-08 syslog.1
-1997-12-08 syslog.2
-1997-12-08 syslog.3
-1997-12-08 syslog.4
-1997-12-08 syslog.5
-1997-12-08 syslog.6
-1997-12-08 syslog.7
+1997\-12\-09 daemon.log
+1997\-12\-09 syslog
+1997\-12\-08 authlog
+1997\-12\-08 sysidconfig.log
+1997\-12\-08 syslog.0
+1997\-12\-08 syslog.1
+1997\-12\-08 syslog.2
+1997\-12\-08 syslog.3
+1997\-12\-08 syslog.4
+1997\-12\-08 syslog.5
+1997\-12\-08 syslog.6
+1997\-12\-08 syslog.7
 amrecover> add syslog.7
 Added /log/syslog.7
 amrecover> lpwd
@@ -306,26 +368,28 @@ Continue? [Y/n/t]: y
 set owner/mode for '.'? [yn] n
 amrecover> quit
 200 Good bye.
-# ls -l syslog.7
+# ls \-l syslog.7
 total 26
--rw-r--r--   1 root     other      12678 Oct 14 16:36 syslog.7
+\-rw\-r\-\-r\-\-   1 root     other      12678 Oct 14 16:36 syslog.7
 .fi
+.RE
 .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.
+.sp
+.RS 4
 .nf
-
 # cd /var
 # (umask 077 ; mkdir .restore)
 # cd .restore
 # amrecover
 AMRECOVER Version 2.4.2. Contacting server on oops ...
-...
+\&...
 amrecover> cd log
 /var/log
 amrecover> ls
-...
+\&...
 amrecover> add syslog.7
 Added /log/syslog.7
 amrecover> lpwd
@@ -333,13 +397,14 @@ amrecover> lpwd
 amrecover> extract
 
 Extracting files using tape drive /dev/nst0 on host 192.168.0.10
-...
+\&...
 amrecover> quit
 200 Good bye.
-# mv -i log/syslog.7 ../log/syslog.7-restored
+# mv \-i log/syslog.7 ../log/syslog.7\-restored
 # cd ..
-# rm -fr .restore
+# rm \-fr .restore
 .fi
+.RE
 .PP
 If you need to run
 \fBamrestore\fR
@@ -348,68 +413,73 @@ by hand instead of letting
 control it, use the
 \fBlist\fR
 command after browsing to display the needed tapes.
+.sp
+.RS 4
 .nf
-
 # cd /var/log
 # amrecover
 AMRECOVER Version 2.4.2. Contacting server on oops ...
-...
+\&...
 amrecover> ls
-...
+\&...
 amrecover> add syslog syslog.6 syslog.7
 Added /log/syslog
 Added /log/syslog.6
 Added /log/syslog.7
 amrecover> list
-TAPE DMP014 LEVEL 0 DATE 1997-12-08
+TAPE DMP014 LEVEL 0 DATE 1997\-12\-08
         /log/syslog.7
         /log/syslog.6
-TAPE DMP015 LEVEL 1 DATE 1997-12-09
+TAPE DMP015 LEVEL 1 DATE 1997\-12\-09
         /log/syslog
 amrecover> quit 
 .fi
+.RE
 .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.
 .PP
 Tape file position zero is a label. The first backup image is in file position one.
+.sp
+.RS 4
 .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"
-201- 1997-12-09 1 DMP015 9
-201- 1997-12-08 1 DMP014 11
-201- 1997-12-07 0 DMP013 22
-201- 1997-12-06 1 DMP012 16
-201- 1997-12-05 1 DMP011 9
-201- 1997-12-04 0 DMP010 11
-201- 1997-12-03 1 DMP009 7
-201- 1997-12-02 1 DMP008 7
-201- 1997-12-01 1 DMP007 9
-201- 1997-11-30 1 DMP006 6
-...
+200\- Dump history for config "daily" 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
+201\- 1997\-12\-06 1 DMP012 16
+201\- 1997\-12\-05 1 DMP011 9
+201\- 1997\-12\-04 0 DMP010 11
+201\- 1997\-12\-03 1 DMP009 7
+201\- 1997\-12\-02 1 DMP008 7
+201\- 1997\-12\-01 1 DMP007 9
+201\- 1997\-11\-30 1 DMP006 6
+\&...
 amrecover> quit 
 .fi
+.RE
 .SH "ENVIRONMENT"
 .PP
-\fBPAGER\fRThe
+\fBPAGER\fR
+The
 \fBls\fR
 and
 \fBlist\fR
 commands will use $PAGER to display the file lists. Defaults to
-\fBmore\fR
+\fImore\fR
 if PAGER is not set.
 .PP
 \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.
+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
 \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.
+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 "AUTHOR"
 .PP
 Alan M. McIvor
@@ -418,12 +488,11 @@ Alan M. McIvor
 .PP
 Stefan G. Weichinger,
 <sgw@amanda.org>, maintainer of the
-\fBAmanda\fR-documentation: XML-conversion
+\fIAmanda\fR\-documentation: XML\-conversion
 .SH "SEE ALSO"
 .PP
 \fBamanda\fR(8),
-\fBamanda-client.conf\fR(5),
+\fBamanda\-client.conf\fR(5),
 \fBamrestore\fR(8),
 \fBamfetchdump\fR(8),
 \fBreadline\fR(3)
-