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

   1 '\" t
   2 .\"     Title: amgtar
   3 .\"    Author: Jean-Louis Martineau <martineau@zmanda.com>
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
   5 .\"      Date: 11/05/2009
   6 .\"    Manual: System Administration Commands
   7 .\"    Source: Amanda 2.6.1p2
   8 .\"  Language: English
   9 .\"
  10 .TH "AMGTAR" "8" "11/05/2009" "Amanda 2\&.6\&.1p2" "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 amgtar \- Amanda Application to interface with GNU Tar
  23 .SH "DESCRIPTION"
  24 .PP
  25 Amgtar is an
  26 \fIAmanda\fR
  27 Application API script\&. It should not be run by users directly\&. It uses GNU Tar to backup and restore data\&.
  28 .SH "PROPERTIES"
  29 .PP
  30 This section lists the properties that control amgtar\'s functionality\&. See
  31 \fBamanda-applications\fR(7)
  32 for information on application properties and how they are configured\&.
  33 .PP
  34 ATIME\-PRESERVE
  35 .RS 4
  36
  37 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"\&.
  38 .RE
  39 .PP
  40 CHECK\-DEVICE
  41 .RS 4
  42
  43 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\&.
  44 .RE
  45 .PP
  46 DIRECTORY
  47 .RS 4
  48
  49 If set, gnutar will backup from that directory instead of the \fIdiskdevice\fR set by the DLE\&.
  50 .RE
  51 .PP
  52 GNUTAR\-LISTDIR
  53 .RS 4
  54
  55 The directory where gnutar stores the database it uses to generate incremental dumps\&.  The default is set when \fIAmanda\fR is built\&.
  56 .RE
  57 .PP
  58 GNUTAR\-PATH
  59 .RS 4
  60
  61 The path to the gnutar binary\&.  The default is set when \fIAmanda\fR is built\&.
  62 .RE
  63 .PP
  64 ONE\-FILE\-SYSTEM
  65 .RS 4
  66
  67 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\&.
  68 .RE
  69 .PP
  70 TAR\-BLOCKSIZE
  71 .RS 4
  72
  73 Block size of Nx512 bytes (default N=20)\&.  This corresponds to the \fI\-\-blocking\-factor\fR option of gnutar\&.
  74 .RE
  75 .PP
  76 SPARSE
  77 .RS 4
  78
  79 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\&.
  80 .RE
  81 .PP
  82 EXIT\-HANDLING
  83 .RS 4
  84
  85 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\&.
  86 .RE
  87 .PP
  88 NORMAL
  89 .RS 4
  90
  91 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:
  92 .nf
  93   "^could not open conf file"
  94   "^Elapsed time:"
  95   "^Throughput"
  96   ": socket ignored$"
  97   ": File \&.* shrunk by [0\-9][0\-9]* bytes, padding with zeros"
  98   ": Cannot add file \&.*: No such file or directory$"
  99   ": Error exit delayed from previous errors"
 100 .fi
 101 To treat one of these default patterns differently, specify it explicitly in a different property\&.
 102 .RE
 103 .PP
 104 IGNORE
 105 .RS 4
 106
 107 List all regex (POSIX Extended Regular Expression syntax) that amanda ignore\&. These output are never in the email report\&. Default values:
 108 .nf
 109   ": Directory is new$"
 110   ": Directory has been renamed"
 111 .fi
 112 To treat one of these default patterns differently, specify it explicitly in a different property\&.
 113 .RE
 114 .PP
 115 STRANGE
 116 .RS 4
 117
 118 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\&.
 119 .RE
 120 .SH "EXAMPLE"
 121 .nf
 122   define application\-tool app_amgtar {
 123     property "ATIME\-PRESERVE" "NO"
 124     property "CHECK\-DEVICE" "YES"
 125     property "GNUTAR\-LISTDIR" "
 126     property "GNUTAR\-PATH" "/bin/tar"
 127     property "ONE\-FILE\-SYSTEM" "YES"
 128     property "TAR_BLOCKSIZE" "20"
 129     property "SPARSE" "YES"
 130     property "EXIT\-HANDLING" "1=GOOD 2=BAD"
 131     # change a default NORMAL regex to a STRANGE regex\&.
 132     property "STRANGE" ": socket ignored$"
 133     # add three new IGNORE regex
 134     property "IGNORE" ": Directory is new$"
 135     property append "IGNORE" ": Directory has been renamed"
 136     property append "IGNORE" "file changed as we read it$"
 137   }
 138 .fi
 139 .SH "SEE ALSO"
 140 .PP
 141
 142 \fBamanda.conf\fR(5),
 143 \fBamanda-applications\fR(7)
 144 .SH "AUTHORS"
 145 .PP
 146 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
 147 .RS 4
 148 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 149 .RE
 150 .PP
 151 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
 152 .RS 4
 153 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 154 .RE