Imported Upstream version 2.6.0p2
[debian/amanda] / man / amstatus.8
index 9a96e9bf7998ba8e722d085bf53cecc841bc3d02..f17d645534b71645d8765facb65230248318aadf 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 "" "" ""
+.\"     Title: amstatus
+.\"    Author: 
+.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
+.\"      Date: 08/22/2008
+.\"    Manual: 
+.\"    Source: 
+.\"
+.TH "AMSTATUS" "8" "08/22/2008" "" ""
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
 .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]
+\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
+\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