X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Fxml-source%2Famanda-client.conf.5.xml;fp=man%2Fxml-source%2Famanda-client.conf.5.xml;h=10b2d921aaa9efde6a0532765556258a86c5c5cc;hb=2627875b7d18858bc1f9f7652811e4d8c15a23eb;hp=d11029190c6c43dae4835b0dd7e064350e15bd5b;hpb=fb2bd066c2f8b34addafe48d62550e3033a59431;p=debian%2Famanda diff --git a/man/xml-source/amanda-client.conf.5.xml b/man/xml-source/amanda-client.conf.5.xml index d110291..10b2d92 100644 --- a/man/xml-source/amanda-client.conf.5.xml +++ b/man/xml-source/amanda-client.conf.5.xml @@ -12,11 +12,18 @@ amanda-client.conf 5 +&rmi.source; +&rmi.version; +&rmi.manual.5; amanda-client.conf Client configuration file for &A;, the Advanced Maryland Automatic Network Disk Archiver + +&author.jds; +&author.sgw.xml; + DESCRIPTION @@ -25,131 +32,34 @@ relevant sections and parameters of this file for quick reference. The files <CONFIG_DIR>/amanda-client.conf and <CONFIG_DIR>/<config>/amanda-client.conf are loaded. -PARAMETERS +SYNTAX -There are a number of configuration parameters that control the -behavior of the &A; programs. -All have default values, -so you need not specify the parameter in -amanda-client.conf -if the default is suitable. +The syntax of &amclientconf; is identical to that for +amanda.conf5. -Lines starting with # are ignored, as are blank lines. -Comments may be placed on a line with a directive by starting -the comment with a #. -The remainder of the line is ignored. - -Keywords are case insensitive, i.e. -auth -and -Auth -are treated the same. - -Integer arguments may have one of the following (case insensitive) suffixes, -some of which have a multiplier effect: + -POSSIBLE SUFFIXES + +GLOBAL PARAMETERS - b byte bytes - -Some number of bytes. - - - - bps - -Some number of bytes per second. - - - - k kb kbyte kbytes kilobyte kilobytes - -Some number of kilobytes (bytes*1024). - - - - kps kbps - -Some number of kilobytes per second (bytes*1024). - - - - m mb meg mbyte mbytes megabyte megabytes - -Some number of megabytes (bytes*1024*1024). - - - - mps mbps - -Some number of megabytes per second (bytes*1024*1024). - - - - g gb gbyte gbytes gigabyte gigabytes - -Some number of gigabytes (bytes*1024*1024*1024). - - - - tape tapes - -Some number of tapes. - - - - day days - -Some number of days. - - - - week weeks + conf string -Some number of weeks (days*7). - -The value -inf -may be used in most places where an integer is expected -to mean an infinite amount. - -Boolean arguments may have any of the values -y, -yes, -t, -true -or -on -to indicate a true state, or -n, -no, -f, -false -or -off -to indicate a false state. -If no argument is given, -true -is assumed. - - +Default: +Set by configure. +The conf use by amrecover. - - - -PARAMETERS - - - conf string + client_username string Default: -Set by configure. -The conf use by amrecover. +CLIENT_LOGIN. +Similar to the parameter of the same name in &amconf;, this specifies the username that +&amrecover; should send when connecting to the server. It should match the username +specified in &amandahosts; on the server. @@ -224,6 +134,13 @@ The directory where gnutar keep its state file. + + mailer string + +Default found by configure. A mail program that can send mail with 'MAILER -s "subject" user < message_file'. + + + amandates string @@ -377,13 +294,228 @@ Unreserved tcp port that will be used (bsd, bsdudp) + + property "name" "value" + +Adds a global property for this client host, useful for e.g., Application API plugins. + + + + + + +APPLICATION SECTION +The +amanda.conf +file may define multiple types of application. +The information is entered in a application-tool +section, which looks like this: + + +define application-tool "name" { + application-option appli +cation-value + ... +} + + +name +is the name of this type of application. It is referenced from the +dumptype + +The application-tool options and values are: + + + comment string + +Default: +none. +A comment string describing this application. + + + + plugin string + +No default. Must be set to the name of the program. This program must be +in the $libexecdir/amanda/application directory +on the client. + + + + property [append] [priority] string string+ + +No default. You can set property for the application, each application have a different set of property. Both strings are quoted; the first string contains the name of +the property to set, and the others contains its values. +append keyword append the values to the list of values for that property. +priority keyword disallow the setting of that property on the server. + + + - -AUTHOR -James da Silva, &email.jds;: Original text -&maintainer.sgw;: XML-conversion, major update, splitting +SCRIPT SECTION +The +amanda.conf +file may define multiple types of script. +The information is entered in a script-tool +section, which looks like this: + + +define script-tool "name" { + script-option script-value + ... +} + + +name +is the name of this type of script. It is referenced from the +dumptype + +The script-tool options and values are: + + + comment string + +Default: +none. +A comment string describing this script. + + + + plugin string + +No default. Must be set to the name of the program. This program must be in the $libdir/amanda/application directory on the client and/or server. + + + + execute_where [client|server] + +Default: client. Where the script must be executed, on the client or server. Only client is valid. + + + + execute_on execute_on[,execute_on]* + +No default. When the script must be executed, you can specify many of them: + + + + pre-dle-amcheck + +Execute before the amcheck command for the dle. + + + + pre-host-amcheck + +Execute before the amcheck command for all dle for the client. + + + + post-dle-amcheck + +Execute after the amcheck command for the dle. + + + + post-host-amcheck + +Execute after the amcheck command for all dle for the client. + + + + pre-dle-estimate + +Execute before the estimate command for the dle. + + + + pre-host-estimate + +Execute before the estimate command for all dle for the client. + + + + post-dle-estimate + +Execute after the estimate command for the dle. + + + + post-host-estimate + +Execute after the estimate command for all dle for the client. + + + + pre-dle-backup + +Execute before the backup command for the dle. + + + + pre-host-backup + +Execute before the backup command for all dle for the client. + + + + post-dle-backup + +Execute after the backup command for the dle. + + + + post-host-backup + +Execute after the backup command for all dle for the client. + + + + pre-recover + +Execute before any level is recovered. + + + + post-recover + +Execute after all levels are recovered. + + + + pre-level-recover + +Execute before each level recovery. + + + + post-level-recover + +Execute after each level recovery. + + + + inter-level-recover + +Execute between two levels of recovery. + + + + + + + property [append] [priority] string string+ + +No default. You can set property for the script, each script have a different set of property. Both strings are quoted; the first string contains the name of +the property to set, and the others contains its values. +append keyword append the values to the list of values for that property. +priority keyword disallow the setting of that property on the server. + + + + SEE ALSO