Imported Upstream version 3.3.1

[debian/amanda] / man / xml-source / amanda-client.conf.5.xml

diff --git a/man/xml-source/amanda-client.conf.5.xml b/man/xml-source/amanda-client.conf.5.xml
index 7942d70acdddcdd90343eadb475b37293e588244..9380657b94829712722065b5a723bda336382af2 100644 (file)
--- a/man/xml-source/amanda-client.conf.5.xml
+++ b/man/xml-source/amanda-client.conf.5.xml
@@ -53,7 +53,7 @@ The conf use by amrecover.</para>
   </varlistentry>
 
   <varlistentry>
-  <term><amkeyword>client_username</amkeyword> <amtype>string</amtype></term>
+  <term><amkeyword>client-username</amkeyword> <amtype>string</amtype></term>
   <listitem>
 <para>Default:
 <amdefault>CLIENT_LOGIN</amdefault>.
@@ -64,7 +64,7 @@ specified in &amandahosts; on the server.</para>
   </varlistentry>
 
   <varlistentry>
-  <term><amkeyword>client_port</amkeyword> [ <amtype>int</amtype> | <amtype>string</amtype> ]</term>
+  <term><amkeyword>client-port</amkeyword> [ <amtype>int</amtype> | <amtype>string</amtype> ]</term>
   <listitem>
 <para>Default:
 <amdefault>"amanda"</amdefault>.
@@ -73,7 +73,16 @@ Similar to the parameter of the same name in &amconf;, this specifies the port t
   </varlistentry>
 
   <varlistentry>
-  <term><amkeyword>index_server</amkeyword> <amtype>string</amtype></term>
+  <term><amkeyword>amdump-server</amkeyword> <amtype>string</amtype></term>
+  <listitem>
+<para>No default:
+<amdefault>Set by configure</amdefault>.
+The amanda server to connect with the amdump_client program.</para>
+  </listitem>
+  </varlistentry>
+
+  <varlistentry>
+  <term><amkeyword>index-server</amkeyword> <amtype>string</amtype></term>
   <listitem>
 <para>Default:
 <amdefault>Set by configure</amdefault>.
@@ -82,7 +91,7 @@ The amindexd server amrecover will connect to.</para>
   </varlistentry>
 
   <varlistentry>
-  <term><amkeyword>tape_server</amkeyword> <amtype>string</amtype></term>
+  <term><amkeyword>tape-server</amkeyword> <amtype>string</amtype></term>
   <listitem>
 <para>Default:
 <amdefault>Set by configure</amdefault>.
@@ -103,7 +112,7 @@ The tapedev amrecover will use.</para>
   <term><amkeyword>auth</amkeyword> <amtype>string</amtype></term>
   <listitem>
 <para>Default:
-<amkeyword>"bsd"</amkeyword>.
+<amkeyword>"bsdtcp"</amkeyword>.
 Type of authorization to perform between tape server and backup client hosts.</para>
 <para><amkeyword>"bsd"</amkeyword>, bsd authorization with udp initial
 connection and one tcp connection by data stream.</para>
@@ -124,7 +133,7 @@ authorization.</para>
   </varlistentry>
 
   <varlistentry>
-  <term><amkeyword>ssh_keys</amkeyword> <amtype>string</amtype></term>
+  <term><amkeyword>ssh-keys</amkeyword> <amtype>string</amtype></term>
   <listitem>
 <para>Default:
 <amdefault>No default</amdefault>.
@@ -133,7 +142,7 @@ The key file the ssh auth will use, it must be the private key. If this paramete
   </varlistentry>
 
   <varlistentry>
-  <term><amkeyword>gnutar_list_dir</amkeyword> <amtype>string</amtype></term>
+  <term><amkeyword>gnutar-list-dir</amkeyword> <amtype>string</amtype></term>
   <listitem>
 <para>Default from configure 
 <amdefault>--with-gnutar-listdir=DIR</amdefault>.
@@ -158,7 +167,7 @@ The file where amanda keep the last date of each dumplevel.</para>
   </varlistentry>
 
   <varlistentry>
-  <term><amkeyword>connect_tries</amkeyword> <amtype>int</amtype></term>
+  <term><amkeyword>connect-tries</amkeyword> <amtype>int</amtype></term>
   <listitem>
 <para>Default:
 <amdefault>3</amdefault>.
@@ -167,7 +176,7 @@ How many times the server will try a connection.</para>
   </varlistentry>
 
   <varlistentry>
-  <term><amkeyword>rep_tries</amkeyword> <amtype>int</amtype></term>
+  <term><amkeyword>rep-tries</amkeyword> <amtype>int</amtype></term>
   <listitem>
 <para>Default:
 <amdefault>5</amdefault>.
@@ -176,7 +185,7 @@ How many times amandad will resend a REP packet if it doesn't get the ACK packet
   </varlistentry>
 
   <varlistentry>
-  <term><amkeyword>debug_days</amkeyword> <amtype>int</amtype></term>
+  <term><amkeyword>debug-days</amkeyword> <amtype>int</amtype></term>
   <listitem>
 <para>Default:
 <amdefault>3</amdefault>.
