Imported Upstream version 2.6.0
[debian/amanda] / man / xml-source / amgetconf.8.xml
index d824dde4f5eeb17745d3e7cc652c1341b5f4e6c3..d0e668bd28068afc2168b6cc2e3c8c0e79f944cf 100644 (file)
@@ -23,7 +23,9 @@
 <cmdsynopsis>
   <command>amgetconf</command>    
     <arg choice='opt'><replaceable>config</replaceable></arg>
+    <arg choice='opt'><replaceable>--list</replaceable></arg>
     <arg choice='plain'><replaceable>parameter</replaceable></arg>
+    <arg choice='plain' rep='repeat'><group><arg choice='plain'>-o </arg><replaceable>configoption</replaceable></group></arg>
 </cmdsynopsis>
 </refsynopsisdiv>
 
@@ -81,6 +83,77 @@ followed by a colon (:) and the previously opened file name.</para>
 man page for more details about &A;.</para>
 </refsect1>
 
+<refsect1><title>OPTIONS</title>
+<variablelist remap='TP'>
+
+  <varlistentry>
+  <term><emphasis remap='B'>--list</emphasis></term>
+  <listitem>
+<para>The parameter must be 'tapetype', 'dumptype, 'holdingdisk' or 'interface'. It will output, one by line, the list of identifier for the parameter.</para>
+<variablelist remap='TP'>
+<varlistentry>
+  <term>--list tapetype</term>
+  <listitem>
+    <para>Output the list of tapetype, one by line.</para>
+  </listitem>
+</varlistentry>
+<varlistentry>
+  <term>--list dumptype</term>
+  <listitem>
+    <para>Output the list of dumptype, one by line.</para>
+  </listitem>
+</varlistentry>
+<varlistentry>
+  <term>--list holdingdisk</term>
+  <listitem>
+    <para>Output the list of holdingdisk, one by line.</para>
+  </listitem>
+</varlistentry>
+<varlistentry>
+  <term>--list interface</term>
+  <listitem>
+    <para>Output the list of interface, one by line.</para>
+  </listitem>
+</varlistentry>
+</variablelist>
+  </listitem>
+  </varlistentry>
+
+  <varlistentry>
+  <term><emphasis remap='B'>parameter</emphasis></term>
+  <listitem>
+    <para>It could be one of the below format:</para>
+<variablelist remap='TP'>
+<varlistentry>
+    <term>runtapes</term><listitem><para></para></listitem>
+</varlistentry>
+<varlistentry>
+    <term>DUMPTYPE:no-compress:compress</term><listitem><para></para></listitem>
+</varlistentry>
+<varlistentry>
+    <term>TAPETYPE:HP-DAT:length</term><listitem><para></para></listitem>
+</varlistentry>
+<varlistentry>
+    <term>INTERFACE:local:use</term><listitem><para></para></listitem>
+</varlistentry>
+<varlistentry>
+    <term>HOLDINGDISK:hd1:use</term><listitem><para></para></listitem>
+</varlistentry>
+</variablelist>
+  </listitem>
+  </varlistentry>
+
+<varlistentry>
+<term><emphasis remap='B'>-o</emphasis> <replaceable>configoption</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>EXAMPLE</title>
 <para>Find out the path to the log file directory:</para>
 
@@ -127,16 +200,17 @@ is not a known keyword
 (e.g. not a valid
 <emphasis remap='I'>amanda.conf</emphasis>
 keyword).
-In this case,
-<command>amgetconf</command>
-will write &quot;<emphasis remap='B'>BUGGY</emphasis>&quot; to stdout as the value.</para>
+</para>
   </listitem>
   </varlistentry>
 </variablelist>
 </refsect1>
 
 <refsect1><title>SEE ALSO</title>
-<para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry></para>
+<para>
+  <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+  <citerefentry><refentrytitle>http://wiki.zmanda.com</refentrytitle></citerefentry>
+</para>
 </refsect1>
 </refentry>