Imported Upstream version 2.5.0
[debian/amanda] / 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'><arg choice='plain'><replaceable>host</replaceable></arg><arg choice='opt' rep='repeat'><replaceable>disk</replaceable></arg></arg>
27     
28 </cmdsynopsis>
29 </refsynopsisdiv>
30
31
32 <refsect1><title>DESCRIPTION</title>
33 <para><emphasis remap='B'>Amdump</emphasis>
34 switches to the appropriate &A; configuration directory,
35 e.g. /usr/local/etc/amanda/<emphasis remap='I'>config</emphasis>,
36 then attempts to back up every disk specified by the
37 <emphasis remap='I'>amanda.conf</emphasis>
38 file.
39 <emphasis remap='B'>Amdump</emphasis>
40 is normally run by
41 <emphasis remap='B'>cron</emphasis>.</para>
42
43 <para>You can specify many host/disk expressions, only disks that
44 match an expression will be dumped. All disks are dumped if no
45 expressions are given.</para>
46
47 <para>If the file /usr/local/etc/amanda/<emphasis remap='I'>config</emphasis>/hold exists,
48 <command>amdump</command>
49 will wait until it is removed before starting the backups.
50 This allows scheduled backups to be delayed when circumstances warrant, for example, 
51 if the tape device is being used for some other purpose.
52 While waiting,
53 <command>amdump</command>
54 checks for the hold file every minute.</para>
55
56 <para>See the
57 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
58 man page for more details about &A;.</para>
59 </refsect1>
60
61 <refsect1><title>EXAMPLE</title>
62 <para>Here is a typical crontab entry. It runs
63 <command>amdump</command>
64 every weeknight at 1 a.m. as user
65 <emphasis remap='B'>bin</emphasis>:</para>
66
67 <programlisting>
68 0 1 * * 1-5 bin /usr/local/sbin/amdump daily
69 </programlisting>
70
71 <para>Please see the 
72 <citerefentry><refentrytitle>crontab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
73 or
74 <citerefentry><refentrytitle>crontab</refentrytitle><manvolnum>1</manvolnum></citerefentry>
75 manual page for the correct crontab format for your system.</para>
76 </refsect1>
77
78 <refsect1><title>MESSAGES</title>
79 <variablelist remap='TP'>
80   <varlistentry>
81   <term>amdump: waiting for hold file to be removed</term>
82   <listitem>
83 <para>The &quot;hold&quot; file exists and &amdump; is waiting for it to be removed
84 before starting backups.</para>
85   </listitem>
86   </varlistentry>
87   <varlistentry>
88   <term>amdump: amdump or amflush is already running, or you must run amcleanup</term>
89   <listitem>
90 <para>Amdump detected another &amdump; or &amflush; running,
91 or the remains of a previous incomplete &amdump; or &amflush; run.
92 This run is terminated.
93 If the problem is caused by the remains of a previous run,
94 you must execute
95 <citerefentry><refentrytitle>amcleanup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
96 and then rerun
97 <command>amdump</command>.</para>
98   </listitem>
99   </varlistentry>
100 </variablelist>
101 </refsect1>
102
103 <refsect1><title>AUTHOR</title>
104 <para>James da Silva, &email.jds; : Original text</para>
105 <para>&maintainer.sgw;: XML-conversion</para>
106 </refsect1>
107
108 <refsect1><title>SEE ALSO</title>
109 <para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
110 <citerefentry><refentrytitle>amcheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
111 <citerefentry><refentrytitle>amcleanup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
112 <citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
113 <citerefentry><refentrytitle>amflush</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
114 <citerefentry><refentrytitle>cron</refentrytitle><manvolnum>8</manvolnum></citerefentry></para>
115 </refsect1>
116 </refentry>
117