Imported Upstream version 2.6.1p1
[debian/amanda] / man / amdump.8
index 3b3b5d9e70287727763bb9748cdc862204b2de66..e53875ba2fea4b5b02f6739cfdd46fb2f237d8d7 100644 (file)
@@ -1,81 +1,86 @@
+'\" t
 .\"     Title: amdump
-.\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
-.\"      Date: 02/07/2007
-.\"    Manual: 
-.\"    Source: 
+.\"    Author: James da Silva <jds@amanda.org>
+.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
+.\"      Date: 04/10/2009
+.\"    Manual: System Administration Commands
+.\"    Source: Amanda 2.6.1p1
+.\"  Language: English
 .\"
-.TH "AMDUMP" "8" "02/07/2007" "" ""
+.TH "AMDUMP" "8" "04/10/2009" "Amanda 2\&.6\&.1p1" "System Administration Commands"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
 .ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
 .SH "NAME"
-amdump \- back up all disks in an Amanda configuration
+amdump \- back up all disks in an \fIAmanda\fR configuration
 .SH "SYNOPSIS"
-.HP 7
+.HP \w'\fBamdump\fR\ 'u
 \fBamdump\fR \fIconfig\fR [\fIhost\fR\ [\fIdisk\fR...]...] [\-o\ \fIconfigoption\fR]...
 .SH "DESCRIPTION"
 .PP
 \fBAmdump\fR
 switches to the appropriate
 \fIAmanda\fR
-configuration directory, e.g. /usr/local/etc/amanda/\fIconfig\fR, then attempts to back up every disk specified by the
-\fIamanda.conf\fR
-file.
+configuration directory, e\&.g\&. /usr/local/etc/amanda/\fIconfig\fR, then attempts to back up every disk specified by the
+\fIamanda\&.conf\fR
+file\&.
 \fBAmdump\fR
 is normally run by
-\fBcron\fR.
+\fBcron\fR\&.
 .PP
-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.
+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\&.
 .PP
 If the file /usr/local/etc/amanda/\fIconfig\fR/hold exists,
 \fBamdump\fR
-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,
+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,
 \fBamdump\fR
-checks for the hold file every minute.
+checks for the hold file every minute\&.
 .PP
 See the
 \fBamanda\fR(8)
 man page for more details about
-\fIAmanda\fR.
+\fIAmanda\fR\&.
 .SH "OPTIONS"
 .PP
 \fIhost\fR [\fIdisk\fR]*
 .RS 4
-Specify the host and disk on which the command will work.
+Specify the host and disk on which the command will work\&.
 .RE
 .PP
 \fB\-o\fR \fIconfigoption\fR
 .RS 4
-See the "\fBCONFIGURATION OVERWRITE\fR" section in
-\fBamanda\fR(8).
+See the "\fBCONFIGURATION OVERRIDE\fR" section in
+\fBamanda\fR(8)\&.
 .RE
 .SH "EXAMPLE"
 .PP
-Here is a typical crontab entry. It runs
+Here is a typical crontab entry\&. It runs
 \fBamdump\fR
-every weeknight at 1 a.m. as user
+every weeknight at 1 a\&.m\&. as user
 \fBbin\fR:
-.sp
-.RS 4
 .nf
 0 1 * * 1\-5 bin /usr/local/sbin/amdump daily
 .fi
-.RE
 .PP
 Please see the
 \fBcrontab\fR(5)
 or
 \fBcrontab\fR(1)
-manual page for the correct crontab format for your system.
+manual page for the correct crontab format for your system\&.
 .SH "MESSAGES"
 .PP
 amdump: waiting for hold file to be removed
 .RS 4
 The "hold" file exists and
 \fBamdump\fR
-is waiting for it to be removed before starting backups.
+is waiting for it to be removed before starting backups\&.
 .RE
 .PP
 amdump: amdump or amflush is already running, or you must run amcleanup
@@ -88,25 +93,34 @@ running, or the remains of a previous incomplete
 \fBamdump\fR
 or
 \fBamflush\fR
-run. This run is terminated. If the problem is caused by the remains of a previous run, you must execute
+run\&. This run is terminated\&. If the problem is caused by the remains of a previous run, you must execute
 \fBamcleanup\fR(8)
 and then rerun
-\fBamdump\fR.
+\fBamdump\fR\&.
 .RE
-.SH "AUTHOR"
-.PP
-James da Silva,
-<jds@amanda.org>
-: Original text
-.PP
-Stefan G. Weichinger,
-<sgw@amanda.org>, maintainer of the
-\fIAmanda\fR\-documentation: XML\-conversion
+.SH "EXIT CODE"
+
+The exit code of \fBamdump\fR is the ORed value of:
+.nf
+ 0  = success
+ 1  = error
+ 2  = a dle give strange message
+ 4  = a dle failed
+ 8  = Don\'t know the status of a dle (RESULT_MISSING in the report)
+ 16 = tape error or no more tape
+.fi
 .SH "SEE ALSO"
 .PP
+
 \fBamanda\fR(8),
 \fBamcheck\fR(8),
 \fBamcleanup\fR(8),
 \fBamrestore\fR(8),
 \fBamflush\fR(8),
-\fBcron\fR(8)
+\fBcron\fR(8),
+: http://wiki.zmanda.com
+.SH "AUTHORS"
+.PP
+\fBJames da Silva\fR <\&jds@amanda\&.org\&>
+.PP
+\fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>