Imported Upstream version 3.1.0
[debian/amanda] / man / amanda.8
index a2f41c76d91a6c483dfa74ea4b43c7aa9357432b..b83fb7a0b9258f4907a3cfe00fdcf6e930a4c1fa 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: amanda
 .\"    Author: James da Silva <jds@amanda.org>
 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
-.\"      Date: 11/05/2009
+.\"      Date: 06/01/2010
 .\"    Manual: System Administration Commands
-.\"    Source: Amanda 2.6.1p2
+.\"    Source: Amanda 3.1.0
 .\"  Language: English
 .\"
-.TH "AMANDA" "8" "11/05/2009" "Amanda 2\&.6\&.1p2" "System Administration Commands"
+.TH "AMANDA" "8" "06/01/2010" "Amanda 3\&.1\&.0" "System Administration Commands"
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
 amanda \- The Open Source Backup Platform
 .SH "DESCRIPTION"
 .PP
-This manual page gives an overview of the
-\fIAmanda\fR
-commands and configuration files for quick reference\&.
+This manual page gives an overview of the Amanda commands and configuration files for quick reference\&.
 .SS "COMMANDS"
 .PP
-Here are all the
-\fIAmanda\fR
-commands\&. Each one has its own manual page\&. See them for all the gory details\&.
+Here are all the Amanda commands\&. Each one has its own manual page\&. See them for all the gory details\&.
 .sp
 .RS 4
 .ie n \{\
@@ -72,7 +68,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail
 .sp -1
 .IP \(bu 2.3
 .\}
-\fBamcheck\fR(8),
+\fBamarchiver\fR(8),
 .RE
 .sp
 .RS 4
@@ -83,7 +79,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail
 .sp -1
 .IP \(bu 2.3
 .\}
-\fBamcheckdb\fR(8),
+\fBamcheck\fR(8),
 .RE
 .sp
 .RS 4
@@ -94,7 +90,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail
 .sp -1
 .IP \(bu 2.3
 .\}
-\fBamcheckdump\fR(8),
+\fBamcheckdb\fR(8),
 .RE
 .sp
 .RS 4
@@ -105,7 +101,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail
 .sp -1
 .IP \(bu 2.3
 .\}
-\fBamcleanup\fR(8),
+\fBamcheckdump\fR(8),
 .RE
 .sp
 .RS 4
@@ -116,7 +112,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail
 .sp -1
 .IP \(bu 2.3
 .\}
-\fBamcrypt-ossl-asym\fR(8),
+\fBamcleanup\fR(8),
 .RE
 .sp
 .RS 4
@@ -127,7 +123,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail
 .sp -1
 .IP \(bu 2.3
 .\}
-\fBamcrypt-ossl\fR(8),
+\fBamcrypt-ossl-asym\fR(8),
 .RE
 .sp
 .RS 4
@@ -138,7 +134,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail
 .sp -1
 .IP \(bu 2.3
 .\}
-\fBamcrypt\fR(8),
+\fBamcrypt-ossl\fR(8),
 .RE
 .sp
 .RS 4
@@ -149,7 +145,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail
 .sp -1
 .IP \(bu 2.3
 .\}
-\fBamcryptsimple\fR(8),
+\fBamcrypt\fR(8),
 .RE
 .sp
 .RS 4
@@ -160,7 +156,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail
 .sp -1
 .IP \(bu 2.3
 .\}
-\fBamdd\fR(8),
+\fBamcryptsimple\fR(8),
 .RE
 .sp
 .RS 4
@@ -259,7 +255,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail
 .sp -1
 .IP \(bu 2.3
 .\}
-\fBammt\fR(8),
+\fBamoverview\fR(8),
 .RE
 .sp
 .RS 4
@@ -270,7 +266,7 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail
 .sp -1
 .IP \(bu 2.3
 .\}
-\fBamoverview\fR(8),
+\fBampgsql\fR(8),
 .RE
 .sp
 .RS 4
@@ -292,6 +288,17 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail
 .sp -1
 .IP \(bu 2.3
 .\}
+\fBamraw\fR(8),
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
 \fBamrecover\fR(8),
 .RE
 .sp
@@ -391,6 +398,17 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail
 .sp -1
 .IP \(bu 2.3
 .\}
+\fBamsuntar\fR(8),
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
 \fBamtape\fR(8),
 .RE
 .sp
@@ -559,6 +577,17 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail
 .sp -1
 .IP \(bu 2.3
 .\}
+\fBamanda-compatibility\fR(7),
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
 \fBamanda-devices\fR(7),
 .RE
 .sp
@@ -572,17 +601,25 @@ commands\&. Each one has its own manual page\&. See them for all the gory detail
 .\}
 \fBamanda-scripts\fR(7),
 .RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fBamanda-taperscan\fR(7),
