git.gag.com Git - debian/amanda/blob - man/xml-source/amstar.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 <refentry id='amstar.8'>
  11
  12 <refmeta>
  13 <refentrytitle>amstar</refentrytitle>
  14 <manvolnum>8</manvolnum>
  15 &rmi.source;
  16 &rmi.version;
  17 &rmi.manual.8;
  18 </refmeta>
  19 <refnamediv>
  20 <refname>amstar</refname>
  21 <refpurpose>Amanda Application to interface with star</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>Amstar is an Amanda Application API script.  It should not be run
  32 by users directly.  It uses star 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 amstar's functionality.
  39 See <manref name="amanda-applications" vol="7"/>
  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>COMMAND-OPTIONS</term><listitem>
  46 <para>If set, theses options are passed asis to star. Each option must be a different value of the property. Some option can break how amanda do backup, use it with care.</para>
  47 Use:
  48 <programlisting>
  49   property "COMMAND-OPTIONS" "--foo" "bar"
  50 </programlisting>
  51 Do not use:
  52 <programlisting>
  53   property "COMMAND-OPTIONS" "--foo bar"
  54 </programlisting>
  55 </listitem></varlistentry>
  56  <!-- ==== -->
  57  <varlistentry><term>DIRECTORY</term><listitem>
  58 If set, gnutar will backup from that directory instead of the <emphasis>diskdevice</emphasis> set by the DLE. On restore, the data is restore in that directpory instead of the current working directory.
  59 </listitem></varlistentry>
  60  <!-- ==== -->
  61  <varlistentry><term>ONE-FILE-SYSTEM</term><listitem>
  62 The default is "YES". This property is deprecated and the default value can't be changed. star requires it when it works in dump mode.  This corresponds to the <emphasis>-xdev</emphasis> option of star.
  63 </listitem></varlistentry>
  64  <!-- ==== -->
  65  <varlistentry><term>SPARSE</term><listitem>
  66 If "YES" (the default), star will store sparse files efficiently. If "NO", then the <emphasis>-sparse</emphasis> option is not given to star, and it will not try to detect sparse files.
  67 </listitem></varlistentry>
  68  <!-- ==== -->
  69  <varlistentry><term>STAR-DLE-TARDUMP</term><listitem>
  70 If "YES", amstar will use a different tardump file for each DLE. The default is "NO".  This property is needed with older versions of star doing many dumps in parallel, because of a race condition in updating the tardump file.
  71 </listitem></varlistentry>
  72  <!-- ==== -->
  73  <varlistentry><term>STAR-PATH</term><listitem>
  74 The path to the star binary. The default is set when Amanda is built by the
  75 --with-star configure option.
  76 </listitem></varlistentry>
  77  <!-- ==== -->
  78  <varlistentry><term>STAR-TARDUMP</term><listitem>
  79 The directory where star stores the database it uses to generate incremental
  80 dumps.  The default is /etc/tardumps.
  81 </listitem></varlistentry>
  82  <!-- ==== -->
  83  <varlistentry><term>NORMAL</term><listitem>
  84 List all regex (POSIX Extended Regular Expression syntax) that are normal output from star. These output are in the "FAILED DUMP DETAILS" section of the email report if the dump result is STRANGE or FAILED. Default values:
  85 <programlisting>
  86   "^could not open conf file"
  87   "^Type of this level "
  88   "^Date of this level "
  89   "^Date of last level "
  90   "^Dump record  level "
  91   "^Throughput"
  92   "^.*is sparse$"
  93   "^star: dumped [0-9][0-9]* (tar )?files"
  94   "^.*The following problems occurred during .* processing.*$"
  95   "^.*Processed all possible files, despite earlier errors.*$"
  96   "^.*not written due to problems during backup.*$"
  97 </programlisting>
  98 <para>To treat one of these default patterns differently, specify it explicitly in a different property.</para>
  99 </listitem></varlistentry>
 100  <!-- ==== -->
 101  <varlistentry><term>IGNORE</term><listitem>
 102 List all regex (POSIX Extended Regular Expression syntax) that amanda ignore. These output are never in the email report.
 103 </listitem></varlistentry>
 104  <!-- ==== -->
 105  <varlistentry><term>STRANGE</term><listitem>
 106 List all regex (POSIX Extended Regular Expression syntax) that are strange output from star. All star output that doesn't match a normal or ignore regex are strange by default. The result of the dump is STRANGE if star produce a strange output. These output are in the "FAILED DUMP DETAILS" section of the email report.
 107 <programlisting>
 108   "^Perform a level 0 dump first.*$"
 109 </programlisting>
 110 <para>To treat one of these default patterns differently, specify it explicitly in a different property.</para>
 111 </listitem></varlistentry>
 112
 113 </variablelist>
 114
 115 </refsect1>
 116
 117 <seealso>
 118 <manref name="amanda.conf" vol="5"/>,
 119 <manref name="amanda-applications" vol="7"/>
 120 </seealso>
 121
 122 </refentry>