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