X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Fxml-source%2Famgtar.8.xml;h=557e5637db78987380617eb3969cc054307f62b6;hb=441dd72d27c13b97098a519388e6c194b16519f0;hp=480cedf0b0f4c9c6b88512cc60398de0a1538650;hpb=afaa71b3866b46b082b6c895772e15b36d8865fe;p=debian%2Famanda diff --git a/man/xml-source/amgtar.8.xml b/man/xml-source/amgtar.8.xml index 480cedf..557e563 100644 --- a/man/xml-source/amgtar.8.xml +++ b/man/xml-source/amgtar.8.xml @@ -3,7 +3,7 @@ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ - + %global_entities; ]> @@ -28,15 +28,18 @@ DESCRIPTION -Amgtar is an &A; Application API script. It should not be run +Amgtar is an Amanda Application API script. It should not be run by users directly. It uses GNU Tar to backup and restore data. +The diskdevice in the disklist (DLE) +must be the directory to backup. + PROPERTIES This section lists the properties that control amgtar's functionality. -See amanda-applications7 +See for information on application properties and how they are configured. @@ -48,18 +51,43 @@ If "YES" (the default), amgtar use the --atime-preserve=system CHECK-DEVICE 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 --no-check-device 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. + + + COMMAND-OPTIONS +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. +Use: + + property "COMMAND-OPTIONS" "--foo" "bar" + +Do not use: + + property "COMMAND-OPTIONS" "--foo bar" + DIRECTORY -If set, gnutar will backup from that directory instead of the diskdevice set by the DLE. +If set, gnutar will backup from that directory instead of the diskdevice set by the DLE. On restore, the data is restore in that directory instead of the current working directory. GNUTAR-LISTDIR -The directory where gnutar stores the database it uses to generate incremental dumps. The default is set when &A; is built. +The directory where gnutar stores the database it uses to generate incremental dumps. The default is set when Amanda is built. GNUTAR-PATH -The path to the gnutar binary. The default is set when &A; is built. +The path to the gnutar binary. The default is set when Amanda is built. + + + IGNORE-ZEROS +If "YES" (the default), use the --ignore-zeros argument of gtar on recovery, +set it to "NO" if you do not want that argument. + + + INCLUDE-LIST-GLOB +A filename containing include glob expression for the restore command. + + + EXCLUDE-LIST-GLOB +A filename containing exclude glob expression for the restore command. ONE-FILE-SYSTEM @@ -72,6 +100,22 @@ Block size of Nx512 bytes (default N=20). This corresponds to the --b SPARSE If "YES" (the default), gnutar will store sparse files efficiently. If "NO", then the --sparse option is not given to gnutar, and it will not try to detect sparse files. + + + NO-UNQUOTE +If "NO" (the default), gnutar doesn't get the --no-unquote option and the diskname can't have some characters, eg. '\'. If "YES", then the --no-unquote 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. + + + ACLS +Default "NO". If "YES", gnutar will preserve ACL extended attributes. This corresponds to the --acls gnutar option. Requires a GNU Tar with nonstandard extended attribute patches from the Fedora Project. + + + SELINUX +Default "NO". If "YES", gnutar will preserve SELinux extended attributes on Linux. This corresponds to the --selinux gnutar option. Requires a GNU Tar with nonstandard extended attribute patches from the Fedora Project. + + + XATTRS +Default "NO". If "YES", gnutar will preserve all extended attributes. This corresponds to the --xattrs 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. EXIT-HANDLING @@ -103,21 +147,64 @@ List all regex (POSIX Extended Regular Expression syntax) that amanda ignore. Th STRANGE 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. + + + VERBOSE +Default: "NO". If "YES", amgtar print more verbose debugging message and can leave temporary files in AMANDA_TMPDIR. +INCLUDE AND EXCLUDE LISTS + +This application supplies exclude lists via the &gnutar; + option. This option accepts normal +shell-style wildcard expressions, using to match any +number of characters and to match a single character. +Character classes are represented with , 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: + + ./temp-files # exclude top-level directory entirely + ./temp-files/ # BAD: does nothing + /temp-files # BAD: does nothing + ./temp-files/* # exclude directory contents; include directory + temp-files # exclude anything named "temp-files" + generated-* # exclude anything beginning with "generated-" + *.iso # exclude ISO files + proxy/local/cache # exclude "cache" in dir "local" in "proxy" + + + +Similarly, include expressions are supplied to &gnutar;'s + 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". + + + EXAMPLE + define application-tool app_amgtar { + plugin "amgtar" + property "ATIME-PRESERVE" "NO" property "CHECK-DEVICE" "YES" - property "GNUTAR-LISTDIR" " + property "GNUTAR-LISTDIR" "/path/to/listdir" property "GNUTAR-PATH" "/bin/tar" property "ONE-FILE-SYSTEM" "YES" - property "TAR_BLOCKSIZE" "20" + property "TAR-BLOCKSIZE" "20" property "SPARSE" "YES" + property "ACLS" "NO" + property "SELINUX" "NO" + property "XATTRS" "NO" property "EXIT-HANDLING" "1=GOOD 2=BAD" # change a default NORMAL regex to a STRANGE regex. property "STRANGE" ": socket ignored$" @@ -127,13 +214,24 @@ List all regex (POSIX Extended Regular Expression syntax) that are strange outpu property append "IGNORE" "file changed as we read it$" } +A dumptype using this application might look like: + + define dumptype amgtar_app_dtyp { + global + program "APPLICATION" + application "app_amgtar" + } + +Note that the program parameter must be set to +"APPLICATION" to use the application +parameter. + -SEE ALSO - -amanda.conf5, -amanda-applications7 - + +, +, + + -