amgtar and amstar need to be setuid root to work

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

diff --git a/man/xml-source/amcheck.8.xml b/man/xml-source/amcheck.8.xml
index f4a17cba85b34662163a810c87da88410db69fea..ada507228e8021a32108df9eeb82369afaf5a2e9 100644 (file)
--- a/man/xml-source/amcheck.8.xml
+++ b/man/xml-source/amcheck.8.xml
@@ -13,20 +13,32 @@
 <refmeta>
 <refentrytitle>amcheck</refentrytitle>
 <manvolnum>8</manvolnum>
+&rmi.source;
+&rmi.version;
+&rmi.manual.8;
 </refmeta>
 <refnamediv>
 <refname>amcheck</refname>
 <refpurpose>run &A; self-checks</refpurpose>
 </refnamediv>
+<refentryinfo>
+&author.jds;
+&author.sgw.xml;
+</refentryinfo>
 <!-- body begins here -->
 <refsynopsisdiv>
 <cmdsynopsis>
   <command>amcheck</command>    
-    <arg choice='opt'>-mwsclt </arg>
-    <arg choice='opt'>-Maddress </arg>
+    <arg choice='opt'>-am</arg>
+    <arg choice='opt'>-w</arg>
+    <arg choice='opt'>-sclt</arg>
+    <arg choice='opt'>-M <replaceable>address</replaceable></arg>
     <arg choice='plain'><replaceable>config</replaceable></arg>
-    <arg choice='opt' rep='repeat'><arg choice='plain'><replaceable>host</replaceable></arg><arg choice='opt' rep='repeat'><replaceable>disk</replaceable></arg></arg>
-    
+    <arg choice='opt' rep='repeat'>
+       <arg choice='plain'><replaceable>host</replaceable></arg>
+       <arg choice='opt' rep='repeat'><replaceable>disk</replaceable></arg>
+    </arg>
+    <arg choice='plain' rep='repeat'><group><arg choice='plain'>-o </arg><replaceable>configoption</replaceable></group></arg>
 </cmdsynopsis>
 </refsynopsisdiv>
 
@@ -68,7 +80,8 @@ man page for more details about &A;.</para>
   <varlistentry>
   <term><option>-c</option></term>
   <listitem>
-<para>Run the client host checks.</para>
+<para>Run the client host checks. Multiple specific clients can be
+checked by specifying the client name.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
@@ -94,8 +107,7 @@ If the tape
 is writable, this check causes all data after the tape label to be
 erased. If the label_new_tapes option is enabled, this check may ERASE
 any non-Amanda tape in the drive or changer.
-The check implies
-<option>-t</option>
+The check enable the tape tests on the server host
 and is only made if the tape is otherwise correct.</para>
   </listitem>
   </varlistentry>
@@ -122,8 +134,9 @@ is set.</para>
 but the mail is always sent.</para>
   </listitem>
   </varlistentry>
+
   <varlistentry>
-  <term><option>-M</option><replaceable>address</replaceable></term>
+  <term><option>-M</option> <replaceable>address</replaceable></term>
   <listitem>
 <para>Mail the report to
 <emphasis remap='I'>address</emphasis>
@@ -135,6 +148,20 @@ Implies
 <option>-m</option>.</para>
   </listitem>
   </varlistentry>
+
+  <varlistentry>
+  <term><replaceable>host</replaceable> [<replaceable>disk</replaceable>]*</term>
+  <listitem>
+<para>Specify the host and disk on which the command will work.</para>
+  </listitem>
+  </varlistentry>
+
+  <varlistentry>
+  <term><emphasis remap='B'>-o</emphasis> <replaceable>configoption</replaceable></term>
+  <listitem>
+<para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>" section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
+  </listitem>
+  </varlistentry>
 </variablelist>
 
 <para>The default is
@@ -398,10 +425,7 @@ in
       <varlistentry>
       <term>tapelist</term>
       <listitem>
-<para>for the &A; tapelist directory (see
-<emphasis remap='B'>tapelist</emphasis>
-in
-<emphasis remap='B'>amanda.conf</emphasis>)</para>
+<para>for the &tapelist;</para>
       </listitem>
       </varlistentry>
     </variablelist>
@@ -487,27 +511,13 @@ does not allow search permission.</para>
   <varlistentry>
   <term>ERROR: tape list <emphasis remap='I'>tapelist</emphasis>: not writable</term>
   <listitem>
-<para>(error)
-&A; tape list file
-<emphasis remap='I'>tapelist</emphasis>
-(see
-<emphasis remap='B'>tapelist</emphasis>
-in
-<emphasis remap='B'>amanda.conf</emphasis>)
-is not writable or was not found.</para>
+<para>(error) &tapelist; is not writable or was not found.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
   <term>ERROR: tape list <emphasis remap='I'>tapelist</emphasis>: parse error</term>
   <listitem>
-<para>(error)
-&A; tape list file
-<emphasis remap='I'>tapelist</emphasis>
-(see
-<emphasis remap='B'>tapelist</emphasis>
-in
-<emphasis remap='B'>amanda.conf</emphasis>)
-could not be read or parsed.</para>
+<para>(error) &tapelist; could not be read or parsed.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
@@ -586,7 +596,8 @@ KBytes were available.
 <emphasis remap='I'>amanda.conf</emphasis>
 option)
 to allow for unexpected overruns.</para>
-<note>Even though this message is listed as a warning, it causes &amcheck; to exit with a non-zero status.</note>
+<note><para>Even though this message is listed as a warning, it causes &amcheck; to exit with a non-zero status.</para>
+</note>
   </listitem>
   </varlistentry>
 </variablelist>
@@ -841,14 +852,19 @@ was reported by the status check on
 </variablelist>
 </refsect1>
 
-<refsect1><title>AUTHOR</title>
-<para>James da Silva, &email.jds; : Original text</para>
-<para>&maintainer.sgw;: XML-conversion</para>
+<refsect1><title>EXIT CODE</title>
+The exit code of <command>amcheck</command> is one of:
+<programlisting>
+ 0  = success
+ 1  = error
+</programlisting>
 </refsect1>
 
 <refsect1><title>SEE ALSO</title>
 <para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry></para>
+<citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<ulink url="http://wiki.zmanda.com"/>
+</para>
 </refsect1>
 </refentry>