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 '../entities/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     <arg choice='opt'>-o <replaceable>config_overwrite</replaceable></arg>
  41     <arg><replaceable>device</replaceable></arg>
  42 </cmdsynopsis>
  43 </refsynopsisdiv>
  44
  45 <refsect1><title>DESCRIPTION</title>
  46 <para><emphasis remap='B'>amtapetype</emphasis>
  47 generates a tapetype entry for &A; by testing the device directly</para>
  48 </refsect1>
  49
  50 <refsect1><title>OPTIONS</title>
  51 <note><para>The options for &amtapetype; have changed in version 2.6.1</para></note>
  52 <variablelist remap='TP'>
  53   <varlistentry>
  54   <term><option>-h</option></term>
  55   <listitem>
  56 <para>Display the help message.</para>
  57   </listitem>
  58   </varlistentry>
  59   <varlistentry>
  60   <term><option>-c</option></term>
  61   <listitem>
  62 <para>Run only the hardware compression detection heuristic test and stop.
  63 This takes a few minutes only.</para>
  64   </listitem>
  65   </varlistentry>
  66   <varlistentry>
  67   <term><option>-f</option></term>
  68   <listitem>
  69 <para>Run amtapetype even if the loaded volume is already in use or compression
  70 is enabled.</para>
  71   </listitem>
  72   </varlistentry>
  73   <varlistentry>
  74   <term><option>-p</option></term>
  75   <listitem>
  76 <para>Run only the device property discovery.
  77 </para>
  78   </listitem>
  79   </varlistentry>
  80   <varlistentry>
  81   <term><option>-b</option><replaceable> blocksize</replaceable></term>
  82   <listitem>
  83 <para>block size to use with the device (default: 32k)</para>
  84   </listitem>
  85   </varlistentry>
  86   <varlistentry>
  87   <term><option>-t</option> <replaceable>typename</replaceable></term>
  88   <listitem>
  89 <para>Name to give to the new tapetype definition.</para>
  90   </listitem>
  91   </varlistentry>
  92   <varlistentry>
  93   <term><option>-l</option><replaceable> label</replaceable></term>
  94   <listitem>
  95 <para>Label to write on the tape (default is randomly generated).</para>
  96   </listitem>
  97   </varlistentry>
  98   <varlistentry>
  99   <term><option>-o</option> <replaceable>configoption</replaceable></term>
 100   <listitem>
 101 <para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>" section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
 102   </listitem>
 103   </varlistentry>
 104 </variablelist>
 105 </refsect1>
 106
 107 <refsect1><title>EXAMPLE</title>
 108 <para>Generate a tapetype definition for your tape device:</para>
 109
 110 <!-- .RS -->
 111 <literallayout remap='.nf'>
 112 % amtapetype -f /dev/nst0
 113 </literallayout></refsect1>
 114
 115 <refsect1><title>NOTES</title>
 116 <para>If the device cannot reliably report its comprssion status (and as of
 117 this writing, no devices can do so), hardware compression is detected by
 118 measuring the writing speed difference of the tape drive when writing an amount
 119 of compressable and uncompresseable data.  If your tape drive has very large
 120 buffers or is very fast, the program could fail to detect hardware compression
 121 status reliably.</para>
 122
 123 <para>Volume capacity is determined by writing one large file until an error,
 124 interpereted as end-of-tape, is encountered.  In the next phase, about 100
 125 files are written to fill the tape.  This second phase will write less data,
 126 because each filemark consumes some tape.  With a little arithmetic,
 127 &amtapetype; calculates the size of these filemarks.</para>
 128
 129 <para>All sorts of things might happen to cause the amount of data written to
 130 vary enough to generate a strange file mark size guess.  A little more
 131 &quot;shoe shining&quot; because of the additional file marks (and flushes),
 132 dirt left on the heads from the first pass of a brand new tape, the
 133 temperature/humidity changed during the multi-hour run, a different amount of
 134 data was written after the last file mark before EOT was reported, etc.</para>
 135
 136 <para>Note that the file mark size might really be zero for whatever device this
 137 is, and it was just the measured capacity variation that caused &amtapetype;
 138 to think those extra file marks in pass 2 actually took up space.</para>
 139
 140 </refsect1>
 141
 142 </refentry>