Imported Upstream version 2.6.0
[debian/amanda] / man / xml-source / amdevcheck.8.xml
diff --git a/man/xml-source/amdevcheck.8.xml b/man/xml-source/amdevcheck.8.xml
new file mode 100644 (file)
index 0000000..c47ca58
--- /dev/null
@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
+[
+  <!-- entities files to use -->
+  <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
+  %global_entities;
+]>
+
+<refentry id='amdevcheck.8'>
+
+  <refmeta>
+    <refentrytitle>amdevcheck</refentrytitle>
+    <manvolnum>8</manvolnum>
+  </refmeta>
+  <refnamediv>
+    <refname>amdevcheck</refname>
+    <refpurpose>Validate an &A; device and volume.</refpurpose>
+  </refnamediv>
+  <!-- body begins here -->
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>amdevcheck</command>
+      <arg choice='plain'><replaceable>config</replaceable></arg>
+      <group choice='opt'>
+        <arg choice='plain'><replaceable>device name</replaceable></arg>
+      </group>
+      <arg choice='plain' rep='repeat'><group><arg choice='plain'>-o
+      </arg><replaceable>configoption</replaceable></group></arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1><title>DESCRIPTION</title>
+    <para>
+      <emphasis remap='B'>Amdevcheck</emphasis> provides a way to check that a
+      particular &A; device is accessible, whether or not it contains a volume,
+      and whether or not that volume is labeled. Some devices can't distinguish
+      between all of these cases; a missing volume and an unlabeled volume might
+      generate the same error code, for example. In those cases, this tool
+      reports all possible causes of the error.
+    </para>
+    
+    <para>See the
+      <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+      man page for more details about &A;.
+      See the
+      <emphasis remap='B'>OUTPUT DRIVERS</emphasis>
+      section of
+      <emphasis remap='I'>amanda(8)</emphasis>
+      for more information on the &A; output drivers.
+  </para>
+  </refsect1>
+
+  <refsect1><title>OPTIONS</title>
+    <variablelist remap='TP'>
+      <varlistentry>
+        <term><replaceable>config</replaceable></term>
+        <listitem>
+          <para>
+            &A; configuration to use. Note that <command>amdevcheck</command>
+            ignores any tape changer configuration.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><replaceable> device</replaceable></term>
+        <listitem>
+          <para>
+            &A; device to use. This option overrides any tapedev configuration
+            specified in the configuration file.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><emphasis remap='B'>-o</emphasis> <replaceable>clientconfigoption</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>
+  </refsect1>
+
+  <refsect1><title>AUTHOR</title>
+    <para>
+      Ian Turner <email>ian@zmanda.com</email> and others. Authorship of this
+      tool and its documentation was funded by Zmanda, Inc.
+    </para>
+  </refsect1>
+
+  <refsect1><title>SEE ALSO</title>
+    <para>
+      <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>ammt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>http://wiki.zmanda.com</refentrytitle></citerefentry>
+    </para>
+  </refsect1>
+</refentry>