X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Fxml-source%2Famgetconf.8.xml;h=5be005a1054a87833e177b1c785ed2b180aa2400;hb=2627875b7d18858bc1f9f7652811e4d8c15a23eb;hp=9dab51140584b49b525b7710cbb7a271b220b368;hpb=fb2bd066c2f8b34addafe48d62550e3033a59431;p=debian%2Famanda
diff --git a/man/xml-source/amgetconf.8.xml b/man/xml-source/amgetconf.8.xml
index 9dab511..5be005a 100644
--- a/man/xml-source/amgetconf.8.xml
+++ b/man/xml-source/amgetconf.8.xml
@@ -13,195 +13,292 @@
amgetconf
8
+&rmi.source;
+&rmi.version;
+&rmi.manual.8;
amgetconf
-look up amanda.conf variables
+look up configuration parameters and manipulate debug logs
+
+&author.jlm;
+
amgetconf
+ -l|--list
+ -o configoption
+ --client
+ --execute-where client|server
config
- --list
parameter
- -o configoption
-
DESCRIPTION
-Amgetconf
-looks up parameters in
-amanda.conf,
-the &A; configuration file,
-or from the build and runtime environment,
-and returns their corresponding value.
-
-If
-config
-is not specified,
-amgetconf
-assumes it is being run from the configuration directory and that
-amanda.conf
-is present.
-
-If
-parameter
-begins with
-build.,
-the (case insensitive) string following the period
-is a build environment variable.
-Variables without a value (e.g.
-XFSDUMP
-on a system that does not support that type of file system)
-will not report an error and will return an empty string as the value.
-Flag variables (e.g.
-USE_AMANDAHOSTS)
-will return
-1
-if the flag is set or an empty string if it is not.
-
-If
-parameter
-begins with
-dbopen.,
-the string following the period is a program name and an &A; debug
-file will be created for the caller.
-The name of the file is returned.
-
-If
-parameter
-begins with
-dbclose.,
-the string following the period is a program name previously used with
-dbopen.,
-followed by a colon (:) and the previously opened file name.
-
-See the
+
+Amgetconf has three main jobs:
+ to
+fetch configuration information from the Amanda configuration; to fetch
+build-time configuration values; and to open and close debug logs for
+shell scripts. Each is treated in its own subsection, below.
+
+If config is not
+specified, amgetconf assumes it is
+being run from the configuration directory and that amanda.conf is present. The order of options and
+arguments does not matter. parameter
+is always case-insensitive, and '-' and '_' are treated as identical, just
+as in amanda.conf5.
+
+See the "CONFIGURATION OVERRIDE" section in
amanda8
-man page for more details about &A;.
-
+for information on the -o option.
-OPTIONS
-
+AMANDA CONFIGURATION
-
- --list
-
-The parameter must be 'tapetype', 'dumptype, 'holdingdisk' or 'interface'. It will output, one by line, the list of identifier for the parameter.
-
-
- --list tapetype
-
- Output the list of tapetype, one by line.
-
-
-
- --list dumptype
-
- Output the list of dumptype, one by line.
-
-
-
- --list holdingdisk
-
- Output the list of holdingdisk, one by line.
-
-
-
- --list interface
-
- Output the list of interface, one by line.
-
-
-
-
-
+If parameter is a configuration
+keyword (from amanda.conf
+5 ), then amgetconf will return
+the corresponding value. For keywords which can take multiple values,
+amgetconf will return all values, one on each line.
-
- parameter
-
- It could be one of the below format:
-
-
- runtapes
-
-
- DUMPTYPE:no-compress:compress
-
-
- TAPETYPE:HP-DAT:length
-
-
- INTERFACE:local:use
-
-
- HOLDINGDISK:hd1:use
-
-
-
-
+Values in configuration subsections are specified with
+parameters of the form TYPE:NAME:PARAMETER,
+where TYPE is the subsection type (one
+of dumptype, tapetype,
+interface, holdingdisk,
+application-tool, or script-tool;
+NAME is the name of the subsection (e.g.,
+user-tar), and PARAMETER is
+the name of the disired parameter within that subsection.
-
--o configoption
-
-See the "CONFIGURATION OVERRIDE" section in amanda8.
-
-
+The --list option lists the subsections of
+a certain type, where the type is givein as the parameter.
+
+The --client option is equivalent to
+--execute-where server (below).
+
+The --execute-where option tells amgetconf whether
+to operate on the client or the server; the server is the default.
+
+
+
+BUILD CONFIGURATION
+
+If parameter begins
+with build., then the following name is a
+build environment variable. Variables without a value (e.g.
+XFSDUMP on a system that does not support that
+type of file system) will not report an error and will return an
+empty string as the value. Some boolean variables (e.g. USE_AMANDAHOSTS) will return 1
+if the flag is set or an empty string if it is not, while others
+return yes or no, as indicated
+below (the difference is historical).
+
+Combining the --list option with the parameter
+build will enumerate all available build parameters.
+
+Build Parameters
+ bindir
+ sbindir
+ libexecdir
+ mandir
+ Install directories
+
+
+ AMANDA_TMPDIR
+ CONFIG_DIR
+ AMANDA_DBGDIR
+ GNUTAR_LISTED_INCREMENTAL_DIR
+ Runtime directories
+
+ listed_inc_dir
+ Same as GNUTAR_LISTED_INCREMENTAL_DIR
+
+
+ CC
+ VERSION
+ ASSERTIONS
+ LOCKING
+ USE_VERSION_SUFFIXES
+ Build information. ASSERTIONS
+ is 1 or empty, while USE_VERSION_SUFFIXES is
+ yes/no.
+
+ DUMP
+ RESTORE
+ VDUMP
+ VRESTORE
+ XFSDUMP
+ XFSRESTORE
+ VXDUMP
+ VXRESTORE
+ SAMBA_CLIENT
+ GNUTAR
+ STAR
+ COMPRESS_PATH
+ UNCOMPRESS_PATH
+ Paths to various utility progarms (empty if they
+ are not found or not used)
+
+
+ AIX_BACKUP
+ Is DUMP the AIX backup program? (empty or 1)
+
+
+ DUMP_RETURNS_1
+ Does DUMP return 1 on success? (empty or 1)
+
+
+ BSD_SECURITY
+ BSDUDP_SECURITY
+ BSDTCP_SECURITY
+ KRB4_SECURITY
+ KRB5_SECURITY
+ SSH_SECURITY
+ RSH_SECURITY
+ Indicate which authentication mechanisms are
+ available (yes or no).
+
+
+ USE_AMANDAHOSTS
+ Should the "bsd" authentication mechanism use
+ amandahosts? (yes or no).
+
+
+ AMANDA_DEBUG_DAYS
+ Number of days after which debug logs are deleted.
+
+
+ DEFAULT_SERVER
+ DEFAULT_CONFIG
+ DEFAULT_TAPE_SERVER
+ DEFAULT_TAPE_DEVICE
+ Default values for configuration parameters
+
+
+ CLIENT_LOGIN
+ Userid under which the client runs (from
+ --with-user).
+
+
+ USE_RUNDUMP
+ Should Amanda use the rundump
+ wrapper? (empty or 1)
+
+
+ CHECK_USERID
+ Does Amanda check that userids are correct? (empty or 1)
+
+
+ COMPRESS_SUFFIX
+ COMPRESS_FAST_OPT
+ COMPRESS_BEST_OPT
+ UNCOMPRESS_OPT
+ Command-line options for the compression program.
+
+
+ TICKET_LIFETIME
+ SERVER_HOST_PRINCIPAL
+ SERVER_HOST_INSTANCE
+ SERVER_HOST_KEY_FILE
+ CLIENT_HOST_PRINCIPAL
+ CLIENT_HOST_INSTANCE
+ CLIENT_HOST_KEY_FILE
+ Kerberos parameters.
+
+
+
+
+DEBUG LOG MANAGEMENT
+
+That this application is responsible for debug logs is a
+historical quirk, but the functionality is widely used.
+
+If parameter begins with dbopen., the string following the period is a
+program name and an &A; debug file will be created for the caller.
+The name of the logfile is returned.
+
+If parameter begins with
+dbclose., the string following
+the period is a program name previously used with dbopen., followed by a colon (:) and
+the previously opened file name. The name of the logfile is
+returned.
+
+
-EXAMPLE
+
+EXAMPLES
Find out the path to the log file directory:
-
-
+
% amgetconf daily logdir
-/usr/local/etc/amanda//daily
-
+/usr/local/etc/amanda/daily/logs
+
Find out the current tape type:
-
-
-
+
% amgetconf daily tapetype
DLT4000-IV
-
+
-Find out the default configuration directory:
+Find out that tape type's length:
+
+% amgetconf daily tapetype:DLT4000-IV:length
+1024000
+
-
-
-% amgetconf daily build.CONFIG_DIR
+List the other available tapetype:
+
+% amgetconf daily --list tapetype
+DISK
+QIC-60
+DEC-DLT2000
+...
+
+
+Find out the configuration directory:
+
+% amgetconf build.CONFIG_DIR
/usr/local/etc/amanda/
-
+
-Create, use and close a debug file in a script:
+List all build-time parameters
+
+% amgetconf --list build
+AIX_BACKUP
+AMANDA_DBGDIR
+AMANDA_DEBUG_DAYS
+...
+
-
-
-% set debug_file = `amgetconf daily dbopen.myscript`
+Create, use and close a debug file in a script:
+
+% debug_file=`amgetconf daily dbopen.myscript`
% echo debug information >> $debug_file
% amgetconf daily dbclose.myscript:$debug_file
-
+
MESSAGES
amgetconf: no such parameter param
-
-Parameter
-param
-is not a known keyword
-(e.g. not a valid
-amanda.conf
-keyword).
-
-
+
+ Parameter param
+ is not a known keyword (e.g. not a valid amanda.conf keyword).
@@ -213,4 +310,3 @@ keyword).
-