git.gag.com Git - debian/amanda/blob - man/disklist.5

   1 .\"     Title: disklist
   2 .\"    Author: James da Silva <jds@amanda.org>
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 01/22/2009
   5 .\"    Manual: File formats and conventions
   6 .\"    Source: Amanda 2.6.1
   7 .\"  Language: English
   8 .\"
   9 .TH "DISKLIST" "5" "01/22/2009" "Amanda 2\&.6\&.1" "File formats and conventions"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 disklist \- List of partitions to back up for \fIAmanda\fR
 171 .SH "DESCRIPTION"
 172 .PP
 173 The
 174 \fIdisklist\fR
 175 file determines which disks will be backed up by
 176 \fIAmanda\fR\&. The file usually contains one line per disk:
 177 .nf
 178 \fIhostname diskname\fR [\fIdiskdevice\fR] \fIdumptype\fR [\fIspindle\fR [\fIinterface\fR] ]
 179 .fi
 180 .PP
 181 All pairs [
 182 \fIhostname diskname\fR
 183 ] must be unique\&.
 184 .PP
 185 Lines starting with # are ignored, as are blank lines\&. The fields have the following meanings:
 186 .PP
 187 \fIhostname\fR
 188 .RS 4
 189 The name of the host to be backed up\&. If
 190 \fBdiskdevice\fR
 191 refers to a PC share, this is the host
 192 \fIAmanda\fR
 193 will run the Samba
 194 \fBsmbclient\fR
 195 program on to back up the share\&.
 196 .RE
 197 .PP
 198 \fIdiskname\fR
 199 .RS 4
 200 The name of the disk (a label)\&. In most case, you set your
 201 \fBdiskname\fR
 202 to the
 203 \fBdiskdevice\fR
 204 and you don\'t set the
 205 \fBdiskdevice\&.\fR
 206 If you want multiple entries with the same
 207 \fBdiskdevice\fR, you must set a different
 208 \fBdiskname\fR
 209 for each entry\&. It\'s the
 210 \fBdiskname\fR
 211 that you use on the commandline for any
 212 \fIAmanda\fR
 213 command\&. Look at the example/disklist file for example\&.
 214 .RE
 215 .PP
 216 \fIdiskdevice\fR
 217 .RS 4
 218 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
 219 \FC/dev/\F[]
 220 prefix, e\&.g\&.
 221 \fIsd0a\fR, or a mount point such as
 222 \FC/usr\F[]\&.
 223 .sp
 224 It may also refer to a PC share by starting the name with two (forward) slashes, e\&.g\&.
 225 \FC//some\-pc/home\F[]\&. In this case, the
 226 \fBprogram\fR
 227 option in the associated
 228 \fBdumptype\fR
 229 must be entered as
 230 \fBGNUTAR\fR\&. It is the combination of the double slash disk name and
 231 \fBprogram GNUTAR\fR
 232 in the
 233 \fBdumptype\fR
 234 that triggers the use of Samba\&.
 235 .RE
 236 .PP
 237 \fIdumptype\fR
 238 .RS 4
 239 Refers to a
 240 \fBdumptype\fR
 241 defined in the
 242 \fBamanda\&.conf\fR
 243 file\&.
 244 \fIDumptype\fRs specify backup related parameters, such as whether to compress the backups, whether to record backup results in
 245 \FC/etc/dumpdates\F[], the disk\'s relative priority, etc\&.
 246 .RE
 247 .PP
 248 \fIspindle\fR
 249 .RS 4
 250 Default:
 251 \fB\-1\fR\&. A number used to balance backup load on a host\&.
 252 \fIAmanda\fR
 253 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\&.
 254 .RE
 255 .PP
 256 \fIinterface\fR
 257 .RS 4
 258 Default:
 259 \fIlocal\fR\&. The name of a network interface definition in the
 260 \fBamanda\&.conf\fR
 261 file, used to balance network load\&.
 262 .RE
 263 .PP
 264 Instead of naming a
 265 \fBdumptype\fR, it is possible to define one in\-line, enclosing
 266 \fBdumptype\fR
 267 options within curly braces, one per line, just like a
 268 \fBdumptype\fR
 269 definition in
 270 \fBamanda\&.conf\fR\&. Since pre\-existing
 271 \fBdumptype\fRs are valid option names, this syntax may be used to customize
 272 \fBdumptype\fRs for particular disks\&.
 273 .PP
 274 A line break
 275 \fBmust\fR
 276 follow the left curly bracket\&.
 277 .PP
 278 For instance, if a
 279 \fBdumptype\fR
 280 named
 281 \fInormal\fR
 282 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:
 283 .nf
 284 \fIhostname diskname\fR [ \fIdiskdevice\fR ] {
 285   normal
 286   holdingdisk never
 287 } [ \fIspindle\fR [ \fIinterface\fR ] ]
 288 .fi
 289 .SH "Authors"
 290 .PP
 291 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
 292 .PP
 293 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>
 294 .PP
 295 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
 296 .RS 4
 297 Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])
 298 .RE