lintian doesn't like orphan packages with uploaders...
[debian/amanda] / man / disklist.5
index 59f8e0b669d52c5dc09076abdefe894574d14dbf..f66ea8fc264e7fd7437285f266852d36fcb57d69 100644 (file)
@@ -1,13 +1,22 @@
 '\" t
 .\"     Title: disklist
 .\"    Author: James da Silva <jds@amanda.org>
-.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
-.\"      Date: 04/10/2009
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 01/10/2013
 .\"    Manual: File formats and conventions
-.\"    Source: Amanda 2.6.1p1
+.\"    Source: Amanda 3.3.3
 .\"  Language: English
 .\"
-.TH "DISKLIST" "5" "04/10/2009" "Amanda 2\&.6\&.1p1" "File formats and conventions"
+.TH "DISKLIST" "5" "01/10/2013" "Amanda 3\&.3\&.3" "File formats and conventions"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
 .\" * MAIN CONTENT STARTS HERE *
 .\" -----------------------------------------------------------------
 .SH "NAME"
-disklist \- List of partitions to back up for \fIAmanda\fR
+disklist \- List of partitions to back up for Amanda
 .SH "DESCRIPTION"
 .PP
 The
 \fIdisklist\fR
-file determines which disks will be backed up by
-\fIAmanda\fR\&. The file usually contains one line per disk:
+file determines which disks will be backed up by Amanda\&. The file contains
+\fBincludefile\fR
+directive or disklist entry (\fBDLE\fR)\&.
+.PP
+\fBincludefile\fR \fIstring\fR
+.RS 4
+Default:
+\fIno default\fR\&. The name of a disklist file to include within the current file\&. Useful for sharing disklist among several configurations\&. Relative pathnames are relative to the configuration directory\&.
+.RE
+.PP
+A
+\fBDLE\fR
+usually contains one line per disk:
 .nf
 \fIhostname diskname\fR [\fIdiskdevice\fR] \fIdumptype\fR [\fIspindle\fR [\fIinterface\fR] ]
 .fi
@@ -40,9 +60,7 @@ Lines starting with # are ignored, as are blank lines\&. The fields have the fol
 .RS 4
 The name of the host to be backed up\&. If
 \fBdiskdevice\fR
-refers to a PC share, this is the host
-\fIAmanda\fR
-will run the Samba
+refers to a PC share, this is the host Amanda will run the Samba
 \fBsmbclient\fR
 program on to back up the share\&.
 .RE
@@ -53,16 +71,14 @@ 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
+and you don\*(Aqt 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
+for each entry\&. It\*(Aqs the
 \fBdiskname\fR
-that you use on the commandline for any
-\fIAmanda\fR
-command\&. Look at the example/disklist file for example\&.
+that you use on the commandline for any Amanda command\&. Look at the example/disklist file for example\&.
 .RE
 .PP
 \fIdiskdevice\fR
@@ -94,15 +110,13 @@ defined in the
 \fBamanda\&.conf\fR
 file\&.
 \fIDumptype\fRs specify backup related parameters, such as whether to compress the backups, whether to record backup results in
-/etc/dumpdates, the disk\'s relative priority, etc\&.
+/var/lib/dumpdates, the disk\*(Aqs relative priority, etc\&.
 .RE
 .PP
 \fIspindle\fR
 .RS 4
 Default:
-\fB\-1\fR\&. A number used to balance backup load on a host\&.
-\fIAmanda\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\&.
+\fB\-1\fR\&. A number used to balance backup load on a host\&. Amanda 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\&.
 .RE
 .PP
 \fIinterface\fR
@@ -138,6 +152,15 @@ is used for most disks, but use of the holding disk needs to be disabled for the
   holdingdisk never
 } [ \fIspindle\fR [ \fIinterface\fR ] ]
 .fi
+.PP
+The { must appear at the end of a line, and the } on its own line possibly followed by the spindle and interface\&.
+.SH "SEE ALSO"
+.PP
+\fBamanda\fR(8),
+\fBamanda.conf\fR(5)
+.PP
+The Amanda Wiki:
+: http://wiki.zmanda.com/
 .SH "AUTHORS"
 .PP
 \fBJames da Silva\fR <\&jds@amanda\&.org\&>