Imported Upstream version 3.2.0
[debian/amanda] / man / amstatus.8
index 87ea0fefea811ea8b0634e64b4c514bdff1cfc51..1d37ed2da8f4ba2b000263fb118cca7ff7288e18 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 "AMSTATUS" 8 "" "" ""
-.SH NAME
-amstatus \- display the state of an AMANDA run
-.SH "SYNOPSIS"
+'\" t
+.\"     Title: amstatus
+.\"    Author: Stefan G. Weichinger <sgw@amanda.org>
+.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
+.\"      Date: 10/18/2010
+.\"    Manual: System Administration Commands
+.\"    Source: Amanda 3.2.0
+.\"  Language: English
+.\"
+.TH "AMSTATUS" "8" "10/18/2010" "Amanda 3\&.2\&.0" "System Administration Commands"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
 .ad l
-.hy 0
-.HP 9
-\fBamstatus\fR [\-\-config] \fIconfig\fR [\-\-file\ \fIamdumpfile\fR] [\-\-summary] [\-\-dumping] [\-\-waitdumping] [\-\-waittaper] [\-\-dumpingtape] [\-\-writingtape] [\-\-finished] [\-\-failed] [\-\-estimate] [\-\-gestimate] [\-\-stats]
-.ad
-.hy
-
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+amstatus \- display the state of an Amanda run
+.SH "SYNOPSIS"
+.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]
 .SH "DESCRIPTION"
-
 .PP
-\fBAmstatus\fR gives the current state of the \fBAMANDA\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\&.
-
+\fBAmstatus\fR
+gives the current state of the Amanda run specified by the
+\fIconfig\fR
+configuration\&. If there is no active Amanda 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\&.
-
+See the
+\fBamanda\fR(8)
+man page for more details about Amanda\&.
 .SH "OPTIONS"
-
 .PP
 All options may be abbreviated to the shortest non\-ambiguous sub\-string\&. If no options are given, everything is displayed\&.
-
-.TP
+.PP
 \fB[\-\-config] config\fR
-Specify the \fBAMANDA\fR configuration you want to display the state for\&.
-
-.TP
+.RS 4
+Specify the Amanda configuration you want to display the state for\&.
+.RE
+.PP
 \fB\-\-file amdumpfile\fR
-Specify an alternate file instead of the \fBamdump\fR or \fBamflush\fR file\&.
-
-.TP
+.RS 4
+Specify an alternate file instead of the
+\fIamdump\fR
+or
+\fIamflush\fR
+file\&.
+.RE
+.PP
 \fB\-\-summary\fR
+.RS 4
 Display a summary of the state of the run\&.
-
-.TP
+.RE
+.PP
 \fB\-\-dumping\fR
+.RS 4
 Display all partitions that are dumping\&.
-
-.TP
+.RE
+.PP
 \fB\-\-waitdumping|wdumping\fR
+.RS 4
 Display all partitions that are waiting to be dumped\&.
-
-.TP
+.RE
+.PP
 \fB\-\-waittaper|wtaper\fR
+.RS 4
 Display all partitions dumped that are waiting to be written to tape\&.
-
-.TP
+.RE
+.PP
 \fB\-\-dumpingtape|dtape\fR
+.RS 4
 Display all partitions that are dumping directly to tape\&.
-
-.TP
+.RE
+.PP
 \fB\-\-writingtape|wtape\fR
+.RS 4
 Display all partitions that are writing to tape\&.
-
-.TP
+.RE
+.PP
 \fB\-\-finished\fR
+.RS 4
 Display all partitions that are dumped and written to tape\&.
-
-.TP
+.RE
+.PP
 \fB\-\-failed|error\fR
+.RS 4
 Display all partitions that failed\&.
-
-.TP
+.RE
+.PP
 \fB\-\-estimate\fR
+.RS 4
 Display all partitions whose estimate is finished\&. Works only during the estimate phase\&.
-
-.TP
+.RE
+.PP
 \fB\-\-gestimate|gettingestimate\fR
+.RS 4
 Display all partitions whose estimate is not finished\&. Works only during the estimate phase\&.
-
-.TP
+.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)
-
+\fBamanda\fR(8),
+\fBamcheck\fR(8),
+\fBamdump\fR(8),
+\fBamrestore\fR(8),
+\fBamadmin\fR(8)
+.PP
+The Amanda Wiki:
+: http://wiki.zmanda.com/
+.SH "AUTHOR"
+.PP
+\fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>