2 .\" Author: James da Silva <jds@amanda.org>
3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
5 .\" Manual: File formats and conventions
6 .\" Source: Amanda 2.6.1
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 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 .\" SH-xref - format a cross-reference to an SH section
23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33 .\" SH - level-one heading that works better for non-TTY output
34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36 .\" put an extra blank line of space above the head in non-TTY output
43 .nr an-prevailing-indent \\n[IN]
47 .HTML-TAG ".NH \\n[an-level]"
49 .nr an-no-space-flag 1
51 \." make the size of the head bigger
56 .\" if n (TTY output), use uppercase
61 .\" if not n (not TTY), use normal case (not uppercase)
65 .\" if not n (not TTY), put a border/line under subheading
70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71 .\" SS - level-two heading that works better for non-TTY output
72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
77 .nr an-prevailing-indent \\n[IN]
82 .nr an-no-space-flag 1
85 \." make the size of the head bigger
91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92 .\" BB/BE - put background/screen (filled box) around block of text
93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
106 .if "\\$2"adjust-for-leading-newline" \{\
114 .nr BW \\n(.lu-\\n(.i
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[]
121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133 .\" BM/EM - put colored marker in margin next to block of text
134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
159 .\" -----------------------------------------------------------------
160 .\" * set default formatting
161 .\" -----------------------------------------------------------------
162 .\" disable hyphenation
164 .\" disable justification (adjust text to left margin only)
166 .\" -----------------------------------------------------------------
167 .\" * MAIN CONTENT STARTS HERE *
168 .\" -----------------------------------------------------------------
170 disklist \- List of partitions to back up for \fIAmanda\fR
175 file determines which disks will be backed up by
176 \fIAmanda\fR\&. The file usually contains one line per disk:
178 \fIhostname diskname\fR [\fIdiskdevice\fR] \fIdumptype\fR [\fIspindle\fR [\fIinterface\fR] ]
182 \fIhostname diskname\fR
185 Lines starting with # are ignored, as are blank lines\&. The fields have the following meanings:
189 The name of the host to be backed up\&. If
191 refers to a PC share, this is the host
195 program on to back up the share\&.
200 The name of the disk (a label)\&. In most case, you set your
204 and you don\'t set the
206 If you want multiple entries with the same
207 \fBdiskdevice\fR, you must set a different
209 for each entry\&. It\'s the
211 that you use on the commandline for any
213 command\&. Look at the example/disklist file for example\&.
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
221 \fIsd0a\fR, or a mount point such as
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
227 option in the associated
230 \fBGNUTAR\fR\&. It is the combination of the double slash disk name and
234 that triggers the use of Samba\&.
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\&.
251 \fB\-1\fR\&. A number used to balance backup load on a host\&.
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\&.
259 \fIlocal\fR\&. The name of a network interface definition in the
261 file, used to balance network load\&.
265 \fBdumptype\fR, it is possible to define one in\-line, enclosing
267 options within curly braces, one per line, just like a
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\&.
276 follow the left curly bracket\&.
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:
284 \fIhostname diskname\fR [ \fIdiskdevice\fR ] {
287 } [ \fIspindle\fR [ \fIinterface\fR ] ]
291 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
293 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>
295 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
297 Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])