X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Famanda.conf.5;fp=man%2Famanda.conf.5;h=61389060c2da612f5cdb201fa96ae328684cb54c;hb=d74dc4d908fcbc1a4ef474edaf51e61ec90eab6b;hp=c0299afbff77495c5fafd4619d4413e58761a779;hpb=2627875b7d18858bc1f9f7652811e4d8c15a23eb;p=debian%2Famanda diff --git a/man/amanda.conf.5 b/man/amanda.conf.5 index c0299af..6138906 100644 --- a/man/amanda.conf.5 +++ b/man/amanda.conf.5 @@ -1,161 +1,13 @@ +'\" t .\" Title: amanda.conf .\" Author: James da Silva -.\" Generator: DocBook XSL Stylesheets v1.74.0 -.\" Date: 01/22/2009 +.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 +.\" Date: 04/10/2009 .\" Manual: File formats and conventions -.\" Source: Amanda 2.6.1 +.\" Source: Amanda 2.6.1p1 .\" Language: English .\" -.TH "AMANDA\&.CONF" "5" "01/22/2009" "Amanda 2\&.6\&.1" "File formats and conventions" -.\" ----------------------------------------------------------------- -.\" * (re)Define some macros -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" toupper - uppercase a string (locale-aware) -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de toupper -.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ -\\$* -.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" SH-xref - format a cross-reference to an SH section -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de SH-xref -.ie n \{\ -.\} -.toupper \\$* -.el \{\ -\\$* -.\} -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" SH - level-one heading that works better for non-TTY output -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de1 SH -.\" put an extra blank line of space above the head in non-TTY output -.if t \{\ -.sp 1 -.\} -.sp \\n[PD]u -.nr an-level 1 -.set-an-margin -.nr an-prevailing-indent \\n[IN] -.fi -.in \\n[an-margin]u -.ti 0 -.HTML-TAG ".NH \\n[an-level]" -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -\." make the size of the head bigger -.ps +3 -.ft B -.ne (2v + 1u) -.ie n \{\ -.\" if n (TTY output), use uppercase -.toupper \\$* -.\} -.el \{\ -.nr an-break-flag 0 -.\" if not n (not TTY), use normal case (not uppercase) -\\$1 -.in \\n[an-margin]u -.ti 0 -.\" if not n (not TTY), put a border/line under subheading -.sp -.6 -\l'\n(.lu' -.\} -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" SS - level-two heading that works better for non-TTY output -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de1 SS -.sp \\n[PD]u -.nr an-level 1 -.set-an-margin -.nr an-prevailing-indent \\n[IN] -.fi -.in \\n[IN]u -.ti \\n[SN]u -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.ps \\n[PS-SS]u -\." make the size of the head bigger -.ps +2 -.ft B -.ne (2v + 1u) -.if \\n[.$] \&\\$* -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" BB/BE - put background/screen (filled box) around block of text -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de BB -.if t \{\ -.sp -.5 -.br -.in +2n -.ll -2n -.gcolor red -.di BX -.\} -.. -.de EB -.if t \{\ -.if "\\$2"adjust-for-leading-newline" \{\ -.sp -1 -.\} -.br -.di -.in -.ll -.gcolor -.nr BW \\n(.lu-\\n(.i -.nr BH \\n(dn+.5v -.ne \\n(BHu+.5v -.ie "\\$2"adjust-for-leading-newline" \{\ -\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] -.\} -.el \{\ -\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] -.\} -.in 0 -.sp -.5v -.nf -.BX -.in -.sp .5v -.fi -.\} -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" BM/EM - put colored marker in margin next to block of text -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de BM -.if t \{\ -.br -.ll -2n -.gcolor red -.di BX -.\} -.. -.de EM -.if t \{\ -.br -.di -.ll -.gcolor -.nr BH \\n(dn -.ne \\n(BHu -\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] -.in 0 -.nf -.BX -.in -.fi -.\} -.. +.TH "AMANDA\&.CONF" "5" "04/10/2009" "Amanda 2\&.6\&.1p1" "File formats and conventions" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -166,7 +18,7 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- -.SH "Name" +.SH "NAME" amanda.conf \- Main configuration file for \fIAmanda\fR, the Advanced Maryland Automatic Network Disk Archiver .SH "DESCRIPTION" .PP @@ -288,7 +140,6 @@ Some number of weeks (days*7)\&. .sp .\} .RS 4 -.BM yellow .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 @@ -319,7 +170,6 @@ to indicate a false state\&. If no argument is given, \fBtrue\fR is assumed\&. .sp .5v -.EM yellow .RE .RE .SS "PARAMETER ORDER" @@ -405,7 +255,6 @@ Default: .sp .\} .RS 4 -.BM yellow .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 @@ -422,7 +271,6 @@ This parameter may also be set in a specific before any \fBdumptype\fRs are defined\&. .sp .5v -.EM yellow .RE .RE .PP @@ -510,7 +358,7 @@ option\&. \fBtapedev\fR string .RS 4 Default: -\FCnull:\F[]\&. The device name, referencing the name of a "device" section in the configuration file\&. See +null:\&. The device name, referencing the name of a "device" section in the configuration file\&. See \fBamanda-devices\fR(7) for more information on device names\&. .sp @@ -558,7 +406,7 @@ If a tape changer is configured, choose one of the changer scripts (e\&.g\&. \fBchangerdev\fR string .RS 4 Default: -\FC/dev/null\F[]\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the +/dev/null\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the \fBtpchanger\fR option\&. .RE @@ -566,7 +414,7 @@ option\&. \fBchangerfile\fR string .RS 4 Default: -\FC/usr/adm/amanda/log/changer\-status\F[]\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the +/usr/adm/amanda/log/changer\-status\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the \fBtpchanger\fR option\&. .RE @@ -574,7 +422,7 @@ option\&. \fBruntapes\fR int .RS 4 Default: -\FC1\F[]\&. 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\&. +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\&. .sp If a tape changer is configured, this may be set larger than one to let \fIAmanda\fR @@ -711,7 +559,7 @@ section\&. \fBinparallel\fR int .RS 4 Default: -\FC10\F[]\&. The maximum number of backups that +10\&. The maximum number of backups that \fIAmanda\fR will attempt to run in parallel\&. \fIAmanda\fR @@ -721,7 +569,7 @@ will stay within the constraints of network bandwidth and holding disk space ava \fBdisplayunit\fR "k|m|g|t" .RS 4 Default: -\FC"k"\F[]\&. The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera\&. +"k"\&. The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera\&. .RE .PP \fBdumporder\fR string @@ -742,7 +590,7 @@ B: largest bandwidth \fBmaxdumps\fR int .RS 4 Default: -\FC1\F[]\&. The maximum number of backups from a single host that +1\&. The maximum number of backups from a single host that \fIAmanda\fR will attempt to run in parallel\&. See also the \fBinparallel\fR @@ -800,7 +648,7 @@ and \fBbumpmult\fR \fI float\fR .RS 4 Default: -\FC1\&.5\F[]\&. The bump size multiplier\&. +1\&.5\&. The bump size multiplier\&. \fIAmanda\fR multiplies \fBbumpsize\fR @@ -836,7 +684,7 @@ file holding client hosts, disks and other client dumping information\&. \fBinfofile\fR \fI string\fR .RS 4 Default: -\FC/usr/adm/amanda/curinfo\F[]\&. The file or directory name for the historical information database\&. If +/usr/adm/amanda/curinfo\&. The file or directory name for the historical information database\&. If \fIAmanda\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\&. .RE @@ -844,7 +692,7 @@ was configured to use DBM databases, this is the base file name for them\&. If i \fBlogdir\fR \fI string\fR .RS 4 Default: -\FC/usr/adm/amanda\F[]\&. The directory for the +/usr/adm/amanda\&. The directory for the \fBamdump\fR and \fBlog\fR @@ -854,7 +702,7 @@ files\&. \fBindexdir\fR \fI string\fR .RS 4 Default -\FC/usr/adm/amanda/index\F[]\&. The directory where index files (backup image catalogues) are stored\&. Index files are only generated for filesystems whose +/usr/adm/amanda/index\&. The directory where index files (backup image catalogues) are stored\&. Index files are only generated for filesystems whose \fBdumptype\fR has the \fBindex\fR @@ -873,7 +721,7 @@ maintains this file with information about the active set of tapes\&. \fBdevice_output_buffer_size\fR \fI int\fR .RS 4 Default: -\FC1280k\F[]\&. Controls the amount of memory used by +1280k\&. Controls the amount of memory used by \fIAmanda\fR 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\&. .sp @@ -883,7 +731,7 @@ The default unit is bytes if it is not specified\&. \fBtapebufs\fR \fI int\fR .RS 4 Default: -\FC20\F[]\&. This option is deprecated; use the +20\&. This option is deprecated; use the \fBdevice_output_buffer_size\fR directive instead\&. \fBtapebufs\fR @@ -893,7 +741,7 @@ works the same way, but the number specified is multiplied by the device blocksi \fBreserve\fR \fI number\fR .RS 4 Default: -\FC100\F[]\&. The part of holding\-disk space that should be reserved for incremental backups if no tape is available, expressed as a percentage of the available holding\-disk space (0\-100)\&. By default, when there is no tape to write to, degraded mode (incremental) backups will be performed to the holding disk\&. If full backups should also be allowed in this case, the amount of holding disk space reserved for incrementals should be lowered\&. +100\&. The part of holding\-disk space that should be reserved for incremental backups if no tape is available, expressed as a percentage of the available holding\-disk space (0\-100)\&. By default, when there is no tape to write to, degraded mode (incremental) backups will be performed to the holding disk\&. If full backups should also be allowed in this case, the amount of holding disk space reserved for incrementals should be lowered\&. .RE .PP \fBautoflush\fR \fI bool\fR @@ -972,7 +820,6 @@ the amount of space to display before the column (used to get whitespace between .\} 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\&. .RE -.RS 4 Here is an example: .sp .nf @@ -1151,7 +998,7 @@ file may define one or more holding disks used as buffers to hold backup images .nf holdingdisk \fIname\fR { \fIholdingdisk\-option\fR \fIholdingdisk\-value\fR - \FC\&.\&.\&.\F[] + \&.\&.\&. } .fi .PP @@ -1169,7 +1016,7 @@ Default: \fBdirectory\fR \fI disk\fR .RS 4 Default: -\FC/dumps/amanda\F[]\&. The path to this holding area\&. +/dumps/amanda\&. The path to this holding area\&. .RE .PP \fBuse\fR \fI int\fR @@ -1211,7 +1058,7 @@ section, which looks like this: .nf define dumptype "\fIname\fR" { \fIdumptype\-option\fR \fIdumptype\-value\fR - \FC\&.\&.\&.\F[] + \&.\&.\&. } .fi .PP @@ -1293,7 +1140,7 @@ and \fBbumpmult\fR \fI float\fR .RS 4 Default: -\FC1\&.5\F[]\&. The bump size multiplier\&. +1\&.5\&. The bump size multiplier\&. \fIAmanda\fR multiplies \fBbumpsize\fR @@ -1323,8 +1170,8 @@ Default: \fBcomprate\fR \fIfloat\fR [, \fIfloat\fR ] .RS 4 Default: -\FC0\&.50\F[], -\FC0\&.50\F[]\&. The expected full and incremental compression factor for dumps\&. It is only used if +0\&.50, +0\&.50\&. The expected full and incremental compression factor for dumps\&. It is only used if \fIAmanda\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\&. .RE @@ -1521,12 +1368,12 @@ For exclude list "\&.amanda\&.excludes" .fi the actual file used would be -\FC/var/\&.amanda\&.excludes\F[] +/var/\&.amanda\&.excludes for a backup of -\FC/var\F[], -\FC/usr/local/\&.amanda\&.excludes\F[] +/var, +/usr/local/\&.amanda\&.excludes for a backup of -\FC/usr/local\F[], and so on\&. +/usr/local, and so on\&. .RE .PP \fBholdingdisk\fR [ never|auto|required ] @@ -1594,7 +1441,6 @@ Include expressions must always be specified as relative to the head directory o .sp .\} .RS 4 -.BM yellow .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 @@ -1607,7 +1453,6 @@ For globbing to work at all, even the limited single level, the top level direct \fIAmanda\fR user\&. .sp .5v -.EM yellow .RE With the \fBappend\fR @@ -1645,7 +1490,7 @@ Default: \fBmaxdumps\fR \fI int\fR .RS 4 Default: -\FC1\F[]\&. The maximum number of backups from a single host that +1\&. The maximum number of backups from a single host that \fIAmanda\fR will attempt to run in parallel\&. See also the main section parameter \fBinparallel\fR\&. @@ -1654,7 +1499,7 @@ will attempt to run in parallel\&. See also the main section parameter \fBmaxpromoteday\fR \fI int\fR .RS 4 Default: -\FC10000\F[]\&. 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\&. +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\&. .RE .PP \fBpriority\fR \fI string\fR @@ -1712,9 +1557,9 @@ keyword append the values to the list of values for that property\&. .RS 4 Default: \fIyes\fR\&. Whether to ask the backup program to update its database (e\&.g\&. -\FC/etc/dumpdates\F[] +/etc/dumpdates for DUMP or -\FC/usr/local/var/amanda/gnutar\-lists\F[] +/usr/local/var/amanda/gnutar\-lists for GNUTAR) of time stamps\&. This is normally enabled for daily backups and turned off for periodic archival runs\&. .RE .PP @@ -1744,7 +1589,7 @@ has scheduled an incremental backup, these disks will be skipped\&. .RS 4 Default: \fInone\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 -\FC1830\F[]\&. +1830\&. .RE .PP \fBstrategy\fR \fI string\fR @@ -1886,7 +1731,7 @@ section, which looks like this in the config file: .nf define tapetype "\fIname\fR" { \fItapetype\-option\fR \fItapetype\-value\fR - \FC\&.\&.\&.\F[] + \&.\&.\&. } .fi .PP @@ -1912,7 +1757,7 @@ Default: \fBlength\fR \fI int\fR .RS 4 Default: -\fI2000 kbytes\fR\&. How much data will fit on a tape\&. +\fI2000 kbytes\fR\&. How much data will fit on a tape, expressed in kbytes\&. .sp Note that this value is only used by \fIAmanda\fR @@ -1920,21 +1765,17 @@ to schedule which backups will be run\&. Once the backups start, \fIAmanda\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)\&. -.sp -The default unit is bytes if it is not specified\&. +(but see +\fBamanda-devices\fR(7) +for exceptions)\&. .RE .PP \fBblocksize\fR \fI int\fR .RS 4 Default: -\fI32 kbytes\fR\&. How much data will be written in each tape record\&. This is equivalent to the +\fI32 kbytes\fR\&. How much data will be written in each tape record, expressed in kbytes\&. This is similar to the \fIBLOCK_SIZE\fR -device property\&. -.sp -The default unit is Kbytes if it is not specified\&. +device property, but if the blocksize is not a multiple of 1024 bytes, then this parameter cannot be used to specify it, and the property must be used instead\&. .RE .PP \fBreadblocksize\fR \fI int\fR @@ -1995,7 +1836,7 @@ section, which looks like this: .nf define interface "\fIname\fR" { \fIinterface\-option\fR \fIinterface\-value\fR - \FC\&.\&.\&.\F[] + \&.\&.\&. } .fi .PP @@ -2041,7 +1882,7 @@ section, which looks like this: .nf define application\-tool "\fIname\fR" { \fIapplication\-option\fR \fIapplication\-value\fR - \FC\&.\&.\&.\F[] + \&.\&.\&. } .fi .PP @@ -2082,7 +1923,7 @@ section, which looks like this: .nf define script\-tool "\fIname\fR" { \fIscript\-option\fR \fIscript\-value\fR - \FC\&.\&.\&.\F[] + \&.\&.\&. } .fi .PP @@ -2232,7 +2073,7 @@ define device \fIname\fR { commend "\fIcomment (optional)\fR" tapedev "\fIdevice\-specifier\fR" device_property "\fIprop\-name\fR" "\fIprop\-value\fR" - \FC\&.\&.\&.\F[] + \&.\&.\&. } .fi .PP @@ -2263,14 +2104,12 @@ define changer \fIname\fR { tpchanger "\fIchanger\-type\fR" changerdev "\fIdevice\-name\fR" changerfile "\fIstate\-file\fR" - \FC\&.\&.\&.\F[] + \&.\&.\&. } .fi .PP \fIname\fR is the user\-specified name of this device\&. The remaining parameters are specific to the changer type selected\&. -.PP -TODO: more detail here once it\'s known .SH "SEE ALSO" .PP @@ -2279,7 +2118,7 @@ TODO: more detail here once it\'s known \fBamcrypt\fR(8), \fBaespipe\fR(1), : http://wiki.zmanda.com -.SH "Authors" +.SH "AUTHORS" .PP \fBJames da Silva\fR <\&jds@amanda\&.org\&> .PP