46a380558c819df9a74317f058f58b256b085733
[debian/amanda] / docs / amgetconf.8.txt
1
2                              amgetconf
3 Prev  Chapter 35. The AMANDA Manual Pages.  Next
4
5 -------------------------------------------------------------------------------
6
7 Name
8
9 amgetconf \14 look up amanda.conf variables
10
11 Synopsis
12
13 amgetconf [config] parameter
14
15 DESCRIPTION
16
17 Amgetconf looks up parameters in amanda.conf, the AMANDA configuration file, or
18 from the build and runtime environment, and returns their corresponding value.
19 If config is not specified, amgetconf assumes it is being run from the
20 configuration directory and that amanda.conf is present.
21 If parameter begins with build., the (case insensitive) string following the
22 period is a build environment variable. Variables without a value (e.g. XFSDUMP
23 on a system that does not support that type of file system) will not report an
24 error and will return an empty string as the value. Flag variables (e.g.
25 USE_AMANDAHOSTS) will return 1 if the flag is set or an empty string if it is
26 not.
27 If parameter begins with dbopen., the string following the period is a program
28 name and an AMANDA debug file will be created for the caller. The name of the
29 file is returned.
30 If parameter begins with dbclose., the string following the period is a program
31 name previously used with dbopen., followed by a colon (:) and the previously
32 opened file name.
33 See the amanda(8) man page for more details about AMANDA.
34
35 EXAMPLE
36
37 Find out the path to the log file directory:
38
39 % amgetconf daily logdir
40 /usr/local/etc/amanda//daily
41 Find out the current tape type:
42
43 % amgetconf daily tapetype
44 DLT4000-IV
45 Find out the default configuration directory:
46
47 % amgetconf daily build.CONFIG_DIR
48 /usr/local/etc/amanda/
49 Create, use and close a debug file in a script:
50
51 % set debug_file = `amgetconf daily dbopen.myscript`
52 % echo debug information >> $debug_file
53 % amgetconf daily dbclose.myscript:$debug_file
54
55 MESSAGES
56
57
58
59   amgetconf: no such parameter param
60       Parameter param is not a known keyword (e.g. not a valid amanda.conf
61       keyword). In this case, amgetconf will write "BUGGY" to stdout as the
62       value.
63
64
65 SEE ALSO
66
67 amanda(8)
68 -------------------------------------------------------------------------------
69
70 Prev      Up      Next
71 amflush  Home  amlabel
72