lintian doesn't like orphan packages with uploaders...
[debian/amanda] / man / amadmin.8
index d3012e03aae8306a8c468389f741d26d3cc3902d..d304887ddc592ecab538b4304e8c045db10b33e4 100644 (file)
@@ -1,13 +1,22 @@
 '\" t
 .\"     Title: amadmin
 .\"    Author: James da Silva <jds@amanda.org>
-.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
-.\"      Date: 06/01/2010
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 01/10/2013
 .\"    Manual: System Administration Commands
-.\"    Source: Amanda 3.1.0
+.\"    Source: Amanda 3.3.3
 .\"  Language: English
 .\"
-.TH "AMADMIN" "8" "06/01/2010" "Amanda 3\&.1\&.0" "System Administration Commands"
+.TH "AMADMIN" "8" "01/10/2013" "Amanda 3\&.3\&.3" "System Administration Commands"
+.\" -----------------------------------------------------------------
+.\" * 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
 .\" -----------------------------------------------------------------
@@ -22,7 +31,7 @@
 amadmin \- administrative interface to control Amanda backups
 .SH "SYNOPSIS"
 .HP \w'\fBamadmin\fR\ 'u
-\fBamadmin\fR \fIconfig\fR \fIcommand\fR [\fIcommand_options\fR...] [{\fB\-o\fR\ \fIconfigoption\fR}...]
+\fBamadmin\fR [\-\-version] [\-\-no\-default] [\-\-print\-source] [\-\-exact\-match] [\fB\-o\fR\ \fIconfigoption\fR...] \fIconfig\fR \fIcommand\fR [\fIcommand_options\fR...]
 .SH "DESCRIPTION"
 .PP
 \fBAmadmin\fR
@@ -33,6 +42,35 @@ Amanda configuration\&.
 See the
 \fBamanda\fR(8)
 man page for more details about Amanda\&.
+.SH "OPTIONS"
+.PP
+\fB\-\-version\fR
+.RS 4
+Print the version and exit\&.
+.RE
+.PP
+\fB\-\-no\-default\fR
+.RS 4
+Do not print default values for
+\fBconfig\fR
+and
+\fBdisklist\fR
+commands\&.
+.RE
+.PP
+\fB\-\-print\-source\fR
+.RS 4
+Print where a value is defined for
+\fBconfig\fR
+and
+\fBdisklist\fR
+commands\&.
+.RE
+.PP
+\fB\-\-exact\-match\fR
+.RS 4
+The host and disk are parsed as exact values
+.RE
 .SH "COMMANDS"
 .PP
 Commands that take a
@@ -46,18 +84,13 @@ for that
 if no disks are specified\&. Where
 \fIhostname\fR
 is also marked as being optional, the command operates on all hosts and disks in the
-\fBdisklist\fR(5)\&. Both
+\fBdisklist\fR(5)
+when no hostname is given\&. Both
 \fIhostname\fR
 and
 \fIdisks\fR
-are special expressions; see the "HOST & DISK EXPRESSION" section of
-\fBamanda\fR(8)
-for a description\&.
-.PP
-Commands that take one or more
-\fIdumpspec\fR
-parameters operate on the set of dumps specified by all of the expressions\&. See the "DUMP SPECIFICATIONS" section of
-\fBamanda\fR(8)
+are match expressions; see
+\fBamanda-match\fR(7)
 for a description\&.
 .PP
 \fBversion\fR
@@ -192,11 +225,13 @@ Delete holding files matching the given specification\&. At least a hostname mus
 .PP
 \fBholding list\fR [\-l] [\-d] [ \fIhostname\fR [ \fIdisk\fR [ \fIdatestamp\fR [ \&.\&. ] ] ] ]
 .RS 4
