X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Fxml-source%2Famcheck.8.xml;h=9b641352d3c726be81acaa652c0cf8d2e1bbc9e1;hb=42ff24f2a525d5965e1841b2ebe3ee0f4b918ac6;hp=f4a17cba85b34662163a810c87da88410db69fea;hpb=eefb15c5c04acb3c75f0c704ea664feb1bbae75c;p=debian%2Famanda

diff --git a/man/xml-source/amcheck.8.xml b/man/xml-source/amcheck.8.xml
index f4a17cb..9b64135 100644
--- a/man/xml-source/amcheck.8.xml
+++ b/man/xml-source/amcheck.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;
 ]>
 
@@ -13,28 +13,40 @@
 <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>
+<refpurpose>run Amanda 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>
+    &configoverride.synopsis;
 </cmdsynopsis>
 </refsynopsisdiv>
 
 
 <refsect1><title>DESCRIPTION</title>
 <para><emphasis remap='B'>Amcheck</emphasis>
-runs a number of self-checks on both the &A; tape server host and
-the &A; client hosts.</para>
+runs a number of self-checks on both the Amanda tape server host and
+the Amanda client hosts.</para>
 
 <para>On the tape server host,
 <command>amcheck</command>
@@ -52,8 +64,8 @@ match an expression will be checked. All disks are checked if no
 expressions are given.</para>
 
 <para>See the
-<citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-man page for more details about &A;.</para>
+<manref name="amanda" vol="8"/>
+man page for more details about Amanda.</para>
 </refsect1>
 
 <refsect1><title>OPTIONS</title>
@@ -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>
@@ -92,10 +105,9 @@ tape (which would otherwise cause the subsequent
 to fail).
 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
+erased. If the <amkeyword>autolabel</amkeyword> 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,16 @@ 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>
+
+  &configoverride.varlistentry;
+
 </variablelist>
 
 <para>The default is
@@ -147,21 +170,21 @@ The results are displayed on standard output.</para>
 
 <programlisting>
 % amcheck daily
-&A; Tape Server Host Check
+Amanda Tape Server Host Check
 -----------------------------
 /amanda2/amanda/work: 911475 KB disk space available, that's plenty.
 NOTE: skipping tape-writable test.
 Tape VOL10 label ok.
 Server check took 34.966 seconds.
 
-&A; Backup Client Hosts Check
+Amanda Backup Client Hosts Check
 --------------------------------
 WARNING: northstar: selfcheck request timed out.  Host down?
 WARNING: drinkme: selfcheck request timed out.  Host down?
 WARNING: scruffy: selfcheck request timed out.  Host down?
 Client check: 136 hosts checked in 51.945 seconds, 3 problems found.
 
-(brought to you by &A; 2.5.0) 
+(brought to you by Amanda 2.5.0) 
 </programlisting>
 
 <para>In this example, if the line
@@ -301,7 +324,7 @@ instead of
   <term>ERROR: program dir <emphasis remap='I'>directory</emphasis>: not accessible</term>
   <listitem>
 <para>(error)
-The directory &A; expects to find its auxiliary programs in,
+The directory Amanda expects to find its auxiliary programs in,
 <emphasis remap='I'>directory</emphasis>,
 is not accessible.</para>
   </listitem>
@@ -361,7 +384,7 @@ may be:</para>
       <varlistentry>
       <term>log</term>
       <listitem>
-<para>for the &A; log directory (see
+<para>for the Amanda log directory (see
 <emphasis remap='B'>logdir</emphasis>
 in
 <emphasis remap='B'>amanda.conf</emphasis>)</para>
@@ -379,7 +402,7 @@ in
       <varlistentry>
       <term>info</term>
       <listitem>
-<para>for an &A; database information directory (see
+<para>for an Amanda database information directory (see
 <emphasis remap='B'>curinfo</emphasis>
 in
 <emphasis remap='B'>amanda.conf</emphasis>)
@@ -389,7 +412,7 @@ or</para>
       <varlistentry>
       <term>index</term>
       <listitem>
-<para>for an &A; index directory (see
+<para>for an Amanda index directory (see
 <emphasis remap='B'>indexdir</emphasis>
 in
 <emphasis remap='B'>amanda.conf</emphasis>)</para>
@@ -398,10 +421,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 +507,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>
@@ -520,7 +526,7 @@ parameter in
 <emphasis remap='B'>amanda.conf</emphasis>
 is set to
 <filename>/dev/null</filename>
-and &A; uses that when debugging to throw all the dump images away.</para>
+and Amanda uses that when debugging to throw all the dump images away.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
@@ -586,7 +592,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>
@@ -620,7 +627,7 @@ Holding disk
 <emphasis remap='I'>disk</emphasis>
 has
 <emphasis remap='I'>F</emphasis>
-KBytes of free space and &A; will be using up to
+KBytes of free space and Amanda will be using up to
 <emphasis remap='I'>U</emphasis>
 Kbytes.</para>
   </listitem>
@@ -814,7 +821,7 @@ to the status check request.</para>
 <emphasis remap='B'>Amcheck</emphasis>
 could not parse the negative acknowledgment error from
 <emphasis remap='I'>host</emphasis>.
-There might be an &A; version mismatch between the host running
+There might be an Amanda version mismatch between the host running
 <command>amcheck</command>
 and
 <emphasis remap='I'>host</emphasis>.</para>
@@ -841,14 +848,18 @@ 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>
-</refsect1>
+<seealso>
+<manref name="amanda.conf" vol="5"/>
+<manref name="amdump" vol="8"/>
+</seealso>
+
 </refentry>