Imported Upstream version 2.6.1p2
[debian/amanda] / man / amflush.8
index f4051814a20426b72902e94035767c95a4d11c4a..5eb7e5545f9807593bceab0fa8baec5a0ed4f293 100644 (file)
-.\"Generated by db2man.xsl. Don't modify this, modify the source.
-.de Sh \" Subsection
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
-.TH "AMFLUSH" 8 "" "" ""
-.SH NAME
-amflush \- flush Amanda backup files from holding disk to tape
-.SH "SYNOPSIS"
+'\" t
+.\"     Title: amflush
+.\"    Author: James da Silva <jds@amanda.org>
+.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
+.\"      Date: 11/05/2009
+.\"    Manual: System Administration Commands
+.\"    Source: Amanda 2.6.1p2
+.\"  Language: English
+.\"
+.TH "AMFLUSH" "8" "11/05/2009" "Amanda 2\&.6\&.1p2" "System Administration Commands"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
 .ad l
-.hy 0
-.HP 8
-\fBamflush\fR [\-b] [\-f] [\-s] [\-D\ \fIdatestamp\fR...] \fIconfig\fR [\fIhost\fR\ [\fIdisk\fR...]...]
-.ad
-.hy
-
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+amflush \- flush \fIAmanda\fR 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]...
 .SH "DESCRIPTION"
-
 .PP
-\fBAmflush\fR writes \fBAmanda\fR backups from the holding disks to tape, and updates the \fBAmanda\fR info database and tapelist accordingly\&. 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\&.
-
+\fBAmflush\fR
+writes
+\fIAmanda\fR
+backups from the holding disks to tape, and updates the
+\fIAmanda\fR
+info database and
+\fBtapelist\fR(5)
+accordingly\&. 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\&.
 .SH "OPTIONS"
-
-.TP
+.PP
 \fB\-b\fR
-Run \fBamflush\fR in batch mode\&. All datestamps are selected unless specified\&. The flush is started without confirmation\&.
-
-.TP
+.RS 4
+Run
+\fBamflush\fR
+in batch mode\&. All datestamps are selected unless specified\&. The flush is started without confirmation\&.
+.RE
+.PP
 \fB\-f\fR
-Run \fBamflush\fR in foreground\&. \fBAmflush\fR normally detaches itself from the tty and runs as a background process\&. With the \fB\-f\fR option, \fBamflush\fR stays in the foreground\&. This is useful if \fBamflush\fR is run as part of another script that, for example, advances the tape after the flush is completed\&.
-
-.TP
+.RS 4
+Run
+\fBamflush\fR
+in foreground\&.
+\fBAmflush\fR
+normally detaches itself from the tty and runs as a background process\&. With the
+\fB\-f\fR
+option,
+\fBamflush\fR
+stays in the foreground\&. This is useful if
+\fBamflush\fR
+is run as part of another script that, for example, advances the tape after the flush is completed\&.
+.RE
+.PP
 \fB\-s\fR
-Write log to stdout/stderr instead of the amflush log file\&. Requires the \fB\-f\fR option\&.
-
-.TP
+.RS 4
+Write log to stdout/stderr instead of the amflush log file\&. Requires the
+\fB\-f\fR
+option\&.
+.RE
+.PP
 \fB\-D datestamp\fR
-specify a datestamp expression you want to flush, see the "DATESTAMP EXPRESSION" section of \fBamanda\fR(8) for a description\&. \fB\-D 20001225\-7\fR will flush all dumps from 25 december 2000 to 27 december 2000\&.
-
+.RS 4
+specify a datestamp expression you want to flush, see the "DATESTAMP EXPRESSION" section of
+\fBamanda\fR(8)
+for a description\&.
+\fB\-D 20001225\-7\fR
+will flush all dumps from 25 december 2000 to 27 december 2000\&.
+.RE
 .PP
-You can specify many host/disk expressions, only disks that match an expression will be flushed\&. All disks are flushed if no expressions are given\&. see the "HOST & DISK EXPRESSION" section of \fBamanda\fR(8) for a description\&.
-
+\fIhost\fR [\fIdisk\fR]*
+.RS 4
+Specify the host and disk on which the command will work\&.
+.RE
 .PP
-\fBAmflush\fR will look in the holding disks specified by the \fBamanda\&.conf\fR file in /usr/local/etc/amanda/\fBconfig\fR for any non\-empty \fBAmanda\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 \fBamdump\fR was run, e\&.g\&. 19910215\&.
-
+\fB\-o\fR \fIconfigoption\fR
+.RS 4
+See the "\fBCONFIGURATION OVERRIDE\fR" section in
+\fBamanda\fR(8)\&.
+.RE
 .PP
-See the \fBamanda\fR(8) man page for more details about \fBAmanda\fR\&.
-
+You can specify many host/disk expressions, only disks that match an expression will be flushed\&. All disks are flushed if no expressions are given\&. see the "HOST & DISK EXPRESSION" section of
+\fBamanda\fR(8)
+for a description\&.
+.PP
+\fBAmflush\fR
+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
+\fBamdump\fR
+was run, e\&.g\&.
+19910215\&.
+.PP
+See the
+\fBamanda\fR(8)
+man page for more details about
+\fIAmanda\fR\&.
 .SH "EXAMPLE"
-
 .PP
-\fBAmflush\fR will search for holding areas associated with the \fBdaily\fR configuration\&. After you select which holding area to flush, \fBamflush\fR writes the data to tape, updates the databases and sends a mail report similar to \fBamdump\fR(8)\&.
+\fBAmflush\fR
+will search for holding areas associated with the
+\fIdaily\fR
+configuration\&. After you select which holding area to flush,
+\fBamflush\fR
+writes the data to tape, updates the databases and sends a mail report similar to
+\fBamdump\fR(8)\&.
 .nf
-
-% amflush daily
+% amflush MyConfig
 Scanning /amanda\-hold\&.\&.\&.
-  20001113: found \fBAmanda\fR directory\&.
-  20001114: found \fBAmanda\fR directory\&.
+  20001113: found \fIAmanda\fR directory\&.
+  20001114: found \fIAmanda\fR directory\&.
 
-Multiple \fBAmanda\fR directories, please pick one by letter:
+Multiple \fIAmanda\fR directories, please pick one by letter:
   A\&. 20001113
   B\&. 20001114
 Select directories to flush [A\&.\&.B]: [ALL] all
@@ -82,19 +133,31 @@ 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\'ll get mail when amflush is finished\&.
 .fi
-
-.SH "AUTHOR"
-
 .PP
-James da Silva, <jds@amanda\&.org> : Original text
-
-.PP
-Stefan G\&. Weichinger, <sgw@amanda\&.org>, maintainer of the \fBAmanda\fR\-documentation: XML\-conversion
+The following example causes amflush to flush everything to tape, then ejects tape, using \'at\' to run the task in the background\&.
+.nf
+% echo \'amflush \-b \-f MyConfig && mt offline\' | at now
+.fi
+.SH "EXIT CODE"
 
+The exit code of \fBamflush\fR is the ORed value of:
+.nf
+ 0  = success
+ 1  = error
+ 4  = a dle failed
+ 8  = Don\'t 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)
 
+\fBamanda\fR(8),
+\fBamdump\fR(8),
+: http://wiki.zmanda.com
+.SH "AUTHORS"
+.PP
+\fBJames da Silva\fR <\&jds@amanda\&.org\&>
+.PP
+\fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>