3 .\" Author: Jean-Louis Martineau <martineau@zmanda.com>
4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
6 .\" Manual: System Administration Commands
7 .\" Source: Amanda 3.2.0
10 .TH "AMGTAR" "8" "10/18/2010" "Amanda 3\&.2\&.0" "System Administration Commands"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
16 .\" disable justification (adjust text to left margin only)
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
22 amgtar \- Amanda Application to interface with GNU Tar
25 Amgtar is an Amanda Application API script\&. It should not be run by users directly\&. It uses GNU Tar to backup and restore data\&.
28 This section lists the properties that control amgtar\'s functionality\&. See
29 \fBamanda-applications\fR(7)
30 for information on application properties and how they are configured\&.
35 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"\&.
41 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\&.
46 If set, theses options are passed asis to gtar\&. Each option must be a different value of the property\&. Some option can break how amanda do backup, use it with care\&.
50 property "COMMAND\-OPTIONS" "\-\-foo" "bar"
55 property "COMMAND\-OPTIONS" "\-\-foo bar"
62 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 directory instead of the current working directory\&.
68 The directory where gnutar stores the database it uses to generate incremental dumps\&. The default is set when Amanda is built\&.
74 The path to the gnutar binary\&. The default is set when Amanda is built\&.
80 A filename containing include glob expression for the restore command\&.
86 A filename containing exclude glob expression for the restore command\&.
92 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\&.
98 Block size of Nx512 bytes (default N=20)\&. This corresponds to the \fI\-\-blocking\-factor\fR option of gnutar\&.
104 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\&.
110 If "NO" (the default), gnutar doesn\'t get the \fI\-\-no\-unquote\fR option and the diskname can\'t have some characters, eg\&. \'\e\'\&. If "YES", then the \fI\-\-no\-unquote\fR option is given to gnutar and the diskname can have any characters\&. This option is available only if you are using tar\-1\&.16 or newer\&.
116 Default "NO"\&. If "YES", gnutar will preserve ACL extended attributes\&. This corresponds to the \fI\-\-acls\fR gnutar option\&. Requires a GNU Tar with nonstandard extended attribute patches from the Fedora Project\&.
122 Default "NO"\&. If "YES", gnutar will preserve SELinux extended attributes on Linux\&. This corresponds to the \fI\-\-selinux\fR gnutar option\&. Requires a GNU Tar with nonstandard extended attribute patches from the Fedora Project\&.
128 Default "NO"\&. If "YES", gnutar will preserve all extended attributes\&. This corresponds to the \fI\-\-xattrs\fR gnutar option\&. If enabled, this option also implies the ACLS and SELINUX properties, regardless of their settings, as they are implemented as extended attributes\&. Requires a GNU Tar with nonstandard extended attribute patches from the Fedora Project\&.
134 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\&.
140 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:
142 "^could not open conf file"
146 ": File \&.* shrunk by [0\-9][0\-9]* bytes, padding with zeros"
147 ": Cannot add file \&.*: No such file or directory$"
148 ": Error exit delayed from previous errors"
150 To treat one of these default patterns differently, specify it explicitly in a different property\&.
156 List all regex (POSIX Extended Regular Expression syntax) that amanda ignore\&. These output are never in the email report\&. Default values:
158 ": Directory is new$"
159 ": Directory has been renamed"
161 To treat one of these default patterns differently, specify it explicitly in a different property\&.
167 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\&.
173 Default: "NO"\&. If "YES", amgtar print more verbose debugging message and can leave temporary files in AMANDA_TMPDIR\&.
175 .SH "INCLUDE AND EXCLUDE LISTS"
177 This application supplies exclude lists via the
179 \fB\-\-exclude\-from\fR
180 option\&. This option accepts normal shell\-style wildcard expressions, using
182 to match any number of characters and
184 to match a single character\&. Character classes are represented with
185 \fB[\&.\&.]\fR, which will match any of the characters in the brackets\&. Expressions can be "anchored" to the base directory of the DLE by prefixing them with "\&./"\&. Without this prefix, they will match at any directory level\&. Expressions that begin or end with a "/" will not match anything: to completely exclude a directory, do not include the trailing slash\&. Example expressions:
188 \&./temp\-files # exclude top\-level directory entirely
189 \&./temp\-files/ # BAD: does nothing
190 /temp\-files # BAD: does nothing
191 \&./temp\-files/* # exclude directory contents; include directory
192 temp\-files # exclude anything named "temp\-files"
193 generated\-* # exclude anything beginning with "generated\-"
194 *\&.iso # exclude ISO files
195 proxy/local/cache # exclude "cache" in dir "local" in "proxy"
198 Similarly, include expressions are supplied to
200 \fB\-\-files\-from\fR
201 option\&. This option ordinarily does not accept any sort of wildcards, but amgtar "manually" applies glob pattern matching to include expressions with only one slash\&. The expressions must still begin with "\&./", so this effectively only allows expressions like "\&./[abc]*" or "\&./*\&.txt"\&.
207 define application\-tool app_amgtar {
210 property "ATIME\-PRESERVE" "NO"
211 property "CHECK\-DEVICE" "YES"
212 property "GNUTAR\-LISTDIR" "/path/to/listdir"
213 property "GNUTAR\-PATH" "/bin/tar"
214 property "ONE\-FILE\-SYSTEM" "YES"
215 property "TAR\-BLOCKSIZE" "20"
216 property "SPARSE" "YES"
218 property "SELINUX" "NO"
219 property "XATTRS" "NO"
220 property "EXIT\-HANDLING" "1=GOOD 2=BAD"
221 # change a default NORMAL regex to a STRANGE regex\&.
222 property "STRANGE" ": socket ignored$"
223 # add three new IGNORE regex
224 property "IGNORE" ": Directory is new$"
225 property append "IGNORE" ": Directory has been renamed"
226 property append "IGNORE" "file changed as we read it$"
229 A dumptype using this application might look like:
232 define dumptype amgtar_app_dtyp {
234 program "APPLICATION"
235 application "app_amgtar"
240 parameter must be set to
249 \fBamanda.conf\fR(5),
250 \fBamanda-applications\fR(7)
253 : http://wiki.zmanda.com/
256 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
258 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
261 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
263 Zmanda, Inc\&. (http://www\&.zmanda\&.com)