Merge tag 'upstream/3.3.3'

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

diff --git a/man/xml-source/amanda.conf.5.xml b/man/xml-source/amanda.conf.5.xml
index 518264d9103a819881b0f56f9043996e6df25ef5..abacce1cfc98dc2c63bb8a7bd5455bcaa3aaadfb 100644 (file)
--- a/man/xml-source/amanda.conf.5.xml
+++ b/man/xml-source/amanda.conf.5.xml
@@ -348,6 +348,38 @@ Specify which types of messages will trigger an email from amreport. amreport is
     </variablelist>
   </listitem>
   </varlistentry>
+
+  <varlistentry>
+  <term><amkeyword>report-use-media</amkeyword> <amtype>boolean</amtype></term>
+  <listitem>
+<para>Default:
+<amdefault>True</amdefault> if <amkeyword>max-dle-by-volume</amkeyword>
+is not set,
+<amdefault>False</amdefault> if it is set.
+If the reporter must print the list of media used in the run.</para>
+  </listitem>
+  </varlistentry>
+
+  <varlistentry>
+  <term><amkeyword>report-next-media</amkeyword> <amtype>boolean</amtype></term>
+  <listitem>
+<para>Default:
+<amdefault>True</amdefault> if <amkeyword>max-dle-by-volume</amkeyword>
+is not set,
+<amdefault>False</amdefault> if it is set.
+If the reporter must print the list of media expected for the next run.</para>
+  </listitem>
+  </varlistentry>
+
+  <varlistentry>
+  <term><amkeyword>max-dle-by-volume</amkeyword> <amtype>int</amtype></term>
+  <listitem>
+<para>Default:
+<amdefault>1000000000</amdefault>.
+The maximum number of dle written to a single volume.</para>
+  </listitem>
+  </varlistentry>
+
   <varlistentry>
   <term><amkeyword>dumpcycle</amkeyword> <amtype>int</amtype></term>
   <listitem>
@@ -387,6 +419,7 @@ days /
 <amkeyword>runtapes</amkeyword>.</para>
   </listitem>
   </varlistentry>
+
   <varlistentry>
   <term><amkeyword>tapecycle</amkeyword> <amtype>int</amtype></term>
   <listitem>
@@ -466,9 +499,11 @@ values:
     $c : config name
     $o : org configuration
     $b : barcode of the volume
+    $s : slot number, can specify a minimun number of digit:
+         $3s to get '001'
     $m : meta label
 </programlisting></para>
-<para>The template should contain some number of contiguous '%'
+<para>The template can contain some number of contiguous '%'
 characters, which will be replaced with a generated number. Be sure to
 specify enough '%' characters that you do not run out of tape labels.
 Example:
@@ -477,6 +512,10 @@ Example:
 <markup>&quot;$m-%%%&quot;</markup>,
 <markup>&quot;$m-$b&quot;</markup>
 </para>
+<para>The generared label can be used only if it match the
+<amkeyword>labelstr</amkeyword> setting. The volume will not be used if the
+generated label doesn't match the <amkeyword>labelstr</amkeyword> setting.
+</para>
 <para>Note that many devices cannot distinguish an empty tape from an error
 condition, so it may is often necessary to include
 <amkeyword>volume-error</amkeyword> as an autolabel condition.</para>
@@ -729,13 +768,23 @@ The algorithm used to choose which dump image to send to the taper.</para>
   </listitem>
   </varlistentry>
 <varlistentry>
-<term><amkeyword>taper-parallel-write</amkeyword> <amtype>int</amtype></term>
-<listitem>
-  </listitem>
-<para>Default: <amdefault>1</amdefault>.
+  <term><amkeyword>taper-parallel-write</amkeyword> <amtype>int</amtype></term>
+  <listitem>
+    <para>Default: <amdefault>1</amdefault>.
 Amanda can write simultaneously up to that number of volume at any given
 time. The changer must have as many drives.</para>
-  </varlistentry>
+  </listitem>
+</varlistentry>
+
+<varlistentry>
+  <term><amkeyword>eject-volume</amkeyword> <amtype>int</amtype></term>
+  <listitem>
+    <para>Default: <amdefault>no</amdefault>.
+Set to <amkeyword>yes</amkeyword> if you want the volume to be ejected
+after Amanda wrote data to it. It works only with some changer and device.</para>
+  </listitem>
+</varlistentry>
+
 <varlistentry>
 <term><amkeyword>labelstr</amkeyword> <amtype>string</amtype></term>
 <listitem>