-List holding files matching the given specification, or all holding files if no specification is provided\&. With \'\-l\', additional information (size, level, and whether the dump is outdated) is provided\&. With \'\-d\', only outdated dumps are shown\&.
+List holding files matching the given dump specification, or all holding files if no specification is provided\&. See
+\fBamanda-match\fR(7)
+for more information on dump specifications\&. With \*(Aq\-l\*(Aq, additional information (size, level, and whether the dump is outdated) is provided\&. With \*(Aq\-d\*(Aq, only outdated dumps are shown\&.
 .sp
 An outdated holding file is one which is not required for a restore of the
 \fImost recent\fR
-dump\&. Note that outdated dumps may still be required for restores at earlier dates\&. For example, assume that a DLE had a level 0 on Monday, level 1\'s Tuesday through Thursday, and a level 2 on Friday\&. Then the files required for a restore of Fridays (the most recent) dump are those from Monday (level 0), Thursday (level 1), and Friday (level 2)\&. Tuesday and Wednesday\'s files are outdated\&.
+dump\&. Note that outdated dumps may still be required for restores at earlier dates\&. For example, assume that a DLE had a level 0 on Monday, level 1\*(Aqs Tuesday through Thursday, and a level 2 on Friday\&. Then the files required for a restore of Fridays (the most recent) dump are those from Monday (level 0), Thursday (level 1), and Friday (level 2)\&. Tuesday and Wednesday\*(Aqs files are outdated\&.
 .RE
 .PP
 \fBdelete\fR [ \fIhostname\fR [ \fIdisks\fR ]* ]+
@@ -264,6 +299,18 @@ on
 (or all hosts)\&. Mostly used for debugging\&.
 .RE
 .PP
+\fBhosts\fR
+.RS 4
+Output a list of distinct hosts in the
+\fBdisklist\fR(5), one per line, for easy use in shell scripts\&.
+.RE
+.PP
+\fBdles\fR
+.RS 4
+Output a list of distinct DLEs in the
+\fBdisklist\fR(5), one per line with host and diskname separated by a space, for easy use in shell scripts\&.
+.RE
+.PP
 \fBinfo\fR [ \fIhostname\fR [ \fIdisks\fR ]* ]*
 .RS 4
 Display the database record for each of the
@@ -346,7 +393,7 @@ file, Amanda will treat it as a new disk during the next run\&.
 .nf
 $ amadmin daily delete machine\-d /workspace
 amadmin: machine\-d:/workspace deleted from database\&.
-amadmin: NOTE: you\'ll have to remove these from the \fBdisklist\fR(5) yourself\&.
+amadmin: NOTE: you\*(Aqll have to remove these from the \fBdisklist\fR(5) yourself\&.
 .fi
 .PP
 Find the next tape Amanda will use (in this case,
@@ -368,7 +415,7 @@ show the estimated total size of the backups before and after any compression, r
 .PP
 The
 \fIbalance\fR
-column shows how far off that night\'s backups are from the average size (shown at the bottom of the balance column)\&. Amanda tries to keep the backups within +/\- 5%, but since the amount of data on each filesystem is always changing, and Amanda will never delay backups just to rebalance the schedule, it is common for the schedule to fluctuate by larger percentages\&. In particular, in the case of a tape or backup failure, a bump will occur the following night, which will not be smoothed out until the next pass through the schedule\&.
+column shows how far off that night\*(Aqs backups are from the average size (shown at the bottom of the balance column)\&. Amanda tries to keep the backups within +/\- 5%, but since the amount of data on each filesystem is always changing, and Amanda will never delay backups just to rebalance the schedule, it is common for the schedule to fluctuate by larger percentages\&. In particular, in the case of a tape or backup failure, a bump will occur the following night, which will not be smoothed out until the next pass through the schedule\&.
 .PP
 The last line also shows an estimate of how many Amanda runs will be made between full backups for a file system\&. In the example, a file system will probably have a full backup done every eight times Amanda is run (e\&.g\&. every eight days)\&.
 .nf
@@ -388,9 +435,6 @@ $ amadmin daily balance
 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
 TOTAL      241  12412187   7316312   731631  (estimated 8 runs per dumpcycle)
 .fi
-.SH "FILES"
-.PP
-/usr/local/etc/amanda/\fIconfig\fR/amanda\&.conf
 .SH "SEE ALSO"
 .PP
 \fBamanda\fR(8),
@@ -398,7 +442,8 @@ TOTAL      241  12412187   7316312   731631  (estimated 8 runs per dumpcycle)
 \fBamcheck\fR(8),
 \fBamdump\fR(8),
 \fBamrestore\fR(8),
-\fBamfetchdump\fR(8)
+\fBamfetchdump\fR(8),
+\fBamanda-match\fR(7)
 .PP
 The Amanda Wiki:
 : http://wiki.zmanda.com/