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