lintian doesn't like orphan packages with uploaders...
[debian/amanda] / man / amanda-client.conf.5
index 692ccc359f41c931e9b8ab607f0e4dfb2075c1f7..7e8f537d167f062bc630c8a788a858fc3b85d60d 100644 (file)
@@ -1,13 +1,22 @@
 '\" t
 .\"     Title: amanda-client.conf
 .\"    Author: James da Silva <jds@amanda.org>
-.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
-.\"      Date: 06/01/2010
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 01/10/2013
 .\"    Manual: File formats and conventions
-.\"    Source: Amanda 3.1.0
+.\"    Source: Amanda 3.3.3
 .\"  Language: English
 .\"
-.TH "AMANDA\-CLIENT\&.CON" "5" "06/01/2010" "Amanda 3\&.1\&.0" "File formats and conventions"
+.TH "AMANDA\-CLIENT\&.CON" "5" "01/10/2013" "Amanda 3\&.3\&.3" "File formats and conventions"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
@@ -43,7 +52,7 @@ Default:
 \fISet by configure\fR\&. The conf use by amrecover\&.
 .RE
 .PP
-\fBclient_username\fR \fIstring\fR
+\fBclient\-username\fR \fIstring\fR
 .RS 4
 Default:
 \fICLIENT_LOGIN\fR\&. Similar to the parameter of the same name in
@@ -54,20 +63,26 @@ should send when connecting to the server\&. It should match the username specif
 on the server\&.
 .RE
 .PP
-\fBclient_port\fR [ \fIint\fR | \fIstring\fR ]
+\fBclient\-port\fR [ \fIint\fR | \fIstring\fR ]
 .RS 4
 Default:
 \fI"amanda"\fR\&. Similar to the parameter of the same name in
 \fBamanda.conf\fR(5), this specifies the port to connect on the server\&. It can be a service name or a numeric port number\&.
 .RE
 .PP
-\fBindex_server\fR \fIstring\fR
+\fBamdump\-server\fR \fIstring\fR
+.RS 4
+No default:
+\fISet by configure\fR\&. The amanda server to connect with the amdump_client program\&.
+.RE
+.PP
+\fBindex\-server\fR \fIstring\fR
 .RS 4
 Default:
 \fISet by configure\fR\&. The amindexd server amrecover will connect to\&.
 .RE
 .PP
-\fBtape_server\fR \fIstring\fR
+\fBtape\-server\fR \fIstring\fR
 .RS 4
 Default:
 \fISet by configure\fR\&. The amidxtaped server amrecover will connect to\&.
@@ -82,7 +97,7 @@ Default:
 \fBauth\fR \fIstring\fR
 .RS 4
 Default:
-\fB"bsd"\fR\&. Type of authorization to perform between tape server and backup client hosts\&.
+\fB"bsdtcp"\fR\&. Type of authorization to perform between tape server and backup client hosts\&.
 .sp
 \fB"bsd"\fR, bsd authorization with udp initial connection and one tcp connection by data stream\&.
 .sp
@@ -93,7 +108,7 @@ Default:
 \fB"krb5"\fR
 to use Kerberos\-V authorization\&.
 .sp
