git.gag.com Git - debian/amanda/blob - man/xml-source/amdump.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 <!-- lifted from troff+man by doclifter -->
  11 <refentry id='amdump.8'>
  12
  13 <refmeta>
  14 <refentrytitle>amdump</refentrytitle>
  15 <manvolnum>8</manvolnum>
  16 </refmeta>
  17 <refnamediv>
  18 <refname>amdump</refname>
  19 <refpurpose>back up all disks in an &A; configuration</refpurpose>
  20 </refnamediv>
  21 <!-- body begins here -->
  22 <refsynopsisdiv>
  23 <cmdsynopsis>
  24   <command>amdump</command>
  25     <arg choice='plain'><replaceable>config</replaceable></arg>
  26     <arg choice='opt' rep='repeat'>
  27        <arg choice='plain'><replaceable>host</replaceable></arg>
  28        <arg choice='opt' rep='repeat'><replaceable>disk</replaceable></arg>
  29     </arg>
  30     <arg choice='plain' rep='repeat'><group><arg choice='plain'>-o </arg><replaceable>configoption</replaceable></group></arg>
  31 </cmdsynopsis>
  32 </refsynopsisdiv>
  33
  34
  35 <refsect1><title>DESCRIPTION</title>
  36 <para><emphasis remap='B'>Amdump</emphasis>
  37 switches to the appropriate &A; configuration directory,
  38 e.g. /usr/local/etc/amanda/<emphasis remap='I'>config</emphasis>,
  39 then attempts to back up every disk specified by the
  40 <emphasis remap='I'>amanda.conf</emphasis>
  41 file.
  42 <emphasis remap='B'>Amdump</emphasis>
  43 is normally run by
  44 <emphasis remap='B'>cron</emphasis>.</para>
  45
  46 <para>You can specify many host/disk expressions, only disks that
  47 match an expression will be dumped. All disks are dumped if no
  48 expressions are given.</para>
  49
  50 <para>If the file /usr/local/etc/amanda/<emphasis remap='I'>config</emphasis>/hold exists,
  51 <command>amdump</command>
  52 will wait until it is removed before starting the backups.
  53 This allows scheduled backups to be delayed when circumstances warrant, for example,
  54 if the tape device is being used for some other purpose.
  55 While waiting,
  56 <command>amdump</command>
  57 checks for the hold file every minute.</para>
  58
  59 <para>See the
  60 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  61 man page for more details about &A;.</para>
  62 </refsect1>
  63
  64 <refsect1><title>OPTIONS</title>
  65 <variablelist remap='TP'>
  66
  67   <varlistentry>
  68   <term><replaceable>host</replaceable> [<replaceable>disk</replaceable>]*</term>
  69   <listitem>
  70 <para>Specify the host and disk on which the command will work.</para>
  71   </listitem>
  72   </varlistentry>
  73
  74   <varlistentry>
  75   <term><emphasis remap='B'>-o</emphasis> <replaceable>configoption</replaceable></term>
  76   <listitem>
  77 <para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>" section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
  78   </listitem>
  79   </varlistentry>
  80
  81 </variablelist>
  82 </refsect1>
  83
  84 <refsect1><title>EXAMPLE</title>
  85 <para>Here is a typical crontab entry. It runs
  86 <command>amdump</command>
  87 every weeknight at 1 a.m. as user
  88 <emphasis remap='B'>bin</emphasis>:</para>
  89
  90 <programlisting>
  91 0 1 * * 1-5 bin /usr/local/sbin/amdump daily
  92 </programlisting>
  93
  94 <para>Please see the
  95 <citerefentry><refentrytitle>crontab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  96 or
  97 <citerefentry><refentrytitle>crontab</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  98 manual page for the correct crontab format for your system.</para>
  99 </refsect1>
 100
 101 <refsect1><title>MESSAGES</title>
 102 <variablelist remap='TP'>
 103   <varlistentry>
 104   <term>amdump: waiting for hold file to be removed</term>
 105   <listitem>
 106 <para>The &quot;hold&quot; file exists and &amdump; is waiting for it to be removed
 107 before starting backups.</para>
 108   </listitem>
 109   </varlistentry>
 110   <varlistentry>
 111   <term>amdump: amdump or amflush is already running, or you must run amcleanup</term>
 112   <listitem>
 113 <para>Amdump detected another &amdump; or &amflush; running,
 114 or the remains of a previous incomplete &amdump; or &amflush; run.
 115 This run is terminated.
 116 If the problem is caused by the remains of a previous run,
 117 you must execute
 118 <citerefentry><refentrytitle>amcleanup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 119 and then rerun
 120 <command>amdump</command>.</para>
 121   </listitem>
 122   </varlistentry>
 123 </variablelist>
 124 </refsect1>
 125
 126 <refsect1><title>AUTHOR</title>
 127 <para>James da Silva, &email.jds; : Original text</para>
 128 <para>&maintainer.sgw;: XML-conversion</para>
 129 </refsect1>
 130
 131 <refsect1><title>SEE ALSO</title>
 132 <para>
 133   <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 134   <citerefentry><refentrytitle>amcheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 135   <citerefentry><refentrytitle>amcleanup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 136   <citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 137   <citerefentry><refentrytitle>amflush</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 138   <citerefentry><refentrytitle>cron</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 139   <ulink url="http://wiki.zmanda.com"/>
 140 </para>
 141 </refsect1>
 142 </refentry>
 143