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"
5 <!-- entities files to use -->
6 <!ENTITY % global_entities SYSTEM 'global.entities'>
10 <!-- lifted from troff+man by doclifter -->
11 <refentry id='amanda.8'>
14 <refentrytitle>amanda</refentrytitle>
15 <manvolnum>8</manvolnum>
21 <refname>amanda</refname>
22 <refpurpose>The Open Source Backup Platform</refpurpose>
28 <!-- body begins here -->
30 <refsect1><title>DESCRIPTION</title>
31 <para>This manual page gives an overview of the Amanda commands and
32 configuration files for quick reference.</para>
35 - NOTE: the comma after each citerefentry works around a bug in the docbook-to-man conversion; using
36 - causes problems in the docbook-to-html conversion.
39 <refsect2><title>COMMANDS</title> <!-- a.k.a. any section 8 manpage -->
40 <para>Here are all the Amanda commands. Each one has its own manual page. See them for all the gory details.</para>
43 <manref name="amaddclient" vol="8"/>,
46 <manref name="amadmin" vol="8"/>,
49 <manref name="amaespipe" vol="8"/>,
52 <manref name="amarchiver" vol="8"/>,
55 <manref name="amcheck" vol="8"/>,
58 <manref name="amcheckdb" vol="8"/>,
61 <manref name="amcheckdump" vol="8"/>,
64 <manref name="amcleanup" vol="8"/>,
67 <manref name="amcrypt-ossl-asym" vol="8"/>,
70 <manref name="amcrypt-ossl" vol="8"/>,
73 <manref name="amcrypt" vol="8"/>,
76 <manref name="amcryptsimple" vol="8"/>,
79 <manref name="amdevcheck" vol="8"/>,
82 <manref name="amdump" vol="8"/>,
85 <manref name="amfetchdump" vol="8"/>,
88 <manref name="amflush" vol="8"/>,
91 <manref name="amgetconf" vol="8"/>,
94 <manref name="amgpgcrypt" vol="8"/>,
97 <manref name="amgtar" vol="8"/>,
100 <manref name="amlabel" vol="8"/>,
103 <manref name="amoverview" vol="8"/>,
106 <manref name="ampgsql" vol="8"/>,
109 <manref name="amplot" vol="8"/>,
112 <manref name="amraw" vol="8"/>,
115 <manref name="amrecover" vol="8"/>,
118 <manref name="amreport" vol="8"/>,
121 <manref name="amrestore" vol="8"/>,
124 <manref name="amrmtape" vol="8"/>,
127 <manref name="amsamba" vol="8"/>,
130 <manref name="amserverconfig" vol="8"/>,
133 <manref name="amservice" vol="8"/>,
136 <manref name="amstar" vol="8"/>,
139 <manref name="amstatus" vol="8"/>,
142 <manref name="amsuntar" vol="8"/>,
145 <manref name="amtape" vol="8"/>,
148 <manref name="amtapetype" vol="8"/>,
151 <manref name="amtoc" vol="8"/>,
154 <manref name="amvault" vol="8"/>,
157 <manref name="amzfs-sendrecv" vol="8"/>,
160 <manref name="amzfs-snapshot" vol="8"/>,
163 <manref name="script-email" vol="8"/>,
167 <refsect2><title>CONFIGURATION FILES</title> <!-- a.k.a. most section 5 manpages -->
170 <manref name="amanda.conf" vol="5"/>,
173 <manref name="amanda-client.conf" vol="5"/>,
176 <manref name="disklist" vol="5"/>,
179 <manref name="tapelist" vol="5"/>,
183 <refsect2><title>DATA FORMATS</title> <!-- a.k.a. section 5 manpages about internal data formats -->
186 <manref name="amanda-archive-format" vol="5"/>,
190 <refsect2><title>CONCEPTS</title> <!-- a.k.a. any section 7 manpage -->
193 <manref name="amanda-applications" vol="7"/>,
196 <manref name="amanda-auth" vol="7"/>,
199 <manref name="amanda-changers" vol="7"/>,
202 <manref name="amanda-compatibility" vol="7"/>,
205 <manref name="amanda-devices" vol="7"/>,
208 <manref name="amanda-interactivity" vol="7"/>,
211 <manref name="amanda-match" vol="7"/>,
214 <manref name="amanda-scripts" vol="7"/>,
217 <manref name="amanda-taperscan" vol="7"/>,
223 <refsect1><title>CONFIGURATION FILES</title>
224 <para>There are four user-editable files that control the behavior of Amanda.
227 The first two are &amconf; and &amclientconf;,
228 the main configuration files for the server and client, respectively.
229 They contain parameters to customize Amanda for the site.
232 Next is the &disklist; file, which lists hosts and disk partitions to back up.
235 Last is the seldom-edited &tapelist;
236 file, which lists tapes that are currently active.
237 These files are described in more detail in the following sections.</para>
239 <para>All configuration files are stored in individual configuration
240 directories, usually under <filename>/etc/amanda/</filename>.
241 A site will often have more than
243 For example, it might have a
244 <emphasis remap='I'>normal</emphasis>
245 configuration for everyday backups and an
246 <emphasis remap='I'>archive</emphasis>
247 configuration for infrequent full archival backups.
248 The configuration files would be stored under directories
249 <filename>/etc/amanda/normal/</filename> and
250 <filename>/etc/amanda/archive/</filename>, respectively.
251 Part of the job of an Amanda administrator is to create,
252 populate and maintain these directories.</para>
254 <para>Most Amanda applications take a "config" parameter; this is generally the
255 (unqualified) name of the configuration directory, e.g.,
256 <filename>normal</filename>. If the parameter is <filename>.</filename> (dot),
257 the current directory is used. This feature is present for backward
258 compatibility, but is not commonly used.</para>
260 <refsect2><title>Configuration Override</title>
261 <para>Most commands allow the override of specific
262 configuration options on the command line, using the <arg
263 choice="plain">-o</arg> option. This option has the form <arg
264 choice="plain">-o</arg><replaceable>name</replaceable>=<replaceable>value</replaceable>.
265 An optional space is allowed after the <arg choice="plain">-o</arg>.
266 Each configuration option should be specified in a separate
267 command-line option.</para>
269 <para>For global options, <replaceable>name</replaceable> is simply the name of the option, e.g.,
273 For options in a named section of the configuration, <replaceable>name</replaceable> has the
274 form <replaceable>SECTION</replaceable>:<replaceable>section_name</replaceable>:<replaceable>name</replaceable>,
275 where <replaceable>SECTION</replaceable> is one of TAPETYPE, DUMPTYPE, HOLDINGDISK, or INTERFACE, and
276 <replaceable>section_name</replaceable> is the name of the tapetype, dumptype, holdingdisk, or interface.
279 amdump -o TAPETYPE:HP-DAT:length=2000m
280 amdump -o DUMPTYPE:no-compress:compress="server fast"
281 amdump -o HOLDINGDISK:hd1:use="-100 mb"
282 amdump -o INTERFACE:local:use="2000 kbps"
286 <para>When overriding device properties, one must carefully quote the
287 command line to simulate the syntax of real configuration files. The
288 following example should serve as a guide:
290 amdump -o 'device-property="PROPERTY_MAX_VOLUME_USAGE" "100000"'
291 </programlisting></para>
293 <para>Note that configuration overrides are not effective for tape
294 changers, which supply a tapedev based on their own configuration. In order to
295 override <emphasis remap="I">tapedev</emphasis>, you must also disable any changer:
297 amdump -otapedev=/dev/nst1 -otpchanger=''