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

   1 .\"     Title: amgtar
   2 .\"    Author: Jean-Louis Martineau <martineau@zmanda.com>
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 01/22/2009
   5 .\"    Manual: System Administration Commands
   6 .\"    Source: Amanda 2.6.1
   7 .\"  Language: English
   8 .\"
   9 .TH "AMGTAR" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 amgtar \- Amanda Application to interface with GNU Tar
 171 .SH "DESCRIPTION"
 172 .PP
 173 Amgtar is an
 174 \fIAmanda\fR
 175 Application API script\&. It should not be run by users directly\&. It uses GNU Tar to backup and restore data\&.
 176 .SH "PROPERTIES"
 177 .PP
 178 This section lists the properties that control amgtar\'s functionality\&. See
 179 \fBamanda-applications\fR(7)
 180 for information on application properties and how they are configured\&.
 181 .PP
 182 ATIME\-PRESERVE
 183 .RS 4
 184
 185 If "YES" (the default), amgtar use the \fI\-\-atime\-preserve=system\fR option of gnutar to not update the atime of all files accessed; if "NO", gnutar will updates the atime for all files accessed\&. This property works only if you have gnutar 1\&.15\&.90 or newer, if not, you must set ATIME_PRESERVE to "NO"\&.
 186 .RE
 187 .PP
 188 CHECK\-DEVICE
 189 .RS 4
 190
 191 If "YES" (the default), amgtar checks that the device number doesn\'t change for each file\&. If "NO", changes in device number are ignored\&.  To ignore device numbers, tar must support the \fI\-\-no\-check\-device\fR option (gnutar 1\&.19\&.90 and newer)\&. This option is needed for some filesystems and devices on which device numbers change frequently, such as LVM or FiberChannel\&.
 192 .RE
 193 .PP
 194 DIRECTORY
 195 .RS 4
 196
 197 If set, gnutar will backup from that directory instead of the \fIdiskdevice\fR set by the DLE\&.
 198 .RE
 199 .PP
 200 GNUTAR\-LISTDIR
 201 .RS 4
 202
 203 The directory where gnutar stores the database it uses to generate incremental dumps\&.  The default is set when \fIAmanda\fR is built\&.
 204 .RE
 205 .PP
 206 GNUTAR\-PATH
 207 .RS 4
 208
 209 The path to the gnutar binary\&.  The default is set when \fIAmanda\fR is built\&.
 210 .RE
 211 .PP
 212 ONE\-FILE\-SYSTEM
 213 .RS 4
 214
 215 If "YES" (the default), do not allow gnutar to cross filesystem boundaries\&. If "NO", gnutar will cross filesystem boundaries\&.  This corresponds to the \fI\-\-one\-filesystem\fR option of gnutar\&.
 216 .RE
 217 .PP
 218 TAR\-BLOCKSIZE
 219 .RS 4
 220
 221 Block size of Nx512 bytes (default N=20)\&.  This corresponds to the \fI\-\-blocking\-factor\fR option of gnutar\&.
 222 .RE
 223 .PP
 224 SPARSE
 225 .RS 4
 226
 227 If "YES" (the default), gnutar will store sparse files efficiently\&. If "NO", then the \fI\-\-sparse\fR option is not given to gnutar, and it will not try to detect sparse files\&.
 228 .RE
 229 .PP
 230 EXIT\-HANDLING
 231 .RS 4
 232
 233 List which exit status of gtar are good or bad\&. eg\&. "1=GOOD 2=BAD", exit status of 1 will produce a good backup, exit status of 2 will give an error\&.
 234 .RE
 235 .PP
 236 NORMAL
 237 .RS 4
 238
 239 List all regex (POSIX Extended Regular Expression syntax) that are normal output from gtar\&. These output are in the "FAILED DUMP DETAILS" section of the email report if the dump result is STRANGE or FAILED\&. Default values:
 240 .nf
 241   "^could not open conf file"
 242   "^Elapsed time:"
 243   "^Throughput"
 244   ": socket ignored$"
 245   ": File \&.* shrunk by [0\-9][0\-9]* bytes, padding with zeros"
 246   ": Cannot add file \&.*: No such file or directory$"
 247   ": Error exit delayed from previous errors"
 248 .fi
 249 To treat one of these default patterns differently, specify it explicitly in a different property\&.
 250 .RE
 251 .PP
 252 IGNORE
 253 .RS 4
 254
 255 List all regex (POSIX Extended Regular Expression syntax) that amanda ignore\&. These output are never in the email report\&. Default values:
 256 .nf
 257   ": Directory is new$"
 258   ": Directory has been renamed"
 259 .fi
 260 To treat one of these default patterns differently, specify it explicitly in a different property\&.
 261 .RE
 262 .PP
 263 STRANGE
 264 .RS 4
 265
 266 List all regex (POSIX Extended Regular Expression syntax) that are strange output from gtar\&. All gtar output that doesn\'t match a normal or ignore regex are strange by default\&. The result of the dump is STRANGE if gtar produce a strange output\&. These output are in the "FAILED DUMP DETAILS" section of the email report\&.
 267 .RE
 268 .SH "EXAMPLE"
 269 .nf
 270   define application\-tool app_amgtar {
 271     property "ATIME\-PRESERVE" "NO"
 272     property "CHECK\-DEVICE" "YES"
 273     property "GNUTAR\-LISTDIR" "
 274     property "GNUTAR\-PATH" "/bin/tar"
 275     property "ONE\-FILE\-SYSTEM" "YES"
 276     property "TAR_BLOCKSIZE" "20"
 277     property "SPARSE" "YES"
 278     property "EXIT\-HANDLING" "1=GOOD 2=BAD"
 279     # change a default NORMAL regex to a STRANGE regex\&.
 280     property "STRANGE" ": socket ignored$"
 281     # add three new IGNORE regex
 282     property "IGNORE" ": Directory is new$"
 283     property append "IGNORE" ": Directory has been renamed"
 284     property append "IGNORE" "file changed as we read it$"
 285   }
 286 .fi
 287 .SH "SEE ALSO"
 288 .PP
 289
 290 \fBamanda.conf\fR(5),
 291 \fBamanda-applications\fR(7)
 292 .SH "Authors"
 293 .PP
 294 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
 295 .RS 4
 296 Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])
 297 .RE
 298 .PP
 299 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
 300 .RS 4
 301 Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])
 302 .RE