"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;
]>
<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>
+ &configoverride.synopsis;
<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>
</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>
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>
<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>
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>
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>
<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
<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
<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>
<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>
<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>)
<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>
<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>
<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>
<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>
<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>
<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>
<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>
</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>
projects / debian / amanda / blobdiff