git.gag.com Git - debian/amanda/blob - man/xml-source/amraw.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='amraw.8'>
  11
  12 <refmeta>
  13 <refentrytitle>amraw</refentrytitle>
  14 <manvolnum>8</manvolnum>
  15 &rmi.source;
  16 &rmi.version;
  17 &rmi.manual.8;
  18 </refmeta>
  19 <refnamediv>
  20 <refname>amraw</refname>
  21 <refpurpose>Amanda Application open and read data</refpurpose>
  22 </refnamediv>
  23 <refentryinfo>
  24 &author.jlm;
  25 </refentryinfo>
  26 <!-- body begins here -->
  27
  28 <refsect1><title>DESCRIPTION</title>
  29
  30 <para>Amraw is an Amanda Application API script.  It should not be run
  31 by users directly.  It uses dd to backup and restore data.</para>
  32
  33 <para>Amraw can backup only one directory entry, it can be a single file, a raw device, anything that amanda can open and read.</para>
  34
  35 <para>Restore is done in place, an open is done and the data is written to it. A file owned by root and permission 0600 is create if the directory entry doesn't exist before the restore.</para>
  36
  37 <para>Only full backup is allowed</para>
  38 </refsect1>
  39
  40 <refsect1><title>PROPERTIES</title>
  41
  42 <para>This section lists the properties that control amgtar's functionality.
  43 See <manref name="amanda-applications" vol="7"/>
  44 for information on application properties and how they are configured.</para>
  45
  46 <!-- PLEASE KEEP THIS LIST IN ALPHABETICAL ORDER -->
  47 <variablelist>
  48  <!-- ==== -->
  49  <varlistentry><term>DIRECTORY</term><listitem>
  50 Used only for restore command, can be a device name or file, the data will be restored to it.
  51 </listitem></varlistentry>
  52 </variablelist>
  53
  54 </refsect1>
  55
  56 <refsect1><title>EXAMPLE</title>
  57 <para>
  58 <programlisting>
  59   define application-tool app_amraw {
  60     plugin "amraw"
  61   }
  62 </programlisting>
  63 A dumptype using this application might look like:
  64 <programlisting>
  65   define dumptype amraw {
  66     global
  67     program "APPLICATION"
  68     application "app_amraw"
  69   }
  70 </programlisting>
  71 Note that the <emphasis>program</emphasis> parameter must be set to
  72 <emphasis>"APPLICATION"</emphasis> to use the <emphasis>application</emphasis>
  73 parameter.
  74 </para>
  75 </refsect1>
  76
  77 <seealso>
  78 <manref name="amanda.conf" vol="5"/>,
  79 <manref name="amanda-applications" vol="7"/>
  80 </seealso>
  81
  82 </refentry>