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

   1 '\" t
   2 .\"     Title: disklist
   3 .\"    Author: James da Silva <jds@amanda.org>
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
   5 .\"      Date: 04/10/2009
   6 .\"    Manual: File formats and conventions
   7 .\"    Source: Amanda 2.6.1p1
   8 .\"  Language: English
   9 .\"
  10 .TH "DISKLIST" "5" "04/10/2009" "Amanda 2\&.6\&.1p1" "File formats and conventions"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 disklist \- List of partitions to back up for \fIAmanda\fR
  23 .SH "DESCRIPTION"
  24 .PP
  25 The
  26 \fIdisklist\fR
  27 file determines which disks will be backed up by
  28 \fIAmanda\fR\&. The file usually contains one line per disk:
  29 .nf
  30 \fIhostname diskname\fR [\fIdiskdevice\fR] \fIdumptype\fR [\fIspindle\fR [\fIinterface\fR] ]
  31 .fi
  32 .PP
  33 All pairs [
  34 \fIhostname diskname\fR
  35 ] must be unique\&.
  36 .PP
  37 Lines starting with # are ignored, as are blank lines\&. The fields have the following meanings:
  38 .PP
  39 \fIhostname\fR
  40 .RS 4
  41 The name of the host to be backed up\&. If
  42 \fBdiskdevice\fR
  43 refers to a PC share, this is the host
  44 \fIAmanda\fR
  45 will run the Samba
  46 \fBsmbclient\fR
  47 program on to back up the share\&.
  48 .RE
  49 .PP
  50 \fIdiskname\fR
  51 .RS 4
  52 The name of the disk (a label)\&. In most case, you set your
  53 \fBdiskname\fR
  54 to the
  55 \fBdiskdevice\fR
  56 and you don\'t set the
  57 \fBdiskdevice\&.\fR
  58 If you want multiple entries with the same
  59 \fBdiskdevice\fR, you must set a different
  60 \fBdiskname\fR
  61 for each entry\&. It\'s the
  62 \fBdiskname\fR
  63 that you use on the commandline for any
  64 \fIAmanda\fR
  65 command\&. Look at the example/disklist file for example\&.
  66 .RE
  67 .PP
  68 \fIdiskdevice\fR
  69 .RS 4
  70 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
  71 /dev/
  72 prefix, e\&.g\&.
  73 \fIsd0a\fR, or a mount point such as
  74 /usr\&.
  75 .sp
  76 It may also refer to a PC share by starting the name with two (forward) slashes, e\&.g\&.
  77 //some\-pc/home\&. In this case, the
  78 \fBprogram\fR
  79 option in the associated
  80 \fBdumptype\fR
  81 must be entered as
  82 \fBGNUTAR\fR\&. It is the combination of the double slash disk name and
  83 \fBprogram GNUTAR\fR
  84 in the
  85 \fBdumptype\fR
  86 that triggers the use of Samba\&.
  87 .RE
  88 .PP
  89 \fIdumptype\fR
  90 .RS 4
  91 Refers to a
  92 \fBdumptype\fR
  93 defined in the
  94 \fBamanda\&.conf\fR
  95 file\&.
  96 \fIDumptype\fRs specify backup related parameters, such as whether to compress the backups, whether to record backup results in
  97 /var/lib/dumpdates, the disk\'s relative priority, etc\&.
  98 .RE
  99 .PP
 100 \fIspindle\fR
 101 .RS 4
 102 Default:
 103 \fB\-1\fR\&. A number used to balance backup load on a host\&.
 104 \fIAmanda\fR
 105 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\&.
 106 .RE
 107 .PP
 108 \fIinterface\fR
 109 .RS 4
 110 Default:
 111 \fIlocal\fR\&. The name of a network interface definition in the
 112 \fBamanda\&.conf\fR
 113 file, used to balance network load\&.
 114 .RE
 115 .PP
 116 Instead of naming a
 117 \fBdumptype\fR, it is possible to define one in\-line, enclosing
 118 \fBdumptype\fR
 119 options within curly braces, one per line, just like a
 120 \fBdumptype\fR
 121 definition in
 122 \fBamanda\&.conf\fR\&. Since pre\-existing
 123 \fBdumptype\fRs are valid option names, this syntax may be used to customize
 124 \fBdumptype\fRs for particular disks\&.
 125 .PP
 126 A line break
 127 \fBmust\fR
 128 follow the left curly bracket\&.
 129 .PP
 130 For instance, if a
 131 \fBdumptype\fR
 132 named
 133 \fInormal\fR
 134 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:
 135 .nf
 136 \fIhostname diskname\fR [ \fIdiskdevice\fR ] {
 137   normal
 138   holdingdisk never
 139 } [ \fIspindle\fR [ \fIinterface\fR ] ]
 140 .fi
 141 .SH "AUTHORS"
 142 .PP
 143 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
 144 .PP
 145 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>
 146 .PP
 147 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
 148 .RS 4
 149 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 150 .RE