Imported Upstream version 3.3.2
[debian/amanda] / man / amcleanup.8
1 '\" t
2 .\"     Title: amcleanup
3 .\"    Author: James da Silva <jds@amanda.org>
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
5 .\"      Date: 07/25/2012
6 .\"    Manual: System Administration Commands
7 .\"    Source: Amanda 3.3.2
8 .\"  Language: English
9 .\"
10 .TH "AMCLEANUP" "8" "07/25/2012" "Amanda 3\&.3\&.2" "System Administration Commands"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 amcleanup \- run the Amanda cleanup process after a failure
32 .SH "SYNOPSIS"
33 .HP \w'\fBamcleanup\fR\ 'u
34 \fBamcleanup\fR [\fB\-k\fR] [\fB\-p\fR] [\fB\-r\fR] [\fB\-v\fR] \fIconfig\fR
35 .SH "DESCRIPTION"
36 .PP
37 \fBAmcleanup\fR
38 generates the
39 \fIAmanda Mail Report\fR
40 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
41 \fBamdump\fR
42 program, but if
43 \fBamdump\fR
44 cannot complete for some reason (usually because of a tape server host crash),
45 \fBamcleanup\fR
46 must be run some time later (usually during system boot)\&.
47 .PP
48 The
49 \fBamcleanupdisk\fR
50 program is run with the same
51 [\fB\-r\fR]
52 and
53 [\fB\-v\fR]
54 options\&.
55 .PP
56 See the
57 \fBamanda\fR(8)
58 man page for more details about Amanda\&.
59 .SH "OPTIONS"
60 .PP
61 \fB\-k\fR
62 .RS 4
63 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\&.
64 .RE
65 .PP
66 \fB\-p\fR
67 .RS 4
68 Do the cleanup only if all process listed in the log file are already terminated\&.
69 .RE
70 .PP
71 \fB\-r\fR
72 .RS 4
73 Remove bad file in holding disk\&. This options is passed to amcleanupdisk\&.
74 .RE
75 .PP
76 \fB\-v\fR
77 .RS 4
78 Generate verbose output\&. This options is passed to amcleanupdisk\&.
79 .RE
80 .SH "EXAMPLES"
81 .PP
82 This example runs the Amanda cleanup process by hand after a failure\&.
83 .nf
84 % amcleanup daily
85 .fi
86 .PP
87 Putting the following line in a system boot script (e\&.g\&.
88 /etc/rc\&.local) runs the Amanda cleanup process as part of the reboot, eliminating the need to run it by hand\&.
89 .nf
90 /usr/local/sbin/amcleanup daily
91 .fi
92 .PP
93 If nothing needs to be done,
94 \fBamcleanup\fR
95 exits normally with the message:
96 .nf
97 amcleanup: no unprocessed logfile to clean up\&.
98 .fi
99 .SH "SEE ALSO"
100 .PP
101 \fBamanda\fR(8),
102 \fBamdump\fR(8)
103 .PP
104 The Amanda Wiki:
105 : http://wiki.zmanda.com/
106 .SH "AUTHORS"
107 .PP
108 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
109 .PP
110 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>