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 '../entities/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 &A; 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 <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>ONE-FILE-SYSTEM</term><listitem>
  46 If "YES" (the default), do not allow star to cross filesystem boundaries. If "NO", star will cross filesystem boundaries.  This corresponds to the <emphasis>-xdev</emphasis> option of star.
  47 </listitem></varlistentry>
  48  <!-- ==== -->
  49  <varlistentry><term>SPARSE</term><listitem>
  50 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.
  51 </listitem></varlistentry>
  52  <!-- ==== -->
  53  <varlistentry><term>STAR-DLE-TARDUMP</term><listitem>
  54 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.
  55 </listitem></varlistentry>
  56  <!-- ==== -->
  57  <varlistentry><term>STAR-PATH</term><listitem>
  58 The path to the star binary.  The default is set when &A; is built.
  59 </listitem></varlistentry>
  60  <!-- ==== -->
  61  <varlistentry><term>STAR-TARDUMP</term><listitem>
  62 The directory where star stores the database it uses to generate incremental dumps.  The default is set when &A; is built.
  63 </listitem></varlistentry>
  64 </variablelist>
  65
  66 </refsect1>
  67
  68 <refsect1><title>SEE ALSO</title>
  69 <para>
  70 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  71 <citerefentry><refentrytitle>amanda-applications</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  72 </para>
  73
  74 </refsect1>
  75 </refentry>