Imported Upstream version 3.2.0
[debian/amanda] / man / amstatus.8
index 6a146ec31595bfe9271c91028c7a769bd8f99582..1d37ed2da8f4ba2b000263fb118cca7ff7288e18 100644 (file)
@@ -1,44 +1,45 @@
+'\" t
 .\"     Title: amstatus
-.\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
-.\"      Date: 05/14/2008
-.\"    Manual: 
-.\"    Source: 
+.\"    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" "05/14/2008" "" ""
+.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
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
 .SH "NAME"
-amstatus - display the state of an Amanda run
+amstatus \- display the state of an Amanda run
 .SH "SYNOPSIS"
-.HP 9
+.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
-\fIAmanda\fR
-run specified by the
+gives the current state of the Amanda run specified by the
 \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\.
+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
-\fIAmanda\fR\.
+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\.
+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
-\fIAmanda\fR
-configuration you want to display the state for\.
+Specify the Amanda configuration you want to display the state for\&.
 .RE
 .PP
 \fB\-\-file amdumpfile\fR
@@ -47,73 +48,88 @@ Specify an alternate file instead of the
 \fIamdump\fR
 or
 \fIamflush\fR
-file\.
+file\&.
 .RE
 .PP
 \fB\-\-summary\fR
 .RS 4
-Display a summary of the state of the run\.
+Display a summary of the state of the run\&.
 .RE
 .PP
 \fB\-\-dumping\fR
 .RS 4
-Display all partitions that are dumping\.
+Display all partitions that are dumping\&.
 .RE
 .PP
 \fB\-\-waitdumping|wdumping\fR
 .RS 4
-Display all partitions that are waiting to be dumped\.
+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\.
+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\.
+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\.
+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\.
+Display all partitions that are dumped and written to tape\&.
 .RE
 .PP
 \fB\-\-failed|error\fR
 .RS 4
-Display all partitions that failed\.
+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\.
+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\.
+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\.
+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\'
+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),
-\fI\%http://wiki.zmanda.com\fR
+\fBamadmin\fR(8)
+.PP
+The Amanda Wiki:
+: http://wiki.zmanda.com/
+.SH "AUTHOR"
+.PP
+\fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>