-.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\&.
-
-.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\&.
-
-.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\&.
-
-All exclude expressions are concatenated in one file and passed to \fBGNU\-tar\fR as an \fB\-\-exclude\-from\fR argument\&.
-
-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\&.
-
-For \fBexclude list\fR, if the file name is relative, the disk name being backed up is prepended\&. So if this is entered:
-
-.nf
-
- exclude list ``\fB\&.amanda\&.excludes\fR''
-.fi
-the actual file used would be \fI/var/\&.amanda\&.excludes\fR for a backup of \fI/var\fR, \fI/usr/local/\&.amanda\&.excludes\fR for a backup of \fI/usr/local\fR, and so on\&.
-
-.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\&.
-
-.TP
-\fBignore\fR \fB boolean\fR
-Default: \fBno\fR\&. Whether disks associated with this backup type should be backed up or not\&. This option is useful when the \fBdisklist\fR file is shared among several configurations, some of which should not back up all the listed file systems\&.
-
-.TP
-\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 "/"\&.
-
-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\&.
-
-For \fBinclude list\fR, If the file name is relative, the disk name being backed up is prepended\&.
-
-.TP
-\fBindex\fR \fB boolean\fR
-Default: \fBno\fR\&. Whether an index (catalogue) of the backup should be generated and saved in \fBindexdir\fR\&. These catalogues are used by the \fBamrecover\fR utility\&.
-
-.TP
-\fBkencrypt\fR \fB boolean\fR
-Default: \fBno\fR\&. Whether the backup image should be encrypted by Kerberos as it is sent across the network from the backup client host to the tape server host\&.
-
-.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\&.
-
-.TP
-\fBmaxpromoteday\fR \fB int\fR
-Default: 10000\&. The maximum number of day for a promotion, set it 0 if you don't want promotion, set it to 1 or 2 if your disks get overpromoted\&.
-
-.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\&.
-
-.TP
-\fBprogram\fR \fB string\fR
-Default: \fBDUMP\fR\&. The type of backup to perform\&. Valid values are \fBDUMP\fR for the native operating system backup program, and \fBGNUTAR\fR to use \fBGNU\-tar\fR or to do PC backups using Samba\&.
-
-.TP
-\fBrecord\fR \fB boolean\fR
-Default: \fByes\fR\&. Whether to ask the backup program to update its database (e\&.g\&. \fI/etc/dumpdates\fR for DUMP or \fI/usr/local/var/amanda/gnutar\-lists\fR for GNUTAR) of time stamps\&. This is normally enabled for daily backups and turned off for periodic archival runs\&.
-
-.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\&.
-
-.TP
-\fBskip\-incr\fR \fB boolean\fR
-Default: \fBno\fR\&. If \fBtrue\fR and \fBplanner\fR has scheduled an incremental backup, these disks will be skipped\&.
-
-.TP
-\fBstarttime\fR \fB int\fR
-Default: \fBnone\fR\&. Backups will not start until after this time of day\&. The value should be hh*100+mm, e\&.g\&. 6:30PM (18:30) would be entered as 1830\&.
-
-.TP
-\fBstrategy\fR \fB string\fR
-Default: \fBstandard\fR\&. Strategy to use when planning what level of backup to run next\&. Values are:
-
-.TP
-\fBstandard\fR
-The standard \fBAMANDA\fR schedule\&.
-
-.TP
-\fBnofull\fR
-Never do full backups, only level 1 incrementals\&.
-
-.TP
-\fBnoinc\fR
-Never do incremental backups, only full dumps\&.
-
-.TP
-\fBskip\fR
-Never do backups (useful when sharing the \fBdisklist\fR file)\&.
-
-.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\&.
-
-.PP
-The following \fBdumptype\fR entries are predefined by \fBAMANDA\fR:
-.nf
-
-define dumptype no\-compress {
- compress none
-}
-define dumptype compress\-fast {
- compress client fast
-}
-define dumptype compress\-best {
- compress client best
-}
-define dumptype srvcompress {
- compress server fast
-}
-define dumptype bsd\-auth {
- auth bsd
-}
-define dumptype krb4\-auth {
- auth krb4
-}
-define dumptype no\-record {
- record no
-}
-define dumptype no\-hold {
- holdingdisk no
-}
-define dumptype no\-full {
- skip\-full yes
-}
-.fi
-
-.PP
-In addition to options in a \fBdumptype\fR section, one or more other \fBdumptype\fR names may be entered, which make this \fBdumptype\fR inherit options from other previously defined \fBdumptype\fRs\&. For instance, two sections might be the same except for the \fBrecord\fR option:
-.nf
-
-define dumptype normal {
- comment "Normal backup, no compression, do indexing"
- no\-compress
- index yes
- maxdumps 2
-}
-define dumptype testing {
- comment "Test backup, no compression, do indexing, no recording"
- normal
- record no
-}
-.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\&.
-
-.SH "TAPETYPE SECTION"
-
-.PP
-The \fBamanda\&.conf\fR file may define multiple types of tape media and devices\&. The information is entered in a \fBtapetype\fR section, which looks like this in the config file:
-.nf
-
-define tapetype \fBname\fR {
- \fBtapetype\-option\fR \fBtapetype\-value\fR
- \&.\&.\&.
-}
-.fi
-
-.PP
-\fBName\fR is the name of this type of tape medium/device\&. It is referenced from the \fBtapetype\fR option in the main part of the config file\&.
-
-.PP
-The tapetype options and values are:
-
-.TP
-\fBcomment\fR \fB string\fR
-Default: \fBnone\fR\&. A comment string describing this set of tape information\&.
-
-.TP
-\fBfilemark\fR \fB int\fR
-Default: \fB1000 bytes\fR\&. How large a file mark (tape mark) is, measured in bytes\&. If the size is only known in some linear measurement (e\&.g\&. inches), convert it to bytes using the device density\&.
-
-.TP
-\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 OUTPUT DRIVERS section later 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\&.
-
-.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\&.
-
-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)\&.
-
-If this parameter is false, the last record in a file may be shorter than the block size\&. The file will contain the same amount of data the dump program generated, without trailing null byte padding\&. When read, the same amount of data that was written will be returned\&.
-
-.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\&.
-
-.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\&.
-
-.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:
-.nf
-
-define tapetype DLT4000\-III {
- comment "DLT4000 tape drives with Compact\-III tapes"
- length 12500 mbytes # 10 Gig tapes with some compression
- filemark 2000 kbytes
- speed 1536 kps
-}
-define tapetype DLT4000\-IV {
- DLT4000\-III
- comment "DLT4000 tape drives with Compact\-IV tapes"
- length 25000 mbytes # 20 Gig tapes with some compression
-}
-.fi
-
-.SH "INTERFACE SECTION"
-
-.PP
-The \fBamanda\&.conf\fR file may define multiple types of network interfaces\&. The information is entered in an \fBinterface\fR section, which looks like this:
-.nf
-
-define interface \fBname\fR {
- \fBinterface\-option\fR \fBinterface\-value\fR
- \&.\&.\&.
-}
-.fi
-
-.PP
-\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\&.
-
-.PP
-The interface options and values are:
-
-.TP
-\fBcomment\fR \fB string\fR
-Default: \fBnone\fR\&. A comment string describing this set of network information\&.
-
-.TP
-\fBuse\fR \fB int\fR
-Default: \fB300 Kbps\fR\&. The speed of the interface in Kbytes per second\&.
-
-.PP
-In addition to options, another \fBinterface\fR name may be entered, which makes this \fBinterface\fR inherit options from another \fBinterface\fR\&. At the moment, this is of little use\&.
-
-.SH "DISKLIST FILE"
-
-.PP
-The \fBdisklist\fR file determines which disks will be backed up by \fBAMANDA\fR\&. The file usually contains one line per disk:
-.nf
-
-\fBhostname diskname\fR [\fBdiskdevice\fR] \fBdumptype\fR [\fBspindle\fR [\fBinterface\fR] ]
-.fi
-
-.PP
-All pairs [ \fBhostname diskname\fR ] must be unique\&.
-
-.PP
-Lines starting with # are ignored, as are blank lines\&. The fields have the following meanings:
-
-.TP
-\fBhostname\fR
-The name of the host to be backed up\&. If \fBdiskdevice\fR refers to a PC share, this is the host \fBAMANDA\fR will run the Samba \fBsmbclient\fR program on to back up the share\&.
-
-.TP
-\fBdiskname\fR
-The name of the disk (a label)\&. In most case, you set your \fBdiskname\fR to the \fBdiskdevice\fR and you don't set the \fBdiskdevice\&.\fR If you want multiple entries with the same \fBdiskdevice\fR, you must set a different \fBdiskname\fR for each entry\&. It's the \fBdiskname\fR that you use on the commandline for any \fBAMANDA\fR command\&. Look at the example/disklist file for example\&.
-
-.TP
-\fBdiskdevice\fR
-Default: same as diskname\&. The name of the disk device to be backed up\&. It may be a full device name, a device name without the \fI/dev/\fR prefix, e\&.g\&. \fBsd0a\fR, or a mount point such as \fI/usr\fR\&.
-
-It may also refer to a PC share by starting the name with two (forward) slashes, e\&.g\&. \fI//some\-pc/home\fR\&. In this case, the \fBprogram\fR option in the associated \fBdumptype\fR must be entered as \fBGNUTAR\fR\&. It is the combination of the double slash disk name and \fBprogram GNUTAR\fR in the \fBdumptype\fR that triggers the use of Samba\&.
-
-.TP
-\fBdumptype\fR
-Refers to a \fBdumptype\fR defined in the \fBamanda\&.conf\fR file\&. \fBDumptype\fRs specify backup related parameters, such as whether to compress the backups, whether to record backup results in \fI/etc/dumpdates\fR, the disk's relative priority, etc\&.
-
-.TP
-\fBspindle\fR
-Default: \fB\-1\fR\&. A number used to balance backup load on a host\&. \fBAMANDA\fR will not run multiple backups at the same time on the same spindle, unless the spindle number is \-1, which means there is no spindle restriction\&.
-
-.TP
-\fBinterface\fR
-Default: \fBlocal\fR\&. The name of a network interface definition in the \fBamanda\&.conf\fR file, used to balance network load\&.
-
-.PP
-Instead of naming a \fBdumptype\fR, it is possible to define one in\-line, enclosing \fBdumptype\fR options within curly braces, one per line, just like a \fBdumptype\fR definition in \fBamanda\&.conf\fR\&. Since pre\-existing \fBdumptype\fRs are valid option names, this syntax may be used to customize \fBdumptype\fRs for particular disks\&.
-
-.PP
-A line break \fBmust\fR follow the left curly bracket\&.
-
-.PP
-For instance, if a \fBdumptype\fR named \fBnormal\fR is used for most disks, but use of the holding disk needs to be disabled for the file system that holds it, this would work instead of defining a new dumptype:
-.nf
-
-\fBhostname diskname\fR [ \fBdiskdevice\fR ] {
- normal
- holdingdisk no
-} [ \fBspindle\fR [ \fBinterface\fR ] ]
-.fi
-
-.SH "TAPE MANAGEMENT"
-
-.PP
-The \fBtapelist\fR file contains the list of tapes in active use\&. This file is maintained entirely by \fBAMANDA\fR and should not be created or edited during normal operation\&. It contains lines of the form:
-
-.PP
-
-.nf
-YYYYMMDD label flags
-.fi
-
-
-.PP
-Where \fBYYYYMMDD\fR is the date the tape was written, \fBlabel\fR is a label for the tape as written by \fBamlabel\fR and \fBflags\fR tell \fBAMANDA\fR whether the tape may be reused, etc (see the \fBreuse\fR options of \fBamadmin\fR)\&.
-
-.PP
-\fBAmdump\fR and \fBamflush\fR will refuse to write to an unlabeled tape, or to a labeled tape that is considered active\&. There must be more tapes in active rotation (see the \fBtapecycle\fR option) than there are runs in the backup cycle (see the \fBdumpcycle\fR option) to prevent overwriting a backup image that would be needed to do a full recovery\&.
-
-.SH "OUTPUT DRIVERS"
-
-.PP
-The normal value for the \fBtapedev\fR parameter, or for what a tape changer returns, is a full path name to a non\-rewinding tape device, such as \fI/dev/nst0\fR or \fI/dev/rmt/0mn\fR or \fI/dev/nst0\&.1\fR or whatever conventions the operating system uses\&. \fBAMANDA\fR provides additional application level drivers that support non\-traditional tape\-simulations or features\&. To access a specific output driver, set \fBtapedev\fR (or configure your changer to return) a string of the form \fBdriver\fR:\fBdriver\-info\fR where \fBdriver\fR is one of the supported drivers and \fBdriver\-info\fR is optional additional information needed by the driver\&.
-
-.PP
-The supported drivers are:
-
-.TP
-\fBtape\fR
-This is the default driver\&. The \fBdriver\-info\fR is the tape device name\&. Entering
-.nf
-tapedev /dev/rmt/0mn
-.fi
- is really a short hand for
-.nf
-tapedev tape:/dev/rmt/0mn
-.fi
-\&.
-
-.TP
-\fBnull\fR
-This driver throws away anything written to it and returns EOF for any reads except a special case is made for reading a label, in which case a ``\fBfake\fR'' value is returned that \fBAMANDA\fR checks for and allows through regardless of what you have set in \fBlabelstr\fR\&. The \fBdriver\-info\fR field is not used and may be left blank:
-
-
-.nf
-tapedev null:
-.fi
-
-
-The \fBlength\fR value from the associated \fBtapetype\fR is used to limit the amount of data written\&. When the limit is reached, the driver will simulate end of tape\&.
-
-.RS
-.Sh "Note"
-This driver should only be used for debugging and testing,
-and probably only with the
-\fBrecord\fR
-option set to
-\fBno\fR\&.