git.gag.com Git - debian/amanda/blob - man/amstar.8

   1 '\" t
   2 .\"     Title: amstar
   3 .\"    Author: Jean-Louis Martineau <martineau@zmanda.com>
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
   5 .\"      Date: 10/18/2010
   6 .\"    Manual: System Administration Commands
   7 .\"    Source: Amanda 3.2.0
   8 .\"  Language: English
   9 .\"
  10 .TH "AMSTAR" "8" "10/18/2010" "Amanda 3\&.2\&.0" "System Administration Commands"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 amstar \- Amanda Application to interface with star
  23 .SH "DESCRIPTION"
  24 .PP
  25 Amstar is an Amanda Application API script\&. It should not be run by users directly\&. It uses star to backup and restore data\&.
  26 .SH "PROPERTIES"
  27 .PP
  28 This section lists the properties that control amstar\'s functionality\&. See
  29 \fBamanda-applications\fR(7)
  30 for information on application properties and how they are configured\&.
  31 .PP
  32 COMMAND\-OPTIONS
  33 .RS 4
  34 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\&.
  35
  36 Use:
  37 .nf
  38   property "COMMAND\-OPTIONS" "\-\-foo" "bar"
  39 .fi
  40
  41 Do not use:
  42 .nf
  43   property "COMMAND\-OPTIONS" "\-\-foo bar"
  44 .fi
  45 .RE
  46 .PP
  47 DIRECTORY
  48 .RS 4
  49
  50 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\&.
  51 .RE
  52 .PP
  53 ONE\-FILE\-SYSTEM
  54 .RS 4
  55
  56 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\&.
  57 .RE
  58 .PP
  59 SPARSE
  60 .RS 4
  61
  62 If "YES" (the default), star will store sparse files efficiently\&. If "NO", then the \fI\-sparse\fR option is not given to star, and it will not try to detect sparse files\&.
  63 .RE
  64 .PP
  65 STAR\-DLE\-TARDUMP
  66 .RS 4
  67
  68 If "YES", amstar will use a different tardump file for each DLE\&. The default is "NO"\&.  This property is needed with older versions of star doing many dumps in parallel, because of a race condition in updating the tardump file\&.
  69 .RE
  70 .PP
  71 STAR\-PATH
  72 .RS 4
  73
  74 The path to the star binary\&. The default is set when Amanda is built by the
  75 \-\-with\-star configure option\&.
  76 .RE
  77 .PP
  78 STAR\-TARDUMP
  79 .RS 4
  80
  81 The directory where star stores the database it uses to generate incremental
  82 dumps\&.  The default is /etc/tardumps\&.
  83 .RE
  84 .PP
  85 NORMAL
  86 .RS 4
  87
  88 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:
  89 .nf
  90   "^could not open conf file"
  91   "^Type of this level "
  92   "^Date of this level "
  93   "^Date of last level "
  94   "^Dump record  level "
  95   "^Throughput"
  96   "^\&.*is sparse$"
  97   "^star: dumped [0\-9][0\-9]* (tar )?files"
  98   "^\&.*The following problems occurred during \&.* processing\&.*$"
  99   "^\&.*Processed all possible files, despite earlier errors\&.*$"
 100   "^\&.*not written due to problems during backup\&.*$"
 101 .fi
 102 To treat one of these default patterns differently, specify it explicitly in a different property\&.
 103 .RE
 104 .PP
 105 IGNORE
 106 .RS 4
 107
 108 List all regex (POSIX Extended Regular Expression syntax) that amanda ignore\&. These output are never in the email report\&.
 109 .RE
 110 .PP
 111 STRANGE
 112 .RS 4
 113
 114 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\&.
 115 .nf
 116   "^Perform a level 0 dump first\&.*$"
 117 .fi
 118 To treat one of these default patterns differently, specify it explicitly in a different property\&.
 119 .RE
 120 .SH "SEE ALSO"
 121 .PP
 122 \fBamanda\fR(8),
 123 \fBamanda.conf\fR(5),
 124 \fBamanda-applications\fR(7)
 125 .PP
 126 The Amanda Wiki:
 127 : http://wiki.zmanda.com/
 128 .SH "AUTHORS"
 129 .PP
 130 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
 131 .RS 4
 132 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 133 .RE
 134 .PP
 135 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
 136 .RS 4
 137 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 138 .RE