git.gag.com Git - debian/amanda/blob - 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 </cmdsynopsis>
  41 </refsynopsisdiv>
  42
  43
  44 <refsect1><title>DESCRIPTION</title>
  45 <para><emphasis remap='B'>Amstatus</emphasis>
  46 gives the current state of the &A; run specified by the
  47 <emphasis remap='I'>config</emphasis>
  48 configuration.
  49 If there is no active &A; running, it summarizes the result of the last run.
  50 It may also be used to summarize the results of a previous run.</para>
  51
  52 <para>See the
  53 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  54 man page for more details about &A;.</para>
  55 </refsect1>
  56
  57 <refsect1><title>OPTIONS</title>
  58 <para>All options may be abbreviated to the shortest non-ambiguous sub-string.
  59 If no options are given, everything is displayed.</para>
  60 <variablelist remap='TP'>
  61   <varlistentry>
  62   <term><emphasis remap='B'>[--config] config</emphasis></term>
  63   <listitem>
  64 <para>Specify the &A; configuration you want to display the state for.</para>
  65   </listitem>
  66   </varlistentry>
  67   <varlistentry>
  68   <term><option>--file amdumpfile</option></term>
  69   <listitem>
  70 <para>Specify an alternate file instead of the
  71 <emphasis remap='I'>amdump</emphasis>
  72 or
  73 <emphasis remap='I'>amflush</emphasis>
  74 file.</para>
  75   </listitem>
  76   </varlistentry>
  77   <varlistentry>
  78   <term><option>--summary</option></term>
  79   <listitem>
  80 <para>Display a summary of the state of the run.</para>
  81   </listitem>
  82   </varlistentry>
  83   <varlistentry>
  84   <term><option>--dumping</option></term>
  85   <listitem>
  86 <para>Display all partitions that are dumping.</para>
  87   </listitem>
  88   </varlistentry>
  89   <varlistentry>
  90   <term><option>--waitdumping|wdumping</option></term>
  91   <listitem>
  92 <para>Display all partitions that are waiting to be dumped.</para>
  93   </listitem>
  94   </varlistentry>
  95   <varlistentry>
  96   <term><option>--waittaper|wtaper</option></term>
  97   <listitem>
  98 <para>Display all partitions dumped that are waiting to be written to tape.</para>
  99   </listitem>
 100   </varlistentry>
 101   <varlistentry>
 102   <term><option>--dumpingtape|dtape</option></term>
 103   <listitem>
 104 <para>Display all partitions that are dumping directly to tape.</para>
 105   </listitem>
 106   </varlistentry>
 107   <varlistentry>
 108   <term><option>--writingtape|wtape</option></term>
 109   <listitem>
 110 <para>Display all partitions that are writing to tape.</para>
 111   </listitem>
 112   </varlistentry>
 113   <varlistentry>
 114   <term><option>--finished</option></term>
 115   <listitem>
 116 <para>Display all partitions that are dumped and written to tape.</para>
 117   </listitem>
 118   </varlistentry>
 119   <varlistentry>
 120   <term><option>--failed|error</option></term>
 121   <listitem>
 122 <para>Display all partitions that failed.</para>
 123   </listitem>
 124   </varlistentry>
 125   <varlistentry>
 126   <term><option>--estimate</option></term>
 127   <listitem>
 128 <para>Display all partitions whose estimate is finished.
 129 Works only during the estimate phase.</para>
 130   </listitem>
 131   </varlistentry>
 132   <varlistentry>
 133   <term><option>--gestimate|gettingestimate</option></term>
 134   <listitem>
 135 <para>Display all partitions whose estimate is not finished.
 136 Works only during the estimate phase.</para>
 137   </listitem>
 138   </varlistentry>
 139   <varlistentry>
 140   <term><option>--stats|statistics</option></term>
 141   <listitem>
 142 <para>Display statistics about active-time of taper and dumpers.</para>
 143   </listitem>
 144   </varlistentry>
 145 </variablelist>
 146 </refsect1>
 147
 148 <refsect1><title>SEE ALSO</title>
 149 <para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 150 <citerefentry><refentrytitle>amcheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 151 <citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 152 <citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 153 <citerefentry><refentrytitle>amadmin</refentrytitle><manvolnum>8</manvolnum></citerefentry></para>
 154 </refsect1>
 155 </refentry>
 156