Imported Upstream version 2.6.0
[debian/amanda] / man / xml-source / amadmin.8.xml
index d98bd78e62868cfab88b21be5ab077ae9066142f..19002d2b3c7f7590c3439d1e130f2c27ab9ee2a5 100644 (file)
@@ -24,8 +24,8 @@
   <command>amadmin</command>    
     <arg choice='plain'><replaceable>config</replaceable></arg>
     <arg choice='plain'><replaceable>command</replaceable></arg>
-    <group><replaceable><arg choice='plain'>command</arg><arg choice='plain'>options</arg></replaceable></group>
-    <group><arg choice='plain'>-o</arg><arg choice='plain'><replaceable>configoption</replaceable></arg></group>*
+    <arg choice='opt' rep='repeat'><replaceable>command_options</replaceable></arg>
+    <arg choice='plain' rep='repeat'><group><option>-o </option><replaceable>configoption</replaceable></group></arg>
 </cmdsynopsis>
 </refsynopsisdiv>
 
@@ -42,27 +42,19 @@ man page for more details about &A;.</para>
 </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
-<emphasis remap='I'>disklist</emphasis>
-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
-<emphasis remap='I'>disklist</emphasis>.
-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 
+<para>Commands that take a <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]
+parameter pair operate on all disks in the <emphasis remap='I'>disklist</emphasis> 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 <emphasis remap='I'>disklist</emphasis>.
+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 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+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
 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 for a description.</para>
 
@@ -140,6 +132,9 @@ Note that if this causes the number of reusable tapes to drop below the
 <emphasis remap='B'>amanda.conf</emphasis>
 <emphasis remap='I'>tapecycle</emphasis>
 value, &A; will request new tapes until the count is satisfied again.</para>
+<para>Tape marked <emphasis remap='I'>no-reuse</emphasis> are available
+for recovery, marking them <emphasis remap='I'>no-reuse</emphasis> is a
+security to be sure amanda will not overwrite them.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
@@ -155,20 +150,52 @@ value, &A; will request new tapes until the count is satisfied again.</para>
 The tape label or holding disk filename,
 file number,
 and status are displayed.</para>
-<para>The <option>--sort</option> option changes the sort order using the following flags:</para>
-
-<para><emphasis remap='B'>h</emphasis> host name
-<emphasis remap='B'>k</emphasis>       disk name
-<emphasis remap='B'>d</emphasis>       dump date
-<emphasis remap='B'>l</emphasis>       backup level
-<emphasis remap='B'>p</emphasis>        dump part
-<emphasis remap='B'>b</emphasis>       tape label</para>
+<para>The <option>--sort</option> option changes the sort order using the following flags:
+<programlisting>
+<emphasis>h</emphasis>: host name
+<emphasis>k</emphasis>: disk name
+<emphasis>d</emphasis>: dump date
+<emphasis>l</emphasis>: backup level
+<emphasis>p</emphasis>: dump part
+<emphasis>b</emphasis>: tape label
+</programlisting></para>
 
 <para>An uppercase letter reverses the sort order for that key.
 The default sort order is <emphasis remap='B'>hkdlpb</emphasis>.</para>
 </listitem>
 </varlistentry>
 
+  <varlistentry>
+  <term><emphasis remap='B'>holding delete</emphasis> <emphasis remap="I">hostname</emphasis> [ <emphasis remap="I">disk</emphasis> [ <emphasis remap="I">datestamp</emphasis> [ .. ] ] ]</term>
+  <listitem>
+
+    <para>Delete holding files matching the given specification.  At least
+    a hostname must be provided.</para>
+
+  </listitem>
+  </varlistentry>
+
+  <varlistentry>
+  <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>An outdated holding file is one which is not required for a
+    restore of the <emphasis>most recent</emphasis> dump.  Note that
+    outdated dumps may still be required for restores at earlier dates.
+    For example, assume that a DLE had a level 0 on Monday, level
+    1's Tuesday through Thursday, and a level 2 on Friday.  Then the
+    files required for a restore of Fridays (the most recent) dump
+    are those from Monday (level 0), Thursday (level 1), and Friday
+    (level 2).  Tuesday and Wednesday's files are outdated. </para>
+
+  </listitem>
+  </varlistentry>
+
   <varlistentry>
   <term><emphasis remap='B'>delete</emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]+</term>
   <listitem>
@@ -177,9 +204,10 @@ The default sort order is <emphasis remap='B'>hkdlpb</emphasis>.</para>
 on
 <emphasis remap='I'>hostname</emphasis>
 from the &A; database.</para>
-<note>If you do not also remove the disk from the
+<note><para>If you do not also remove the disk from the
 <emphasis remap='I'>disklist</emphasis>
-file, &A; will treat it as a new disk during the next run.</note>
+file, &A; will treat it as a new disk during the next run.</para>
+</note>
   </listitem>
   </varlistentry>
 
@@ -250,7 +278,7 @@ Mostly used for debugging.</para>
   <varlistentry>
   <term><emphasis remap='B'>-o</emphasis> <replaceable>configoption</replaceable></term>
   <listitem>
-<para>See the "<emphasis remap='B'>CONFIGURATION OVERWRITE</emphasis>"
+<para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>"
  section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
   </listitem>
   </varlistentry>
@@ -317,16 +345,16 @@ some type of error.</para>
 <programlisting>
 $ amadmin daily find machine-c /var
 date        host      disk lv tape or file                 file part  status
-2000\-11\-09  machine\-c /var  0 000110                       9   --  OK
-2000\-11\-08  machine\-c /var  2 000109                       2   --  OK
-2000\-11\-07  machine\-c /var  2 /amanda/20001107/machine-c._var.2  0 OK
-2000\-11\-06  machine\-c /var  2 000107                       2   --  OK
-2000\-11\-05  machine\-c /var  2 000106                       3   --  OK
-2000\-11\-04  machine\-c /var  2 000105                       2   --  OK
-2000\-11\-03  machine\-c /var  2 000104                       2   --  OK
-2000\-11\-02  machine\-c /var  2 000103                       2   --  OK
-2000\-11\-01  machine\-c /var  1 000102                       5   --  OK
-2000\-10\-31  machine\-c /var  1 000101                       3   --  OK
+2000-11-09  machine-c /var  0 000110                       9   --  OK
+2000-11-08  machine-c /var  2 000109                       2   --  OK
+2000-11-07  machine-c /var  2 /amanda/20001107/machine-c._var.2  0 OK
+2000-11-06  machine-c /var  2 000107                       2   --  OK
+2000-11-05  machine-c /var  2 000106                       3   --  OK
+2000-11-04  machine-c /var  2 000105                       2   --  OK
+2000-11-03  machine-c /var  2 000104                       2   --  OK
+2000-11-02  machine-c /var  2 000103                       2   --  OK
+2000-11-01  machine-c /var  1 000102                       5   --  OK
+2000-10-31  machine-c /var  1 000101                       3   --  OK
 </programlisting>
 
 <para>Forget about the
@@ -411,6 +439,8 @@ TOTAL      241  12412187   7316312   731631  (estimated 8 runs per dumpcycle)
 <citerefentry><refentrytitle>amcheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amfetchdump</refentrytitle><manvolnum>8</manvolnum></citerefentry></para>
+<citerefentry><refentrytitle>amfetchdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>http://wiki.zmanda.com</refentrytitle></citerefentry>
+</para>
 </refsect1>
 </refentry>