<refsect1><title>DESCRIPTION</title>
<para>&amconf; is the main configuration file for &A;. This manpage lists the
relevant sections and parameters of this file for quick reference.</para>
+<para> The file <emphasis remap='B'><CONFIG_DIR>/<config>/amanda.conf</emphasis> is loaded.</para>
</refsect1>
<refsect1><title>PARAMETERS</title>
<listitem>
<para>Some number of weeks (days*7).</para>
-<note>The value
+<note><para>The value
<emphasis remap='B'>inf</emphasis>
may be used in most places where an integer is expected
-to mean an infinite amount.
+to mean an infinite amount.</para>
<para>Boolean arguments may have any of the values
<emphasis remap='B'>y</emphasis>,
The number of days in the backup cycle.
Each disk will get a full backup at least this often.
Setting this to zero tries to do a full backup each run.</para>
-<note>This parameter may also be set in a specific
+<note><para>This parameter may also be set in a specific
<emphasis remap='B'>dumptype</emphasis>
(see below).
This value sets the default for all
<emphasis remap='B'>amanda.conf</emphasis>
before any
<emphasis remap='B'>dumptype</emphasis>s
-are defined.</note>
+are defined.</para>
+</note>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term><emphasis remap='B'>runspercycle</emphasis> <emphasis remap='I'> int</emphasis></term>
<listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>label_new_tapes</emphasis>
- <emphasis remap='I'> string</emphasis></term>
-<listitem>
- <para>Default: not set.
-When set, this directive will cause &A; to automatically write an &A;
-tape label to any blank tape she encounters. This option is DANGEROUS
-because when set, &A; will ERASE any non-&A; tapes you may have, and may
-also ERASE any near-failing tapes. Use with caution.</para>
-<para>When using this directive, specify the template for new tape
-labels. The template should contain some number of contiguous '%'
-characters, which will be replaced with a generated number. Be sure to
-specify enough '%' characters that you do not run out of tape labels.
-Example:
-<markup>label_new_tapes "DailySet1-%%%"</markup>
-</para>
-</listitem>
-</varlistentry>
+ <term><emphasis remap='B'>usetimestamps</emphasis>
+ <emphasis remap='I'> bool</emphasis></term>
+ <listitem>
+ <para>Default: <emphasis remap='B'>Yes</emphasis>.
+This option allows Amanda to track multiple runs per calendar
+day. The only reason one might disable it is that Amanda versions before 2.5.1
+can't read logfiles written when this option was enabled.
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry>
-=======
<term><emphasis remap='B'>label_new_tapes</emphasis>
<emphasis remap='I'> string</emphasis></term>
<listitem>
<para>Default: not set.
-When set, this directive will cause &A; to automatically write an Amanda
-tape label to any black tape she encounters. This option is DANGEROUS
+When set, this directive will cause &A; to automatically write an &A;
+tape label to any blank tape she encounters. This option is DANGEROUS
because when set, &A; will ERASE any non-&A; tapes you may have, and may
also ERASE any near-failing tapes. Use with caution.</para>
<para>When using this directive, specify the template for new tape
option.</para>
</listitem>
</varlistentry>
+
<varlistentry>
<term><emphasis remap='B'>tapedev</emphasis> string</term>
<listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>rawtapedev</emphasis> string</term>
+ <term><emphasis remap='B'>device_property</emphasis> string string</term>
<listitem>
-<para>Default:
-<filename>null:</filename>.
-The path name of the raw tape device.
-This is only used if &A; is compiled for Linux machines with floppy tapes
-and is needed for QIC volume table operations.</para>
+<para>These options can set various device properties, including block size,
+maximum volume usage, authentication information, hardware feature support,
+and more.Specifics of how properties are used are device-dependent, though
+some common properties are supported across multiple device drivers.</para>
+
+<para> Both strings are quoted; the first string contains the name of
+the property to set, and the second contains its value. For example, to set
+a fixed block size of 128k, do:</para><programlisting>device_property "BLOCK_SIZE" "131072"</programlisting>
+<para></para>
+<para>The order in which device properties are set is as follows:
+<orderedlist><listitem><para>Tapetype parameters, including length, blocksize,
+readblocksize, file-pad, are translated into device properties and set
+accordingly.</para></listitem>
+<listitem><para>Device properties from any device_property configuration directives
+are set, in the order they appear in the configuration file.</para></listitem>
+</orderedlist></para>
</listitem>
</varlistentry>
+
<varlistentry>
<term><emphasis remap='B'>tpchanger</emphasis> string</term>
<listitem>
will wait before it fails with a data timeout error.</para>
</listitem>
</varlistentry>
+
<varlistentry>
<term><emphasis remap='B'>etimeout</emphasis> int</term>
<listitem>
<para>Default:
<emphasis remap='I'>300 seconds</emphasis>.
-Amount of time per disk on a given client that the
-<emphasis remap='B'>planner</emphasis>
-step of
-<command>amdump</command>
-will wait to get the dump size estimates.
-For instance, with the default of 300 seconds and four disks on client A,
-<emphasis remap='B'>planner</emphasis>
-will wait up to 20 minutes for that machine.
-A negative value will be interpreted as a total amount of time to wait
+Amount of time per estimate on a given client that the
+<emphasis remap='B'>planner</emphasis> step of
+<command>amdump</command> will wait to get the dump size estimates
+(note: Amanda runs up to 3 estimates for each DLE). For instance,
+with the default of 300 seconds and four DLE's, each estimating level
+0 and level 1 on client A, <emphasis remap='B'>planner</emphasis>
+will wait up to 40 minutes for that machine. A negative value will
+be interpreted as a total amount of time to wait
per client instead of per disk.</para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term><emphasis remap='B'>connect_tries</emphasis> int</term>
+ <listitem>
+<para>Default:
+<emphasis remap='I'>3</emphasis>.
+How many times the server will try a connection.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis remap='B'>req_tries</emphasis> int</term>
+ <listitem>
+<para>Default:
+<emphasis remap='I'>3</emphasis>.
+How many times the server will resend a REQ packet if it doesn't get the ACK packet.</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><emphasis remap='B'>netusage</emphasis> int</term>
<listitem>
<para>Default:
-<emphasis remap='I'>300 Kbps</emphasis>.
+<emphasis remap='I'>8000 Kbps</emphasis>.
The maximum network bandwidth allocated to &A;, in Kbytes per second.
See also the
<emphasis remap='B'>interface</emphasis>
<listitem>
<para>Default:
<emphasis remap='I'>tttTTTTTTT</emphasis>.
-The priority order of each dumper:</para>
+The priority order of each dumper:
-<itemizedlist>
-<listitem><para>s: smallest size</para></listitem>
-<listitem><para>S: largest size</para></listitem>
-<listitem><para>t: smallest time</para></listitem>
-<listitem><para>T: largest time</para></listitem>
-<listitem><para>b: smallest bandwidth</para></listitem>
-<listitem><para>B: largest bandwidth</para></listitem>
-</itemizedlist>
+<programlisting>
+s: smallest size
+S: largest size
+t: smallest time
+T: largest time
+b: smallest bandwidth
+B: largest bandwidth
+</programlisting></para>
</listitem>
</varlistentry>
<emphasis remap='I'>tapelist</emphasis>
file.
&A; maintains this file with information about the active set of tapes.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>device_output_buffer_size</emphasis> <emphasis remap='I'> int</emphasis></term>
+ <listitem>
+<para>Default:
+<literal>640k</literal>.
+Controls the amount of memory used by &A;
+to hold data as it is read from the network or disk before it is written to
+the output device. Higher values may be
+useful on fast tape drives and optical media.</para>
</listitem>
</varlistentry>
<varlistentry>
<listitem>
<para>Default:
<literal>20</literal>.
-The number of buffers used by the
-<emphasis remap='B'>taper</emphasis>
-process run by
-<command>amdump</command>
-and
-<emphasis remap='B'>amflush</emphasis>
-to hold data as it is read from the network or disk before it is written to tape.
-Each buffer is a little larger than 32 KBytes and is held in a shared memory region.</para>
+This option is deprecated; use
+the <emphasis remap='B'>device_output_buffer_size</emphasis> directive
+instead. <emphasis remap='B'>tapebufs</emphasis> works the same way,
+but the number specified is multiplied by the device blocksize prior
+to use.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis remap='B'>amrecover_do_fsf</emphasis> <emphasis remap='I'> bool</emphasis></term>
<listitem>
<para>Default:
-<emphasis remap='I'>off</emphasis>.
+<emphasis remap='I'>on</emphasis>.
Amrecover will call amrestore with the -f flag for faster positioning of the tape.</para>
</listitem>
</varlistentry>
<term><emphasis remap='B'>amrecover_check_label</emphasis> <emphasis remap='I'> bool</emphasis></term>
<listitem>
<para>Default:
-<emphasis remap='I'>off</emphasis>.
+<emphasis remap='I'>on</emphasis>.
Amrecover will call amrestore with the -l flag to check the label.</para>
</listitem>
</varlistentry>
of three parts which are separated by a equal sign ('=') and a colon (':') (see the example).
These three parts specify:</para>
- <itemizedlist>
+ <orderedlist>
<listitem>
<para>the name of the column, which may be:</para>
- <itemizedlist>
- <listitem><para>Compress (compression ratio)</para></listitem>
- <listitem><para>Disk (client disk name)</para></listitem>
- <listitem><para>DumpRate (dump rate in KBytes/sec)</para></listitem>
- <listitem><para>DumpTime (total dump time in hours:minutes)</para></listitem>
- <listitem><para>HostName (client host name)</para></listitem>
- <listitem><para>Level (dump level)</para></listitem>
- <listitem><para>OrigKB (original image size in KBytes)</para></listitem>
- <listitem><para>OutKB (output image size in KBytes)</para></listitem>
- <listitem><para>TapeRate (tape writing rate in KBytes/sec)</para></listitem>
- <listitem><para>TapeTime (total tape time in hours:minutes)</para></listitem>
- </itemizedlist>
+ <programlisting>
+ Compress (compression ratio)
+ Disk (client disk name)
+ DumpRate (dump rate in KBytes/sec)
+ DumpTime (total dump time in hours:minutes)
+ HostName (client host name)
+ Level (dump level)
+ OrigKB (original image size in KBytes)
+ OutKB (output image size in KBytes)
+ TapeRate (tape writing rate in KBytes/sec)
+ TapeTime (total tape time in hours:minutes)
+ </programlisting>
</listitem>
<listitem>
-<para>the amount of space to display before the column (used to get whitespace between columns).</para>
+<para>the amount of space to display before the column (used to get whitespace between columns).</para><para/>
</listitem>
<listitem>
<para>the width of the column itself.
If set to a negative value, the width will be calculated on demand to fit the largest entry in
this column.</para>
</listitem>
- </itemizedlist>
-
-<para>Here is an example:</para>
+ </orderedlist>
+<para>Here is an example:
<programlisting>
-<para>columnspec "Disk=1:18,HostName=0:10,OutKB=1:7"</para>
-</programlisting>
+columnspec "Disk=1:18,HostName=0:10,OutKB=1:7"
+</programlisting></para>
+<para>
The above will display the disk information in 18 characters
and put one space before it. The hostname column will be 10 characters wide with
no space to the left. The output KBytes column is seven characters wide
-with one space before it.
+with one space before it.</para>
</listitem>
</varlistentry>
<para>Default:
<emphasis remap='I'>none</emphasis>.
The name of an &A; configuration file to include within the current file.
-Useful for sharing dumptypes, tapetypes and interface definitions among several configurations.</para>
+Useful for sharing dumptypes, tapetypes and interface definitions among several configurations.
+Relative pathnames are relative to the configuration directory.
+</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis remap='B'>debug_auth</emphasis> int</term>
+ <listitem>
+<para>Default:
+<emphasis remap='I'>0</emphasis>.
+Debug level of the auth module</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis remap='B'>debug_event</emphasis> int</term>
+ <listitem>
+<para>Default:
+<emphasis remap='I'>0</emphasis>.
+Debug level of the event module</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis remap='B'>debug_holding</emphasis> int</term>
+ <listitem>
+<para>Default:
+<emphasis remap='I'>0</emphasis>.
+Debug level of the holdingdisk module</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis remap='B'>debug_protocol</emphasis> int</term>
+ <listitem>
+<para>Default:
+<emphasis remap='I'>0</emphasis>.
+Debug level of the protocol module</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis remap='B'>debug_planner</emphasis> int</term>
+ <listitem>
+<para>Default:
+<emphasis remap='I'>0</emphasis>.
+Debug level of the planner process</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis remap='B'>debug_driver</emphasis> int</term>
+ <listitem>
+<para>Default:
+<emphasis remap='I'>0</emphasis>.
+Debug level of the driver process</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis remap='B'>debug_dumper</emphasis> int</term>
+ <listitem>
+<para>Default:
+<emphasis remap='I'>0</emphasis>.
+Debug level of the dumper process</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis remap='B'>debug_chunker</emphasis> int</term>
+ <listitem>
+<para>Default:
+<emphasis remap='I'>0</emphasis>.
+Debug level of the chunker process</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis remap='B'>debug_taper</emphasis> int</term>
+ <listitem>
+<para>Default:
+<emphasis remap='I'>0</emphasis>.
+Debug level of the taper process</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis remap='B'>flush-threshold-dumped</emphasis> int</term>
+ <listitem>
+<para>Default: <emphasis remap='I'>0</emphasis>.
+ &A; will not begin writing data to a new volume until the amount of
+ data on the holding disk is at least this percentage of the volume
+ size. In other words, &A; will not begin until the
+ inequality <inlineequation><mathphrase>h < t ×
+ d</mathphrase></inlineequation> is satisfied,
+ where <mathphrase>h</mathphrase> is the amount of data on the
+ holding disk, <mathphrase>t</mathphrase> is the capacity of a
+ volume, and <mathphrase>d</mathphrase> is this parameter, expressed as a
+ percentage.</para>
+<para> Needless to say, your holding disk must be big enough
+ that this criterion could be satisfied. If the holding disk cannot
+ be used for a particular dump (because, for example, there is no
+ remaining holding space) then &A; will disregard the constraint
+ specified by this setting and start a new volume anyway. Once
+ writing to a volume has begun, this constraint is not applied unless
+ and until a new volume is needed.</para>
+<para> The value of this parameter may not exceed than that of
+ the <emphasis remap='B'>flush-threshold-scheduled</emphasis>
+ parameter.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis remap='B'>flush-threshold-scheduled</emphasis> int</term>
+ <listitem>
+<para>Default: <emphasis remap='I'>0</emphasis>.
+ &A; will not begin writing data to a new volume until the sum of the
+ amount of data on the holding disk and the estimated amount of data
+ remaining to be dumped during this run is at least this percentage
+ of the volume size. In other words, &A; will not begin until the
+ inequality <inlineequation><mathphrase>h + s < t ×
+ d</mathphrase></inlineequation> is satisfied,
+ where <mathphrase>h</mathphrase> is the amount of data on the
+ holding disk, <mathphrase>s</mathphrase> is the total amount of
+ data scheduled for this run but not dumped
+ yet, <mathphrase>t</mathphrase> is the capacity of a volume,
+ and <mathphrase>d</mathphrase> is this parameter, expressed as a
+ percentage.</para>
+<para> Needless to say, your holding disk must be big enough
+ that this criterion could be satisfied. If the holding disk cannot
+ be used for a particular dump (because, for example, there is no
+ remaining holding space) then &A; will disregard the constraint
+ specified by this setting and start a new volume anyway. Once
+ writing to a volume has begun, this constraint is not applied unless
+ and until a new volume is needed.</para>
+<para> The value of this parameter may not be less than that of
+ the <emphasis remap='B'>flush-threshold-dumped</emphasis>
+ or <emphasis remap='B'>taperflush</emphasis> parameters.</para>
+ </listitem>
+ </varlistentry>
+
+<!-- the entity '#215' below is U+00D7 MULTIPLICATION SIGN; the 'times' entity
+ is not as portable as one might hope. -->
+ <varlistentry>
+ <term><emphasis remap='B'>taperflush</emphasis> int</term>
+ <listitem>
+<para>Default: <emphasis remap='I'>0</emphasis>.
+ At the end of a run, &A; will start a new tape to flush remaining
+ data if there is more data on the holding disk at the end of a run
+ than this setting allows; the amount is specified as a percentage of
+ the capacity of a single
+ volume. In other words, at the end of a run, &A; will begin
+ a new tape if the
+ inequality <inlineequation><mathphrase>h < t ×
+ f</mathphrase></inlineequation> is satisfied,
+ where <mathphrase>h</mathphrase> is the amount of data remaining on the
+ holding disk from this or previous runs, <mathphrase>t</mathphrase>
+ is the capacity of a volume,
+ and <mathphrase>f</mathphrase> is this parameter, expressed as a
+ percentage.</para>
+<para> The value of this parameter may not exceed that of
+ the <emphasis remap='B'>flush-threshold-scheduled</emphasis>
+ parameter.; <emphasis remap='B'>autoflush</emphasis> must be set to 'yes' if
+ <emphasis remap='B'>taperflush</emphasis> is greater than 0.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis remap='B'>reserved-udp-port</emphasis> int,int</term>
+ <listitem>
+<para>Default: --with-udpportrange or
+<emphasis remap='I'>512,1023</emphasis>.
+Reserved udp port that will be used (bsd, bsdudp).
+Range is inclusive.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis remap='B'>reserved-tcp-port</emphasis> int,int</term>
+ <listitem>
+<para>Default: --with-low-tcpportrange or
+<emphasis remap='I'>512,1023</emphasis>.
+Reserved tcp port that will be used (bsdtcp).
+Range is inclusive.</para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term><emphasis remap='B'>unreserved-tcp-port</emphasis> int,int</term>
+ <listitem>
+<para>Default: --with-tcpportrange or
+<emphasis remap='I'>1024,65535</emphasis>.
+Unreserved tcp port that will be used (bsd, bsdudp).
+Range is inclusive.</para>
+ </listitem>
+ </varlistentry>
+
</variablelist>
</refsect2>
</refsect1>
holdingdisk <emphasis remap='I'>name</emphasis> {
<emphasis remap='I'>holdingdisk-option</emphasis> <emphasis remap='I'>holdingdisk-value</emphasis>
<literal>...</literal>
-}</programlisting>
+}
+</programlisting>
<para><emphasis remap='I'>Name</emphasis>
is a logical name for this holding disk.</para>
A comment string describing this holding disk.</para>
</listitem>
</varlistentry>
+
<varlistentry>
<term><emphasis remap='B'>directory</emphasis> <emphasis remap='I'> disk</emphasis></term>
<listitem>
The path to this holding area.</para>
</listitem>
</varlistentry>
+
<varlistentry>
<term><emphasis remap='B'>use</emphasis> <emphasis remap='I'> int</emphasis></term>
<listitem>
-Default:
+<para>Default:
<emphasis remap='I'>0 Gb</emphasis>.
Amount of space that can be used in this holding disk area.
If the value is zero, all available space on the file system is used.
-If the value is negative, &A; will use all available space minus that value.
+If the value is negative, &A; will use all available space minus that value.</para>
</listitem>
</varlistentry>
+
<varlistentry>
<term><emphasis remap='B'>chunksize</emphasis> <emphasis remap='I'> int</emphasis></term>
<listitem>
-Default:
+<para>Default:
<emphasis remap='I'>1 Gb</emphasis>.
Holding disk chunk size. Dumps larger than the specified size will be stored in multiple
holding disk files. The size of each chunk will not exceed the specified value.
However, even though dump images are split in the holding disk, they are concatenated as
they are written to tape, so each dump image still corresponds to a single continuous
-tape section.
+tape section.</para>
-If 0 is specified, &A; will create holding disk chunks as large as
-((INT_MAX/1024)-64) Kbytes.
+<para>If 0 is specified, &A; will create holding disk chunks as large as
+((INT_MAX/1024)-64) Kbytes.</para>
-Each holding disk chunk includes a 32 Kbyte header, so the minimum
-chunk size is 64 Kbytes (but that would be really silly).
+<para>Each holding disk chunk includes a 32 Kbyte header, so the minimum
+chunk size is 64 Kbytes (but that would be really silly).</para>
-Operating systems that are limited to a maximum file size of 2 Gbytes
+<para>Operating systems that are limited to a maximum file size of 2 Gbytes
actually cannot handle files that large.
They must be at least one byte less than 2 Gbytes.
Since &A; works with 32 Kbyte blocks, and
to handle the final read at the end of the chunk, the chunk size
should be at least 64 Kbytes (2 * 32 Kbytes) smaller than the maximum
-file size, e.g. 2047 Mbytes.
+file size, e.g. 2047 Mbytes.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Default:
<emphasis remap='I'>bsd</emphasis>.
Type of authorization to perform between tape server and backup client hosts.</para>
+<para><emphasis remap='B'>bsd</emphasis>, bsd authorization with udp initial
+connection and one tcp connection by data stream.</para>
+<para><emphasis remap='B'>bsdtcp</emphasis>, bsd authorization but use only
+one tcp connection.</para>
+<para><emphasis remap='B'>bsdudp</emphasis>, like bsd, but will use only one
+tcp connection for all data stream.</para>
<para><emphasis remap='B'>krb4</emphasis> to use Kerberos-IV
authorization.</para>
<para><emphasis remap='B'>krb5</emphasis> to use Kerberos-V
authorization.</para>
+<para><emphasis remap='B'>local</emphasis>, if the client is the server, it
+doesn't require authencation setup.</para>
+<para><emphasis remap='B'>rsh</emphasis> to use rsh
+authorization.</para>
<para><emphasis remap='B'>ssh</emphasis> to use OpenSSH
authorization.</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>amandad_path</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <listitem>
+<para>Default:
+<emphasis remap='I'>$libexec/amandad</emphasis>.
+Specify the amandad path of the client, only use with rsh/ssh authentification.
+</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis remap='B'>client_username</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <listitem>
+<para>Default:
+<emphasis remap='I'>CLIENT_LOGIN</emphasis>.
+Specify the username to connect on the client, only use with rsh/ssh authentification.
+</para>
+ </listitem>
+ </varlistentry>
+
<!-- bumping parameters yanked from the global section above -->
<varlistentry>
but usually less CPU overhead. Or to specify <emphasis remap='B'>Custom</emphasis>
to use your own compression method. (See dumptype custom-compress in example/amanda.conf for reference)</para>
-
-
<para>So the <emphasis remap='B'>compress</emphasis> options line may be one of:</para>
-<itemizedlist>
-<listitem><para>compress none</para></listitem>
-<listitem><para>compress [client] fast</para></listitem>
-<listitem><para>compress [client] best</para></listitem>
-<listitem><para>compress client custom</para>
-<para>Specify client_custom_compress "PROG"</para>
-<para>PROG must not contain white space and it must accept -d for uncompress.</para></listitem>
-<listitem><para>compress server fast</para></listitem>
-<listitem><para>compress server best</para></listitem>
-<listitem><para>compress server custom</para>
-<para>Specify server_custom_compress "PROG"</para>
-<para>PROG must not contain white space and it must accept -d for uncompress.</para></listitem>
-</itemizedlist>
-
+<variablelist remap='TP'>
+ <varlistentry>
+ <term>compress none</term><listitem><para/></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>compress client fast</term><listitem><para/></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>compress client best</term><listitem><para/></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>compress client custom</term>
+ <listitem>
+ <para>Specify <emphasis>client_custom_compress</emphasis> "PROG"</para>
+ <para>PROG must not contain white space and it must accept -d for uncompress.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>compress server fast</term><listitem><para/></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>compress server best</term><listitem><para/></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>compress server custom</term>
+ <listitem>
+ <para>Specify <emphasis>server_custom_compress</emphasis> "PROG"</para>
+ <para>PROG must not contain white space and it must accept -d for uncompress.</para>
+ </listitem>
+ </varlistentry>
+</variablelist>
<para>Note that some tape devices do compression and this option has nothing
to do with whether that is used. If hardware compression is used (usually via a particular tape device name
or <emphasis remap='B'>mt</emphasis> option), &A; (software) compression should be disabled.</para>
<para>So the <emphasis remap='B'>encrypt</emphasis> options line may be one
of:</para>
-<itemizedlist>
-<listitem><para>encrypt none</para></listitem>
-<listitem><para>encrypt client</para>
-<para>Specify client_encrypt "PROG"</para>
-<para>PROG must not contain white space.</para>
-<para>Specify client_decrypt_option "decryption-parameter" Default: "-d"</para>
-<para>decryption-parameter must not contain white space.</para>
-<para>(See dumptype encrypt-fast in example/amanda.conf for reference)</para>
-</listitem>
-<listitem><para>encrypt server</para>
-<para>Specify server_encrypt "PROG"</para>
-<para>PROG must not contain white space.</para>
-<para>Specify server_decrypt_option "decryption-parameter" Default: "-d"</para>
-<para>decryption-parameter must not contain white space.</para>
-</listitem>
-</itemizedlist>
-</listitem>
+<variablelist remap='TP'>
+ <varlistentry>
+ <term>encrypt none</term><listitem><para/></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>encrypt client</term>
+ <listitem>
+ <para>Specify client_encrypt "PROG"</para>
+ <para>PROG must not contain white space.</para>
+ <para>Specify client_decrypt_option "decryption-parameter" Default: "-d"</para>
+ <para>decryption-parameter must not contain white space.</para>
+ <para>(See dumptype server-encrypt-fast in example/amanda.conf for reference)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>encrypt server</term>
+ <listitem>
+ <para>Specify server_encrypt "PROG"</para>
+ <para>PROG must not contain white space.</para>
+ <para>Specify server_decrypt_option "decryption-parameter" Default: "-d"</para>
+ <para>decryption-parameter must not contain white space.</para>
+ <para>(See dumptype client-encrypt-nocomp in example/amanda.conf for reference)</para>
+ </listitem>
+ </varlistentry>
+</variablelist>
<para>Note that current logic assumes compression then encryption during
backup(thus decrypt then uncompress during restore). So specifying
client-encryption AND server-compression is not supported.
<emphasis remap='I'>amcrypt</emphasis> which is a wrapper of
<emphasis remap='I'>aespipe</emphasis> is provided as a reference
- encryption program.</para>
+ symmetric encryption program.</para>
+</listitem>
</varlistentry>
<listitem>
<para>Default: <emphasis remap='I'>client</emphasis>.
Determine the way &A; does it's estimate.</para>
-<itemizedlist>
-<listitem>
-<para>client:</para>
-<para>
-Use the same program as the dumping program, this is the most accurate way to do estimates, but it can take a long time.
-</para>
-</listitem>
-<listitem>
-<para>calcsize:</para>
-<para>Use a faster program to do estimates, but the result is less accurate.</para>
-</listitem>
-<listitem>
-<para>server:</para>
-<para>Use only statistics from the previous run to give an estimate,
-it takes only a few seconds but the result is not accurate if your disk
-usage changes from day to day.
-</para>
- </listitem>
- </itemizedlist>
- </listitem>
+<variablelist remap='TP'>
+ <varlistentry>
+ <term>client</term>
+ <listitem>
+ <para>Use the same program as the dumping program, this is the most
+ accurate way to do estimates, but it can take a long time.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>calcsize</term>
+ <listitem>
+ <para>Use a faster program to do estimates, but the result is less accurate.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>server</term>
+ <listitem>
+ <para>Use only statistics from the previous run to give an estimate,
+ it takes only a few seconds but the result is not accurate if your disk
+ usage changes from day to day.</para>
+ </listitem>
</varlistentry>
+</variablelist>
+</listitem>
+</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>exclude</emphasis> [ <emphasis remap='I'>list|file</emphasis> ][[optional][ <emphasis remap='I'>append</emphasis> ][ <emphasis remap='I'> string</emphasis> ]+]</term>
+ <term><emphasis remap='B'>exclude</emphasis> [ list|file ][[optional][ append ][ <emphasis remap='I'>string</emphasis> ]+]</term>
<listitem>
<para>Default:
<emphasis remap='I'>file</emphasis>.
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>holdingdisk</emphasis> <emphasis remap='I'> boolean</emphasis></term>
+ <term><emphasis remap='B'>holdingdisk</emphasis> [ never|auto|required ]</term>
<listitem>
<para>Default:
-<emphasis remap='I'>yes</emphasis>.
+<emphasis remap='I'>auto</emphasis>.
Whether a holding disk should be used for these backups or whether they should go directly to tape.
If the holding disk is a portion of another file system that &A;
is backing up, that file system should refer to a dumptype with
<emphasis remap='B'>holdingdisk</emphasis>
set to
-<emphasis remap='I'>no</emphasis>
+<emphasis remap='I'>never</emphasis>
to avoid backing up the holding disk into itself.</para>
+
+ <variablelist remap='TP'>
+ <varlistentry>
+ <term><emphasis remap='B'>never</emphasis>|no|false|off</term>
+ <listitem>
+ <para>Never use a holdingdisk, the dump will always go directly to tape. There will be no dump if you have a tape error.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>auto</emphasis>|yes|true|on</term>
+ <listitem>
+ <para>Use the holding disk, unless there is a problem with the holding disk, the dump won't fit there or the medium doesn't require spooling (e.g., VFS device)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>required</emphasis></term>
+ <listitem>
+ <para>Always dump to holdingdisk, never directly to tape. There will be no dump if it doesn't fit on holdingdisk</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
</listitem>
</varlistentry>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>include</emphasis> [ <emphasis remap='I'>list|file</emphasis> ][[optional][ <emphasis remap='I'>append</emphasis> ][ <emphasis remap='I'> string</emphasis> ]+]</term>
+ <term><emphasis remap='B'>include</emphasis> [ list|file ][[optional][ append ][ <emphasis remap='I'>string</emphasis> ]+]</term>
<listitem>
<para>Default:
<emphasis remap='I'>file</emphasis>
<para>Include expressions must always be specified as relative to the
head directory of the DLE.</para>
-<note>For globbing to work at all, even the limited single level,
-the top level directory of the DLE must be readable by the &A; user.</note>
+<note><para>For globbing to work at all, even the limited single level,
+the top level directory of the DLE must be readable by the &A; user.</para>
+</note>
<para>With the <emphasis remap='B'>append</emphasis> keyword, the
<emphasis remap='I'>string</emphasis> is appended to the current list, without it, the
<term><emphasis remap='B'>filemark</emphasis> <emphasis remap='I'> int</emphasis></term>
<listitem>
<para>Default:
-<emphasis remap='I'>1000 bytes</emphasis>.
-How large a file mark (tape mark) is, measured in bytes.
+<emphasis remap='I'>1 kbytes</emphasis>.
+How large a file mark (tape mark) is, measured in kbytes.
If the size is only known in some linear measurement (e.g. inches),
-convert it to bytes using the device density.</para>
+convert it to kbytes using the device density.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis remap='B'>blocksize</emphasis> <emphasis remap='I'> int</emphasis></term>
<listitem>
<para>Default:
-<emphasis remap='I'>32</emphasis>.
+<emphasis remap='I'>32 kbytes</emphasis>.
How much data will be written in each tape record expressed in KiloBytes.
The tape record size (= blocksize) can not be reduced below the default 32 KBytes.
The parameter blocksize can only be raised if &A; was compiled with the configure option
--with-maxtapeblocksize=N set with "N" greater than 32 during
&configure;.
+</para>
+ </listitem>
+ </varlistentry>
+<varlistentry>
+<term><emphasis remap='B'>readblocksize</emphasis> <emphasis remap='I'> int</emphasis></term>
+<listitem>
+<para>Default:
+(<emphasis remap='I'>from configure --with-maxtapeblocksize</emphasis>).
+How much data will be read in each tape record expressed in KiloBytes.
+Some hardware require a value not too large, and some require it to be equal to the blocksize.
+It is useful if you configured amanda with a big --with-maxtapeblocksize and your
+hardware don't work with a value that big.
</para>
</listitem>
</varlistentry>
<term><emphasis remap='B'>use</emphasis> <emphasis remap='I'> int</emphasis></term>
<listitem>
<para>Default:
-<emphasis remap='I'>300 Kbps</emphasis>.
+<emphasis remap='I'>8000 Kbps</emphasis>.
The speed of the interface in Kbytes per second.</para>
</listitem>
</varlistentry>
<refsect1><title>SEE ALSO</title>
<para>
<citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>amanda-client.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>amcrypt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>aespipe</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>http://wiki.zmanda.com</refentrytitle></citerefentry>
+</para>
+
+<para>
+An updated version of this man page may be available at http://wiki.zmanda.com/index.php/Amanda.conf.
</para>
</refsect1>
</refentry>
projects / debian / amanda / blobdiff