git.gag.com Git - debian/amanda/blob - man/xml-source/amgtar.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 <refentry id='amgtar.8'>
  11
  12 <refmeta>
  13 <refentrytitle>amgtar</refentrytitle>
  14 <manvolnum>8</manvolnum>
  15 &rmi.source;
  16 &rmi.version;
  17 &rmi.manual.8;
  18 </refmeta>
  19 <refnamediv>
  20 <refname>amgtar</refname>
  21 <refpurpose>Amanda Application to interface with GNU Tar</refpurpose>
  22 </refnamediv>
  23 <refentryinfo>
  24 &author.jlm;
  25 &author.dustin;
  26 </refentryinfo>
  27 <!-- body begins here -->
  28
  29 <refsect1><title>DESCRIPTION</title>
  30
  31 <para>Amgtar is an &A; Application API script.  It should not be run
  32 by users directly.  It uses GNU Tar to backup and restore data.</para>
  33
  34 </refsect1>
  35
  36 <refsect1><title>PROPERTIES</title>
  37
  38 <para>This section lists the properties that control amgtar's functionality.
  39 See <citerefentry><refentrytitle>amanda-applications</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  40 for information on application properties and how they are configured.</para>
  41
  42 <!-- PLEASE KEEP THIS LIST IN ALPHABETICAL ORDER -->
  43 <variablelist>
  44  <!-- ==== -->
  45  <varlistentry><term>ATIME-PRESERVE</term><listitem>
  46 If "YES" (the default), amgtar use the <emphasis>--atime-preserve=system</emphasis> option of gnutar to not update the atime of all files accessed; if "NO", gnutar will updates the atime for all files accessed. This property works only if you have gnutar 1.15.90 or newer, if not, you must set ATIME_PRESERVE to "NO".
  47 </listitem></varlistentry>
  48  <!-- ==== -->
  49  <varlistentry><term>CHECK-DEVICE</term><listitem>
  50 If "YES" (the default), amgtar checks that the device number doesn't change for each file. If "NO", changes in device number are ignored.  To ignore device numbers, tar must support the <emphasis>--no-check-device</emphasis> option (gnutar 1.19.90 and newer). This option is needed for some filesystems and devices on which device numbers change frequently, such as LVM or FiberChannel.
  51 </listitem></varlistentry>
  52  <!-- ==== -->
  53  <varlistentry><term>DIRECTORY</term><listitem>
  54 If set, gnutar will backup from that directory instead of the <emphasis>diskdevice</emphasis> set by the DLE.
  55 </listitem></varlistentry>
  56  <!-- ==== -->
  57  <varlistentry><term>GNUTAR-LISTDIR</term><listitem>
  58 The directory where gnutar stores the database it uses to generate incremental dumps.  The default is set when &A; is built.
  59 </listitem></varlistentry>
  60  <!-- ==== -->
  61  <varlistentry><term>GNUTAR-PATH</term><listitem>
  62 The path to the gnutar binary.  The default is set when &A; is built.
  63 </listitem></varlistentry>
  64  <!-- ==== -->
  65  <varlistentry><term>ONE-FILE-SYSTEM</term><listitem>
  66 If "YES" (the default), do not allow gnutar to cross filesystem boundaries. If "NO", gnutar will cross filesystem boundaries.  This corresponds to the <emphasis>--one-filesystem</emphasis> option of gnutar.
  67 </listitem></varlistentry>
  68  <!-- ==== -->
  69  <varlistentry><term>TAR-BLOCKSIZE</term><listitem>
  70 Block size of Nx512 bytes (default N=20).  This corresponds to the <emphasis>--blocking-factor</emphasis> option of gnutar.
  71 </listitem></varlistentry>
  72  <!-- ==== -->
  73  <varlistentry><term>SPARSE</term><listitem>
  74 If "YES" (the default), gnutar will store sparse files efficiently. If "NO", then the <emphasis>--sparse</emphasis> option is not given to gnutar, and it will not try to detect sparse files.
  75 </listitem></varlistentry>
  76  <!-- ==== -->
  77  <varlistentry><term>EXIT-HANDLING</term><listitem>
  78 List which exit status of gtar are good or bad. eg. "1=GOOD 2=BAD", exit status of 1 will produce a good backup, exit status of 2 will give an error.
  79 </listitem></varlistentry>
  80  <!-- ==== -->
  81  <varlistentry><term>NORMAL</term><listitem>
  82 List all regex (POSIX Extended Regular Expression syntax) that are normal output from gtar. These output are in the "FAILED DUMP DETAILS" section of the email report if the dump result is STRANGE or FAILED. Default values:
  83 <programlisting>
  84   "^could not open conf file"
  85   "^Elapsed time:"
  86   "^Throughput"
  87   ": socket ignored$"
  88   ": File .* shrunk by [0-9][0-9]* bytes, padding with zeros"
  89   ": Cannot add file .*: No such file or directory$"
  90   ": Error exit delayed from previous errors"
  91 </programlisting>
  92 <para>To treat one of these default patterns differently, specify it explicitly in a different property.</para>
  93 </listitem></varlistentry>
  94  <!-- ==== -->
  95  <varlistentry><term>IGNORE</term><listitem>
  96 List all regex (POSIX Extended Regular Expression syntax) that amanda ignore. These output are never in the email report. Default values:
  97 <programlisting>
  98   ": Directory is new$"
  99   ": Directory has been renamed"
 100 </programlisting>
 101 <para>To treat one of these default patterns differently, specify it explicitly in a different property.</para>
 102 </listitem></varlistentry>
 103  <!-- ==== -->
 104  <varlistentry><term>STRANGE</term><listitem>
 105 List all regex (POSIX Extended Regular Expression syntax) that are strange output from gtar. All gtar output that doesn't match a normal or ignore regex are strange by default. The result of the dump is STRANGE if gtar produce a strange output. These output are in the "FAILED DUMP DETAILS" section of the email report.
 106 </listitem></varlistentry>
 107 </variablelist>
 108
 109 </refsect1>
 110
 111 <refsect1><title>EXAMPLE</title>
 112 <programlisting>
 113   define application-tool app_amgtar {
 114     property "ATIME-PRESERVE" "NO"
 115     property "CHECK-DEVICE" "YES"
 116     property "GNUTAR-LISTDIR" "
 117     property "GNUTAR-PATH" "/bin/tar"
 118     property "ONE-FILE-SYSTEM" "YES"
 119     property "TAR_BLOCKSIZE" "20"
 120     property "SPARSE" "YES"
 121     property "EXIT-HANDLING" "1=GOOD 2=BAD"
 122     # change a default NORMAL regex to a STRANGE regex.
 123     property "STRANGE" ": socket ignored$"
 124     # add three new IGNORE regex
 125     property "IGNORE" ": Directory is new$"
 126     property append "IGNORE" ": Directory has been renamed"
 127     property append "IGNORE" "file changed as we read it$"
 128   }
 129 </programlisting>
 130 </refsect1>
 131
 132 <refsect1><title>SEE ALSO</title>
 133 <para>
 134 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 135 <citerefentry><refentrytitle>amanda-applications</refentrytitle><manvolnum>7</manvolnum></citerefentry>
 136 </para>
 137
 138 </refsect1>
 139 </refentry>