X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Famstar.8;h=067e9dd4477e712c9f5309a8de1d65ad7181ae01;hb=b116e9366c7b2ea2c2eb53b0a13df4090e176235;hp=c5830ce99bcfdba7581d47738a0b5964a6e0b738;hpb=2627875b7d18858bc1f9f7652811e4d8c15a23eb;p=debian%2Famanda diff --git a/man/amstar.8 b/man/amstar.8 index c5830ce..067e9dd 100644 --- a/man/amstar.8 +++ b/man/amstar.8 @@ -1,161 +1,13 @@ +'\" t .\" Title: amstar .\" Author: Jean-Louis Martineau -.\" Generator: DocBook XSL Stylesheets v1.74.0 -.\" Date: 01/22/2009 +.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 +.\" Date: 10/18/2010 .\" Manual: System Administration Commands -.\" Source: Amanda 2.6.1 +.\" Source: Amanda 3.2.0 .\" Language: English .\" -.TH "AMSTAR" "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 -.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 -.\} -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" BM/EM - put colored marker in margin next to block of text -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de BM -.if t \{\ -.br -.ll -2n -.gcolor red -.di BX -.\} -.. -.de EM -.if t \{\ -.br -.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 "AMSTAR" "8" "10/18/2010" "Amanda 3\&.2\&.0" "System Administration Commands" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -166,23 +18,42 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- -.SH "Name" +.SH "NAME" amstar \- Amanda Application to interface with star .SH "DESCRIPTION" .PP -Amstar is an -\fIAmanda\fR -Application API script\&. It should not be run by users directly\&. It uses star to backup and restore data\&. +Amstar is an Amanda Application API script\&. It should not be run by users directly\&. It uses star to backup and restore data\&. .SH "PROPERTIES" .PP This section lists the properties that control amstar\'s functionality\&. See \fBamanda-applications\fR(7) for information on application properties and how they are configured\&. .PP +COMMAND\-OPTIONS +.RS 4 +If set, theses options are passed asis to star\&. Each option must be a different value of the property\&. Some option can break how amanda do backup, use it with care\&. + +Use: +.nf + property "COMMAND\-OPTIONS" "\-\-foo" "bar" +.fi + +Do not use: +.nf + property "COMMAND\-OPTIONS" "\-\-foo bar" +.fi +.RE +.PP +DIRECTORY +.RS 4 + +If set, gnutar will backup from that directory instead of the \fIdiskdevice\fR set by the DLE\&. On restore, the data is restore in that directpory instead of the current working directory\&. +.RE +.PP ONE\-FILE\-SYSTEM .RS 4 -If "YES" (the default), do not allow star to cross filesystem boundaries\&. If "NO", star will cross filesystem boundaries\&. This corresponds to the \fI\-xdev\fR option of star\&. +The default is "YES"\&. This property is deprecated and the default value can\'t be changed\&. star requires it when it works in dump mode\&. This corresponds to the \fI\-xdev\fR option of star\&. .RE .PP SPARSE @@ -200,27 +71,68 @@ If "YES", amstar will use a different tardump file for each DLE\&. The default i STAR\-PATH .RS 4 -The path to the star binary\&. The default is set when \fIAmanda\fR is built\&. +The path to the star binary\&. The default is set when Amanda is built by the +\-\-with\-star configure option\&. .RE .PP STAR\-TARDUMP .RS 4 -The directory where star stores the database it uses to generate incremental dumps\&. The default is set when \fIAmanda\fR is built\&. +The directory where star stores the database it uses to generate incremental +dumps\&. The default is /etc/tardumps\&. +.RE +.PP +NORMAL +.RS 4 + +List all regex (POSIX Extended Regular Expression syntax) that are normal output from star\&. These output are in the "FAILED DUMP DETAILS" section of the email report if the dump result is STRANGE or FAILED\&. Default values: +.nf + "^could not open conf file" + "^Type of this level " + "^Date of this level " + "^Date of last level " + "^Dump record level " + "^Throughput" + "^\&.*is sparse$" + "^star: dumped [0\-9][0\-9]* (tar )?files" + "^\&.*The following problems occurred during \&.* processing\&.*$" + "^\&.*Processed all possible files, despite earlier errors\&.*$" + "^\&.*not written due to problems during backup\&.*$" +.fi +To treat one of these default patterns differently, specify it explicitly in a different property\&. .RE -.SH "SEE ALSO" .PP +IGNORE +.RS 4 +List all regex (POSIX Extended Regular Expression syntax) that amanda ignore\&. These output are never in the email report\&. +.RE +.PP +STRANGE +.RS 4 + +List all regex (POSIX Extended Regular Expression syntax) that are strange output from star\&. All star output that doesn\'t match a normal or ignore regex are strange by default\&. The result of the dump is STRANGE if star produce a strange output\&. These output are in the "FAILED DUMP DETAILS" section of the email report\&. +.nf + "^Perform a level 0 dump first\&.*$" +.fi +To treat one of these default patterns differently, specify it explicitly in a different property\&. +.RE +.SH "SEE ALSO" +.PP +\fBamanda\fR(8), \fBamanda.conf\fR(5), \fBamanda-applications\fR(7) -.SH "Authors" +.PP +The Amanda Wiki: +: http://wiki.zmanda.com/ +.SH "AUTHORS" .PP \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&> .RS 4 -Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[]) +Zmanda, Inc\&. (http://www\&.zmanda\&.com) .RE .PP \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&> .RS 4 -Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[]) +Zmanda, Inc\&. (http://www\&.zmanda\&.com) .RE