Imported Upstream version 2.6.1p1
[debian/amanda] / man / amstatus.8
index 9733d1181d3f74e0096464c8b7fe734279e0abf8..a118c26ca888e772f0de87b6df32d15327946b18 100644 (file)
@@ -1,20 +1,28 @@
+'\" t
 .\"     Title: amstatus
-.\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
-.\"      Date: 02/07/2007
-.\"    Manual: 
-.\"    Source: 
+.\"    Author: Stefan G. Weichinger <sgw@amanda.org>
+.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
+.\"      Date: 04/10/2009
+.\"    Manual: System Administration Commands
+.\"    Source: Amanda 2.6.1p1
+.\"  Language: English
 .\"
-.TH "AMSTATUS" "8" "02/07/2007" "" ""
+.TH "AMSTATUS" "8" "04/10/2009" "Amanda 2\&.6\&.1p1" "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 \fIAmanda\fR run
 .SH "SYNOPSIS"
-.HP 9
-\fBamstatus\fR [\-\-config] \fIconfig\fR [\-\-file\ \fIamdumpfile\fR] [\-\-summary] [\-\-dumping] [\-\-waitdumping] [\-\-waittaper] [\-\-dumpingtape] [\-\-writingtape] [\-\-finished] [\-\-failed] [\-\-estimate] [\-\-gestimate] [\-\-stats]
+.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
@@ -22,23 +30,23 @@ gives the current state of the
 \fIAmanda\fR
 run specified by the
 \fIconfig\fR
-configuration. If there is no active
+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.
+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.
+\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.
+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.
+configuration you want to display the state for\&.
 .RE
 .PP
 \fB\-\-file amdumpfile\fR
@@ -47,67 +55,86 @@ 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\'
+.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\&>