X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Famstatus.8;h=092c9a0eefae490cb75090370b0e2a44c1a43abd;hb=bdf58e69fdbfb0ed8f24f728361a0aa99366c1f2;hp=9a96e9bf7998ba8e722d085bf53cecc841bc3d02;hpb=cb8e943df4defb25d0362567131dc31fc0ab238e;p=debian%2Famanda diff --git a/man/amstatus.8 b/man/amstatus.8 index 9a96e9b..092c9a0 100644 --- a/man/amstatus.8 +++ b/man/amstatus.8 @@ -1,96 +1,290 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection +.\" Title: amstatus +.\" Author: Stefan G. Weichinger +.\" Generator: DocBook XSL Stylesheets v1.74.0 +.\" Date: 01/22/2009 +.\" Manual: System Administration Commands +.\" Source: Amanda 2.6.1 +.\" Language: English +.\" +.TH "AMSTATUS" "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 Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp +.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 Ip \" List item +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" BM/EM - put colored marker in margin next to block of text +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de BM +.if t \{\ .br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 +.ll -2n +.gcolor red +.di BX +.\} .. -.TH "AMSTATUS" 8 "" "" "" -.SH "NAME" -amstatus - display the state of an Amanda run -.SH "SYNOPSIS" -.HP 9 -\fBamstatus\fR [--config] \fIconfig\fR [--file \fIamdumpfile\fR] [--summary] [--dumping] [--waitdumping] [--waittaper] [--dumpingtape] [--writingtape] [--finished] [--failed] [--estimate] [--gestimate] [--stats] +.de EM +.if t \{\ +.br +.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 +.\} +.. +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "Name" +amstatus \- display the state of an \fIAmanda\fR run +.SH "Synopsis" +.fam C +.HP \w'\fBamstatus\fR\ 'u +\fBamstatus\fR [\-\-config] \fIconfig\fR [\-\-file\ \fIamdumpfile\fR] [\-\-summary] [\-\-dumping] [\-\-waitdumping] [\-\-waittaper] [\-\-dumpingtape] [\-\-writingtape] [\-\-finished] [\-\-failed] [\-\-estimate] [\-\-gestimate] [\-\-stats] [\-\-locale\-independent\-date\-format] +.fam .SH "DESCRIPTION" .PP \fBAmstatus\fR gives the current state of the -\fBAmanda\fR +\fIAmanda\fR run specified by the -\fBconfig\fR -configuration. If there is no active -\fBAmanda\fR -running, it summarizes the result of the last run. It may also be used to summarize the results of a previous run. +\fIconfig\fR +configuration\&. If there is no active +\fIAmanda\fR +running, it summarizes the result of the last run\&. It may also be used to summarize the results of a previous run\&. .PP See the \fBamanda\fR(8) man page for more details about -\fBAmanda\fR. +\fIAmanda\fR\&. .SH "OPTIONS" .PP -All options may be abbreviated to the shortest non-ambiguous sub-string. If no options are given, everything is displayed. -.TP -\fB[--config] config\fR +All options may be abbreviated to the shortest non\-ambiguous sub\-string\&. If no options are given, everything is displayed\&. +.PP +\fB[\-\-config] config\fR +.RS 4 Specify the -\fBAmanda\fR -configuration you want to display the state for. -.TP -\fB--file amdumpfile\fR +\fIAmanda\fR +configuration you want to display the state for\&. +.RE +.PP +\fB\-\-file amdumpfile\fR +.RS 4 Specify an alternate file instead of the -\fBamdump\fR +\fIamdump\fR or -\fBamflush\fR -file. -.TP -\fB--summary\fR -Display a summary of the state of the run. -.TP -\fB--dumping\fR -Display all partitions that are dumping. -.TP -\fB--waitdumping|wdumping\fR -Display all partitions that are waiting to be dumped. -.TP -\fB--waittaper|wtaper\fR -Display all partitions dumped that are waiting to be written to tape. -.TP -\fB--dumpingtape|dtape\fR -Display all partitions that are dumping directly to tape. -.TP -\fB--writingtape|wtape\fR -Display all partitions that are writing to tape. -.TP -\fB--finished\fR -Display all partitions that are dumped and written to tape. -.TP -\fB--failed|error\fR -Display all partitions that failed. -.TP -\fB--estimate\fR -Display all partitions whose estimate is finished. Works only during the estimate phase. -.TP -\fB--gestimate|gettingestimate\fR -Display all partitions whose estimate is not finished. Works only during the estimate phase. -.TP -\fB--stats|statistics\fR -Display statistics about active-time of taper and dumpers. +\fIamflush\fR +file\&. +.RE +.PP +\fB\-\-summary\fR +.RS 4 +Display a summary of the state of the run\&. +.RE +.PP +\fB\-\-dumping\fR +.RS 4 +Display all partitions that are dumping\&. +.RE +.PP +\fB\-\-waitdumping|wdumping\fR +.RS 4 +Display all partitions that are waiting to be dumped\&. +.RE +.PP +\fB\-\-waittaper|wtaper\fR +.RS 4 +Display all partitions dumped that are waiting to be written to tape\&. +.RE +.PP +\fB\-\-dumpingtape|dtape\fR +.RS 4 +Display all partitions that are dumping directly to tape\&. +.RE +.PP +\fB\-\-writingtape|wtape\fR +.RS 4 +Display all partitions that are writing to tape\&. +.RE +.PP +\fB\-\-finished\fR +.RS 4 +Display all partitions that are dumped and written to tape\&. +.RE +.PP +\fB\-\-failed|error\fR +.RS 4 +Display all partitions that failed\&. +.RE +.PP +\fB\-\-estimate\fR +.RS 4 +Display all partitions whose estimate is finished\&. Works only during the estimate phase\&. +.RE +.PP +\fB\-\-gestimate|gettingestimate\fR +.RS 4 +Display all partitions whose estimate is not finished\&. Works only during the estimate phase\&. +.RE +.PP +\fB\-\-stats|statistics\fR +.RS 4 +Display statistics about active\-time of taper and dumpers\&. +.RE +.PP +\fB\-\-locale\-independent\-date\-format\fR +.RS 4 +Output the date in a locale independent format\&. The format is the same executing: date +\'%Y\-%m\-%d %H:%M:%S %Z\' +.RE +.SH "EXIT CODE" + +The exit code of \fBamstatus\fR is the ORed value of: +.nf + 0 = success + 1 = error + 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), \fBamdump\fR(8), \fBamrestore\fR(8), -\fBamadmin\fR(8) - +\fBamadmin\fR(8), +: http://wiki.zmanda.com +.SH "Author" +.PP +\fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>