@@ -185,7 +194,7 @@ The number of days the debug files are kept.</para>
   </varlistentry>
 
   <varlistentry>
-  <term><amkeyword>debug_amandad</amkeyword> <amtype>int</amtype></term>
+  <term><amkeyword>debug-amandad</amkeyword> <amtype>int</amtype></term>
   <listitem>
 <para>Default:
 <emphasis remap='I'>0</emphasis>.
@@ -194,7 +203,7 @@ Debug level of the amandad process</para>
   </varlistentry>
 
   <varlistentry>
-  <term><amkeyword>debug_amidxtaped</amkeyword> <amtype>int</amtype></term>
+  <term><amkeyword>debug-amidxtaped</amkeyword> <amtype>int</amtype></term>
   <listitem>
 <para>Default:
 <amdefault>0</amdefault>.
@@ -203,7 +212,7 @@ Debug level of the amidxtaped process</para>
   </varlistentry>
 
   <varlistentry>
-  <term><amkeyword>debug_amindexd</amkeyword> <amtype>int</amtype></term>
+  <term><amkeyword>debug-amindexd</amkeyword> <amtype>int</amtype></term>
   <listitem>
 <para>Default:
 <amdefault>0</amdefault>.
@@ -212,7 +221,7 @@ Debug level of the amindexd process</para>
   </varlistentry>
 
   <varlistentry>
-  <term><amkeyword>debug_amrecover</amkeyword> <amtype>int</amtype></term>
+  <term><amkeyword>debug-amrecover</amkeyword> <amtype>int</amtype></term>
   <listitem>
 <para>Default:
 <amdefault>0</amdefault>.
@@ -221,7 +230,7 @@ Debug level of the amrecover process</para>
   </varlistentry>
 
   <varlistentry>
-  <term><amkeyword>debug_auth</amkeyword> <amtype>int</amtype></term>
+  <term><amkeyword>debug-auth</amkeyword> <amtype>int</amtype></term>
   <listitem>
 <para>Default:
 <amdefault>0</amdefault>.
@@ -230,7 +239,7 @@ Debug level of the auth module</para>
   </varlistentry>
 
   <varlistentry>
-  <term><amkeyword>debug_event</amkeyword> <amtype>int</amtype></term>
+  <term><amkeyword>debug-event</amkeyword> <amtype>int</amtype></term>
   <listitem>
 <para>Default:
 <amdefault>0</amdefault>.
@@ -239,7 +248,7 @@ Debug level of the event module</para>
   </varlistentry>
 
   <varlistentry>
-  <term><amkeyword>debug_holding</amkeyword> <amtype>int</amtype></term>
+  <term><amkeyword>debug-holding</amkeyword> <amtype>int</amtype></term>
   <listitem>
 <para>Default:
 <amdefault>0</amdefault>.
@@ -248,7 +257,7 @@ Debug level of the holdingdisk module</para>
   </varlistentry>
 
   <varlistentry>
-  <term><amkeyword>debug_protocol</amkeyword> <amtype>int</amtype></term>
+  <term><amkeyword>debug-protocol</amkeyword> <amtype>int</amtype></term>
   <listitem>
 <para>Default:
 <amdefault>0</amdefault>.
@@ -257,7 +266,7 @@ Debug level of the protocol module</para>
   </varlistentry>
 
   <varlistentry>
-  <term><amkeyword>debug_selfcheck</amkeyword> <amtype>int</amtype></term>
+  <term><amkeyword>debug-selfcheck</amkeyword> <amtype>int</amtype></term>
   <listitem>
 <para>Default:
 <amdefault>0</amdefault>.
@@ -266,7 +275,7 @@ Debug level of the selfcheck process</para>
   </varlistentry>
 
   <varlistentry>
-  <term><amkeyword>debug_sendsize</amkeyword> <amtype>int</amtype></term>
+  <term><amkeyword>debug-sendsize</amkeyword> <amtype>int</amtype></term>
   <listitem>
 <para>Default:
 <amdefault>0</amdefault>.
@@ -275,7 +284,7 @@ Debug level of the sendsize process</para>
   </varlistentry>
 
   <varlistentry>
-  <term><amkeyword>debug_sendbackup</amkeyword> <amtype>int</amtype></term>
+  <term><amkeyword>debug-sendbackup</amkeyword> <amtype>int</amtype></term>
   <listitem>
 <para>Default:
 <amdefault>0</amdefault>.
@@ -322,7 +331,7 @@ Unreserved tcp port that will be used (bsd, bsdudp)</para>
 
 <refsect1><title>APPLICATION SECTION</title>
 <para>The
-<emphasis remap='B'>amanda.conf</emphasis>
+<emphasis remap='B'>amanda-client.conf</emphasis>
 file may define multiple types of application.
 The information is entered in a <amkeyword>application</amkeyword>
 section, which looks like this:</para>
