Imported Upstream version 3.1.0
[debian/amanda] / man / xml-source / amrmtape.8.xml
index 359da03a0a54b4b3dfdc1109e4e80d7d6d3ad55c..e23e934d7ecec4a13f1cff2ddf1f44b6230a3484 100644 (file)
@@ -3,7 +3,7 @@
                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
 [
   <!-- entities files to use -->
-  <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
+  <!ENTITY % global_entities SYSTEM 'global.entities'>
   %global_entities;
 ]>
 
@@ -19,7 +19,7 @@
 </refmeta>
 <refnamediv>
 <refname>amrmtape</refname>
-<refpurpose>remove a tape from the &A; database</refpurpose>
+<refpurpose>remove a tape from the Amanda database</refpurpose>
 </refnamediv>
 <refentryinfo>
 &author.atf3r;
 <!-- body begins here -->
 <refsynopsisdiv>
 <cmdsynopsis>
-  <command>amrmtape</command>    
+  <command>amrmtape</command>
+    <arg choice='opt'>--changer <replaceable>changer-name</replaceable> </arg>
+    <arg choice='opt'>--cleanup </arg>
+    <arg choice='opt'>--dryrun </arg>
     <arg choice='opt'>-n </arg>
-    <arg choice='opt'>-v </arg>
+    <arg choice='opt'>--erase </arg>
+    <arg choice='opt'>--keep-label </arg>
+    <arg choice='opt'>--quiet </arg>
     <arg choice='opt'>-q </arg>
-    <arg choice='opt'>-d </arg>
+    <arg choice='opt'>--verbose </arg>
+    <arg choice='opt'>-v </arg>
     <arg choice='plain'><replaceable>config</replaceable></arg>
     <arg choice='plain'><replaceable>label</replaceable></arg>
 </cmdsynopsis>
@@ -48,13 +54,31 @@ good backup is damaged either by faulty hardware or user error,
 e.g. the tape is eaten by the drive or is overwritten.</para>
 
 <para>See the
-<citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-man page for more details about &A;.</para>
+<manref name="amanda" vol="8"/>
+man page for more details about Amanda.</para>
 </refsect1>
 
 <refsect1><title>OPTIONS</title>
 <variablelist remap='TP'>
   <varlistentry>
+  <term><option>--changer <replaceable>changer-name</replaceable> </option></term>
+  <listitem>
+<para>Specify which changer to use when erasing
+<emphasis remap='I'>label</emphasis>
+</para>
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><option>--cleanup</option></term>
+  <listitem>
+<para>Remove logs and indexes associated with
+<emphasis remap='I'>label</emphasis>.
+Otherwise, they'll remain until the next run of amdump.
+</para>
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><option>--dryrun</option></term>
   <term><option>-n</option></term>
   <listitem>
 <para>Generate new &tapelist; and database files with
@@ -65,24 +89,39 @@ and do not update the original copies.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
+  <term><option>--erase</option></term>
+  <listitem>
+<para>Attempt to erase the data contained on the volume with the given label.
+This requires that Amanda be able to find that volume using the tape changer.
+Erasure is not supported by all Amanda devices, and the erasure is not "secure"
+in the sense that the data can most likely be recovered by someone with the
+right tools.  </para>
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><option>--keep-label</option></term>
+  <listitem>
+<para>Do not remove
+<emphasis remap='I'>label</emphasis>
+from the tapelist.
+</para>
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><option>--verbose</option></term>
   <term><option>-v</option></term>
   <listitem>
 <para>List backups of hosts and disks that are being discarded.  Enabled by default.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
+  <term><option>--quiet</option></term>
   <term><option>-q</option></term>
   <listitem>
 <para>Opposite of
 <option>-v</option>.</para>
   </listitem>
   </varlistentry>
-  <varlistentry>
-  <term><option>-d</option></term>
-  <listitem>
-<para>Run in debugging mode so all executed commands are shown.</para>
-  </listitem>
-  </varlistentry>
 </variablelist>
 </refsect1>
 
@@ -98,11 +137,8 @@ configuration.</para>
 </programlisting>
 </refsect1>
 
-<refsect1><title>SEE ALSO</title>
-<para><citerefentry><refentrytitle>amadmin</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<ulink url="http://wiki.zmanda.com"/>
-</para>
-</refsect1>
-</refentry>
+<seealso>
+<manref name="amadmin" vol="8"/>
+</seealso>
 
+</refentry>