Imported Upstream version 2.6.0p1
[debian/amanda] / man / xml-source / amstatus.8.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
4 [
5   <!-- entities files to use -->
6   <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
7   %global_entities;
8 ]>
9
10 <!-- lifted from troff+man by doclifter -->
11
12 <refentry id='amstatus.8'>
13
14 <refmeta>
15 <refentrytitle>amstatus</refentrytitle>
16 <manvolnum>8</manvolnum>
17 </refmeta>
18 <refnamediv>
19 <refname>amstatus</refname>
20 <refpurpose>display the state of an &A; run</refpurpose>
21 </refnamediv>
22 <!-- body begins here -->
23 <refsynopsisdiv>
24 <cmdsynopsis>
25   <command>amstatus</command>    
26     <arg choice='opt'>--config </arg>
27     <arg choice='plain'><replaceable>config</replaceable></arg>
28     <arg choice='opt'><arg choice='plain'>--file </arg><arg choice='plain'><replaceable>amdumpfile</replaceable></arg></arg>
29     <arg choice='opt'>--summary </arg>
30     <arg choice='opt'>--dumping </arg>
31     <arg choice='opt'>--waitdumping </arg>
32     <arg choice='opt'>--waittaper </arg>
33     <arg choice='opt'>--dumpingtape </arg>
34     <arg choice='opt'>--writingtape </arg>
35     <arg choice='opt'>--finished </arg>
36     <arg choice='opt'>--failed </arg>
37     <arg choice='opt'>--estimate </arg>
38     <arg choice='opt'>--gestimate </arg>
39     <arg choice='opt'>--stats </arg>
40     <arg choice='opt'>--locale-independent-date-format </arg>
41 </cmdsynopsis>
42 </refsynopsisdiv>
43
44
45 <refsect1><title>DESCRIPTION</title>
46 <para><emphasis remap='B'>Amstatus</emphasis>
47 gives the current state of the &A; run specified by the 
48 <emphasis remap='I'>config</emphasis>
49 configuration.
50 If there is no active &A; running, it summarizes the result of the last run.
51 It may also be used to summarize the results of a previous run.</para>
52
53 <para>See the
54 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
55 man page for more details about &A;.</para>
56 </refsect1>
57
58 <refsect1><title>OPTIONS</title>
59 <para>All options may be abbreviated to the shortest non-ambiguous sub-string.
60 If no options are given, everything is displayed.</para>
61 <variablelist remap='TP'>
62   <varlistentry>
63   <term><emphasis remap='B'>[--config] config</emphasis></term>
64   <listitem>
65 <para>Specify the &A; configuration you want to display the state for.</para>
66   </listitem>
67   </varlistentry>
68   <varlistentry>
69   <term><option>--file amdumpfile</option></term>
70   <listitem>
71 <para>Specify an alternate file instead of the
72 <emphasis remap='I'>amdump</emphasis>
73 or
74 <emphasis remap='I'>amflush</emphasis>
75 file.</para>
76   </listitem>
77   </varlistentry>
78   <varlistentry>
79   <term><option>--summary</option></term>
80   <listitem>
81 <para>Display a summary of the state of the run.</para>
82   </listitem>
83   </varlistentry>
84   <varlistentry>
85   <term><option>--dumping</option></term>
86   <listitem>
87 <para>Display all partitions that are dumping.</para>
88   </listitem>
89   </varlistentry>
90   <varlistentry>
91   <term><option>--waitdumping|wdumping</option></term>
92   <listitem>
93 <para>Display all partitions that are waiting to be dumped.</para>
94   </listitem>
95   </varlistentry>
96   <varlistentry>
97   <term><option>--waittaper|wtaper</option></term>
98   <listitem>
99 <para>Display all partitions dumped that are waiting to be written to tape.</para>
100   </listitem>
101   </varlistentry>
102   <varlistentry>
103   <term><option>--dumpingtape|dtape</option></term>
104   <listitem>
105 <para>Display all partitions that are dumping directly to tape.</para>
106   </listitem>
107   </varlistentry>
108   <varlistentry>
109   <term><option>--writingtape|wtape</option></term>
110   <listitem>
111 <para>Display all partitions that are writing to tape.</para>
112   </listitem>
113   </varlistentry>
114   <varlistentry>
115   <term><option>--finished</option></term>
116   <listitem>
117 <para>Display all partitions that are dumped and written to tape.</para>
118   </listitem>
119   </varlistentry>
120   <varlistentry>
121   <term><option>--failed|error</option></term>
122   <listitem>
123 <para>Display all partitions that failed.</para>
124   </listitem>
125   </varlistentry>
126   <varlistentry>
127   <term><option>--estimate</option></term>
128   <listitem>
129 <para>Display all partitions whose estimate is finished.
130 Works only during the estimate phase.</para>
131   </listitem>
132   </varlistentry>
133   <varlistentry>
134   <term><option>--gestimate|gettingestimate</option></term>
135   <listitem>
136 <para>Display all partitions whose estimate is not finished.
137 Works only during the estimate phase.</para>
138   </listitem>
139   </varlistentry>
140   <varlistentry>
141   <term><option>--stats|statistics</option></term>
142   <listitem>
143 <para>Display statistics about active-time of taper and dumpers.</para>
144   </listitem>
145   </varlistentry>
146   <varlistentry>
147   <term><option>--locale-independent-date-format</option></term>
148   <listitem>
149 <para>Output the date in a locale independent format. The format is the same executing: date +'%Y-%m-%d %H:%M:%S %Z'</para>
150   </listitem>
151   </varlistentry>
152 </variablelist>
153 </refsect1>
154
155 <refsect1><title>SEE ALSO</title>
156 <para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
157 <citerefentry><refentrytitle>amcheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
158 <citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
159 <citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
160 <citerefentry><refentrytitle>amadmin</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
161 <ulink url="http://wiki.zmanda.com"/>
162 </para>
163 </refsect1>
164 </refentry>
165