-\fB"local"\fR, if the client is the server, it doesn\'t require authencation setup\&.
+\fB"local"\fR, if the client is the server, it doesn\*(Aqt require authencation setup\&.
 .sp
 \fB"rsh"\fR
 to use rsh authorization\&.
@@ -102,13 +117,13 @@ to use rsh authorization\&.
 to use OpenSSH authorization\&.
 .RE
 .PP
-\fBssh_keys\fR \fIstring\fR
+\fBssh\-keys\fR \fIstring\fR
 .RS 4
 Default:
 \fINo default\fR\&. The key file the ssh auth will use, it must be the private key\&. If this parameter is not specified, then the default ssh key will be used\&.
 .RE
 .PP
-\fBgnutar_list_dir\fR \fIstring\fR
+\fBgnutar\-list\-dir\fR \fIstring\fR
 .RS 4
 Default from configure
 \fI\-\-with\-gnutar\-listdir=DIR\fR\&. The directory where gnutar keep its state file\&.
@@ -116,7 +131,7 @@ Default from configure
 .PP
 \fBmailer\fR \fIstring\fR
 .RS 4
-Default found by configure\&. A mail program that can send mail with \'\fIMAILER \-s "subject" user < message_file\fR\'\&.
+Default found by configure\&. A mail program that can send mail with \*(Aq\fIMAILER \-s "subject" user < message_file\fR\*(Aq\&.
 .RE
 .PP
 \fBamandates\fR \fIstring\fR
@@ -125,85 +140,85 @@ Default:
 \fI/etc/amandates\fR\&. The file where amanda keep the last date of each dumplevel\&.
 .RE
 .PP
-\fBconnect_tries\fR \fIint\fR
+\fBconnect\-tries\fR \fIint\fR
 .RS 4
 Default:
 \fI3\fR\&. How many times the server will try a connection\&.
 .RE
 .PP
-\fBrep_tries\fR \fIint\fR
+\fBrep\-tries\fR \fIint\fR
 .RS 4
 Default:
-\fI5\fR\&. How many times amandad will resend a REP packet if it doesn\'t get the ACK packet\&.
+\fI5\fR\&. How many times amandad will resend a REP packet if it doesn\*(Aqt get the ACK packet\&.
 .RE
 .PP
-\fBdebug_days\fR \fIint\fR
+\fBdebug\-days\fR \fIint\fR
 .RS 4
 Default:
 \fI3\fR\&. The number of days the debug files are kept\&.
 .RE
 .PP
-\fBdebug_amandad\fR \fIint\fR
+\fBdebug\-amandad\fR \fIint\fR
 .RS 4
 Default:
 \fI0\fR\&. Debug level of the amandad process
 .RE
 .PP
-\fBdebug_amidxtaped\fR \fIint\fR
+\fBdebug\-amidxtaped\fR \fIint\fR
 .RS 4
 Default:
 \fI0\fR\&. Debug level of the amidxtaped process
 .RE
 .PP
-\fBdebug_amindexd\fR \fIint\fR
+\fBdebug\-amindexd\fR \fIint\fR
 .RS 4
 Default:
 \fI0\fR\&. Debug level of the amindexd process
 .RE
 .PP
-\fBdebug_amrecover\fR \fIint\fR
+\fBdebug\-amrecover\fR \fIint\fR
 .RS 4
 Default:
 \fI0\fR\&. Debug level of the amrecover process
 .RE
 .PP
-\fBdebug_auth\fR \fIint\fR
+\fBdebug\-auth\fR \fIint\fR
 .RS 4
 Default:
 \fI0\fR\&. Debug level of the auth module
 .RE
 .PP
-\fBdebug_event\fR \fIint\fR
+\fBdebug\-event\fR \fIint\fR
 .RS 4
 Default:
 \fI0\fR\&. Debug level of the event module
 .RE
 .PP
-\fBdebug_holding\fR \fIint\fR
+\fBdebug\-holding\fR \fIint\fR
 .RS 4
 Default:
 \fI0\fR\&. Debug level of the holdingdisk module
 .RE
 .PP
-\fBdebug_protocol\fR \fIint\fR
+\fBdebug\-protocol\fR \fIint\fR
 .RS 4
 Default:
 \fI0\fR\&. Debug level of the protocol module
 .RE
 .PP
-\fBdebug_selfcheck\fR \fIint\fR
+\fBdebug\-selfcheck\fR \fIint\fR
 .RS 4
 Default:
 \fI0\fR\&. Debug level of the selfcheck process
 .RE
 .PP
-\fBdebug_sendsize\fR \fIint\fR
+\fBdebug\-sendsize\fR \fIint\fR
 .RS 4
 Default:
 \fI0\fR\&. Debug level of the sendsize process
 .RE
 .PP
-\fBdebug_sendbackup\fR \fIint\fR
+\fBdebug\-sendbackup\fR \fIint\fR
 .RS 4
 Default:
 \fI0\fR\&. Debug level of the sendbackup process
@@ -234,7 +249,7 @@ Adds a global property for this client host, useful for e\&.g\&., Application AP
 .SH "APPLICATION SECTION"
 .PP
 The
-\fBamanda\&.conf\fR
+\fBamanda\-client\&.conf\fR
 file may define multiple types of application\&. The information is entered in a
 \fBapplication\fR
 section, which looks like this:
@@ -246,11 +261,28 @@ define application "\fIname\fR" {
 .fi
 .PP
 \fIname\fR
-is the name of this type of application\&. It is referenced from the
-\fBdumptype\fR
+is the name of this type of application\&.
+.PP
+The setting from an application is merged with the dle setting if the
+\fIname\fR
+is the same as the
+\fBclient\-application\-name\fR
+from the dle or if the
+\fBclient\-application\-name\fR
+from the dle is not set and the
+\fIname\fR
+is the same as the
+\fBplugin\fR
+from the dle\&.
 .PP
 The application options and values are:
 .PP
+\fBclient\-application\-name\fR \fIstring\fR
+.RS 4
+Default:
+\fInone\fR\&. Not use on the client\&.
+.RE
+.PP
 \fBcomment\fR \fIstring\fR
 .RS 4
 Default:
@@ -261,7 +293,8 @@ Default:
 .RS 4
 No default\&. Must be set to the name of the program\&. This program must be in the
 \fI$libexecdir/amanda/application\fR
-directory on the client\&.
+directory on the client\&. If set, it must be the same as the dle
+\fBplugin\fR\&.
 .RE
 .PP
 \fBproperty\fR [\fBappend\fR] [\fBpriority\fR] \fIstring\fR \fIstring\fR+
@@ -275,7 +308,7 @@ keyword disallow the setting of that property on the server\&.
 .SH "SCRIPT SECTION"
 .PP
 The
-\fBamanda\&.conf\fR
+\fBamanda\-client\&.conf\fR
 file may define multiple types of script\&. The information is entered in a
 \fBscript\fR
 section, which looks like this:
@@ -287,11 +320,28 @@ define script "\fIname\fR" {
 .fi
 .PP
 \fIname\fR
-is the name of this type of script\&. It is referenced from the
-\fBdumptype\fR
+is the name of this type of script\&.
+.PP
+The setting from a script is merged with the dle setting if the
+\fIname\fR
+is the same as the
+\fBclient\-script\-name\fR
+from the dle or if the
+\fBclient\-script\-name\fR
+from the dle is not set and the
+\fIname\fR
+is the same as the
+\fBplugin\fR
+from the dle\&.
 .PP
 The script options and values are:
 .PP
+\fBclient\-script\-name\fR \fIstring\fR
+.RS 4
+Default:
+\fInone\fR\&. Not used on the client\&.
+.RE
+.PP
 \fBcomment\fR \fIstring\fR
 .RS 4
 Default:
@@ -302,18 +352,17 @@ Default:
 .RS 4
 No default\&. Must be set to the name of the program\&. This program must be in the
 \fI$libdir/amanda/application\fR
-directory on the client and/or server\&.
+directory on the client\&. If set, it must be the same as the dle
+\fBplugin\fR\&.
 .RE
 .PP
-\fBexecute_where\fR [ \fBclient\fR | \fBserver\fR ]
+\fBexecute\-where\fR \fBclient\fR
 .RS 4
 Default:
-\fBclient\fR\&. Where the script must be executed, on the client or server\&. Only
-\fBclient\fR
-is valid\&.
+\fBclient\fR\&. Value can\*(Aqt be changed\&.
 .RE
 .PP
-\fBexecute_on\fR \fIexecute_on\fR[,\fIexecute_on\fR]*
+\fBexecute\-on\fR \fIexecute_on\fR[,\fIexecute_on\fR]*
 .RS 4
 No default\&. When the script must be executed, you can specify many of them:
 .PP
@@ -362,21 +411,11 @@ Execute after the estimate command for all dle for the client\&.
 Execute before the backup command for the dle\&.
 .RE
 .PP
-\fBpre\-host\-backup\fR
-.RS 4
-Execute before the backup command for all dle for the client\&.
-.RE
-.PP
 \fBpost\-dle\-backup\fR
 .RS 4
 Execute after the backup command for the dle\&.
 .RE
 .PP
-\fBpost\-host\-backup\fR
-.RS 4
-Execute after the backup command for all dle for the client\&.
-.RE
-.PP
 \fBpre\-recover\fR
 .RS 4
 Execute before any level is recovered\&.