+.RE
 .SH "CONFIGURATION"
 .PP
-There are four user\-editable files that control the behavior of
-\fIAmanda\fR\&.
+There are four user\-editable files that control the behavior of Amanda\&.
 .PP
 The first two are
 \fBamanda.conf\fR(5)
 and
-\fBamanda-client.conf\fR(5), the main configuration files for the server and client, respectively\&. They contain parameters to customize
-\fIAmanda\fR
-for the site\&.
+\fBamanda-client.conf\fR(5), the main configuration files for the server and client, respectively\&. They contain parameters to customize Amanda for the site\&.
 .PP
 Next is the
 \fBdisklist\fR(5)
@@ -592,7 +629,7 @@ Last is the seldom\-edited
 \fBtapelist\fR(5)
 file, which lists tapes that are currently active\&. These files are described in more detail in the following sections\&.
 .PP
-All files are stored in individual configuration directories, usually under
+All configuration files are stored in individual configuration directories, usually under
 /etc/amanda/\&. A site will often have more than one configuration\&. For example, it might have a
 \fInormal\fR
 configuration for everyday backups and an
@@ -600,23 +637,22 @@ configuration for everyday backups and an
 configuration for infrequent full archival backups\&. The configuration files would be stored under directories
 /etc/amanda/normal/
 and
-/etc/amanda/archive/, respectively\&. Part of the job of an
-\fIAmanda\fR
-administrator is to create, populate and maintain these directories\&.
+/etc/amanda/archive/, respectively\&. Part of the job of an Amanda administrator is to create, populate and maintain these directories\&.
+.PP
+Most Amanda applications take a "config" parameter; this is generally the (unqualified) name of the configuration directory, e\&.g\&.,
+normal\&. If the parameter is
+\&.
+(dot), the current directory is used\&. This feature is present for backward compatibility, but is not commonly used\&.
 .SH "LOG FILES"
 .PP
-All log and database files generated by
-\fIAmanda\fR
-go in corresponding directories somewhere\&. The exact location is controlled by entries in
+All log and database files generated by Amanda go in corresponding directories somewhere\&. The exact location is controlled by entries in
 \fBamanda.conf\fR(5)\&. A typical location would be under
 /var/adm/amanda\&. For the above example, the files might go in
 /var/adm/amanda/normal/
 and
 /var/adm/amanda/archive/\&.
 .PP
-As log files are no longer needed (no longer contain relevant information),
-\fIAmanda\fR
-cycles them out in various ways, depending on the type of file\&.
+As log files are no longer needed (no longer contain relevant information), Amanda cycles them out in various ways, depending on the type of file\&.
 .PP
 Detailed information about
 \fBamdump\fR
@@ -647,34 +683,30 @@ is a sequence number started at 0\&. At the end of each
 run, log files for runs whose tapes have been reused are renamed into a subdirectory of the main log directory (see the
 \fBlogdir\fR
 parameter below) named
