Imported Upstream version 2.6.0p1
[debian/amanda] / man / xml-source / amflush.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='amflush.8'>
12
13 <refmeta>
14 <refentrytitle>amflush</refentrytitle>
15 <manvolnum>8</manvolnum>
16 </refmeta>
17 <refnamediv>
18 <refname>amflush</refname>
19 <refpurpose>flush &A; backup files from holding disk to tape</refpurpose>
20 </refnamediv>
21 <!-- body begins here -->
22 <refsynopsisdiv>
23 <cmdsynopsis>
24   <command>amflush</command>    
25     <arg choice='opt'>-b</arg>
26     <arg choice='opt'>-f</arg>
27     <arg choice='opt'>-s</arg>
28     <arg choice='opt'>-D <replaceable>datestamp</replaceable></arg>
29     <arg choice='plain'><replaceable>config</replaceable></arg>
30     <arg choice='opt' rep='repeat'>
31        <arg choice='plain'><replaceable>host</replaceable></arg>
32        <arg choice='opt' rep='repeat'><replaceable>disk</replaceable></arg>
33     </arg>
34     <arg choice='plain' rep='repeat'><group><arg choice='plain'>-o </arg><replaceable>configoption</replaceable></group></arg>
35 </cmdsynopsis>
36 </refsynopsisdiv>
37
38
39 <refsect1><title>DESCRIPTION</title>
40 <para><emphasis remap='B'>Amflush</emphasis>
41 writes &A; backups from the holding disks to tape,
42 and updates the &A; info database and tapelist accordingly.
43 Backups may stay in a holding disk when something is wrong with the tape
44 at the time
45 <emphasis remap='B'>amdump</emphasis>
46 is run.
47 When this happens, the problem must be corrected and
48 <command>amflush</command>
49 run by hand.</para>
50 </refsect1>
51
52 <refsect1><title>OPTIONS</title>
53 <variablelist remap='TP'>
54   <varlistentry>
55   <term><option>-b</option></term>
56   <listitem>
57 <para>Run
58 <command>amflush</command>
59 in batch mode. All datestamps are selected unless specified.
60 The flush is started without confirmation.</para>
61   </listitem>
62   </varlistentry>
63   <varlistentry>
64   <term><option>-f</option></term>
65   <listitem>
66 <para>Run
67 <command>amflush</command>
68 in foreground.
69 <emphasis remap='B'>Amflush</emphasis>
70 normally detaches itself from the tty and runs as a background process.
71 With the
72 <option>-f</option>
73 option,
74 <command>amflush</command>
75 stays in the foreground.
76 This is useful if
77 <command>amflush</command>
78 is run as part of another script that, for example, advances the tape
79 after the flush is completed.</para>
80   </listitem>
81   </varlistentry>
82   <varlistentry>
83   <term><option>-s</option></term>
84   <listitem>
85 <para>Write log to stdout/stderr instead of the amflush log file. Requires the
86 <option>-f</option>
87 option.</para>
88   </listitem>
89   </varlistentry>
90   <varlistentry>
91   <term><option>-D datestamp</option></term>
92   <listitem>
93 <para>specify a  datestamp expression you want to flush, see the 
94 &quot;DATESTAMP EXPRESSION&quot; section of
95 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
96 for a description.
97 <option>-D 20001225-7</option>
98 will flush all
99 dumps from 25 december 2000 to 27 december 2000.</para>
100   </listitem>
101   </varlistentry>
102
103   <varlistentry>
104   <term><replaceable>host</replaceable> [<replaceable>disk</replaceable>]*</term>
105   <listitem>
106 <para>Specify the host and disk on which the command will work.</para>
107   </listitem>
108   </varlistentry>
109
110   <varlistentry>
111   <term><emphasis remap='B'>-o</emphasis> <replaceable>configoption</replaceable></term>
112   <listitem>
113 <para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>" section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
114   </listitem>
115   </varlistentry>
116
117 </variablelist>
118
119 <para>You can specify many host/disk expressions, only disks that
120 match an expression will be flushed. All disks are flushed if no
121 expressions are given. see the &quot;HOST &amp; DISK EXPRESSION&quot; section of
122 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
123 for a description.</para>
124
125 <para><emphasis remap='B'>Amflush</emphasis>
126 will look in the holding disks specified by the
127 <emphasis remap='I'>amanda.conf</emphasis>
128 file in /usr/local/etc/amanda/<emphasis remap='I'>config</emphasis>
129 for any non-empty &A; work directories.
130 It then prompts you to select a directory
131 or to process all of the directories.
132 The work directories in the holding disks are named by the date at the time
133 <emphasis remap='B'>amdump</emphasis>
134 was run, e.g.
135 <literal>19910215</literal>.</para>
136
137 <para>See the
138 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
139 man page for more details about &A;.</para>
140 </refsect1>
141
142 <refsect1><title>EXAMPLE</title>
143 <para><emphasis remap='B'>Amflush</emphasis>
144 will search for holding areas associated with the
145 <emphasis remap='I'>daily</emphasis>
146 configuration.
147 After you select which holding area to flush,
148 <command>amflush</command>
149 writes the data to tape, updates the databases and sends
150 a mail report similar to
151 <citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
152
153 <programlisting>
154 % amflush daily
155 Scanning /amanda-hold...
156   20001113: found &A; directory.
157   20001114: found &A; directory.
158
159 Multiple &A; directories, please pick one by letter:
160   A. 20001113
161   B. 20001114
162 Select directories to flush [A..B]: [ALL] all
163
164 Flushing dumps in 20001113, 20001114,
165 today: 20001117
166 to tape drive /dev/rmt/0mn.
167 Expecting tape DMP014 or a new tape.  (The last dumps were to tape DMP013)
168 Are you sure you want to do this? yes
169 Running in background, you can log off now.
170 You'll get mail when amflush is finished.
171 </programlisting>
172 </refsect1>
173
174 <refsect1><title>AUTHOR</title>
175 <para>James da Silva, &email.jds; : Original text</para>
176 <para>&maintainer.sgw;: XML-conversion</para>
177 </refsect1>
178
179 <refsect1><title>SEE ALSO</title>
180 <para>
181   <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
182   <citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
183   <ulink url="http://wiki.zmanda.com"/>
184 </para>
185 </refsect1>
186 </refentry>
187