Imported Upstream version 3.3.1
[debian/amanda] / man / amflush.8
index ec799afee0e9986a62d01c86231d7923cf4827a9..a36d55b25d3f4ac600ac9e809a52ea03f0a3cb6d 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 "" "" ""
+'\" t
+.\"     Title: amflush
+.\"    Author: James da Silva <jds@amanda.org>
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 02/21/2012
+.\"    Manual: System Administration Commands
+.\"    Source: Amanda 3.3.1
+.\"  Language: English
+.\"
+.TH "AMFLUSH" "8" "02/21/2012" "Amanda 3\&.3\&.1" "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
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
 .SH "NAME"
-amflush - flush Amanda backup files from holding disk to tape
+amflush \- flush Amanda backup files from holding disk to tape
 .SH "SYNOPSIS"
-.HP 8
-\fBamflush\fR [-b] [-f] [-s] [-D \fIdatestamp\fR]*
-     \fIconfig\fR [\fIhost\fR [\fIdisk\fR]*]*
-     [-o \fIconfigoption\fR]*
-
+.HP \w'\fBamflush\fR\ 'u
+\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
-\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
+writes Amanda backups from the holding disks to tape, and updates the Amanda info database and
+\fBtapelist\fR(5)
+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
+is run\&. When this happens, the problem must be corrected and
 \fBamflush\fR
-run by hand.
+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"
-.TP
-\fB-b\fR
+.PP
+\fB\-b\fR
+.RS 4
 Run
 \fBamflush\fR
-in batch mode. All datestamps are selected unless specified. The flush is started without confirmation.
-.TP
-\fB-f\fR
+in batch mode\&. All datestamps are selected unless specified\&. The flush is started without confirmation\&.
+.RE
+.PP
+\fB\-f\fR
+.RS 4
 Run
 \fBamflush\fR
-in foreground.
+in foreground\&.
 \fBAmflush\fR
-normally detaches itself from the tty and runs as a background process. With the
-\fB-f\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
+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
-\fB-s\fR
-Write log to stdout/stderr instead of the amflush log file. Requires the
-\fB-f\fR
-option.
-.TP
-\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.
-.TP
+is run as part of another script that, for example, advances the tape after the flush is completed\&.
+.RE
+.PP
+\fB\-s\fR
+.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
+.RS 4
+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]*
-Specify the host and disk on which the command will work.
-.TP
-\fB-o\fR \fIconfigoption\fR
-See the "\fBCONFIGURATION OVERWRITE\fR" section in
-\fBamanda\fR(8).
+.RS 4
+Specify the host and disk on which the command will work \-\- see the description of DLE specifications in
+\fBamanda-match\fR(7)\&.
+.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
+\fB\-o \fR\fB\fIconfigoption\fR\fR
+.RS 4
+See the "CONFIGURATION OVERRIDE" section in
+\fBamanda\fR(8)\&.
+.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.
+for a description\&.
 .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
+\fIamanda\&.conf\fR
+file in /usr/local/etc/amanda/\fIconfig\fR
+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.
+was run, e\&.g\&.
+19910215\&.
 .PP
 See the
 \fBamanda\fR(8)
-man page for more details about
-\fBAmanda\fR.
+man page for more details about Amanda\&.
 .SH "EXAMPLE"
 .PP
 \fBAmflush\fR
 will search for holding areas associated with the
-\fBdaily\fR
-configuration. After you select which holding area to flush,
+\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).
+\fBamdump\fR(8)\&.
 .nf
+% amflush MyConfig
+Scanning /amanda\-hold\&.\&.\&.
+  20001113: found Amanda directory\&.
+  20001114: found Amanda directory\&.
 
-% amflush daily
-Scanning /amanda-hold...
-  20001113: found \fBAmanda\fR directory.
-  20001114: found \fBAmanda\fR directory.
-
-Multiple \fBAmanda\fR directories, please pick one by letter:
-  A. 20001113
-  B. 20001114
-Select directories to flush [A..B]: [ALL] all
+Multiple Amanda directories, please pick one by letter:
+  A\&. 20001113
+  B\&. 20001114
+Select directories to flush [A\&.\&.B]: [ALL] all
 
 Flushing dumps in 20001113, 20001114,
 today: 20001117
-to tape drive /dev/rmt/0mn.
-Expecting tape DMP014 or a new tape.  (The last dumps were to tape DMP013)
+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.
+Running in background, you can log off now\&.
+You\*(Aqll 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 \*(Aqat\*(Aq to run the task in the background\&.
+.nf
+% echo \*(Aqamflush \-b \-f MyConfig && mt offline\*(Aq | 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\*(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)
-
+\fBamdump\fR(8),
+\fBamanda-match\fR(7)
+.PP
+The Amanda Wiki:
+: http://wiki.zmanda.com/
+.SH "AUTHORS"
+.PP
+\fBJames da Silva\fR <\&jds@amanda\&.org\&>
+.PP
+\fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>