Imported Upstream version 2.6.1p2
[debian/amanda] / man / amdump.8
index 39ea5c164c6003eae29bf482585dd5f18256bb56..b151545cc1a14fecde9654e2e89c38718dd71972 100644 (file)
@@ -1,86 +1,90 @@
-.\"Generated by db2man.xsl. Don't modify this, modify the source.
-.de Sh \" Subsection
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
-.TH "AMDUMP" 8 "" "" ""
+'\" t
+.\"     Title: amdump
+.\"    Author: James da Silva <jds@amanda.org>
+.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
+.\"      Date: 11/05/2009
+.\"    Manual: System Administration Commands
+.\"    Source: Amanda 2.6.1p2
+.\"  Language: English
+.\"
+.TH "AMDUMP" "8" "11/05/2009" "Amanda 2\&.6\&.1p2" "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
-\fBamdump\fR \fIconfig\fR [\fIhost\fR [\fIdisk\fR]*]*
-     [-o \fIconfigoption\fR]*
-
+.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
-\fBAmanda\fR
-configuration directory, e.g. /usr/local/etc/amanda/\fBconfig\fR, then attempts to back up every disk specified by the
-\fBamanda.conf\fR
-file.
+\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\&.
 \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/\fBconfig\fR/hold exists,
+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
-\fBAmanda\fR.
+\fIAmanda\fR\&.
 .SH "OPTIONS"
-.TP
+.PP
 \fIhost\fR [\fIdisk\fR]*
-Specify the host and disk on which the command will work.
-.TP
-\fB-o\fR \fIconfigoption\fR
-See the "\fBCONFIGURATION OVERWRITE\fR" section in
-\fBamanda\fR(8).
+.RS 4
+Specify the host and disk on which the command will work\&.
+.RE
+.PP
+\fB\-o\fR \fIconfigoption\fR
+.RS 4
+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:
 .nf
-
-0 1 * * 1-5 bin /usr/local/sbin/amdump daily
+0 1 * * 1\-5 bin /usr/local/sbin/amdump daily
 .fi
 .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"
-.TP
+.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.
-.TP
+is waiting for it to be removed before starting backups\&.
+.RE
+.PP
 amdump: amdump or amflush is already running, or you must run amcleanup
+.RS 4
 Amdump detected another
 \fBamdump\fR
 or
@@ -89,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.
-.SH "AUTHOR"
-.PP
-James da Silva,
-<jds@amanda.org>
-: Original text
-.PP
-Stefan G. Weichinger,
-<sgw@amanda.org>, maintainer of the
-\fBAmanda\fR-documentation: XML-conversion
+\fBamdump\fR\&.
+.RE
+.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\&>