git.gag.com Git - debian/amanda/blob - man/xml-source/amtapetype.8.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4
   5   <!-- entities files to use -->
   6   <!ENTITY % global_entities SYSTEM 'global.entities'>
   7   %global_entities;
   8
   9 ]>
  10
  11 <!-- lifted from troff+man by doclifter -->
  12 <refentry id='amtapetype.8'>
  13
  14 <refmeta>
  15 <refentrytitle>amtapetype</refentrytitle>
  16 <manvolnum>8</manvolnum>
  17 &rmi.source;
  18 &rmi.version;
  19 &rmi.manual.8;
  20 </refmeta>
  21 <refnamediv>
  22 <refname>amtapetype</refname>
  23 <refpurpose>generate a tapetype definition by testing the device directly</refpurpose>
  24 </refnamediv>
  25 <refentryinfo>
  26 &author.dustin;
  27 &author.jlm;
  28 </refentryinfo>
  29 <!-- body begins here -->
  30 <refsynopsisdiv>
  31 <cmdsynopsis>
  32   <command>amtapetype</command>
  33     <arg choice='opt'>-h </arg>
  34     <arg choice='opt'>-c </arg>
  35     <arg choice='opt'>-f </arg>
  36     <arg choice='opt'>-p </arg>
  37     <arg choice='opt'>-b <replaceable>blocksize</replaceable></arg>
  38     <arg choice='opt'>-t <replaceable>typename</replaceable></arg>
  39     <arg choice='opt'>-l <replaceable>label</replaceable></arg>
  40     &configoverride.synopsis;
  41     <group choice='opt'>
  42       <arg choice='plain'><replaceable>config</replaceable></arg>
  43     </group>
  44     <arg><replaceable>device</replaceable></arg>
  45 </cmdsynopsis>
  46 </refsynopsisdiv>
  47
  48 <refsect1><title>DESCRIPTION</title>
  49 <para><emphasis remap='B'>amtapetype</emphasis>
  50 generates a tapetype entry for Amanda by testing the device directly.</para>
  51 </refsect1>
  52
  53 <refsect1><title>OPTIONS</title>
  54 <note><para>The options for &amtapetype; have changed in version 2.6.1</para></note>
  55 <variablelist remap='TP'>
  56   <varlistentry>
  57   <term><option>-h</option></term>
  58   <listitem>
  59 <para>Display the help message.</para>
  60   </listitem>
  61   </varlistentry>
  62   <varlistentry>
  63   <term><option>-c</option></term>
  64   <listitem>
  65 <para>Run only the hardware compression detection heuristic test and stop.
  66 This takes a few minutes only.</para>
  67   </listitem>
  68   </varlistentry>
  69   <varlistentry>
  70   <term><option>-f</option></term>
  71   <listitem>
  72 <para>Run amtapetype even if the loaded volume is already labeled.</para>
  73   </listitem>
  74   </varlistentry>
  75   <varlistentry>
  76   <term><option>-p</option></term>
  77   <listitem>
  78 <para>Run only the device property discovery.
  79 </para>
  80   </listitem>
  81   </varlistentry>
  82   <varlistentry>
  83   <term><option>-b</option><replaceable> blocksize</replaceable></term>
  84   <listitem>
  85 <para>block size to use with the device (default: 32k)</para>
  86   </listitem>
  87   </varlistentry>
  88   <varlistentry>
  89   <term><option>-t</option> <replaceable>typename</replaceable></term>
  90   <listitem>
  91 <para>Name to give to the new tapetype definition.</para>
  92   </listitem>
  93   </varlistentry>
  94   <varlistentry>
  95   <term><option>-l</option><replaceable> label</replaceable></term>
  96   <listitem>
  97 <para>Label to write on the tape (default is randomly generated).</para>
  98   </listitem>
  99   </varlistentry>
 100
 101   &configoverride.varlistentry;
 102
 103 </variablelist>
 104
 105 <para>
 106 If a configuration is specified, it is loaded and used to configure the device.
 107 Note that global configuration parameters are not applied to the device, so if
 108 you need to apply properties to a device to run amtapetype, you should supply
 109 those properties in a named <emphasis>device</emphasis> section.
 110 </para>
 111
 112 </refsect1>
 113
 114 <refsect1><title>EXAMPLE</title>
 115 <para>Generate a tapetype definition for your tape device:</para>
 116
 117 <!-- .RS -->
 118 <literallayout remap='.nf'>
 119 % amtapetype -f /dev/nst0
 120 </literallayout></refsect1>
 121
 122 <refsect1><title>NOTES</title>
 123 <para>If the device cannot reliably report its comprssion status (and as of
 124 this writing, no devices can do so), hardware compression is detected by
 125 measuring the writing speed difference of the tape drive when writing an amount
 126 of compressable and uncompresseable data.  If your tape drive has very large
 127 buffers or is very fast, the program could fail to detect hardware compression
 128 status reliably.</para>
 129
 130 <para>Volume capacity is determined by writing one large file until an error,
 131 interpereted as end-of-tape, is encountered.  In the next phase, about 100
 132 files are written to fill the tape.  This second phase will write less data,
 133 because each filemark consumes some tape.  With a little arithmetic,
 134 &amtapetype; calculates the size of these filemarks.</para>
 135
 136 <para>All sorts of things might happen to cause the amount of data written to
 137 vary enough to generate a strange file mark size guess.  A little more
 138 &quot;shoe shining&quot; because of the additional file marks (and flushes),
 139 dirt left on the heads from the first pass of a brand new tape, the
 140 temperature/humidity changed during the multi-hour run, a different amount of
 141 data was written after the last file mark before EOT was reported, etc.</para>
 142
 143 <para>Note that the file mark size might really be zero for whatever device this
 144 is, and it was just the measured capacity variation that caused &amtapetype;
 145 to think those extra file marks in pass 2 actually took up space.</para>
 146
 147 </refsect1>
 148
 149 <seealso>
 150 <manref name="amanda.conf" vol="5" />
 151 </seealso>
 152
 153 </refentry>