-\fBoldlog\fR\&. It is up to the
-\fIAmanda\fR
-administrator to remove them from this directory when desired\&.
+\fBoldlog\fR\&. It is up to the Amanda administrator to remove them from this directory when desired\&.
 .PP
 Index (backup image catalogue) files older than the full dump matching the oldest backup image for a given client and disk are removed by
 \fBamdump\fR
 at the end of each run\&.
 .SH "USING SAMBA"
 .PP
-For Samba access,
-\fIAmanda\fR
-needs a file on the Samba server (which may or may not also be the tape server) named
+For Samba access, Amanda needs a file on the Samba server (which may or may not also be the tape server) named
 /etc/amandapass
-with share names, (clear text) passwords and (optional) domain names, in that order, one per line, whitespace separated\&. By default, the user used to connect to the PC is the same for all PC\'s and is compiled into
-\fIAmanda\fR\&. It may be changed on a host by host basis by listing it first in the password field followed by a percent sign and then the password\&. For instance:
+with share names, (clear text) passwords and (optional) domain names, in that order, one per line, whitespace separated\&. By default, the user used to connect to the PC is the same for all PC\'s and is compiled into Amanda\&. It may be changed on a host by host basis by listing it first in the password field followed by a percent sign and then the password\&. For instance:
 .nf
   //some\-pc/home normalpw
   //another\-pc/disk otheruser%otherpw
 .fi
 .PP
-With clear text passwords, this file should obviously be tightly protected\&. It only needs to be readable by the
-\fIAmanda\fR\-user on the Samba server\&.
+With clear text passwords, this file should obviously be tightly protected\&. It only needs to be readable by the Amanda\-user on the Samba server\&.
 .SH "HOST & DISK EXPRESSION"
 .PP
-All host and disk arguments to programs are special expressions\&. The command applies to all disks that match your arguments\&. This section describes the matcher\&.
+All host and disk arguments to programs are special expressions\&. The command applies to all DLEs that match the arguments\&. This section describes the matcher\&.
 .PP
 The matcher matches by word, each word is a glob expression, words are separated by the separator \'\&.\' for host and \'/\' for disk\&. You can anchor the expression at left with a \'^\'\&. You can anchor the expression at right with a \'$\'\&. The matcher is case insensitive for host but is case sensitive for disk\&. A match succeeds if all words in your expression match contiguous words in the host or disk\&.
 .PP
+If the disk is a UNC ("\e\ewindows\eshare") then all \'\e\' are converted to \'/\' before the match\&. Using \'\e\' is complicated because of the extra quoting required by the shell and amanda\&. It\'s easier to use \'/\' because it require less quoting ("//windows/share")
+.PP
 dot (\&.)
 .RS 4
 word separator for a host
@@ -685,6 +717,11 @@ word separator for a host
 word separator for a disk
 .RE
 .PP
+\e
+.RS 4
+word separator for a UNC disk
+.RE
+.PP
 ^
 .RS 4
 anchor at left
@@ -710,6 +747,18 @@ match zero or more characters except the separator
 match zero or more characters including the separator
 .RE
 .PP
+[\&.\&.\&.]
+.RS 4
+match a single character, namely any of the characters enclosed by the brackets\&.
+.RE
+.PP
+[!\&.\&.\&.]
+.RS 4
+match a single character, namely any characters that is not enclosed by the brackets\&.
+.RE
+.PP
+The shell interpret some of these characters, they must be escaped by a backslash \'\e\' and/or the expression must be enclosed in simple or double quote\&.
+.PP
 Some examples:
 .PP
 hosta
@@ -809,6 +858,28 @@ Will match the disks
 but not
 /usr/local\&.
 .RE
+.PP
+share
+.RS 4
+Will match the disks
+\e\ewindows1\eshare
+and
+\e\ewindows2\eshare\&.
+.RE
+.PP
+share*
+.RS 4
+Will match the disks
+\e\ewindows\eshare1
+and
+\e\ewindows\eshare2\&.
+.RE
+.PP
+//windows/share
+.RS 4
+Will match the disk
+\e\ewindows\eshare\&.
+.RE
 .SH "DATESTAMP EXPRESSION"
 .PP
 A