..
.TH "AMANDA.CONF" 5 "" "" ""
.SH NAME
-amanda.conf \- Main configuration file for AMANDA, the Advanced Maryland Automatic Network Disk Archiver
+amanda.conf \- Main configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver
.SH "DESCRIPTION"
.PP
-\fIamanda\&.conf\fR is the main configuration file for \fBAMANDA\fR\&. This manpage lists the relevant sections and parameters of this file for quick reference\&.
+\fIamanda\&.conf\fR is the main configuration file for \fBAmanda\fR\&. This manpage lists the relevant sections and parameters of this file for quick reference\&.
.SH "PARAMETERS"
.PP
-There are a number of configuration parameters that control the behavior of the \fBAMANDA\fR programs\&. All have default values, so you need not specify the parameter in \fBamanda\&.conf\fR if the default is suitable\&.
+There are a number of configuration parameters that control the behavior of the \fBAmanda\fR programs\&. All have default values, so you need not specify the parameter in \fBamanda\&.conf\fR if the default is suitable\&.
.PP
Lines starting with # are ignored, as are blank lines\&. Comments may be placed on a line with a directive by starting the comment with a #\&. The remainder of the line is ignored\&.
\fBweek weeks\fR
Some number of weeks (days*7)\&.
- .RS .Sh "Note" The value \fBinf\fR may be used in most places where an integer is expected to mean an infinite amount\&. Boolean arguments may have any of the values \fBy\fR, \fByes\fR, \fBt\fR, \fBtrue\fR or \fBon\fR to indicate a true state, or \fBn\fR, \fBno\fR, \fBf\fR, \fBfalse\fR or \fBoff\fR to indicate a false state\&. If no argument is given, \fBtrue\fR is assumed\&. .RE
+.RS
+.Sh "Note"
+The value
+\fBinf\fR
+may be used in most places where an integer is expected
+to mean an infinite amount\&.
+
+Boolean arguments may have any of the values \fBy\fR, \fByes\fR, \fBt\fR, \fBtrue\fR or \fBon\fR to indicate a true state, or \fBn\fR, \fBno\fR, \fBf\fR, \fBfalse\fR or \fBoff\fR to indicate a false state\&. If no argument is given, \fBtrue\fR is assumed\&.
+
+.RE
.SS "PARAMETERS"
.TP
\fBorg\fR \fB string\fR
-Default: \fBdaily\fR\&. A descriptive name for the configuration\&. This string appears in the Subject line of mail reports\&. Each \fBAMANDA\fR configuration should have a different string to keep mail reports distinct\&.
+Default: \fBdaily\fR\&. A descriptive name for the configuration\&. This string appears in the Subject line of mail reports\&. Each \fBAmanda\fR configuration should have a different string to keep mail reports distinct\&.
.TP
\fBmailto\fR \fB string\fR
\fBdumpcycle\fR \fB int\fR
Default: \fB10 days\fR\&. 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\&.
- .RS .Sh "Note" This parameter may also be set in a specific \fBdumptype\fR (see below)\&. This value sets the default for all \fBdumptype\fRs so must appear in \fBamanda\&.conf\fR before any \fBdumptype\fRs are defined\&. .RE
+.RS
+.Sh "Note"
+This parameter may also be set in a specific
+\fBdumptype\fR
+(see below)\&.
+This value sets the default for all
+\fBdumptype\fRs
+so must appear in
+\fBamanda\&.conf\fR
+before any
+\fBdumptype\fRs
+are defined\&.
+.RE
.TP
\fBrunspercycle\fR \fB int\fR
.TP
\fBtapecycle\fR \fB int\fR
-Default: \fB15 tapes\fR\&. Typically tapes are used by \fBAMANDA\fR in an ordered rotation\&. The \fBtapecycle\fR parameter defines the size of that rotation\&. The number of tapes in rotation must be larger than the number of tapes required for a complete dump cycle (see the \fBdumpcycle\fR parameter)\&.
+Default: \fB15 tapes\fR\&. Typically tapes are used by \fBAmanda\fR in an ordered rotation\&. The \fBtapecycle\fR parameter defines the size of that rotation\&. The number of tapes in rotation must be larger than the number of tapes required for a complete dump cycle (see the \fBdumpcycle\fR parameter)\&.
-This is calculated by multiplying the number of \fBamdump\fR runs per dump cycle (\fBrunspercycle\fR parameter) times the number of tapes used per run (\fBruntapes\fR parameter)\&. Typically two to four times this calculated number of tapes are in rotation\&. While \fBAMANDA\fR is always willing to use a new tape in its rotation, it refuses to reuse a tape until at least '\fBtapecycle\fR \-1' number of other tapes have been used\&.
+This is calculated by multiplying the number of \fBamdump\fR runs per dump cycle (\fBrunspercycle\fR parameter) times the number of tapes used per run (\fBruntapes\fR parameter)\&. Typically two to four times this calculated number of tapes are in rotation\&. While \fBAmanda\fR is always willing to use a new tape in its rotation, it refuses to reuse a tape until at least '\fBtapecycle\fR \-1' number of other tapes have been used\&.
It is considered good administrative practice to set the \fBtapecycle\fR parameter slightly lower than the actual number of tapes in rotation\&. This allows the administrator to more easily cope with damaged or misplaced tapes or schedule adjustments that call for slight adjustments in the rotation order\&.
+.TP
+\fBlabel_new_tapes\fR \fB string\fR
+Default: not set\&. When set, this directive will cause \fBAmanda\fR to automatically write an \fBAmanda\fR tape label to any blank tape she encounters\&. This option is DANGEROUS because when set, \fBAmanda\fR will ERASE any non\-\fBAmanda\fR tapes you may have, and may also ERASE any near\-failing tapes\&. Use with caution\&.
+
+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: label_new_tapes "DailySet1\-%%%"
+
+.TP
+
+=======
+ \fBlabel_new_tapes\fR \fB string\fR
+Default: not set\&. When set, this directive will cause \fBAmanda\fR to automatically write an Amanda tape label to any black tape she encounters\&. This option is DANGEROUS because when set, \fBAmanda\fR will ERASE any non\-\fBAmanda\fR tapes you may have, and may also ERASE any near\-failing tapes\&. Use with caution\&.
+
+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: label_new_tapes "DailySet1\-%%%"
+
.TP
\fBdumpuser\fR \fB string\fR
-Default: \fBamanda\fR\&. The login name \fBAMANDA\fR uses to run the backups\&. The backup client hosts must allow access from the tape server host as this user via \&.rhosts or \&.amandahosts, depending on how the \fBAMANDA\fR software was built\&.
+Default: \fBamanda\fR\&. The login name \fBAmanda\fR uses to run the backups\&. The backup client hosts must allow access from the tape server host as this user via \&.rhosts or \&.amandahosts, depending on how the \fBAmanda\fR software was built\&.
.TP
\fBprinter\fR string
.TP
\fBtapedev\fR string
-Default: \fI/dev/nst0\fR\&. The path name of the non\-rewinding tape device\&. Non\-rewinding tape device names often have an 'n' in the name, e\&.g\&. \fI/dev/rmt/0mn\fR, however this is operating system specific and you should consult that documentation for detailed naming information\&.
+Default: \fInull:\fR\&. The path name of the non\-rewinding tape device\&. Non\-rewinding tape device names often have an 'n' in the name, e\&.g\&. \fI/dev/rmt/0mn\fR, however this is operating system specific and you should consult that documentation for detailed naming information\&.
If a tape changer is configured (see the \fBtpchanger\fR option), this option might not be used\&.
.TP
\fBrawtapedev\fR string
-Default: \fI/dev/null\fR\&. The path name of the raw tape device\&. This is only used if \fBAMANDA\fR is compiled for Linux machines with floppy tapes and is needed for QIC volume table operations\&.
+Default: \fInull:\fR\&. The path name of the raw tape device\&. This is only used if \fBAmanda\fR is compiled for Linux machines with floppy tapes and is needed for QIC volume table operations\&.
.TP
\fBtpchanger\fR string
\fBruntapes\fR int
Default: 1\&. The maximum number of tapes used in a single run\&. If a tape changer is not configured, this option is not used and should be commented out of the configuration file\&.
-If a tape changer is configured, this may be set larger than one to let \fBAMANDA\fR write to more than one tape\&.
+If a tape changer is configured, this may be set larger than one to let \fBAmanda\fR write to more than one tape\&.
-Note that this is an upper bound on the number of tapes, and \fBAMANDA\fR may use less\&.
+Note that this is an upper bound on the number of tapes, and \fBAmanda\fR may use less\&.
-Also note that as of this release, \fBAMANDA\fR does not support true tape overflow\&. When it reaches the end of one tape, the backup image \fBAMANDA\fR was processing starts over again on the next tape\&.
+Also note that as of this release, \fBAmanda\fR does not support true tape overflow\&. When it reaches the end of one tape, the backup image \fBAmanda\fR was processing starts over again on the next tape\&.
.TP
\fBmaxdumpsize\fR int
\fBtapetype\fR \fB string\fR
Default: \fBEXABYTE\fR\&. The type of tape drive associated with \fBtapedev\fR or \fBtpchanger\fR\&. This refers to one of the defined \fBtapetype\fRs in the config file (see below), which specify various tape parameters, like the \fBlength\fR, \fBfilemark\fR size, and \fBspeed\fR of the tape media and device\&.
+First character of a \fBtapetype\fR string must be an alphabetic character
+
.TP
\fBctimeout\fR int
Default: \fB30 seconds\fR\&. Maximum amount of time that \fBamcheck\fR will wait for each client host\&.
.TP
\fBnetusage\fR int
-Default: \fB300 Kbps\fR\&. The maximum network bandwidth allocated to \fBAMANDA\fR, in Kbytes per second\&. See also the \fBinterface\fR section\&.
+Default: \fB300 Kbps\fR\&. The maximum network bandwidth allocated to \fBAmanda\fR, in Kbytes per second\&. See also the \fBinterface\fR section\&.
.TP
\fBinparallel\fR int
-Default: 10\&. The maximum number of backups that \fBAMANDA\fR will attempt to run in parallel\&. \fBAMANDA\fR will stay within the constraints of network bandwidth and holding disk space available, so it doesn't hurt to set this number a bit high\&. Some contention can occur with larger numbers of backups, but this effect is relatively small on most systems\&.
+Default: 10\&. The maximum number of backups that \fBAmanda\fR will attempt to run in parallel\&. \fBAmanda\fR will stay within the constraints of network bandwidth and holding disk space available, so it doesn't hurt to set this number a bit high\&. Some contention can occur with larger numbers of backups, but this effect is relatively small on most systems\&.
.TP
\fBdisplayunit\fR "k|m|g|t"
.TP
\fBmaxdumps\fR int
-Default: 1\&. The maximum number of backups from a single host that \fBAMANDA\fR will attempt to run in parallel\&. See also the \fBinparallel\fR option\&.
+Default: 1\&. The maximum number of backups from a single host that \fBAmanda\fR will attempt to run in parallel\&. See also the \fBinparallel\fR option\&.
Note that this parameter may also be set in a specific \fBdumptype\fR (see below)\&. This value sets the default for all \fBdumptype\fRs so must appear in \fBamanda\&.conf\fR before any \fBdumptype\fRs are defined\&.
.TP
\fBbumpsize\fR int
-Default: \fB10 Mbytes\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size\&. If \fBAMANDA\fR determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&. The value of this parameter is used only if the parameter \fBbumppercent\fR is set to 0\&.
+Default: \fB10 Mbytes\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size\&. If \fBAmanda\fR determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&. The value of this parameter is used only if the parameter \fBbumppercent\fR is set to 0\&.
The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
.TP
\fBbumppercent\fR int
-Default: \fB0 percent\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as percentage of the current size of the DLE (size of current level 0)\&. If \fBAMANDA\fR determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&.
+Default: \fB0 percent\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as percentage of the current size of the DLE (size of current level 0)\&. If \fBAmanda\fR determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&.
If this parameter is set to 0, the value of the parameter \fBbumpsize\fR is used to trigger bumping\&.
.TP
\fBbumpmult\fR \fB float\fR
-Default: 1\&.5\&. The bump size multiplier\&. \fBAMANDA\fR multiplies \fBbumpsize\fR by this factor for each level\&. This prevents active filesystems from bumping too much by making it harder to bump to the next level\&. For example, with the default \fBbumpsize\fR and \fBbumpmult\fR set to 2\&.0, the bump threshold will be 10 Mbytes for level one, 20 Mbytes for level two, 40 Mbytes for level three, and so on\&.
+Default: 1\&.5\&. The bump size multiplier\&. \fBAmanda\fR multiplies \fBbumpsize\fR by this factor for each level\&. This prevents active filesystems from bumping too much by making it harder to bump to the next level\&. For example, with the default \fBbumpsize\fR and \fBbumpmult\fR set to 2\&.0, the bump threshold will be 10 Mbytes for level one, 20 Mbytes for level two, 40 Mbytes for level three, and so on\&.
The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
.TP
\fBbumpdays\fR \fB int\fR
-Default: \fB2 days\fR\&. To insure redundancy in the dumps, \fBAMANDA\fR keeps filesystems at the same incremental level for at least \fBbumpdays\fR days, even if the other bump threshold criteria are met\&.
+Default: \fB2 days\fR\&. To insure redundancy in the dumps, \fBAmanda\fR keeps filesystems at the same incremental level for at least \fBbumpdays\fR days, even if the other bump threshold criteria are met\&.
The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
.TP
\fBinfofile\fR \fB string\fR
-Default: \fI/usr/adm/amanda/curinfo\fR\&. The file or directory name for the historical information database\&. If \fBAMANDA\fR was configured to use DBM databases, this is the base file name for them\&. If it was configured to use text formated databases (the default), this is the base directory and within here will be a directory per client, then a directory per disk, then a text file of data\&.
+Default: \fI/usr/adm/amanda/curinfo\fR\&. The file or directory name for the historical information database\&. If \fBAmanda\fR was configured to use DBM databases, this is the base file name for them\&. If it was configured to use text formated databases (the default), this is the base directory and within here will be a directory per client, then a directory per disk, then a text file of data\&.
.TP
\fBlogdir\fR \fB string\fR
.TP
\fBtapelist\fR \fB string\fR
-Default: \fBtapelist\fR\&. The file name for the active \fBtapelist\fR file\&. \fBAMANDA\fR maintains this file with information about the active set of tapes\&.
+Default: \fBtapelist\fR\&. The file name for the active \fBtapelist\fR file\&. \fBAmanda\fR maintains this file with information about the active set of tapes\&.
.TP
\fBtapebufs\fR \fB int\fR
.TP
\fBautoflush\fR \fB bool\fR
-Default: \fBoff\fR\&. Whether an amdump run will flush the dump already on holding disk to tape\&.
+Default: \fBoff\fR\&. Whether an amdump run will flush the dumps from holding disk to tape\&.
.TP
\fBamrecover_do_fsf\fR \fB bool\fR
.RE
.IP
Here is an example:
-
.nf
-columnspec "Disk=1:18,HostName=0:10,OutKB=1:7".fi
-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\&.
+columnspec "Disk=1:18,HostName=0:10,OutKB=1:7"
+
+.fi
+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\&.
+
.TP
\fBincludefile\fR \fB string\fR
-Default: \fBnone\fR\&. The name of an \fBAMANDA\fR configuration file to include within the current file\&. Useful for sharing dumptypes, tapetypes and interface definitions among several configurations\&.
+Default: \fBnone\fR\&. The name of an \fBAmanda\fR configuration file to include within the current file\&. Useful for sharing dumptypes, tapetypes and interface definitions among several configurations\&.
.SH "HOLDINGDISK SECTION"
.TP
\fBuse\fR \fB int\fR
-Default: \fB0 Gb\fR\&. 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, \fBAMANDA\fR will use all available space minus that value\&.
+Default:
+\fB0 Gb\fR\&.
+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, \fBAmanda\fR will use all available space minus that value\&.
+
.TP
\fBchunksize\fR \fB int\fR
-Default: \fB1 Gb\fR\&. 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\&.
-
-If 0 is specified, \fBAMANDA\fR will create holding disk chunks as large as ((INT_MAX/1024)\-64) Kbytes\&.
-
-Each holding disk chunk includes a 32 Kbyte header, so the minimum chunk size is 64 Kbytes (but that would be really silly)\&.
-
-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 \fBAMANDA\fR 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\&.
+Default:
+\fB1 Gb\fR\&.
+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\&.
+
+If 0 is specified, \fBAmanda\fR will create holding disk chunks as large as
+((INT_MAX/1024)\-64) Kbytes\&.
+
+Each holding disk chunk includes a 32 Kbyte header, so the minimum
+chunk size is 64 Kbytes (but that would be really silly)\&.
+
+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 \fBAmanda\fR 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\&.
+
.SH "DUMPTYPE SECTION"
.PP
-The \fBamanda\&.conf\fR file may define multiple sets of backup options and refer to them by name from the \fBdisklist\fR file\&. For instance, one set of options might be defined for file systems that can benefit from high compression, another set that does not compress well, another set for file systems that should always get a full backup and so on\&.
+The \fIamanda\&.conf\fR file may define multiple sets of backup options and refer to them by name from the \fIdisklist\fR file\&. For instance, one set of options might be defined for file systems that can benefit from high compression, another set that does not compress well, another set for file systems that should always get a full backup and so on\&.
.PP
A set of backup options are entered in a \fBdumptype\fR section, which looks like this:
.fi
.PP
-\fBName\fR is the name of this set of backup options\&. It is referenced from the \fBdisklist\fR file\&.
+\fBName\fR is the name of this set of backup options\&. It is referenced from the \fIdisklist\fR file\&.
.PP
-Some of the options in a \fBdumptype\fR section are the same as those in the main part of \fBamanda\&.conf\fR\&. The main option value is used to set the default for all \fBdumptype\fR sections\&. For instance, setting \fBdumpcycle\fR to 50 in the main part of the config file causes all following \fBdumptype\fR sections to start with that value, but the value may be changed on a section by section basis\&. Changes to variables in the main part of the config file must be done before (earlier in the file) any \fBdumptype\fRs are defined\&.
+Some of the options in a \fBdumptype\fR section are the same as those in the main part of \fIamanda\&.conf\fR\&. The main option value is used to set the default for all \fBdumptype\fR sections\&. For instance, setting \fBdumpcycle\fR to 50 in the main part of the config file causes all following \fBdumptype\fR sections to start with that value, but the value may be changed on a section by section basis\&. Changes to variables in the main part of the config file must be done before (earlier in the file) any \fBdumptype\fRs are defined\&.
.PP
The dumptype options and values are:
.TP
\fBauth\fR \fB string\fR
-Default: \fBbsd\fR\&. Type of authorization to perform between tape server and backup client hosts\&. May be \fBkrb4\fR to use Kerberos\-IV authorization\&.
+Default: \fBbsd\fR\&. Type of authorization to perform between tape server and backup client hosts\&.
+
+\fBkrb4\fR to use Kerberos\-IV authorization\&.
+
+\fBkrb5\fR to use Kerberos\-V authorization\&.
+
+\fBssh\fR to use OpenSSH authorization\&.
.TP
\fBbumpsize\fR int
-Default: \fB10 Mbytes\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size\&. If \fBAMANDA\fR determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&. The value of this parameter is used only if the parameter \fBbumppercent\fR is set to 0\&.
+Default: \fB10 Mbytes\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size\&. If \fBAmanda\fR determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&. The value of this parameter is used only if the parameter \fBbumppercent\fR is set to 0\&.
See also the options \fBbumppercent\fR, \fBbumpmult\fR and \fBbumpdays\fR\&.
.TP
\fBbumppercent\fR int
-Default: \fB0 percent\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as percentage of the current size of the DLE (size of current level 0)\&. If \fBAMANDA\fR determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&.
+Default: \fB0 percent\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as percentage of the current size of the DLE (size of current level 0)\&. If \fBAmanda\fR determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&.
If this parameter is set to 0, the value of the parameter \fBbumpsize\fR is used to trigger bumping\&.
.TP
\fBbumpmult\fR \fB float\fR
-Default: 1\&.5\&. The bump size multiplier\&. \fBAMANDA\fR multiplies \fBbumpsize\fR by this factor for each level\&. This prevents active filesystems from bumping too much by making it harder to bump to the next level\&. For example, with the default \fBbumpsize\fR and \fBbumpmult\fR set to 2\&.0, the bump threshold will be 10 Mbytes for level one, 20 Mbytes for level two, 40 Mbytes for level three, and so on\&.
+Default: 1\&.5\&. The bump size multiplier\&. \fBAmanda\fR multiplies \fBbumpsize\fR by this factor for each level\&. This prevents active filesystems from bumping too much by making it harder to bump to the next level\&. For example, with the default \fBbumpsize\fR and \fBbumpmult\fR set to 2\&.0, the bump threshold will be 10 Mbytes for level one, 20 Mbytes for level two, 40 Mbytes for level three, and so on\&.
.TP
\fBbumpdays\fR \fB int\fR
-Default: \fB2 days\fR\&. To insure redundancy in the dumps, \fBAMANDA\fR keeps filesystems at the same incremental level for at least \fBbumpdays\fR days, even if the other bump threshold criteria are met\&.
+Default: \fB2 days\fR\&. To insure redundancy in the dumps, \fBAmanda\fR keeps filesystems at the same incremental level for at least \fBbumpdays\fR days, even if the other bump threshold criteria are met\&.
.TP
\fBcomment\fR \fB string\fR
.TP
\fBcomprate\fR \fBfloat\fR [, \fBfloat\fR ]
-Default: 0\&.50, 0\&.50\&. The expected full and incremental compression factor for dumps\&. It is only used if \fBAMANDA\fR does not have any history information on compression rates for a filesystem, so should not usually need to be set\&. However, it may be useful for the first time a very large filesystem that compresses very little is backed up\&.
+Default: 0\&.50, 0\&.50\&. The expected full and incremental compression factor for dumps\&. It is only used if \fBAmanda\fR does not have any history information on compression rates for a filesystem, so should not usually need to be set\&. However, it may be useful for the first time a very large filesystem that compresses very little is backed up\&.
.TP
\fBcompress [client|server]\fR \fB string\fR
-Default: \fBclient fast\fR\&. If \fBAMANDA\fR does compression of the backup images, it can do so either on the backup client host before it crosses the network or on the tape server host as it goes from the network into the holding disk or to tape\&. Which place to do compression (if at all) depends on how well the dump image usually compresses, the speed and load on the client or server, network capacity, holding disk capacity, availability of tape hardware compression, etc\&.
+Default: \fBclient fast\fR\&. If \fBAmanda\fR does compression of the backup images, it can do so either on the backup client host before it crosses the network or on the tape server host as it goes from the network into the holding disk or to tape\&. Which place to do compression (if at all) depends on how well the dump image usually compresses, the speed and load on the client or server, network capacity, holding disk capacity, availability of tape hardware compression, etc\&.
-For either type of compression, \fBAMANDA\fR also allows the selection of two styles of compression\&. \fBBest\fR is the best compression available, often at the expense of CPU overhead\&. \fBFast\fR is often not as good a compression as \fBbest\fR, but usually less CPU overhead\&.
+For either type of compression, \fBAmanda\fR also allows the selection of three styles of compression\&. \fBBest\fR is the best compression available, often at the expense of CPU overhead\&. \fBFast\fR is often not as good a compression as \fBbest\fR, but usually less CPU overhead\&. Or to specify \fBCustom\fR to use your own compression method\&. (See dumptype custom\-compress in example/amanda\&.conf for reference)
So the \fBcompress\fR options line may be one of:
compress [client] best
.TP
\(bu
+compress client custom
+
+Specify client_custom_compress "PROG"
+
+PROG must not contain white space and it must accept \-d for uncompress\&.
+.TP
+\(bu
compress server fast
.TP
\(bu
compress server best
+.TP
+\(bu
+compress server custom
+
+Specify server_custom_compress "PROG"
+
+PROG must not contain white space and it must accept \-d for uncompress\&.
.LP
.RE
.IP
-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 \fBmt\fR option), \fBAMANDA\fR (software) compression should be disabled\&.
+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 \fBmt\fR option), \fBAmanda\fR (software) compression should be disabled\&.
.TP
\fBdumpcycle\fR \fB int\fR
-Default: \fB10 days\fR\&. The number of days in the backup cycle\&. Each disk using this set of options will get a full backup at least this often\&. Setting this to zero tries to do a full backup each run\&.
+Default: \fB10 days\fR\&. The number of days in the backup cycle\&. Each disk using this set of options will get a full backup at least this of ten\&. Setting this to zero tries to do a full backup each run\&.
+
+.TP
+\fBencrypt [none|client|server]\fR
+Default: \fBnone\fR\&. To encrypt backup images, it can do so either on the backup client host before it crosses the network or on the tape server host as it goes from the network into the holding disk or to tape\&.
+
+So the \fBencrypt\fR options line may be one of:
+
+.RS
+.TP 3
+\(bu
+encrypt none
+.TP
+\(bu
+encrypt client
+
+Specify client_encrypt "PROG"
+
+PROG must not contain white space\&.
+
+Specify client_decrypt_option "decryption\-parameter" Default: "\-d"
+
+decryption\-parameter must not contain white space\&.
+
+(See dumptype encrypt\-fast in example/amanda\&.conf for reference)
+.TP
+\(bu
+encrypt server
+
+Specify server_encrypt "PROG"
+
+PROG must not contain white space\&.
+
+Specify server_decrypt_option "decryption\-parameter" Default: "\-d"
+
+decryption\-parameter must not contain white space\&.
+.LP
+.RE
+.IP
+
+.PP
+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\&. \fBamcrypt\fR which is a wrapper of \fBaespipe\fR is provided as a reference encryption program\&.
.TP
\fBestimate\fR \fBclient|calcsize|server\fR
-Default: \fBclient\fR\&. Determine the way \fBAMANDA\fR does it's estimate\&.
+Default: \fBclient\fR\&. Determine the way \fBAmanda\fR does it's estimate\&.
.RS
.TP 3
.TP
\fBexclude\fR [ \fBlist|file\fR ][[optional][ \fBappend\fR ][ \fB string\fR ]+]
-Default: \fBfile\fR\&. There are two exclude lists, \fBexclude file\fR and \fBexclude list\&.\fR With \fBexclude file\fR , the \fBstring\fR is a \fBGNU\-tar\fR exclude expression\&. With \fBexclude list\fR , the \fBstring\fR is a file name on the client containing \fBGNU\-tar\fR exclude expressions\&.
+Default: \fBfile\fR\&. There are two exclude lists, \fBexclude file\fR and \fBexclude list\&.\fR With \fBexclude file\fR , the \fBstring\fR is a \fBGNU\-tar\fR exclude expression\&. With \fBexclude list\fR , the \fBstring\fR is a file name on the client containing \fBGNU\-tar\fR exclude expressions\&. The path to the specified exclude list file, if present (see description of 'optional' below), must be readable by the \fBAmanda\fR user\&.
All exclude expressions are concatenated in one file and passed to \fBGNU\-tar\fR as an \fB\-\-exclude\-from\fR argument\&.
+Exclude expressions must always be specified as relative to the head directory of the DLE\&.
+
With the \fBappend\fR keyword, the \fBstring\fR is appended to the current list, without it, the \fBstring\fR overwrites the list\&.
If \fBoptional\fR is specified for \fBexclude list\fR, then amcheck will not complain if the file doesn't exist or is not readable\&.
.TP
\fBholdingdisk\fR \fB boolean\fR
-Default: \fByes\fR\&. 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 \fBAMANDA\fR is backing up, that file system should refer to a dumptype with \fBholdingdisk\fR set to \fBno\fR to avoid backing up the holding disk into itself\&.
+Default: \fByes\fR\&. 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 \fBAmanda\fR is backing up, that file system should refer to a dumptype with \fBholdingdisk\fR set to \fBno\fR to avoid backing up the holding disk into itself\&.
.TP
\fBignore\fR \fB boolean\fR
\fBinclude\fR [ \fBlist|file\fR ][[optional][ \fBappend\fR ][ \fB string\fR ]+]
Default: \fBfile\fR "\&."\&. There are two include lists, \fBinclude file\fR and \fBinclude list\&.\fR With \fBinclude file\fR , the \fBstring\fR is a glob expression\&. With \fBinclude list\fR , the \fBstring\fR is a file name on the client containing glob expressions\&.
-All include expressions are expanded by \fBAMANDA\fR, concatenated in one file and passed to \fBGNU\-tar\fR as a \fB\-\-files\-from\fR argument\&. They must start with "\&./" and contain no other "/"\&.
+All include expressions are expanded by \fBAmanda\fR, concatenated in one file and passed to \fBGNU\-tar\fR as a \fB\-\-files\-from\fR argument\&. They must start with "\&./" and contain no other "/"\&.
+
+Include expressions must always be specified as relative to the head directory of the DLE\&.
+
+.RS
+.Sh "Note"
+For globbing to work at all, even the limited single level,
+the top level directory of the DLE must be readable by the \fBAmanda\fR user\&.
+.RE
With the \fBappend\fR keyword, the \fBstring\fR is appended to the current list, without it, the \fBstring\fR overwrites the list\&.
If \fBoptional\fR is specified for \fBinclude list,\fR then amcheck will not complain if the file doesn't exist or is not readable\&.
.TP
\fBmaxdumps\fR \fB int\fR
-Default: 1\&. The maximum number of backups from a single host that \fBAMANDA\fR will attempt to run in parallel\&. See also the main section parameter \fBinparallel\fR\&.
+Default: 1\&. The maximum number of backups from a single host that \fBAmanda\fR will attempt to run in parallel\&. See also the main section parameter \fBinparallel\fR\&.
.TP
\fBmaxpromoteday\fR \fB int\fR
.TP
\fBpriority\fR \fB string\fR
-Default: \fBmedium\fR\&. When there is no tape to write to, \fBAMANDA\fR will do incremental backups in priority order to the holding disk\&. The priority may be high (2), medium (1), low (0) or a number of your choice\&.
+Default: \fBmedium\fR\&. When there is no tape to write to, \fBAmanda\fR will do incremental backups in priority order to the holding disk\&. The priority may be high (2), medium (1), low (0) or a number of your choice\&.
.TP
\fBprogram\fR \fB string\fR
.TP
\fBskip\-full\fR \fB boolean\fR
-Default: \fBno\fR\&. If \fBtrue\fR and \fBplanner\fR has scheduled a full backup, these disks will be skipped, and full backups should be run off\-line on these days\&. It was reported that \fBAMANDA\fR only schedules level 1 incrementals in this configuration; this is probably a bug\&.
+Default: \fBno\fR\&. If \fBtrue\fR and \fBplanner\fR has scheduled a full backup, these disks will be skipped, and full backups should be run off\-line on these days\&. It was reported that \fBAmanda\fR only schedules level 1 incrementals in this configuration; this is probably a bug\&.
.TP
\fBskip\-incr\fR \fB boolean\fR
.TP
\fBstandard\fR
-The standard \fBAMANDA\fR schedule\&.
+The standard \fBAmanda\fR schedule\&.
.TP
\fBnofull\fR
.TP
\fBincronly\fR
-Only do incremental dumps\&. \fBamadmin force\fR should be used to tell \fBAMANDA\fR that a full dump has been performed off\-line, so that it resets to level 1\&. It is similar to skip\-full, but with incronly full dumps may be scheduled manually\&. Unfortunately, it appears that \fBAMANDA\fR will perform full backups with this configuration, which is probably a bug\&.
+Only do incremental dumps\&. \fBamadmin force\fR should be used to tell \fBAmanda\fR that a full dump has been performed off\-line, so that it resets to level 1\&. It is similar to skip\-full, but with incronly full dumps may be scheduled manually\&. Unfortunately, it appears that \fBAmanda\fR will perform full backups with this configuration, which is probably a bug\&.
.RE
.IP
+.TP
+\fBtape_splitsize\fR \fB int\fR
+Default: \fBnone\fR\&. Split dump file on tape into pieces of a specified size\&. This allows dumps to be spread across multiple tapes, and can potentially make more efficient use of tape space\&. Note that if this value is too large (more than half the size of the average dump being split), substantial tape space can be wasted\&. If too small, large dumps will be split into innumerable tiny dumpfiles, adding to restoration complexity\&. A good rule of thumb, usually, is 1/10 of the size of your tape\&.
+
+.TP
+\fBsplit_diskbuffer\fR \fB string\fR
+Default: \fBnone\fR\&. When dumping a split dump in PORT\-WRITE mode (usually meaning "no holding disk"), buffer the split chunks to a file in the directory specified by this option\&.
+
+.TP
+\fBfallback_splitsize\fR \fB int\fR
+Default: \fB10M\fR\&. When dumping a split dump in PORT\-WRITE mode, if no split_diskbuffer is specified (or if we somehow fail to use our split_diskbuffer), we must buffer split chunks in memory\&. This specifies the maximum size split chunks can be in this scenario, and thus the maximum amount of memory consumed for in\-memory splitting\&. The size of this buffer can be changed from its (very conservative) default to a value reflecting the amount of memory that each taper process on the dump server may reasonably consume\&.
+
.PP
-The following \fBdumptype\fR entries are predefined by \fBAMANDA\fR:
+The following \fBdumptype\fR entries are predefined by \fBAmanda\fR:
.nf
define dumptype no\-compress {
.fi
.PP
-\fBAMANDA\fR provides a \fBdumptype\fR named \fBglobal\fR in the sample \fBamanda\&.conf\fR file that all \fBdumptype\fRs should reference\&. This provides an easy place to make changes that will affect every \fBdumptype\fR\&.
+\fBAmanda\fR provides a \fBdumptype\fR named \fBglobal\fR in the sample \fBamanda\&.conf\fR file that all \fBdumptype\fRs should reference\&. This provides an easy place to make changes that will affect every \fBdumptype\fR\&.
.SH "TAPETYPE SECTION"
\fBlength\fR \fB int\fR
Default: \fB2000 kbytes\fR\&. How much data will fit on a tape\&.
-Note that this value is only used by \fBAMANDA\fR to schedule which backups will be run\&. Once the backups start, \fBAMANDA\fR will continue to write to a tape until it gets an error, regardless of what value is entered for \fBlength\fR (but see the section OUTPUT DRIVERS in the \fBamanda\fR(8) manpage for exceptions)\&.
+Note that this value is only used by \fBAmanda\fR to schedule which backups will be run\&. Once the backups start, \fBAmanda\fR will continue to write to a tape until it gets an error, regardless of what value is entered for \fBlength\fR (but see the section OUTPUT DRIVERS in the \fBamanda\fR(8) manpage for exceptions)\&.
.TP
\fBblocksize\fR \fB int\fR
-Default: \fB32\fR\&. 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 \fBAMANDA\fR was compiled with the configure option \-\-with\-maxtapeblocksize=N set with "N" greater than 32 during \fBconfigure\fR\&.
+Default: \fB32\fR\&. 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 \fBAmanda\fR was compiled with the configure option \-\-with\-maxtapeblocksize=N set with "N" greater than 32 during \fBconfigure\fR\&.
.TP
\fBfile\-pad\fR \fB boolean\fR
-Default: \fBtrue\fR\&. If true, every record, including the last one in the file, will have the same length\&. This matches the way \fBAMANDA\fR wrote tapes prior to the availability of this parameter\&. It may also be useful on devices that only support a fixed blocksize\&.
+Default: \fBtrue\fR\&. If true, every record, including the last one in the file, will have the same length\&. This matches the way \fBAmanda\fR wrote tapes prior to the availability of this parameter\&. It may also be useful on devices that only support a fixed blocksize\&.
Note that the last record on the tape probably includes trailing null byte padding, which will be passed back to \fBgzip\fR, \fBcompress\fR or the restore program\&. Most programs just ignore this (although possibly with a warning)\&.
.TP
\fBspeed\fR \fB int\fR
-Default: \fB200 bps\fR\&. How fast the drive will accept data, in bytes per second\&. This parameter is NOT currently used by \fBAMANDA\fR\&.
+Default: \fB200 bps\fR\&. How fast the drive will accept data, in bytes per second\&. This parameter is NOT currently used by \fBAmanda\fR\&.
.TP
\fBlbl\-templ\fR \fB string\fR
-A PostScript template file used by \fBamreport\fR to generate labels\&. Several sample files are provided with the \fBAMANDA\fR sources in the \fBexample\fR directory\&. See the \fBamreport\fR(8) man page for more information\&.
+A PostScript template file used by \fBamreport\fR to generate labels\&. Several sample files are provided with the \fBAmanda\fR sources in the \fBexample\fR directory\&. See the \fBamreport\fR(8) man page for more information\&.
.PP
In addition to options, another \fBtapetype\fR name may be entered, which makes this \fBtapetype\fR inherit options from another \fBtapetype\fR\&. For instance, the only difference between a DLT4000 tape drive using Compact\-III tapes and one using Compact\-IV tapes is the length of the tape\&. So they could be entered as:
\fBname\fR is the name of this type of network interface\&. It is referenced from the \fBdisklist\fR file\&.
.PP
-Note that these sections define network interface characteristics, not the actual interface that will be used\&. Nor do they impose limits on the bandwidth that will actually be taken up by \fBAMANDA\fR\&. \fBAMANDA\fR computes the estimated bandwidth each file system backup will take based on the estimated size and time, then compares that plus any other running backups with the limit as another of the criteria when deciding whether to start the backup\&. Once a backup starts, \fBAMANDA\fR will use as much of the network as it can leaving throttling up to the operating system and network hardware\&.
+Note that these sections define network interface characteristics, not the actual interface that will be used\&. Nor do they impose limits on the bandwidth that will actually be taken up by \fBAmanda\fR\&. \fBAmanda\fR computes the estimated bandwidth each file system backup will take based on the estimated size and time, then compares that plus any other running backups with the limit as another of the criteria when deciding whether to start the backup\&. Once a backup starts, \fBAmanda\fR will use as much of the network as it can leaving throttling up to the operating system and network hardware\&.
.PP
The interface options and values are:
James da Silva, <jds@amanda\&.org>: Original text
.PP
-Stefan G\&. Weichinger, <sgw@amanda\&.org>, maintainer of the \fBAMANDA\fR\-documentation: XML\-conversion, major update, splitting
+Stefan G\&. Weichinger, <sgw@amanda\&.org>, maintainer of the \fBAmanda\fR\-documentation: XML\-conversion, major update, splitting
.SH "SEE ALSO"
.PP
- \fBamanda\fR(8),
+ \fBamanda\fR(8), \fBamcrypt\fR(8), \fBaespipe\fR(1),
projects / debian / amanda / blobdiff