Imported Upstream version 2.6.0p2
[debian/amanda] / man / amdump.8
index e824edd4c9db2ac5d7fb063a8880c7337ca5654d..90b963c88b3c7e8d58952a6b25bb6d30af5be915 100644 (file)
-.\"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 "" "" ""
-.SH NAME
-amdump \- back up all disks in an AMANDA configuration
-.SH "SYNOPSIS"
+.\"     Title: amdump
+.\"    Author: 
+.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
+.\"      Date: 08/22/2008
+.\"    Manual: 
+.\"    Source: 
+.\"
+.TH "AMDUMP" "8" "08/22/2008" "" ""
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
 .ad l
-.hy 0
+.SH "NAME"
+amdump - back up all disks in an Amanda configuration
+.SH "SYNOPSIS"
 .HP 7
-\fBamdump\fR \fIconfig\fR [\fIhost\fR\ [\fIdisk\fR...]...]
-.ad
-.hy
-
+\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\&. \fBAmdump\fR is normally run by \fBcron\fR\&.
-
+\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\.
+\fBAmdump\fR
+is normally run by
+\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, \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, \fBamdump\fR checks for the hold file every minute\&.
-
+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,
+\fBamdump\fR
+checks for the hold file every minute\.
 .PP
-See the \fBamanda\fR(8) man page for more details about \fBAMANDA\fR\&.
-
+See the
+\fBamanda\fR(8)
+man page for more details about
+\fIAmanda\fR\.
+.SH "OPTIONS"
+.PP
+\fIhost\fR [\fIdisk\fR]*
+.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 \fBamdump\fR every weeknight at 1 a\&.m\&. as user \fBbin\fR:
+Here is a typical crontab entry\. It runs
+\fBamdump\fR
+every weeknight at 1 a\.m\. as user
+\fBbin\fR:
 .nf
-
 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\&.
-
+Please see the
+\fBcrontab\fR(5)
+or
+\fBcrontab\fR(1)
+manual page for the correct crontab format for your system\.
 .SH "MESSAGES"
-
-.TP
+.PP
 amdump: waiting for hold file to be removed
-The ``\fBhold\fR'' file exists and \fBamdump\fR is waiting for it to be removed before starting backups\&.
-
-.TP
+.RS 4
+The "hold" file exists and
+\fBamdump\fR
+is waiting for it to be removed before starting backups\.
+.RE
+.PP
 amdump: amdump or amflush is already running, or you must run amcleanup
-Amdump detected another \fBamdump\fR or \fBamflush\fR 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 \fBamcleanup\fR(8) and then rerun \fBamdump\fR\&.
-
+.RS 4
+Amdump detected another
+\fBamdump\fR
+or
+\fBamflush\fR
+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
+\fBamcleanup\fR(8)
+and then rerun
+\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 "AUTHOR"
-
 .PP
-James da Silva, <jds@amanda\&.org> : Original text
-
+James da Silva,
+<jds@amanda\.org>
+: Original text
 .PP
-Stefan G\&. Weichinger, <sgw@amanda\&.org>, maintainer of the \fBAMANDA\fR\-documentation: XML\-conversion
-
+Stefan G\. Weichinger,
+<sgw@amanda\.org>, maintainer of the
+\fIAmanda\fR\-documentation: XML\-conversion
 .SH "SEE ALSO"
-
 .PP
-\fBamanda\fR(8), \fBamcheck\fR(8), \fBamcleanup\fR(8), \fBamrestore\fR(8), \fBamflush\fR(8), \fBcron\fR(8)
 
+\fBamanda\fR(8),
+\fBamcheck\fR(8),
+\fBamcleanup\fR(8),
+\fBamrestore\fR(8),
+\fBamflush\fR(8),
+\fBcron\fR(8),
+: http://wiki.zmanda.com