git.gag.com Git - debian/amanda/blob - man/xml-source/amanda-client.conf.5.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 <refentry id='amanda-client.conf.5'>
  11
  12 <refmeta>
  13 <refentrytitle>amanda-client.conf</refentrytitle>
  14 <manvolnum>5</manvolnum>
  15 </refmeta>
  16 <refnamediv>
  17 <refname>amanda-client.conf</refname>
  18 <refpurpose>Client configuration file for &A;, the Advanced Maryland Automatic Network Disk Archiver</refpurpose>
  19 </refnamediv>
  20 <!-- body begins here -->
  21
  22 <refsect1><title>DESCRIPTION</title>
  23 <para>&amclientconf; is the client configuration file for &A;. This manpage lists the
  24 relevant sections and parameters of this file for quick reference.</para>
  25 <para> The files <emphasis remap='B'>&lt;CONFIG_DIR&gt;/amanda-client.conf</emphasis> and <emphasis remap='B'>&lt;CONFIG_DIR&gt;/&lt;config&gt;/amanda-client.conf</emphasis> are loaded.</para>
  26 </refsect1>
  27
  28 <refsect1><title>PARAMETERS</title>
  29
  30 <para>There are a number of configuration parameters that control the
  31 behavior of the &A; programs.
  32 All have default values,
  33 so you need not specify the parameter in
  34 <emphasis remap='B'>amanda-client.conf</emphasis>
  35 if the default is suitable.</para>
  36
  37 <para>Lines starting with # are ignored, as are blank lines.
  38 Comments may be placed on a line with a directive by starting
  39 the comment with a #.
  40 The remainder of the line is ignored.</para>
  41
  42 <para>Keywords are case insensitive, i.e.
  43 <emphasis remap='B'>auth</emphasis>
  44 and
  45 <emphasis remap='B'>Auth</emphasis>
  46 are treated the same.</para>
  47
  48 <para>Integer arguments may have one of the following (case insensitive) suffixes,
  49 some of which have a multiplier effect:</para>
  50
  51 <refsect2><title>POSSIBLE SUFFIXES</title>
  52
  53 <variablelist remap='TP'>
  54   <varlistentry>
  55   <term><emphasis remap='B'>b byte bytes</emphasis></term>
  56   <listitem>
  57 <para>Some number of bytes.</para>
  58   </listitem>
  59   </varlistentry>
  60   <varlistentry>
  61   <term><emphasis remap='B'>bps</emphasis></term>
  62   <listitem>
  63 <para>Some number of bytes per second.</para>
  64   </listitem>
  65   </varlistentry>
  66   <varlistentry>
  67   <term><emphasis remap='B'>k kb kbyte kbytes kilobyte kilobytes</emphasis></term>
  68   <listitem>
  69 <para>Some number of kilobytes (bytes*1024).</para>
  70   </listitem>
  71   </varlistentry>
  72   <varlistentry>
  73   <term><emphasis remap='B'>kps kbps</emphasis></term>
  74   <listitem>
  75 <para>Some number of kilobytes per second (bytes*1024).</para>
  76   </listitem>
  77   </varlistentry>
  78   <varlistentry>
  79   <term><emphasis remap='B'>m mb meg mbyte mbytes megabyte megabytes</emphasis></term>
  80   <listitem>
  81 <para>Some number of megabytes (bytes*1024*1024).</para>
  82   </listitem>
  83   </varlistentry>
  84   <varlistentry>
  85   <term><emphasis remap='B'>mps mbps</emphasis></term>
  86   <listitem>
  87 <para>Some number of megabytes per second (bytes*1024*1024).</para>
  88   </listitem>
  89   </varlistentry>
  90   <varlistentry>
  91   <term><emphasis remap='B'>g gb gbyte gbytes gigabyte gigabytes</emphasis></term>
  92   <listitem>
  93 <para>Some number of gigabytes (bytes*1024*1024*1024).</para>
  94   </listitem>
  95   </varlistentry>
  96   <varlistentry>
  97   <term><emphasis remap='B'>tape tapes</emphasis></term>
  98   <listitem>
  99 <para>Some number of tapes.</para>
 100   </listitem>
 101   </varlistentry>
 102   <varlistentry>
 103   <term><emphasis remap='B'>day days</emphasis></term>
 104   <listitem>
 105 <para>Some number of days.</para>
 106   </listitem>
 107   </varlistentry>
 108   <varlistentry>
 109   <term><emphasis remap='B'>week weeks</emphasis></term>
 110   <listitem>
 111 <para>Some number of weeks (days*7).</para>
 112
 113 <note>The value
 114 <emphasis remap='B'>inf</emphasis>
 115 may be used in most places where an integer is expected
 116 to mean an infinite amount.
 117
 118 <para>Boolean arguments may have any of the values
 119 <emphasis remap='B'>y</emphasis>,
 120 <emphasis remap='B'>yes</emphasis>,
 121 <emphasis remap='B'>t</emphasis>,
 122 <emphasis remap='B'>true</emphasis>
 123 or
 124 <emphasis remap='B'>on</emphasis>
 125 to indicate a true state, or
 126 <emphasis remap='B'>n</emphasis>,
 127 <emphasis remap='B'>no</emphasis>,
 128 <emphasis remap='B'>f</emphasis>,
 129 <emphasis remap='B'>false</emphasis>
 130 or
 131 <emphasis remap='B'>off</emphasis>
 132 to indicate a false state.
 133 If no argument is given,
 134 <emphasis remap='B'>true</emphasis>
 135 is assumed.
 136 </para>
 137 </note>
 138   </listitem>
 139   </varlistentry>
 140 </variablelist>
 141 </refsect2>
 142
 143 <refsect2>
 144 <title>PARAMETERS</title>
 145
 146 <variablelist remap='TP'>
 147   <varlistentry>
 148   <term><emphasis remap='B'>conf</emphasis> <emphasis remap='I'> string</emphasis></term>
 149   <listitem>
 150 <para>Default:
 151 <emphasis remap='I'>Set by configure</emphasis>.
 152 The conf use by amrecover.</para>
 153   </listitem>
 154   </varlistentry>
 155
 156   <varlistentry>
 157   <term><emphasis remap='B'>index_server</emphasis> <emphasis remap='I'> string</emphasis></term>
 158   <listitem>
 159 <para>Default:
 160 <emphasis remap='I'>Set by configure</emphasis>.
 161 The amindexd server amrecover will connect to.</para>
 162   </listitem>
 163   </varlistentry>
 164
 165   <varlistentry>
 166   <term><emphasis remap='B'>tape_server</emphasis> <emphasis remap='I'> string</emphasis></term>
 167   <listitem>
 168 <para>Default:
 169 <emphasis remap='I'>Set by configure</emphasis>.
 170 The amidxtaped server amrecover will connect to.</para>
 171   </listitem>
 172   </varlistentry>
 173
 174   <varlistentry>
 175   <term><emphasis remap='B'>tapedev</emphasis> <emphasis remap='I'> string</emphasis></term>
 176   <listitem>
 177 <para>Default:
 178 <emphasis remap='I'>Set by configure</emphasis>.
 179 The tapedev amrecover will use.</para>
 180   </listitem>
 181   </varlistentry>
 182
 183   <varlistentry>
 184   <term><emphasis remap='B'>auth</emphasis> <emphasis remap='I'> string</emphasis></term>
 185   <listitem>
 186 <para>Default:
 187 <emphasis remap='I'>bsd</emphasis>.
 188 Type of authorization to perform between tape server and backup client hosts.</para>
 189 <para><emphasis remap='B'>bsd</emphasis>, bsd authorization with udp initial
 190 connection and one tcp connection by data stream.</para>
 191 <para><emphasis remap='B'>bsdtcp</emphasis>, bsd authorization but use only
 192 one tcp connection.</para>
 193 <para><emphasis remap='B'>bsdudp</emphasis>, like bsd, but will use only one
 194 tcp connection for all data stream.</para>
 195 <para><emphasis remap='B'>krb4</emphasis> to use Kerberos-IV
 196 authorization.</para>
 197 <para><emphasis remap='B'>krb5</emphasis> to use Kerberos-V
 198 authorization.</para>
 199 <para><emphasis remap='B'>rsh</emphasis> to use rsh
 200 authorization.</para>
 201 <para><emphasis remap='B'>ssh</emphasis> to use OpenSSH
 202 authorization.</para>
 203
 204   </listitem>
 205   </varlistentry>
 206
 207   <varlistentry>
 208   <term><emphasis remap='B'>ssh_keys</emphasis> <emphasis remap='I'> string</emphasis></term>
 209   <listitem>
 210 <para>Default:
 211 <emphasis remap='I'>No default</emphasis>.
 212 The key file the ssh auth will use, it must be the private key. If this parameter is not specified, then the deafult ssh key will be used.</para>
 213   </listitem>
 214   </varlistentry>
 215
 216   <varlistentry>
 217   <term><emphasis remap='B'>gnutar_list_dir</emphasis> <emphasis remap='I'> string</emphasis></term>
 218   <listitem>
 219 <para>Default from configure
 220 <emphasis remap='I'>--with-gnutar-listdir=DIR</emphasis>.
 221 The directory where gnutar keep its state file.</para>
 222   </listitem>
 223   </varlistentry>
 224
 225   <varlistentry>
 226   <term><emphasis remap='B'>amandates</emphasis> <emphasis remap='I'> string</emphasis></term>
 227   <listitem>
 228 <para>Default:
 229 <emphasis remap='I'>/etc/amandates</emphasis>.
 230 The file where amanda keep the last date of each dumplevel.</para>
 231   </listitem>
 232   </varlistentry>
 233
 234 </variablelist>
 235 </refsect2>
 236 </refsect1>
 237
 238 <refsect1><title>AUTHOR</title>
 239 <para>James da Silva, &email.jds;: Original text</para>
 240 <para>&maintainer.sgw;: XML-conversion, major update, splitting</para>
 241 </refsect1>
 242
 243 <refsect1><title>SEE ALSO</title>
 244 <para>
 245 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 246 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 247 <citerefentry><refentrytitle>amcrypt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 248 <citerefentry><refentrytitle>aespipe</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 249 </para>
 250 </refsect1>
 251 </refentry>
 252