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>The <emphasis remap='B'>diskdevice</emphasis> in the disklist (DLE)
  36 must be the filename amraw open and read.</para>
  37
  38 <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>
  39
  40 <para>Only full backup is allowed</para>
  41 </refsect1>
  42
  43 <refsect1><title>PROPERTIES</title>
  44
  45 <para>This section lists the properties that control amgtar's functionality.
  46 See <manref name="amanda-applications" vol="7"/>
  47 for information on application properties and how they are configured.</para>
  48
  49 <!-- PLEASE KEEP THIS LIST IN ALPHABETICAL ORDER -->
  50 <variablelist>
  51  <!-- ==== -->
  52  <varlistentry><term>DIRECTORY</term><listitem>
  53 Used only for restore command, can be a device name or file, the data will be restored to it.
  54 </listitem></varlistentry>
  55 </variablelist>
  56
  57 </refsect1>
  58
  59 <refsect1><title>EXAMPLE</title>
  60 <para>
  61 <programlisting>
  62   define application-tool app_amraw {
  63     plugin "amraw"
  64   }
  65 </programlisting>
  66 A dumptype using this application might look like:
  67 <programlisting>
  68   define dumptype amraw {
  69     global
  70     program "APPLICATION"
  71     application "app_amraw"
  72   }
  73 </programlisting>
  74 Note that the <emphasis>program</emphasis> parameter must be set to
  75 <emphasis>"APPLICATION"</emphasis> to use the <emphasis>application</emphasis>
  76 parameter.
  77 </para>
  78 </refsect1>
  79
  80 <seealso>
  81 <manref name="amanda.conf" vol="5"/>,
  82 <manref name="amanda-applications" vol="7"/>
  83 </seealso>
  84
  85 </refentry>