Imported Upstream version 3.3.3
[debian/amanda] / man / xml-source / amanda-changers.7.xml
index 1520f278b47b60a902f29d1b1d7a478ad308dc86..cfdd629abc28bb098705717164b1de80e361a28d 100644 (file)
@@ -158,6 +158,20 @@ tpchanger "aggregate"
 <para>This changer driver allow to use two or more changers or standalone
 drive in sequence.</para>
 
+<refsect3><title>Properties</title>
+<!-- PLEASE KEEP THIS LIST IN ALPHABETICAL ORDER -->
+
+<variablelist>
+<!-- ==== -->
+<varlistentry><term>LOCK-TIMEOUT</term><listitem>
+The time in seconds amanda wait to lock the statefile (default:1000)
+</listitem></varlistentry>
+<!-- ==== -->
+<varlistentry><term>STATE_FILENAME</term><listitem>
+The name of the state file (default: "$CONFIG_DIR/$changer_name.state".
+</listitem></varlistentry>
+</variablelist>
+</refsect3>
 </refsect2>
 
 <refsect2><title>chg-disk:VTAPEROOT (new)</title>
@@ -191,6 +205,10 @@ name="amrestore" vol="8" /> command line.</para>
 If a <computeroutput>slotN</computeroutput> directory in the range 1 to NUM-SLOT does not already exist, and this property is true, then the changer will create the directory.
 </listitem></varlistentry>
 <!-- ==== -->
+<varlistentry><term>LOCK-TIMEOUT</term><listitem>
+The time in seconds amanda wait to lock the statefile (default:1000)
+</listitem></varlistentry>
+<!-- ==== -->
 <varlistentry><term>MOUNT</term><listitem>
 If this property is true, the changer try to mount the removable disk if nothing is mounted. The system must be configured to allow the amanda user to mount it.
 </listitem></varlistentry>
@@ -274,6 +292,10 @@ tpchanger "chg-multi:s3:mycompany-backups/tape-{001..100}"
 This property gives the number of the first slot. The default value is "1".
 </listitem></varlistentry>
 <!-- ==== -->
+<varlistentry><term>LOCK-TIMEOUT</term><listitem>
+The time in seconds amanda wait to lock the statefile (default:1000)
+</listitem></varlistentry>
+<!-- ==== -->
 </variablelist>
 
 </refsect3>
@@ -430,7 +452,7 @@ slotinfofile=FILENAME       #### record slot information to this file, in
 <refsect2><title>chg-rait:{CHILD1,CHILD2,..}</title>
 <programlisting>
 define changer vtape {
-    tpcanger "chg-disk:/path/to/vtape"
+    tpchanger "chg-disk:/path/to/vtape"
 }
 define changer robot {
     tpchanger "chg-robot:/dev/sg0"
@@ -627,6 +649,10 @@ The default value is <command>"0s poll 3s until 2m"</command>.
 </para>
 </listitem></varlistentry>
 <!-- ==== -->
+<varlistentry><term>LOCK-TIMEOUT</term><listitem>
+The time in seconds amanda wait to lock the statefile (default:1000)
+</listitem></varlistentry>
+<!-- ==== -->
 <varlistentry><term>MTX</term><listitem>
 The path to the 'mtx' binary.  The default value is defined at compile time.
 </listitem></varlistentry>
@@ -759,6 +785,17 @@ If true, enables the NDMJOB library's verbose (packet-level) debugging.
 
 </refsect2>
 
+<refsect2><title>chg-single:DEVICE</title>
+<programlisting>
+tpchanger "chg-single:tape:/dev/nst0"
+</programlisting>
+
+<para>This changer is for use with standalone drive, it can work with any
+device. The device (<command>tape:/dev/nst0</command>) must be set in the tpchanger definition.</para>
+<para>The <command>chg-single</command> changer has no property.</para>
+
+</refsect2>
+
 <refsect2><title>Unmaintained Changers</title>
 
 <para>Amanda has many other changer scripts and programs beyond those described