git.gag.com Git - debian/amanda/blob - man/xml-source/amanda-applications.7.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='amanda-applications.7'>
  11
  12 <refmeta>
  13 <refentrytitle>amanda-applications</refentrytitle>
  14 <manvolnum>7</manvolnum>
  15 &rmi.source;
  16 &rmi.version;
  17 &rmi.manual.7;
  18 </refmeta>
  19 <refnamediv>
  20 <refname>amanda-applications</refname>
  21 <refpurpose>Application-api for amanda</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>Describe how to use application with Amanda</para>
  32 </refsect1>
  33
  34 <refsect1><title>APPLICATIONS</title>
  35
  36 <para>This section lists the applications included with Amanda. See the individual man pages for instructions on using them.  For complete How-To information, consult the Amanda wiki at http://wiki.zmanda.com.</para>
  37
  38 <itemizedlist>
  39 <listitem>
  40 <manref name="amgtar" vol="8"/>,
  41 - use GNU Tar to backup and restore data.
  42 </listitem>
  43 <listitem>
  44 <manref name="ampgsql" vol="8"/>,
  45 - use PostgreSQL's continuous WAL archiving.
  46 </listitem>
  47 <listitem>
  48 <manref name="amraw" vol="8"/>,
  49 - use open and read to read the data.
  50 </listitem>
  51 <listitem>
  52 <manref name="amsamba" vol="8"/>,
  53 - use smbclient to backup and restore data.
  54 </listitem>
  55 <listitem>
  56 <manref name="amstar" vol="8"/>,
  57 - use star to backup and restore data.
  58 </listitem>
  59 <listitem>
  60 <manref name="amsuntar" vol="8"/>,
  61 - use native tar on Solaris to backup and restore data.
  62 </listitem>
  63 <listitem>
  64 <manref name="amzfs-sendrecv" vol="8"/>,
  65 - use zfs to create a snapshot and use 'zfs send' to generate the backup.
  66 </listitem>
  67 <listitem>
  68 <manref name="amzfs-snapshot" vol="8"/>,
  69 - use zfs to create a snapshot and for use with other applications (e.g. amgtar)
  70 </listitem>
  71 </itemizedlist>
  72
  73 </refsect1>
  74
  75 <refsect1><title>DEFINING APPLICATIONS</title>
  76
  77 <para>An application is defined in &amconf; as follows:
  78
  79 <programlisting>
  80 define application-tool $appconfigname {
  81    plugin "$pluginname"
  82    property "$PROPERTY_NAME" "$PROPERTY_VALUE"
  83    ...
  84 }
  85 </programlisting>
  86 and then referenced in a dumptype as
  87 <programlisting>
  88 define dumptype $dumptypename {
  89    ...
  90    program "APPLICATION"
  91    application "$appconfigname"
  92 }
  93 </programlisting></para>
  94
  95 <para>Application properties, like Amanda configuration parameters, are
  96 insensitive to case, and <literal>-</literal> (dash) and
  97 <literal>_</literal> (underscore) may be used interchangeably.</para>
  98
  99 <para>See the individual plugin documentation for properties applicable to each
 100 plugin.</para>
 101
 102 </refsect1>
 103
 104 <seealso>
 105 <manref name="amanda.conf" vol="5"/>
 106 </seealso>
 107
 108 </refentry>