Imported Upstream version 3.3.3
[debian/amanda] / man / xml-source / amadmin.8.xml
index 9f70828bf2bf0d7d104b5f2b25d5b6633c66e290..c4261bd1fd111e486cf789ba4cc7176b45243f00 100644 (file)
 <refsynopsisdiv>
 <cmdsynopsis>
   <command>amadmin</command>    
+    <arg choice='opt'>--version</arg>
+    <arg choice='opt'>--no-default</arg>
+    <arg choice='opt'>--print-source</arg>
+    <arg choice='opt'>--exact-match</arg>
+    &configoverride.synopsis;
     <arg choice='plain'><replaceable>config</replaceable></arg>
     <arg choice='plain'><replaceable>command</replaceable></arg>
     <arg choice='opt' rep='repeat'><replaceable>command_options</replaceable></arg>
-    &configoverride.synopsis;
 </cmdsynopsis>
 </refsynopsisdiv>
 
@@ -49,22 +53,38 @@ Amanda configuration.</para>
 man page for more details about Amanda.</para>
 </refsect1>
 
+<refsect1><title>OPTIONS</title>
+<variablelist remap='TP'>
+ <varlistentry>
+    <term><option>--version</option></term>
+<listitem><para>Print the version and exit.</para></listitem>
+  </varlistentry>
+ <varlistentry>
+    <term><option>--no-default</option></term>
+<listitem><para>Do not print default values for <emphasis remap='B'>config</emphasis>
+and <emphasis remap='B'>disklist</emphasis> commands.</para></listitem>
+  </varlistentry>
+ <varlistentry>
+    <term><option>--print-source</option></term>
+<listitem><para>Print where a value is defined for <emphasis remap='B'>config</emphasis>
+and <emphasis remap='B'>disklist</emphasis> commands.</para></listitem>
+  </varlistentry>
+ <varlistentry>
+    <term><option>--exact-match</option></term>
+<listitem><para>The host and disk are parsed as exact values</para></listitem>
+  </varlistentry>
+
+</variablelist>
+</refsect1>
+
 <refsect1><title>COMMANDS</title>
 <para>Commands that take a <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]
 parameter pair operate on all disks in the &disklist; for that
 <emphasis remap='I'>hostname</emphasis> if no disks are specified.  Where
 <emphasis remap='I'>hostname</emphasis> is also marked as being optional,
-the command operates on all hosts and disks in the &disklist;.
+the command operates on all hosts and disks in the &disklist; when no hostname is given.
 Both <emphasis remap='I'>hostname</emphasis> and <emphasis remap='I'>disks</emphasis>
-are special expressions; see the &quot;HOST &amp; DISK EXPRESSION&quot; section
-of <manref name="amanda" vol="8"/>
-for a description.</para>
-
-<para>Commands that take one or more <emphasis remap='I'>dumpspec</emphasis> parameters operate
-on the set of dumps specified by all of the expressions.  See the &quot;DUMP SPECIFICATIONS&quot;
-section of
-<manref name="amanda" vol="8"/>
-for a description.</para>
+are match expressions; see <manref name="amanda-match" vol="7"/> for a description.</para>
 
 <variablelist remap='TP'>
   <varlistentry>
@@ -220,10 +240,12 @@ The default sort order is <emphasis remap='B'>hkdlpbfw</emphasis>.</para>
   <term><emphasis remap='B'>holding list</emphasis> [-l] [-d] [ <emphasis remap="I">hostname</emphasis> [ <emphasis remap="I">disk</emphasis> [ <emphasis remap="I">datestamp</emphasis> [ .. ] ] ] ]</term>
   <listitem>
 
-    <para>List holding files matching the given specification, or all holding
-    files if no specification is provided.  With '-l', additional information
-    (size, level, and whether the dump is outdated) is provided.  With '-d', only
-    outdated dumps are shown.</para>
+    <para>List holding files matching the given dump specification, or all
+       holding files if no specification is provided.  See <manref
+           name="amanda-match" vol="7"/> for more information on dump
+       specifications.  With '-l', additional information (size, level, and
+       whether the dump is outdated) is provided.  With '-d', only outdated
+       dumps are shown.</para>
 
     <para>An outdated holding file is one which is not required for a
     restore of the <emphasis>most recent</emphasis> dump.  Note that
@@ -299,6 +321,18 @@ on
 <emphasis remap='I'>hostname</emphasis>
 (or all hosts).
 Mostly used for debugging.</para>
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><emphasis remap='B'>hosts</emphasis></term>
+  <listitem>
+<para>Output a list of distinct hosts in the &disklist;, one per line, for easy use in shell scripts.</para>
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><emphasis remap='B'>dles</emphasis></term>
+  <listitem>
+<para>Output a list of distinct DLEs in the &disklist;, one per line with host and diskname separated by a space, for easy use in shell scripts.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
@@ -457,16 +491,13 @@ TOTAL      241  12412187   7316312   731631  (estimated 8 runs per dumpcycle)
 </programlisting>
 </refsect1>
 
-<refsect1><title>FILES</title>
-<para>/usr/local/etc/amanda/<emphasis remap='I'>config</emphasis>/amanda.conf</para>
-</refsect1>
-
 <seealso>
 <manref name="amanda" vol="8"/>,
 <manref name="amcheck" vol="8"/>,
 <manref name="amdump" vol="8"/>,
 <manref name="amrestore" vol="8"/>,
 <manref name="amfetchdump" vol="8"/>
+<manref name="amanda-match" vol="7"/>,
 </seealso>
 
 </refentry>