3 .\" Author: Jean-Louis Martineau <martineau@zmanda.com>
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
6 .\" Manual: System Administration Commands
7 .\" Source: Amanda 3.3.1
10 .TH "AMGTAR" "8" "02/21/2012" "Amanda 3\&.3\&.1" "System Administration Commands"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
25 .\" disable justification (adjust text to left margin only)
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 amgtar \- Amanda Application to interface with GNU Tar
34 Amgtar is an Amanda Application API script\&. It should not be run by users directly\&. It uses GNU Tar to backup and restore data\&.
38 in the disklist (DLE) must be the directory to backup\&.
41 This section lists the properties that control amgtar\*(Aqs functionality\&. See
42 \fBamanda-applications\fR(7)
43 for information on application properties and how they are configured\&.
48 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"\&.
54 If "YES" (the default), amgtar checks that the device number doesn\*(Aqt 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\&.
59 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\&.
63 property "COMMAND\-OPTIONS" "\-\-foo" "bar"
68 property "COMMAND\-OPTIONS" "\-\-foo bar"
75 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\&.
81 The directory where gnutar stores the database it uses to generate incremental dumps\&. The default is set when Amanda is built\&.
87 The path to the gnutar binary\&. The default is set when Amanda is built\&.
93 A filename containing include glob expression for the restore command\&.
99 A filename containing exclude glob expression for the restore command\&.
105 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\&.
111 Block size of Nx512 bytes (default N=20)\&. This corresponds to the \fI\-\-blocking\-factor\fR option of gnutar\&.
117 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\&.
123 If "NO" (the default), gnutar doesn\*(Aqt get the \fI\-\-no\-unquote\fR option and the diskname can\*(Aqt have some characters, eg\&. \*(Aq\e\*(Aq\&. 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\&.
129 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\&.
135 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\&.
141 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\&.
147 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\&.
153 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:
155 "^could not open conf file"
159 ": File \&.* shrunk by [0\-9][0\-9]* bytes, padding with zeros"
160 ": Cannot add file \&.*: No such file or directory$"
161 ": Error exit delayed from previous errors"
163 To treat one of these default patterns differently, specify it explicitly in a different property\&.
169 List all regex (POSIX Extended Regular Expression syntax) that amanda ignore\&. These output are never in the email report\&. Default values:
171 ": Directory is new$"
172 ": Directory has been renamed"
174 To treat one of these default patterns differently, specify it explicitly in a different property\&.
180 List all regex (POSIX Extended Regular Expression syntax) that are strange output from gtar\&. All gtar output that doesn\*(Aqt 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\&.
186 Default: "NO"\&. If "YES", amgtar print more verbose debugging message and can leave temporary files in AMANDA_TMPDIR\&.
188 .SH "INCLUDE AND EXCLUDE LISTS"
190 This application supplies exclude lists via the
192 \fB\-\-exclude\-from\fR
193 option\&. This option accepts normal shell\-style wildcard expressions, using
195 to match any number of characters and
197 to match a single character\&. Character classes are represented with
198 \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:
201 \&./temp\-files # exclude top\-level directory entirely
202 \&./temp\-files/ # BAD: does nothing
203 /temp\-files # BAD: does nothing
204 \&./temp\-files/* # exclude directory contents; include directory
205 temp\-files # exclude anything named "temp\-files"
206 generated\-* # exclude anything beginning with "generated\-"
207 *\&.iso # exclude ISO files
208 proxy/local/cache # exclude "cache" in dir "local" in "proxy"
211 Similarly, include expressions are supplied to
213 \fB\-\-files\-from\fR
214 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"\&.
220 define application\-tool app_amgtar {
223 property "ATIME\-PRESERVE" "NO"
224 property "CHECK\-DEVICE" "YES"
225 property "GNUTAR\-LISTDIR" "/path/to/listdir"
226 property "GNUTAR\-PATH" "/bin/tar"
227 property "ONE\-FILE\-SYSTEM" "YES"
228 property "TAR\-BLOCKSIZE" "20"
229 property "SPARSE" "YES"
231 property "SELINUX" "NO"
232 property "XATTRS" "NO"
233 property "EXIT\-HANDLING" "1=GOOD 2=BAD"
234 # change a default NORMAL regex to a STRANGE regex\&.
235 property "STRANGE" ": socket ignored$"
236 # add three new IGNORE regex
237 property "IGNORE" ": Directory is new$"
238 property append "IGNORE" ": Directory has been renamed"
239 property append "IGNORE" "file changed as we read it$"
242 A dumptype using this application might look like:
245 define dumptype amgtar_app_dtyp {
247 program "APPLICATION"
248 application "app_amgtar"
253 parameter must be set to
262 \fBamanda.conf\fR(5),
263 \fBamanda-applications\fR(7)
266 : http://wiki.zmanda.com/
269 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
271 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
274 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
276 Zmanda, Inc\&. (http://www\&.zmanda\&.com)