1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
5 <!-- entities files to use -->
6 <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
10 <!-- lifted from troff+man by doclifter -->
11 <refentry id='amgetconf.8'>
14 <refentrytitle>amgetconf</refentrytitle>
15 <manvolnum>8</manvolnum>
18 <refname>amgetconf</refname>
19 <refpurpose>look up amanda.conf variables</refpurpose>
21 <!-- body begins here -->
24 <command>amgetconf</command>
25 <arg choice='opt'><replaceable>config</replaceable></arg>
26 <arg choice='plain'><replaceable>parameter</replaceable></arg>
27 <group><arg choice='plain'>-o</arg><arg choice='plain'><replaceable>configoption</replaceable></arg></group>*
32 <refsect1><title>DESCRIPTION</title>
33 <para><emphasis remap='B'>Amgetconf</emphasis>
34 looks up parameters in
35 <emphasis remap='I'>amanda.conf</emphasis>,
36 the &A; configuration file,
37 or from the build and runtime environment,
38 and returns their corresponding value.</para>
41 <emphasis remap='I'>config</emphasis>
43 <command>amgetconf</command>
44 assumes it is being run from the configuration directory and that
45 <emphasis remap='I'>amanda.conf</emphasis>
49 <emphasis remap='I'>parameter</emphasis>
51 <emphasis remap='I'>build.</emphasis>,
52 the (case insensitive) string following the period
53 is a build environment variable.
54 Variables without a value (e.g.
55 <emphasis remap='I'>XFSDUMP</emphasis>
56 on a system that does not support that type of file system)
57 will not report an error and will return an empty string as the value.
59 <emphasis remap='I'>USE_AMANDAHOSTS</emphasis>)
62 if the flag is set or an empty string if it is not.</para>
65 <emphasis remap='I'>parameter</emphasis>
67 <emphasis remap='I'>dbopen.</emphasis>,
68 the string following the period is a program name and an &A; debug
69 file will be created for the caller.
70 The name of the file is returned.</para>
73 <emphasis remap='I'>parameter</emphasis>
75 <emphasis remap='I'>dbclose.</emphasis>,
76 the string following the period is a program name previously used with
77 <emphasis remap='I'>dbopen.</emphasis>,
78 followed by a colon (:) and the previously opened file name.</para>
81 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
82 man page for more details about &A;.</para>
85 <refsect1><title>OPTIONS</title>
86 <variablelist remap='TP'>
89 <term><emphasis remap='B'>-o</emphasis> <replaceable>configoption</replaceable></term>
91 <para>See the "<emphasis remap='B'>CONFIGURATION OVERWRITE</emphasis>" section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
99 <refsect1><title>EXAMPLE</title>
100 <para>Find out the path to the log file directory:</para>
103 <literallayout remap='.nf'>
104 % amgetconf daily logdir
105 /usr/local/etc/amanda//daily
106 </literallayout> <!-- .fi -->
108 <para>Find out the current tape type:</para>
111 <literallayout remap='.nf'>
112 % amgetconf daily tapetype
114 </literallayout> <!-- .fi -->
116 <para>Find out the default configuration directory:</para>
119 <literallayout remap='.nf'>
120 % amgetconf daily build.CONFIG_DIR
121 /usr/local/etc/amanda/
122 </literallayout> <!-- .fi -->
124 <para>Create, use and close a debug file in a script:</para>
127 <literallayout remap='.nf'>
128 % set debug_file = `amgetconf daily dbopen.myscript`
129 % echo debug information >> $debug_file
130 % amgetconf daily dbclose.myscript:$debug_file
131 </literallayout> <!-- .fi -->
134 <refsect1><title>MESSAGES</title>
135 <variablelist remap='TP'>
137 <term>amgetconf: no such parameter <emphasis remap='I'>param</emphasis></term>
140 <emphasis remap='I'>param</emphasis>
141 is not a known keyword
143 <emphasis remap='I'>amanda.conf</emphasis>
151 <refsect1><title>SEE ALSO</title>
152 <para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry></para>