Imported Upstream version 3.3.2
[debian/amanda] / man / amflush.8
index aa7c9e3ad183f3c4f282771ff880cb8a5c686810..d37d0631a156ba1f2b4c9b51ab8c01d43b047f80 100644 (file)
@@ -1,13 +1,22 @@
 '\" t
 .\"     Title: amflush
 .\"    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: 07/25/2012
 .\"    Manual: System Administration Commands
-.\"    Source: Amanda 2.6.1p1
+.\"    Source: Amanda 3.3.2
 .\"  Language: English
 .\"
-.TH "AMFLUSH" "8" "04/10/2009" "Amanda 2\&.6\&.1p1" "System Administration Commands"
+.TH "AMFLUSH" "8" "07/25/2012" "Amanda 3\&.3\&.2" "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
 .\" -----------------------------------------------------------------
 .\" * MAIN CONTENT STARTS HERE *
 .\" -----------------------------------------------------------------
 .SH "NAME"
-amflush \- flush \fIAmanda\fR backup files from holding disk to tape
+amflush \- flush Amanda backup files from holding disk to tape
 .SH "SYNOPSIS"
 .HP \w'\fBamflush\fR\ 'u
-\fBamflush\fR [\-b] [\-f] [\-s] [\-D\ \fIdatestamp\fR] \fIconfig\fR [\fIhost\fR\ [\fIdisk\fR...]...] [\-o\ \fIconfigoption\fR]...
+\fBamflush\fR [\-b] [\-f] [\-s] [\-D\ \fIdatestamp\fR] [\fB\-o\fR\ \fIconfigoption\fR...] \fIconfig\fR [\fIhost\fR\ [\fIdisk\fR...]...]
 .SH "DESCRIPTION"
 .PP
 \fBAmflush\fR
-writes
-\fIAmanda\fR
-backups from the holding disks to tape, and updates the
-\fIAmanda\fR
-info database and
+writes Amanda backups from the holding disks to tape, and updates the Amanda info database and
 \fBtapelist\fR(5)
-accordingly\&. Backups may stay in a holding disk when something is wrong with the tape at the time
+accordingly\&. It is similar to amdump, but does not perform any backup operations on Amanda clients\&. Backups may stay in a holding disk when something is wrong with the tape at the time
 \fBamdump\fR
 is run\&. When this happens, the problem must be corrected and
 \fBamflush\fR
 run by hand\&.
+.PP
+The command optionally takes a set of DLE specifications (see
+\fBamanda-match\fR(7)) to narrow the DLEs for which dumps will be flushed\&. All dumps in holding are flushed if no expressions are given\&.
 .SH "OPTIONS"
 .PP
 \fB\-b\fR
@@ -70,21 +78,22 @@ option\&.
 .PP
 \fB\-D datestamp\fR
 .RS 4
-specify a datestamp expression you want to flush, see the "DATESTAMP EXPRESSION" section of
-\fBamanda\fR(8)
-for a description\&.
+specify a datestamp expression you want to flush; see
+\fBamanda-match\fR(7)
+for details on the format of this expression\&.
 \fB\-D 20001225\-7\fR
 will flush all dumps from 25 december 2000 to 27 december 2000\&.
 .RE
 .PP
 \fIhost\fR [\fIdisk\fR]*
 .RS 4
-Specify the host and disk on which the command will work\&.
+Specify the host and disk on which the command will work \-\- see the description of DLE specifications in
+\fBamanda-match\fR(7)\&.
 .RE
 .PP
-\fB\-o\fR \fIconfigoption\fR
+\fB\-o \fR\fB\fIconfigoption\fR\fR
 .RS 4
-See the "\fBCONFIGURATION OVERRIDE\fR" section in
+See the "CONFIGURATION OVERRIDE" section in
 \fBamanda\fR(8)\&.
 .RE
 .PP
@@ -96,17 +105,14 @@ for a description\&.
 will look in the holding disks specified by the
 \fIamanda\&.conf\fR
 file in /usr/local/etc/amanda/\fIconfig\fR
-for any non\-empty
-\fIAmanda\fR
-work directories\&. It then prompts you to select a directory or to process all of the directories\&. The work directories in the holding disks are named by the date at the time
+for any non\-empty Amanda work directories\&. It then prompts you to select a directory or to process all of the directories\&. The work directories in the holding disks are named by the date at the time
 \fBamdump\fR
 was run, e\&.g\&.
 19910215\&.
 .PP
 See the
 \fBamanda\fR(8)
-man page for more details about
-\fIAmanda\fR\&.
+man page for more details about Amanda\&.
 .SH "EXAMPLE"
 .PP
 \fBAmflush\fR
@@ -119,10 +125,10 @@ writes the data to tape, updates the databases and sends a mail report similar t
 .nf
 % amflush MyConfig
 Scanning /amanda\-hold\&.\&.\&.
-  20001113: found \fIAmanda\fR directory\&.
-  20001114: found \fIAmanda\fR directory\&.
+  20001113: found Amanda directory\&.
+  20001114: found Amanda directory\&.
 
-Multiple \fIAmanda\fR directories, please pick one by letter:
+Multiple Amanda directories, please pick one by letter:
   A\&. 20001113
   B\&. 20001114
 Select directories to flush [A\&.\&.B]: [ALL] all
@@ -133,12 +139,12 @@ to tape drive /dev/rmt/0mn\&.
 Expecting tape DMP014 or a new tape\&.  (The last dumps were to tape DMP013)
 Are you sure you want to do this? yes
 Running in background, you can log off now\&.
-You\'ll get mail when amflush is finished\&.
+You\*(Aqll get mail when amflush is finished\&.
 .fi
 .PP
-The following example causes amflush to flush everything to tape, then ejects tape, using \'at\' to run the task in the background\&.
+The following example causes amflush to flush everything to tape, then ejects tape, using \*(Aqat\*(Aq to run the task in the background\&.
 .nf
-% echo \'amflush \-b \-f MyConfig && mt offline\' | at now
+% echo \*(Aqamflush \-b \-f MyConfig && mt offline\*(Aq | at now
 .fi
 .SH "EXIT CODE"
 
@@ -147,15 +153,17 @@ The exit code of \fBamflush\fR is the ORed value of:
  0  = success
  1  = error
  4  = a dle failed
- 8  = Don\'t know the status of a dle (RESULT_MISSING in the report)
+ 8  = Don\*(Aqt know the status of a dle (RESULT_MISSING in the report)
  16 = tape error or no more tape
 .fi
 .SH "SEE ALSO"
 .PP
-
 \fBamanda\fR(8),
 \fBamdump\fR(8),
-: http://wiki.zmanda.com
+\fBamanda-match\fR(7)
+.PP
+The Amanda Wiki:
+: http://wiki.zmanda.com/
 .SH "AUTHORS"
 .PP
 \fBJames da Silva\fR <\&jds@amanda\&.org\&>