@@ -335,11 +344,22 @@ define application "<amtype>name</amtype>" {
 </programlisting>
 
 <para><amtype>name</amtype>
-is the name of this type of application. It is referenced from the
-<amkeyword>dumptype</amkeyword></para>
+is the name of this type of application.</para>
+<para>
+The setting from an application is merged with the dle setting
+  if the <amtype>name</amtype> is the same as the <amkeyword>client-application-name</amkeyword> from the dle
+  or if the <amkeyword>client-application-name</amkeyword> from the dle is not set and the <amtype>name</amtype> is the same as the <amkeyword>plugin</amkeyword> from the dle.</para>
 
 <para>The application options and values are:</para>
 <variablelist remap='TP'>
+  <varlistentry>
+  <term><amkeyword>client-application-name</amkeyword> <amtype>string</amtype></term>
+  <listitem>
+<para>Default:
+<amdefault>none</amdefault>.
+Not use on the client.</para>
+  </listitem>
+  </varlistentry>
   <varlistentry>
   <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
   <listitem>
@@ -353,7 +373,7 @@ A comment string describing this application.</para>
   <listitem>
 <para>No default. Must be set to the name of the program. This program must be
 in the <emphasis remap='I'>$libexecdir/amanda/application</emphasis> directory
-on the client.</para>
+on the client. If set, it must be the same as the dle <amkeyword>plugin</amkeyword>.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
@@ -371,7 +391,7 @@ the property to set, and the others contains its values.
 
 <refsect1><title>SCRIPT SECTION</title>
 <para>The
-<emphasis remap='B'>amanda.conf</emphasis>
+<emphasis remap='B'>amanda-client.conf</emphasis>
 file may define multiple types of script.
 The information is entered in a <emphasis remap='B'>script</emphasis>
 section, which looks like this:</para>
@@ -384,11 +404,22 @@ define script "<amtype>name</amtype>" {
 </programlisting>
 
 <para><amtype>name</amtype>
-is the name of this type of script. It is referenced from the
-<amkeyword>dumptype</amkeyword></para>
+is the name of this type of script.</para>
+<para>
+The setting from a script is merged with the dle setting
+  if the <amtype>name</amtype> is the same as the <amkeyword>client-script-name</amkeyword> from the dle
+  or if the <amkeyword>client-script-name</amkeyword> from the dle is not set and the <amtype>name</amtype> is the same as the <amkeyword>plugin</amkeyword> from the dle.</para>
 
 <para>The script options and values are:</para>
 <variablelist remap='TP'>
+  <varlistentry>
+  <term><amkeyword>client-script-name</amkeyword> <amtype>string</amtype></term>
+  <listitem>
+<para>Default:
+<amdefault>none</amdefault>.
+Not used on the client.</para>
+  </listitem>
+  </varlistentry>
   <varlistentry>
   <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
   <listitem>
@@ -400,17 +431,18 @@ A comment string describing this script.</para>
   <varlistentry>
   <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
   <listitem>
-<para>No default. Must be set to the name of the program. This program must be in the <emphasis remap='I'>$libdir/amanda/application</emphasis> directory on the client and/or server.</para>
+<para>No default. Must be set to the name of the program. This program must be in the <emphasis remap='I'>$libdir/amanda/application</emphasis> directory on the client. If set, it must be the same as the dle <amkeyword>plugin</amkeyword>.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
-  <term><amkeyword>execute_where</amkeyword> [ <amkeyword>client</amkeyword> | <amkeyword>server</amkeyword> ]</term>
+  <term><amkeyword>execute-where</amkeyword> <amkeyword>client</amkeyword></term>
   <listitem>
-<para>Default: <amkeyword>client</amkeyword>. Where the script must be executed, on the client or server. Only <amkeyword>client</amkeyword> is valid.</para>
+<para>Default: <amkeyword>client</amkeyword>.
+Value can't be changed.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
-  <term><amkeyword>execute_on</amkeyword> <amtype>execute_on</amtype>[,<amtype>execute_on</amtype>]*</term>
+  <term><amkeyword>execute-on</amkeyword> <amtype>execute_on</amtype>[,<amtype>execute_on</amtype>]*</term>
   <listitem>
 <para>No default. When the script must be executed, you can specify many of them:</para>
     <!-- .RS -->
@@ -467,24 +499,12 @@ A comment string describing this script.</para>
       <term><amkeyword>pre-dle-backup</amkeyword></term>
       <listitem>
 <para>Execute before the backup command for the dle.</para>
-      </listitem>
-      </varlistentry>
-      <varlistentry>
-      <term><amkeyword>pre-host-backup</amkeyword></term>
-      <listitem>
-<para>Execute before the backup command for all dle for the client.</para>
       </listitem>
       </varlistentry>
       <varlistentry>
       <term><amkeyword>post-dle-backup</amkeyword></term>
       <listitem>
 <para>Execute after the backup command for the dle.</para>
-      </listitem>
-      </varlistentry>
-      <varlistentry>
-      <term><amkeyword>post-host-backup</amkeyword></term>
-      <listitem>
-<para>Execute after the backup command for all dle for the client.</para>
       </listitem>
       </varlistentry>
       <varlistentry>