Imported Upstream version 2.6.0p2
[debian/amanda] / man / amdump.8
1 .\"     Title: amdump
2 .\"    Author: 
3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
4 .\"      Date: 08/22/2008
5 .\"    Manual: 
6 .\"    Source: 
7 .\"
8 .TH "AMDUMP" "8" "08/22/2008" "" ""
9 .\" disable hyphenation
10 .nh
11 .\" disable justification (adjust text to left margin only)
12 .ad l
13 .SH "NAME"
14 amdump - back up all disks in an Amanda configuration
15 .SH "SYNOPSIS"
16 .HP 7
17 \fBamdump\fR \fIconfig\fR [\fIhost\fR\ [\fIdisk\fR...]...] [\-o\ \fIconfigoption\fR]...
18 .SH "DESCRIPTION"
19 .PP
20 \fBAmdump\fR
21 switches to the appropriate
22 \fIAmanda\fR
23 configuration directory, e\.g\. /usr/local/etc/amanda/\fIconfig\fR, then attempts to back up every disk specified by the
24 \fIamanda\.conf\fR
25 file\.
26 \fBAmdump\fR
27 is normally run by
28 \fBcron\fR\.
29 .PP
30 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\.
31 .PP
32 If the file /usr/local/etc/amanda/\fIconfig\fR/hold exists,
33 \fBamdump\fR
34 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,
35 \fBamdump\fR
36 checks for the hold file every minute\.
37 .PP
38 See the
39 \fBamanda\fR(8)
40 man page for more details about
41 \fIAmanda\fR\.
42 .SH "OPTIONS"
43 .PP
44 \fIhost\fR [\fIdisk\fR]*
45 .RS 4
46 Specify the host and disk on which the command will work\.
47 .RE
48 .PP
49 \fB\-o\fR \fIconfigoption\fR
50 .RS 4
51 See the "\fBCONFIGURATION OVERRIDE\fR" section in
52 \fBamanda\fR(8)\.
53 .RE
54 .SH "EXAMPLE"
55 .PP
56 Here is a typical crontab entry\. It runs
57 \fBamdump\fR
58 every weeknight at 1 a\.m\. as user
59 \fBbin\fR:
60 .nf
61 0 1 * * 1\-5 bin /usr/local/sbin/amdump daily
62 .fi
63 .PP
64 Please see the
65 \fBcrontab\fR(5)
66 or
67 \fBcrontab\fR(1)
68 manual page for the correct crontab format for your system\.
69 .SH "MESSAGES"
70 .PP
71 amdump: waiting for hold file to be removed
72 .RS 4
73 The "hold" file exists and
74 \fBamdump\fR
75 is waiting for it to be removed before starting backups\.
76 .RE
77 .PP
78 amdump: amdump or amflush is already running, or you must run amcleanup
79 .RS 4
80 Amdump detected another
81 \fBamdump\fR
82 or
83 \fBamflush\fR
84 running, or the remains of a previous incomplete
85 \fBamdump\fR
86 or
87 \fBamflush\fR
88 run\. This run is terminated\. If the problem is caused by the remains of a previous run, you must execute
89 \fBamcleanup\fR(8)
90 and then rerun
91 \fBamdump\fR\.
92 .RE
93 .SH "EXIT CODE"
94
95 The exit code of \fBamdump\fR is the ORed value of:
96 .nf
97  0  = success
98  1  = error
99  2  = a dle give strange message
100  4  = a dle failed
101  8  = Don\'t know the status of a dle (RESULT_MISSING in the report)
102  16 = tape error or no more tape
103 .fi
104 .SH "AUTHOR"
105 .PP
106 James da Silva,
107 <jds@amanda\.org>
108 : Original text
109 .PP
110 Stefan G\. Weichinger,
111 <sgw@amanda\.org>, maintainer of the
112 \fIAmanda\fR\-documentation: XML\-conversion
113 .SH "SEE ALSO"
114 .PP
115
116 \fBamanda\fR(8),
117 \fBamcheck\fR(8),
118 \fBamcleanup\fR(8),
119 \fBamrestore\fR(8),
120 \fBamflush\fR(8),
121 \fBcron\fR(8),
122 : http://wiki.zmanda.com