Imported Upstream version 2.6.1
[debian/amanda] / man / amdump.8
index f571ab6700bf2fb05e46a6de7fcd8b13c47560c6..0889853d1e601c908f9ff39f22c244ddf74b01cf 100644 (file)
-.\"Generated by db2man.xsl. Don't modify this, modify the source.
-.de Sh \" Subsection
+.\"     Title: amdump
+.\"    Author: James da Silva <jds@amanda.org>
+.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
+.\"      Date: 01/22/2009
+.\"    Manual: System Administration Commands
+.\"    Source: Amanda 2.6.1
+.\"  Language: English
+.\"
+.TH "AMDUMP" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
+.\" -----------------------------------------------------------------
+.\" * (re)Define some macros
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" toupper - uppercase a string (locale-aware)
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de toupper
+.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
+\\$*
+.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SH-xref - format a cross-reference to an SH section
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de SH-xref
+.ie n \{\
+.\}
+.toupper \\$*
+.el \{\
+\\$*
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SH - level-one heading that works better for non-TTY output
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de1 SH
+.\" put an extra blank line of space above the head in non-TTY output
+.if t \{\
+.sp 1
+.\}
+.sp \\n[PD]u
+.nr an-level 1
+.set-an-margin
+.nr an-prevailing-indent \\n[IN]
+.fi
+.in \\n[an-margin]u
+.ti 0
+.HTML-TAG ".NH \\n[an-level]"
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+\." make the size of the head bigger
+.ps +3
+.ft B
+.ne (2v + 1u)
+.ie n \{\
+.\" if n (TTY output), use uppercase
+.toupper \\$*
+.\}
+.el \{\
+.nr an-break-flag 0
+.\" if not n (not TTY), use normal case (not uppercase)
+\\$1
+.in \\n[an-margin]u
+.ti 0
+.\" if not n (not TTY), put a border/line under subheading
+.sp -.6
+\l'\n(.lu'
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SS - level-two heading that works better for non-TTY output
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de1 SS
+.sp \\n[PD]u
+.nr an-level 1
+.set-an-margin
+.nr an-prevailing-indent \\n[IN]
+.fi
+.in \\n[IN]u
+.ti \\n[SN]u
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.ps \\n[PS-SS]u
+\." make the size of the head bigger
+.ps +2
+.ft B
+.ne (2v + 1u)
+.if \\n[.$] \&\\$*
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BB/BE - put background/screen (filled box) around block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BB
+.if t \{\
+.sp -.5
 .br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
+.in +2n
+.ll -2n
+.gcolor red
+.di BX
+.\}
+..
+.de EB
+.if t \{\
+.if "\\$2"adjust-for-leading-newline" \{\
+.sp -1
+.\}
+.br
+.di
+.in
+.ll
+.gcolor
+.nr BW \\n(.lu-\\n(.i
+.nr BH \\n(dn+.5v
+.ne \\n(BHu+.5v
+.ie "\\$2"adjust-for-leading-newline" \{\
+\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
+.\}
+.el \{\
+\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
+.\}
+.in 0
+.sp -.5v
+.nf
+.BX
+.in
+.sp .5v
+.fi
+.\}
 ..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BM/EM - put colored marker in margin next to block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BM
+.if t \{\
+.br
+.ll -2n
+.gcolor red
+.di BX
+.\}
 ..
-.de Ip \" List item
+.de EM
+.if t \{\
 .br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
+.di
+.ll
+.gcolor
+.nr BH \\n(dn
+.ne \\n(BHu
+\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
+.in 0
+.nf
+.BX
+.in
+.fi
+.\}
 ..
-.TH "AMDUMP" 8 "" "" ""
-.SH NAME
-amdump \- back up all disks in an AMANDA configuration
-.SH "SYNOPSIS"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
 .ad l
-.hy 0
-.HP 7
-\fBamdump\fR \fIconfig\fR [\fIhost\fR\ [\fIdisk\fR...]...]
-.ad
-.hy
-
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "Name"
+amdump \- back up all disks in an \fIAmanda\fR configuration
+.SH "Synopsis"
+.fam C
+.HP \w'\fBamdump\fR\ 'u
+\fBamdump\fR \fIconfig\fR [\fIhost\fR\ [\fIdisk\fR...]...] [\-o\ \fIconfigoption\fR]...
+.fam
 .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\&.
-
 .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 "hold" 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\&.
-
-.SH "AUTHOR"
+.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 "SEE ALSO"
 .PP
-James da Silva, <jds@amanda\&.org> : Original text
 
+\fBamanda\fR(8),
+\fBamcheck\fR(8),
+\fBamcleanup\fR(8),
+\fBamrestore\fR(8),
+\fBamflush\fR(8),
+\fBcron\fR(8),
+: http://wiki.zmanda.com
+.SH "Authors"
 .PP
-Stefan G\&. Weichinger, <sgw@amanda\&.org>, maintainer of the \fBAMANDA\fR\-documentation: XML\-conversion
-
-.SH "SEE ALSO"
-
+\fBJames da Silva\fR <\&jds@amanda\&.org\&>
 .PP
-\fBamanda\fR(8), \fBamcheck\fR(8), \fBamcleanup\fR(8), \fBamrestore\fR(8), \fBamflush\fR(8), \fBcron\fR(8)
-
+\fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>