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