@@ -833,7 +882,7 @@ How many times the server will resend a REQ packet if it doesn't get the ACK pac
   <term><amkeyword>netusage</amkeyword> <amtype>int</amtype></term>
   <listitem>
 <para>Default:
-<amdefault>8000 Kbps</amdefault>.
+<amdefault>80000 Kbps</amdefault>.
 The maximum network bandwidth allocated to Amanda, in Kbytes per second.
 See also the
 <emphasis remap='B'>interface</emphasis>
@@ -1132,7 +1181,7 @@ is the same as the <amkeyword>amrecover-changer</amkeyword> setting.</para>
   <varlistentry>
   <term><amkeyword>columnspec</amkeyword> <amtype>string</amtype></term>
   <listitem>
-<para> default: "HostName=0:12:12,Disk=1:11:11,Level=1:1:1,OrigKB=1:-7:0,OutKB=1:-7:0,Compress=1:-6:1,DumpTime=1:-7:7,Dumprate=1:-6:1,TapeTime=1:-6:6,TapeRate=1:-6:1"</para>
+<para> default: "HostName=0:-12:12,Disk=1:-11:11,Level=1:-1:1,OrigKB=1:-7:0,OutKB=1:-7:0,Compress=1:-6:1,DumpTime=1:-7:7,Dumprate=1:-6:1,TapeTime=1:-6:6,TapeRate=1:-6:1"</para>
 <para>Defines the width of columns <emphasis remap='B'>amreport</emphasis>
 should use.
 <emphasis remap='I'>String</emphasis>
@@ -1438,6 +1487,13 @@ Range is inclusive.</para>
   </listitem>
   </varlistentry>
 
+  <varlistentry>
+  <term><amkeyword>tmpdir</amkeyword> <amtype>string</amtype></term>
+  <listitem>
+<para>Default: none (system default).  Set it to a directory with lots of free
+space if sort in amindexd fail with 'No space left on device'.</para>
+  </listitem>
+  </varlistentry>
 </variablelist>
 </refsect1>
 
@@ -2087,6 +2143,17 @@ See also the main section parameter <amkeyword>inparallel</amkeyword>.</para>
 <amdefault>10000</amdefault>.
 The maximum number of day for a promotion, set it 0 if you don't want
 promotion, set it to 1 or 2 if your disks get overpromoted.</para>
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><amkeyword>max-warnings</amkeyword> <amtype>int</amtype></term>
+  <listitem>
+<para>Default:
+<amdefault>20</amdefault>.
+The maximum number of error lines in the report for a dle. A value of '0'
+means unlimited. This is useful to reduce the size of the log file and the
+size of the report. All errors are put in separate files if a dle have more
+errors.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
@@ -2461,13 +2528,10 @@ tape devices.
   <varlistentry>
   <term><amkeyword>part-size</amkeyword> <amtype>int</amtype></term>
   <listitem>
-<para>Default: none.  This is the size (in KB if no units are specified) of
-each split part written to the volume.  It is reduced to
-<amkeyword>part-cache-max-size</amkeyword> when part caching is required.
-If this is set to zero, then no splitting will take place; in this case,
-some devices can span dumps from volume to volume, while others will cause
-the entire dump to fail if they encounter end-of-medium before the dump is
-complete.  See "Dump Splitting Configuration" below.</para>
+<para>If this is set to zero (default), then no splitting will take place,
+and the entire dump will fail, if end-of-medium is encountered before
+the dump is complete, unless the device property LEOM is true, and the
+device can detect EOM.  See "Dump Splitting Configuration" below.</para>
   </listitem>
   </varlistentry>
 
@@ -2600,7 +2664,7 @@ A comment string describing this set of network information.</para>
   <term><amkeyword>use</amkeyword> <amtype>int</amtype></term>
   <listitem>
 <para>Default:
-<amdefault>8000 Kbps</amdefault>.
+<amdefault>80000 Kbps</amdefault>.
 The speed of the interface in Kbytes per second.</para>
   </listitem>
   </varlistentry>
@@ -3054,7 +3118,7 @@ A comment string describing this taperscan.</para>
   <varlistentry>
   <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
   <listitem>
-<para>No default. Must be set to the name of the taperscan module.  See <man name="amanda-taperscan" vol="7" /> for a list of defined taperscan modules.</para>
+<para>No default. Must be set to the name of the taperscan module.  See <manref name="amanda-taperscan" vol="7" /> for a list of defined taperscan modules.</para>
   </listitem>
   </varlistentry>
   <varlistentry>