Imported Upstream version 3.1.0

[debian/amanda] / man / xml-source / amstar.8.xml

diff --git a/man/xml-source/amstar.8.xml b/man/xml-source/amstar.8.xml
index 036035b19a5aaf98e05bf72188ad4bf6d09c0342..ca4c52d72f2f4d88378a551580fcb4d4c6956eab 100644 (file)
--- a/man/xml-source/amstar.8.xml
+++ b/man/xml-source/amstar.8.xml
@@ -3,7 +3,7 @@
                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
 [
   <!-- entities files to use -->
-  <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
+  <!ENTITY % global_entities SYSTEM 'global.entities'>
   %global_entities;
 ]>
 
@@ -28,7 +28,7 @@
 
 <refsect1><title>DESCRIPTION</title>
 
-<para>Amstar is an &A; Application API script.  It should not be run
+<para>Amstar is an Amanda Application API script.  It should not be run
 by users directly.  It uses star to backup and restore data.</para>
 
 </refsect1>
@@ -36,14 +36,30 @@ by users directly.  It uses star to backup and restore data.</para>
 <refsect1><title>PROPERTIES</title>
 
 <para>This section lists the properties that control amstar's functionality.
-See <citerefentry><refentrytitle>amanda-applications</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+See <manref name="amanda-applications" vol="7"/>
 for information on application properties and how they are configured.</para>
 
 <!-- PLEASE KEEP THIS LIST IN ALPHABETICAL ORDER -->
 <variablelist>
+ <!-- ==== -->
+ <varlistentry><term>COMMAND-OPTIONS</term><listitem>
+<para>If set, theses options are passed asis to star. Each option must be a different value of the property. Some option can break how amanda do backup, use it with care.</para>
+Use:
+<programlisting>
+  property "COMMAND-OPTIONS" "--foo" "bar"
+</programlisting>
+Do not use:
+<programlisting>
+  property "COMMAND-OPTIONS" "--foo bar"
+</programlisting>
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>DIRECTORY</term><listitem>
+If set, gnutar will backup from that directory instead of the <emphasis>diskdevice</emphasis> set by the DLE. On restore, the data is restore in that directpory instead of the current working directory.
+</listitem></varlistentry>
  <!-- ==== -->
  <varlistentry><term>ONE-FILE-SYSTEM</term><listitem>
-If "YES" (the default), do not allow star to cross filesystem boundaries. If "NO", star will cross filesystem boundaries.  This corresponds to the <emphasis>-xdev</emphasis> option of star.
+The default is "YES". This property is deprecated and the default value can't be changed. star requires it when it works in dump mode.  This corresponds to the <emphasis>-xdev</emphasis> option of star.
 </listitem></varlistentry>
  <!-- ==== -->
  <varlistentry><term>SPARSE</term><listitem>
@@ -55,21 +71,52 @@ If "YES", amstar will use a different tardump file for each DLE. The default is
 </listitem></varlistentry>
  <!-- ==== -->
  <varlistentry><term>STAR-PATH</term><listitem>
-The path to the star binary.  The default is set when &A; is built.
+The path to the star binary. The default is set when Amanda is built by the
+--with-star configure option.
 </listitem></varlistentry>
  <!-- ==== -->
  <varlistentry><term>STAR-TARDUMP</term><listitem>
-The directory where star stores the database it uses to generate incremental dumps.  The default is set when &A; is built.
+The directory where star stores the database it uses to generate incremental
+dumps.  The default is /etc/tardumps.
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>NORMAL</term><listitem>
+List all regex (POSIX Extended Regular Expression syntax) that are normal output from star. These output are in the "FAILED DUMP DETAILS" section of the email report if the dump result is STRANGE or FAILED. Default values:
+<programlisting>
+  "^could not open conf file"
+  "^Type of this level "
+  "^Date of this level "
+  "^Date of last level "
+  "^Dump record  level "
+  "^Throughput"
+  "^.*is sparse$"
+  "^star: dumped [0-9][0-9]* (tar )?files"
+  "^.*The following problems occurred during .* processing.*$"
+  "^.*Processed all possible files, despite earlier errors.*$"
+  "^.*not written due to problems during backup.*$"
+</programlisting>
+<para>To treat one of these default patterns differently, specify it explicitly in a different property.</para>
 </listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>IGNORE</term><listitem>
+List all regex (POSIX Extended Regular Expression syntax) that amanda ignore. These output are never in the email report. 
+</listitem></varlistentry>
+ <!-- ==== -->
+ <varlistentry><term>STRANGE</term><listitem>
+List all regex (POSIX Extended Regular Expression syntax) that are strange output from star. All star output that doesn't match a normal or ignore regex are strange by default. The result of the dump is STRANGE if star produce a strange output. These output are in the "FAILED DUMP DETAILS" section of the email report.
+<programlisting>
+  "^Perform a level 0 dump first.*$"
+</programlisting>
+<para>To treat one of these default patterns differently, specify it explicitly in a different property.</para>
+</listitem></varlistentry>
+
 </variablelist>
 
 </refsect1>
 
-<refsect1><title>SEE ALSO</title>
-<para>
-<citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amanda-applications</refentrytitle><manvolnum>7</manvolnum></citerefentry>
-</para>
+<seealso>
+<manref name="amanda.conf" vol="5"/>,
+<manref name="amanda-applications" vol="7"/>
+</seealso>
 
-</refsect1>
 </refentry>