X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Famflush.8;h=26a50eeaa17a1c57f7fd4c411591ac1cc5ee8720;hb=afaa71b3866b46b082b6c895772e15b36d8865fe;hp=9276731c58912e1ce34da981926161ec314646fb;hpb=bde83ad58d800ae004caccab6531234272181da2;p=debian%2Famanda diff --git a/man/amflush.8 b/man/amflush.8 index 9276731..26a50ee 100644 --- a/man/amflush.8 +++ b/man/amflush.8 @@ -1,77 +1,278 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection +.\" Title: amflush +.\" Author: James da Silva +.\" Generator: DocBook XSL Stylesheets v1.74.0 +.\" Date: 01/22/2009 +.\" Manual: System Administration Commands +.\" Source: Amanda 2.6.1 +.\" Language: English +.\" +.TH "AMFLUSH" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands" +.\" ----------------------------------------------------------------- +.\" * (re)Define some macros +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" toupper - uppercase a string (locale-aware) +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de toupper +.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ +\\$* +.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SH-xref - format a cross-reference to an SH section +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de SH-xref +.ie n \{\ +.\} +.toupper \\$* +.el \{\ +\\$* +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SH - level-one heading that works better for non-TTY output +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de1 SH +.\" put an extra blank line of space above the head in non-TTY output +.if t \{\ +.sp 1 +.\} +.sp \\n[PD]u +.nr an-level 1 +.set-an-margin +.nr an-prevailing-indent \\n[IN] +.fi +.in \\n[an-margin]u +.ti 0 +.HTML-TAG ".NH \\n[an-level]" +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +\." make the size of the head bigger +.ps +3 +.ft B +.ne (2v + 1u) +.ie n \{\ +.\" if n (TTY output), use uppercase +.toupper \\$* +.\} +.el \{\ +.nr an-break-flag 0 +.\" if not n (not TTY), use normal case (not uppercase) +\\$1 +.in \\n[an-margin]u +.ti 0 +.\" if not n (not TTY), put a border/line under subheading +.sp -.6 +\l'\n(.lu' +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SS - level-two heading that works better for non-TTY output +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de1 SS +.sp \\n[PD]u +.nr an-level 1 +.set-an-margin +.nr an-prevailing-indent \\n[IN] +.fi +.in \\n[IN]u +.ti \\n[SN]u +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.ps \\n[PS-SS]u +\." make the size of the head bigger +.ps +2 +.ft B +.ne (2v + 1u) +.if \\n[.$] \&\\$* +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" BB/BE - put background/screen (filled box) around block of text +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de BB +.if t \{\ +.sp -.5 .br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP +.in +2n +.ll -2n +.gcolor red +.di BX +.\} +.. +.de EB +.if t \{\ +.if "\\$2"adjust-for-leading-newline" \{\ +.sp -1 +.\} +.br +.di +.in +.ll +.gcolor +.nr BW \\n(.lu-\\n(.i +.nr BH \\n(dn+.5v +.ne \\n(BHu+.5v +.ie "\\$2"adjust-for-leading-newline" \{\ +\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] +.\} +.el \{\ +\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] +.\} +.in 0 +.sp -.5v +.nf +.BX +.in +.sp .5v +.fi +.\} .. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" BM/EM - put colored marker in margin next to block of text +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de BM +.if t \{\ +.br +.ll -2n +.gcolor red +.di BX +.\} .. -.de Ip \" List item +.de EM +.if t \{\ .br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 +.di +.ll +.gcolor +.nr BH \\n(dn +.ne \\n(BHu +\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] +.in 0 +.nf +.BX +.in +.fi +.\} .. -.TH "AMFLUSH" 8 "" "" "" -.SH NAME -amflush \- flush AMANDA backup files from holding disk to tape -.SH "SYNOPSIS" +.\" ----------------------------------------------------------------- +.\" * 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" +.fam C +.HP \w'\fBamflush\fR\ 'u +\fBamflush\fR [\-b] [\-f] [\-s] [\-D\ \fIdatestamp\fR] \fIconfig\fR [\fIhost\fR\ [\fIdisk\fR...]...] [\-o\ \fIconfigoption\fR]... +.fam .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\&. +\FC19910215\F[]\&. +.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 +283,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, : Original text - .PP -Stefan G\&. Weichinger, , 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\&>