Imported Upstream version 2.4.4p3
[debian/amanda] / man / amdump.8.in
1 .\"
2 .de EX
3 .if t .ft C
4 .nf
5 ..
6 .de EE
7 .fi
8 .if t .ft
9 ..
10 .TH AMDUMP 8
11 .SH NAME
12 amdump \- back up all disks in an Amanda configuration
13 .SH SYNOPSIS
14 .B amdump
15 .I config
16 [
17 .I host
18 [
19 .I disk
20 ]*
21 ]*
22 .SH DESCRIPTION
23 .B Amdump
24 switches to the appropriate Amanda configuration directory,
25 e.g. @CONFIG_DIR@/\fIconfig\fR,
26 then attempts to back up every disk specified by the
27 .I amanda.conf
28 file.
29 .B Amdump
30 is normally run by
31 .BR cron .
32 .LP
33 You can specify many host/disk expression, only disks that
34 match an expression will be dumped. All disk are dumped if no
35 expression are given.
36 .LP
37 If file @CONFIG_DIR@/\fIconfig\fR/hold exists,
38 .B amdump
39 will wait until it is removed before starting the backups.
40 This allows scheduled backups to be delayed when
41 circumstances warrant, for example, if the tape device is being
42 used for some other purpose.
43 While waiting,
44 .B amdump
45 checks for the hold file every minute.
46 .LP
47 See the
48 .IR amanda (8)
49 man page for more details about Amanda.
50 .SH EXAMPLE
51 Here is a typical crontab entry.
52 It runs
53 .B amdump
54 every weeknight at 1 a.m. as user
55 .BR bin :
56 .LP
57 .RS
58 .EX
59 .ie '@sbindir@'${exec_prefix}/sbin' \{\
60 .ie '@exec_prefix@'${prefix}' .ds pr @prefix@/sbin
61 .el .ds pr @exec_prefix@/sbin\}
62 .el .ds pr @sbindir@
63 0 1 * * 1-5 bin \*(pr/amdump @DEFAULT_CONFIG@
64 .EE
65 .RE
66 .LP
67 Please see the 
68 .IR crontab (5)
69 or
70 .IR crontab (1)
71 manual page for the correct crontab format for your system.
72 .SH MESSAGES
73 .TP
74 amdump: waiting for hold file to be removed
75 The "hold" file exists and amdump is waiting for it to be removed
76 before starting backups.
77 .TP
78 amdump: amdump or amflush is already running, or you must run amcleanup
79 Amdump detected another amdump or amflush running,
80 or the remains of a previous incomplete amdump or amflush run.
81 This run is terminated.
82 If the problem is caused by the remains of a previous run,
83 you must execute
84 .IR amcleanup (8)
85 and then rerun
86 .IR amdump .
87 .SH AUTHOR
88 James da Silva <jds@cs.umd.edu>
89 .br
90 University of Maryland, College Park
91 .SH "SEE ALSO"
92 amanda(8),
93 amcheck(8),
94 amcleanup(8),
95 amrestore(8),
96 amflush(8),
97 cron(8)