Imported Upstream version 3.2.0
[debian/amanda] / man / amcleanup.8
1 '\" t
2 .\"     Title: amcleanup
3 .\"    Author: James da Silva <jds@amanda.org>
4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
5 .\"      Date: 10/18/2010
6 .\"    Manual: System Administration Commands
7 .\"    Source: Amanda 3.2.0
8 .\"  Language: English
9 .\"
10 .TH "AMCLEANUP" "8" "10/18/2010" "Amanda 3\&.2\&.0" "System Administration Commands"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
15 .nh
16 .\" disable justification (adjust text to left margin only)
17 .ad l
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
21 .SH "NAME"
22 amcleanup \- run the Amanda cleanup process after a failure
23 .SH "SYNOPSIS"
24 .HP \w'\fBamcleanup\fR\ 'u
25 \fBamcleanup\fR [\fB\-k\fR] [\fB\-p\fR] [\fB\-v\fR] \fIconfig\fR
26 .SH "DESCRIPTION"
27 .PP
28 \fBAmcleanup\fR
29 generates the
30 \fIAmanda Mail Report\fR
31 and updates the Amanda databases after a system failure on a tape server host\&. This cleanup process is normally done automatically as part of the
32 \fBamdump\fR
33 program, but if
34 \fBamdump\fR
35 cannot complete for some reason (usually because of a tape server host crash),
36 \fBamcleanup\fR
37 must be run some time later (usually during system boot)\&.
38 .PP
39 See the
40 \fBamanda\fR(8)
41 man page for more details about Amanda\&.
42 .SH "OPTIONS"
43 .PP
44 \fB\-k\fR
45 .RS 4
46 Kill all process listed in the log file are their child\&. if there is no log file, then kill all amdump and amflush process and their child\&.
47 .RE
48 .PP
49 \fB\-p\fR
50 .RS 4
51 Do the cleanup only if all process listed in the log file are already terminated\&.
52 .RE
53 .PP
54 \fB\-v\fR
55 .RS 4
56 Generate verbose output\&.
57 .RE
58 .SH "EXAMPLES"
59 .PP
60 This example runs the Amanda cleanup process by hand after a failure\&.
61 .nf
62 % amcleanup daily
63 .fi
64 .PP
65 Putting the following line in a system boot script (e\&.g\&.
66 /etc/rc\&.local) runs the Amanda cleanup process as part of the reboot, eliminating the need to run it by hand\&.
67 .nf
68 /usr/local/sbin/amcleanup daily
69 .fi
70 .PP
71 If nothing needs to be done,
72 \fBamcleanup\fR
73 exits normally with the message:
74 .nf
75 amcleanup: no unprocessed logfile to clean up\&.
76 .fi
77 .SH "SEE ALSO"
78 .PP
79 \fBamanda\fR(8),
80 \fBamdump\fR(8)
81 .PP
82 The Amanda Wiki:
83 : http://wiki.zmanda.com/
84 .SH "AUTHORS"
85 .PP
86 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
87 .PP
88 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>