git.gag.com Git - debian/amanda/blob - man/xml-source/amanda.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='amanda.8'>
  12
  13 <refmeta>
  14 <refentrytitle>amanda</refentrytitle>
  15 <manvolnum>8</manvolnum>
  16 &rmi.source;
  17 &rmi.version;
  18 &rmi.manual.8;
  19 </refmeta>
  20 <refnamediv>
  21 <refname>amanda</refname>
  22 <refpurpose>The Open Source Backup Platform</refpurpose>
  23 </refnamediv>
  24 <refentryinfo>
  25 &author.jds;
  26 &author.sgw.xml;
  27 </refentryinfo>
  28 <!-- body begins here -->
  29
  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>
  33
  34 <!--
  35  - NOTE: the comma after each citerefentry works around a bug in the docbook-to-man conversion; using &nbsp;
  36  - causes problems in the docbook-to-html conversion.
  37 -->
  38
  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>
  41 <itemizedlist>
  42 <listitem>
  43 <manref name="amaddclient" vol="8"/>,
  44 </listitem>
  45 <listitem>
  46 <manref name="amadmin" vol="8"/>,
  47 </listitem>
  48 <listitem>
  49 <manref name="amaespipe" vol="8"/>,
  50 </listitem>
  51 <listitem>
  52 <manref name="amarchiver" vol="8"/>,
  53 </listitem>
  54 <listitem>
  55 <manref name="amcheck" vol="8"/>,
  56 </listitem>
  57 <listitem>
  58 <manref name="amcheckdb" vol="8"/>,
  59 </listitem>
  60 <listitem>
  61 <manref name="amcheckdump" vol="8"/>,
  62 </listitem>
  63 <listitem>
  64 <manref name="amcleanup" vol="8"/>,
  65 </listitem>
  66 <listitem>
  67 <manref name="amcrypt-ossl-asym" vol="8"/>,
  68 </listitem>
  69 <listitem>
  70 <manref name="amcrypt-ossl" vol="8"/>,
  71 </listitem>
  72 <listitem>
  73 <manref name="amcrypt" vol="8"/>,
  74 </listitem>
  75 <listitem>
  76 <manref name="amcryptsimple" vol="8"/>,
  77 </listitem>
  78 <listitem>
  79 <manref name="amdevcheck" vol="8"/>,
  80 </listitem>
  81 <listitem>
  82 <manref name="amdump" vol="8"/>,
  83 </listitem>
  84 <listitem>
  85 <manref name="amfetchdump" vol="8"/>,
  86 </listitem>
  87 <listitem>
  88 <manref name="amflush" vol="8"/>,
  89 </listitem>
  90 <listitem>
  91 <manref name="amgetconf" vol="8"/>,
  92 </listitem>
  93 <listitem>
  94 <manref name="amgpgcrypt" vol="8"/>,
  95 </listitem>
  96 <listitem>
  97 <manref name="amgtar" vol="8"/>,
  98 </listitem>
  99 <listitem>
 100 <manref name="amlabel" vol="8"/>,
 101 </listitem>
 102 <listitem>
 103 <manref name="amoverview" vol="8"/>,
 104 </listitem>
 105 <listitem>
 106 <manref name="ampgsql" vol="8"/>,
 107 </listitem>
 108 <listitem>
 109 <manref name="amplot" vol="8"/>,
 110 </listitem>
 111 <listitem>
 112 <manref name="amraw" vol="8"/>,
 113 </listitem>
 114 <listitem>
 115 <manref name="amrecover" vol="8"/>,
 116 </listitem>
 117 <listitem>
 118 <manref name="amreport" vol="8"/>,
 119 </listitem>
 120 <listitem>
 121 <manref name="amrestore" vol="8"/>,
 122 </listitem>
 123 <listitem>
 124 <manref name="amrmtape" vol="8"/>,
 125 </listitem>
 126 <listitem>
 127 <manref name="amsamba" vol="8"/>,
 128 </listitem>
 129 <listitem>
 130 <manref name="amserverconfig" vol="8"/>,
 131 </listitem>
 132 <listitem>
 133 <manref name="amservice" vol="8"/>,
 134 </listitem>
 135 <listitem>
 136 <manref name="amstar" vol="8"/>,
 137 </listitem>
 138 <listitem>
 139 <manref name="amstatus" vol="8"/>,
 140 </listitem>
 141 <listitem>
 142 <manref name="amsuntar" vol="8"/>,
 143 </listitem>
 144 <listitem>
 145 <manref name="amtape" vol="8"/>,
 146 </listitem>
 147 <listitem>
 148 <manref name="amtapetype" vol="8"/>,
 149 </listitem>
 150 <listitem>
 151 <manref name="amtoc" vol="8"/>,
 152 </listitem>
 153 <listitem>
 154 <manref name="amvault" vol="8"/>,
 155 </listitem>
 156 <listitem>
 157 <manref name="amzfs-sendrecv" vol="8"/>,
 158 </listitem>
 159 <listitem>
 160 <manref name="amzfs-snapshot" vol="8"/>,
 161 </listitem>
 162 <listitem>
 163 <manref name="script-email" vol="8"/>,
 164 </listitem>
 165 </itemizedlist>
 166 </refsect2>
 167 <refsect2><title>CONFIGURATION FILES</title> <!-- a.k.a. most section 5 manpages -->
 168 <itemizedlist>
 169 <listitem>
 170 <manref name="amanda.conf" vol="5"/>,
 171 </listitem>
 172 <listitem>
 173 <manref name="amanda-client.conf" vol="5"/>,
 174 </listitem>
 175 <listitem>
 176 <manref name="disklist" vol="5"/>,
 177 </listitem>
 178 <listitem>
 179 <manref name="tapelist" vol="5"/>,
 180 </listitem>
 181 </itemizedlist>
 182 </refsect2>
 183 <refsect2><title>DATA FORMATS</title> <!-- a.k.a. section 5 manpages about internal data formats -->
 184 <itemizedlist>
 185 <listitem>
 186 <manref name="amanda-archive-format" vol="5"/>,
 187 </listitem>
 188 </itemizedlist>
 189 </refsect2>
 190 <refsect2><title>CONCEPTS</title> <!-- a.k.a. any section 7 manpage -->
 191 <itemizedlist>
 192 <listitem>
 193 <manref name="amanda-applications" vol="7"/>,
 194 </listitem>
 195 <listitem>
 196 <manref name="amanda-auth" vol="7"/>,
 197 </listitem>
 198 <listitem>
 199 <manref name="amanda-changers" vol="7"/>,
 200 </listitem>
 201 <listitem>
 202 <manref name="amanda-compatibility" vol="7"/>,
 203 </listitem>
 204 <listitem>
 205 <manref name="amanda-devices" vol="7"/>,
 206 </listitem>
 207 <listitem>
 208 <manref name="amanda-match" vol="7"/>,
 209 </listitem>
 210 <listitem>
 211 <manref name="amanda-scripts" vol="7"/>,
 212 </listitem>
 213 <listitem>
 214 <manref name="amanda-taperscan" vol="7"/>,
 215 </listitem>
 216 </itemizedlist>
 217 </refsect2>
 218 </refsect1>
 219
 220 <refsect1><title>CONFIGURATION FILES</title>
 221 <para>There are four user-editable files that control the behavior of Amanda.
 222 </para>
 223 <para>
 224 The first two are &amconf; and &amclientconf;,
 225 the main configuration files for the server and client, respectively.
 226 They contain parameters to customize Amanda for the site.
 227 </para>
 228 <para>
 229 Next is the &disklist; file, which lists hosts and disk partitions to back up.
 230 </para>
 231 <para>
 232 Last is the seldom-edited &tapelist;
 233 file, which lists tapes that are currently active.
 234 These files are described in more detail in the following sections.</para>
 235
 236 <para>All configuration files are stored in individual configuration
 237 directories, usually under <filename>/etc/amanda/</filename>.
 238 A site will often have more than
 239 one configuration.
 240 For example, it might have a
 241 <emphasis remap='I'>normal</emphasis>
 242 configuration for everyday backups and an
 243 <emphasis remap='I'>archive</emphasis>
 244 configuration for infrequent full archival backups.
 245 The configuration files would be stored under directories
 246 <filename>/etc/amanda/normal/</filename> and
 247 <filename>/etc/amanda/archive/</filename>, respectively.
 248 Part of the job of an Amanda administrator is to create,
 249 populate and maintain these directories.</para>
 250
 251 <para>Most Amanda applications take a "config" parameter; this is generally the
 252 (unqualified) name of the configuration directory, e.g.,
 253 <filename>normal</filename>.  If the parameter is <filename>.</filename> (dot),
 254 the current directory is used.  This feature is present for backward
 255 compatibility, but is not commonly used.</para>
 256
 257 <refsect2><title>Configuration Override</title>
 258 <para>Most commands allow the override of specific
 259 configuration options on the command line, using the <arg
 260 choice="plain">-o</arg> option.  This option has the form <arg
 261 choice="plain">-o</arg><replaceable>name</replaceable>=<replaceable>value</replaceable>.
 262 An optional space is allowed after the <arg choice="plain">-o</arg>.
 263 Each configuration option should be specified in a separate
 264 command-line option.</para>
 265
 266 <para>For global options, <replaceable>name</replaceable> is simply the name of the option, e.g.,
 267 <programlisting>
 268 amdump -oruntapes=2
 269 </programlisting>
 270 For options in a named section of the configuration, <replaceable>name</replaceable> has the
 271 form <replaceable>SECTION</replaceable>:<replaceable>section_name</replaceable>:<replaceable>name</replaceable>,
 272 where <replaceable>SECTION</replaceable> is one of TAPETYPE, DUMPTYPE, HOLDINGDISK, or INTERFACE, and
 273 <replaceable>section_name</replaceable> is the name of the tapetype, dumptype, holdingdisk, or interface.
 274 Examples:
 275 <programlisting>
 276 amdump -o TAPETYPE:HP-DAT:length=2000m
 277 amdump -o DUMPTYPE:no-compress:compress="server fast"
 278 amdump -o HOLDINGDISK:hd1:use="-100 mb"
 279 amdump -o INTERFACE:local:use="2000 kbps"
 280 </programlisting>
 281 </para>
 282
 283 <para>When overriding device properties, one must carefully quote the
 284   command line to simulate the syntax of real configuration files. The
 285   following example should serve as a guide:
 286 <programlisting>
 287 amdump -o 'device-property="PROPERTY_MAX_VOLUME_USAGE" "100000"'
 288 </programlisting></para>
 289
 290 <para>Note that configuration overrides are not effective for tape
 291 changers, which supply a tapedev based on their own configuration.  In order to
 292 override <emphasis remap="I">tapedev</emphasis>, you must also disable any changer:
 293 <programlisting>
 294 amdump -otapedev=/dev/nst1 -otpchanger=''
 295 </programlisting>
 296 </para>
 297
 298 </refsect2>
 299
 300 </refsect1>
 301
 302 </refentry>
 303