Imported Upstream version 2.6.0p1
[debian/amanda] / man / xml-source / amoverview.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 <refentry id='amoverview.8'>
12
13 <refmeta>
14 <refentrytitle>amoverview</refentrytitle>
15 <manvolnum>8</manvolnum>
16 </refmeta>
17 <refnamediv>
18 <refname>amoverview</refname>
19 <refpurpose>display file systems processed by &A; over time</refpurpose>
20 </refnamediv>
21 <!-- body begins here -->
22 <refsynopsisdiv>
23 <cmdsynopsis>
24   <command>amoverview</command>    
25     <arg choice='opt'><arg choice='opt'>-config </arg><arg choice='plain'><replaceable>config</replaceable></arg></arg>
26     <arg choice='opt'>-hostwidth <replaceable>width</replaceable></arg>
27     <arg choice='opt'>-diskwidth <replaceable>width</replaceable></arg>
28     <arg choice='opt'>-skipmissed</arg>
29     <arg choice='opt'>-last</arg>
30     <arg choice='opt'>-num0</arg>
31     <arg choice='opt'>-togo0</arg>
32     <arg choice='opt'>-verbose</arg>
33 </cmdsynopsis>
34 </refsynopsisdiv>
35
36
37 <refsect1><title>DESCRIPTION</title>
38 <para><emphasis remap='B'>Amoverview</emphasis>
39 displays a chart showing hosts and file systems processed by &A;
40 along with the backup level performed each day.</para>
41
42 <para>See the
43 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
44 man page for more details about &A;.</para>
45 </refsect1>
46
47 <refsect1><title>OPTIONS</title>
48 <variablelist remap='TP'>
49   <varlistentry>
50   <term><option>-config</option> <replaceable>config</replaceable></term>
51   <listitem>
52 <para>Use configuration
53 <emphasis remap='I'>config</emphasis>
54 instead of configuration daily.</para>
55   </listitem>
56   </varlistentry>
57   <varlistentry>
58   <term><option>-hostwidth</option> <replaceable>width</replaceable></term>
59   <listitem>
60 <para>Set
61 <emphasis remap='B'>host</emphasis>
62 field column width to
63 <emphasis remap='I'>width</emphasis>
64 characters instead of 8.</para>
65   </listitem>
66   </varlistentry>
67   <varlistentry>
68   <term><option>-diskwidth</option> <replaceable>width</replaceable></term>
69   <listitem>
70 <para>Set
71 <emphasis remap='B'>disk</emphasis>
72 field column width to
73 <emphasis remap='I'>width</emphasis>
74 characters instead of 20.</para>
75   </listitem>
76   </varlistentry>
77   <varlistentry>
78   <term><option>-skipmissed</option></term>
79   <listitem>
80 <para>Compacts the output by only printing stats 
81 for the days &A; actually ran.
82 </para>
83   </listitem>
84   </varlistentry>
85
86   <varlistentry>
87   <term><option>-last</option></term>
88   <listitem>
89   <para>
90   Outputs the last status of each disk at the start. 
91   Useful for long tapecycles and/or sparse reports.
92   </para>
93   </listitem>
94   </varlistentry>
95
96   <varlistentry>
97   <term><option>-num0</option></term>
98   <listitem>
99   <para>
100   Outputs the number of level 0 dumps for each disk.
101   </para>
102   </listitem>
103   </varlistentry>
104   
105   <varlistentry>
106   <term><option>-togo0</option></term>
107   <listitem>
108   <para>
109   Outputs the number of runs until the last level 0 dump is overwritten.
110   </para>
111   </listitem>
112   </varlistentry>
113
114   <varlistentry>
115   <term><option>-verbose</option></term>
116   <listitem>
117 <para><emphasis remap='B'>Amoverview</emphasis>
118 can take a long while on large systems.
119 This option reports intermediate steps while it is working.</para>
120   </listitem>
121   </varlistentry>
122 </variablelist>
123 </refsect1>
124
125 <refsect1><title>RESULTS</title>
126 <para><command>amoverview</command>
127 is a summary of the output of &quot;
128 <emphasis remap='B'>amadmin &lt;config&gt; find</emphasis>
129 &quot;.
130 When the last column of 
131 <emphasis remap='B'>amadmin find</emphasis>
132 contains anything other than &quot;OK&quot;,
133 amoverview translates this into &quot;E&quot; for that day.</para>
134
135 <para>A number indicates the level of backup and it succeeded.
136 An &quot;E&quot; indicates an error for that day.
137 You get an &quot;E&quot; for all errors, like failed to connect, datatimeout,
138 computer crashed, etc, but also for failing to write to tape.</para>
139
140 <para>You can have an &quot;E&quot; followed by a number if a filesystem ran into
141 end-of-tape once (gives an &quot;E&quot;, and later that day, you flush it to a
142 second tape (a number: the level, indicating success).  If the flush
143 failed too, you get a double &quot;EE&quot; for that day.</para>
144
145 <para>You can also have a double code if you have two tapes in the changer and
146 &A; failed to write to tape the first time because it hit end of tape
147 (resulting in &quot;E0&quot;, for a full, &quot;E1&quot; for an
148 incremental etc.)
149 or twice with error (&quot;EE&quot;), and may a successful flush afterwards
150 giving maybe &quot;EE0&quot;. (Only the latest 2 characters are printed).</para>
151 </refsect1>
152
153 <refsect1><title>EXAMPLE</title>
154 <para>This shows the
155 <filename>/home</filename>
156 file system on
157 <emphasis remap='I'>host2</emphasis>
158 was backed up at level 3 on the 8th, 9th and 10th of December,
159 had a full backup on the 11th,
160 a level 1 on the 12th and a level 2 on the 13th.</para>
161
162 <programlisting remap='.nf'>
163 # amoverview
164                          date 12 12 12 12 12 12
165 host     disk                 08 09 10 11 12 13
166  
167 host1    /                     0  1  1  1  1  1
168 host1    /var                  0  1  1  1  1  1
169 host2    /                     1  1  1  1  1  0
170 host2    /home                 3  3  3  0  1  2
171 host2    /opt                  1  1  1  1  1  1
172 host2    /var                  1  1  0  1  1  1 
173 </programlisting>
174 </refsect1>
175
176 <refsect1><title>SEE ALSO</title>
177 <para><citerefentry><refentrytitle>amadmin</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
178 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
179 <ulink url="http://wiki.zmanda.com"/>
180 </para>
181 </refsect1>
182 </refentry>
183