Imported Upstream version 2.5.1
[debian/amanda] / man / amdump.8
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "AMDUMP" 8 "" "" ""
21 .SH "NAME"
22 amdump - back up all disks in an Amanda configuration
23 .SH "SYNOPSIS"
24 .HP 7
25 \fBamdump\fR \fIconfig\fR [\fIhost\fR [\fIdisk\fR]*]*
26      [-o \fIconfigoption\fR]*
27
28 .SH "DESCRIPTION"
29 .PP
30 \fBAmdump\fR
31 switches to the appropriate
32 \fBAmanda\fR
33 configuration directory, e.g. /usr/local/etc/amanda/\fBconfig\fR, then attempts to back up every disk specified by the
34 \fBamanda.conf\fR
35 file.
36 \fBAmdump\fR
37 is normally run by
38 \fBcron\fR.
39 .PP
40 You can specify many host/disk expressions, only disks that match an expression will be dumped. All disks are dumped if no expressions are given.
41 .PP
42 If the file /usr/local/etc/amanda/\fBconfig\fR/hold exists,
43 \fBamdump\fR
44 will wait until it is removed before starting the backups. This allows scheduled backups to be delayed when circumstances warrant, for example, if the tape device is being used for some other purpose. While waiting,
45 \fBamdump\fR
46 checks for the hold file every minute.
47 .PP
48 See the
49 \fBamanda\fR(8)
50 man page for more details about
51 \fBAmanda\fR.
52 .SH "OPTIONS"
53 .TP
54 \fIhost\fR [\fIdisk\fR]*
55 Specify the host and disk on which the command will work.
56 .TP
57 \fB-o\fR \fIconfigoption\fR
58 See the "\fBCONFIGURATION OVERWRITE\fR" section in
59 \fBamanda\fR(8).
60 .SH "EXAMPLE"
61 .PP
62 Here is a typical crontab entry. It runs
63 \fBamdump\fR
64 every weeknight at 1 a.m. as user
65 \fBbin\fR:
66 .nf
67
68 0 1 * * 1-5 bin /usr/local/sbin/amdump daily
69 .fi
70 .PP
71 Please see the
72 \fBcrontab\fR(5)
73 or
74 \fBcrontab\fR(1)
75 manual page for the correct crontab format for your system.
76 .SH "MESSAGES"
77 .TP
78 amdump: waiting for hold file to be removed
79 The "hold" file exists and
80 \fBamdump\fR
81 is waiting for it to be removed before starting backups.
82 .TP
83 amdump: amdump or amflush is already running, or you must run amcleanup
84 Amdump detected another
85 \fBamdump\fR
86 or
87 \fBamflush\fR
88 running, or the remains of a previous incomplete
89 \fBamdump\fR
90 or
91 \fBamflush\fR
92 run. This run is terminated. If the problem is caused by the remains of a previous run, you must execute
93 \fBamcleanup\fR(8)
94 and then rerun
95 \fBamdump\fR.
96 .SH "AUTHOR"
97 .PP
98 James da Silva,
99 <jds@amanda.org>
100 : Original text
101 .PP
102 Stefan G. Weichinger,
103 <sgw@amanda.org>, maintainer of the
104 \fBAmanda\fR-documentation: XML-conversion
105 .SH "SEE ALSO"
106 .PP
107 \fBamanda\fR(8),
108 \fBamcheck\fR(8),
109 \fBamcleanup\fR(8),
110 \fBamrestore\fR(8),
111 \fBamflush\fR(8),
112 \fBcron\fR(8)
113