Imported Upstream version 2.6.0p1
[debian/amanda] / man / xml-source / amdevcheck.8.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
4 [
5   <!-- entities files to use -->
6   <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
7   %global_entities;
8 ]>
9
10 <refentry id='amdevcheck.8'>
11
12   <refmeta>
13     <refentrytitle>amdevcheck</refentrytitle>
14     <manvolnum>8</manvolnum>
15   </refmeta>
16   <refnamediv>
17     <refname>amdevcheck</refname>
18     <refpurpose>Validate an &A; device and volume.</refpurpose>
19   </refnamediv>
20   <!-- body begins here -->
21   <refsynopsisdiv>
22     <cmdsynopsis>
23       <command>amdevcheck</command>
24       <arg choice='plain'><replaceable>config</replaceable></arg>
25       <group choice='opt'>
26         <arg choice='plain'><replaceable>device name</replaceable></arg>
27       </group>
28       <arg choice='plain' rep='repeat'><group><arg choice='plain'>-o
29       </arg><replaceable>configoption</replaceable></group></arg>
30     </cmdsynopsis>
31   </refsynopsisdiv>
32
33   <refsect1><title>DESCRIPTION</title>
34     <para>
35       <emphasis remap='B'>Amdevcheck</emphasis> provides a way to check that a
36       particular &A; device is accessible, whether or not it contains a volume,
37       and whether or not that volume is labeled. Some devices can't distinguish
38       between all of these cases; a missing volume and an unlabeled volume might
39       generate the same error code, for example. In those cases, this tool
40       reports all possible causes of the error.
41     </para>
42     
43     <para>See the
44       <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
45       man page for more details about &A;.
46       See the
47       <emphasis remap='B'>OUTPUT DRIVERS</emphasis>
48       section of
49       <emphasis remap='I'>amanda(8)</emphasis>
50       for more information on the &A; output drivers.
51   </para>
52   </refsect1>
53
54   <refsect1><title>OPTIONS</title>
55     <variablelist remap='TP'>
56       <varlistentry>
57         <term><replaceable>config</replaceable></term>
58         <listitem>
59           <para>
60             &A; configuration to use. Note that <command>amdevcheck</command>
61             ignores any tape changer configuration.
62           </para>
63         </listitem>
64       </varlistentry>
65
66       <varlistentry>
67         <term><replaceable> device</replaceable></term>
68         <listitem>
69           <para>
70             &A; device to use. This option overrides any tapedev configuration
71             specified in the configuration file.
72           </para>
73         </listitem>
74       </varlistentry>
75
76       <varlistentry>
77         <term><emphasis remap='B'>-o</emphasis> <replaceable>clientconfigoption</replaceable></term>
78         <listitem>
79           <para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>"
80             section in
81             <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
82         </listitem>
83       </varlistentry>
84     </variablelist>
85   </refsect1>
86
87   <refsect1><title>AUTHOR</title>
88     <para>
89       Ian Turner <email>ian@zmanda.com</email> and others. Authorship of this
90       tool and its documentation was funded by Zmanda, Inc.
91     </para>
92   </refsect1>
93
94   <refsect1><title>SEE ALSO</title>
95     <para>
96       <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
97       <citerefentry><refentrytitle>ammt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
98       <ulink url="http://wiki.zmanda.com"/>
99     </para>
100   </refsect1>
101 </refentry>