<refmeta>
<refentrytitle>amgetconf</refentrytitle>
<manvolnum>8</manvolnum>
+&rmi.source;
+&rmi.version;
+&rmi.manual.8;
</refmeta>
<refnamediv>
<refname>amgetconf</refname>
-<refpurpose>look up amanda.conf variables</refpurpose>
+<refpurpose>look up configuration parameters and manipulate debug logs</refpurpose>
</refnamediv>
+<refentryinfo>
+&author.jlm;
+</refentryinfo>
<!-- body begins here -->
<refsynopsisdiv>
<cmdsynopsis>
<command>amgetconf</command>
+ <arg choice='opt'><replaceable>-l|--list</replaceable></arg>
+ <arg choice='plain' rep='repeat'><group><arg choice='plain'>-o </arg><replaceable>configoption</replaceable></group></arg>
+ <arg choice='opt'><replaceable>--client</replaceable></arg>
+ <arg choice='opt'><replaceable>--execute-where client|server</replaceable></arg>
<arg choice='opt'><replaceable>config</replaceable></arg>
- <arg choice='opt'><replaceable>--list</replaceable></arg>
<arg choice='plain'><replaceable>parameter</replaceable></arg>
- <arg choice='plain' rep='repeat'><group><arg choice='plain'>-o </arg><replaceable>configoption</replaceable></group></arg>
</cmdsynopsis>
</refsynopsisdiv>
-
<refsect1><title>DESCRIPTION</title>
-<para><emphasis remap='B'>Amgetconf</emphasis>
-looks up parameters in
-<emphasis remap='I'>amanda.conf</emphasis>,
-the &A; configuration file,
-or from the build and runtime environment,
-and returns their corresponding value.</para>
-
-<para>If
-<emphasis remap='I'>config</emphasis>
-is not specified,
-<command>amgetconf</command>
-assumes it is being run from the configuration directory and that
-<emphasis remap='I'>amanda.conf</emphasis>
-is present.</para>
-
-<para>If
-<emphasis remap='I'>parameter</emphasis>
-begins with
-<emphasis remap='I'>build.</emphasis>,
-the (case insensitive) string following the period
-is a build environment variable.
-Variables without a value (e.g.
-<emphasis remap='I'>XFSDUMP</emphasis>
-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.
-<emphasis remap='I'>USE_AMANDAHOSTS</emphasis>)
-will return
-<literal>1</literal>
-if the flag is set or an empty string if it is not.</para>
-
-<para>If
-<emphasis remap='I'>parameter</emphasis>
-begins with
-<emphasis remap='I'>dbopen.</emphasis>,
-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.</para>
-
-<para>If
-<emphasis remap='I'>parameter</emphasis>
-begins with
-<emphasis remap='I'>dbclose.</emphasis>,
-the string following the period is a program name previously used with
-<emphasis remap='I'>dbopen.</emphasis>,
-followed by a colon (:) and the previously opened file name.</para>
-
-<para>See the
+
+<para><emphasis remap='B'>Amgetconf</emphasis> has three main jobs:
+<!-- itemizedlist doesn't work in translation to a manpage.. --> 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.</para>
+
+<para>If <emphasis remap='I'>config</emphasis> is not
+specified, <command>amgetconf</command> assumes it is
+being run from the configuration directory and that <emphasis
+remap='I'>amanda.conf</emphasis> is present. The order of options and
+arguments does not matter. <emphasis remap='I'>parameter</emphasis>
+is always case-insensitive, and '-' and '_' are treated as identical, just
+as in <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
+
+<para>See the "<emphasis
+remap='B'>CONFIGURATION OVERRIDE</emphasis>" section in
<citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-man page for more details about &A;.</para>
-</refsect1>
+for information on the <literal>-o</literal> option.</para>
-<refsect1><title>OPTIONS</title>
-<variablelist remap='TP'>
+<refsect2><title>AMANDA CONFIGURATION</title>
- <varlistentry>
- <term><emphasis remap='B'>--list</emphasis></term>
- <listitem>
-<para>The parameter must be 'tapetype', 'dumptype, 'holdingdisk' or 'interface'. It will output, one by line, the list of identifier for the parameter.</para>
-<variablelist remap='TP'>
-<varlistentry>
- <term>--list tapetype</term>
- <listitem>
- <para>Output the list of tapetype, one by line.</para>
- </listitem>
-</varlistentry>
-<varlistentry>
- <term>--list dumptype</term>
- <listitem>
- <para>Output the list of dumptype, one by line.</para>
- </listitem>
-</varlistentry>
-<varlistentry>
- <term>--list holdingdisk</term>
- <listitem>
- <para>Output the list of holdingdisk, one by line.</para>
- </listitem>
-</varlistentry>
-<varlistentry>
- <term>--list interface</term>
- <listitem>
- <para>Output the list of interface, one by line.</para>
- </listitem>
-</varlistentry>
-</variablelist>
- </listitem>
- </varlistentry>
+<para>If <emphasis remap='I'>parameter</emphasis> is a configuration
+keyword (from <citerefentry> <refentrytitle>amanda.conf</refentrytitle>
+<manvolnum>5</manvolnum> </citerefentry>), then amgetconf will return
+the corresponding value. For keywords which can take multiple values,
+amgetconf will return all values, one on each line.</para>
- <varlistentry>
- <term><emphasis remap='B'>parameter</emphasis></term>
- <listitem>
- <para>It could be one of the below format:</para>
-<variablelist remap='TP'>
-<varlistentry>
- <term>runtapes</term><listitem><para></para></listitem>
-</varlistentry>
-<varlistentry>
- <term>DUMPTYPE:no-compress:compress</term><listitem><para></para></listitem>
-</varlistentry>
-<varlistentry>
- <term>TAPETYPE:HP-DAT:length</term><listitem><para></para></listitem>
-</varlistentry>
-<varlistentry>
- <term>INTERFACE:local:use</term><listitem><para></para></listitem>
-</varlistentry>
-<varlistentry>
- <term>HOLDINGDISK:hd1:use</term><listitem><para></para></listitem>
-</varlistentry>
-</variablelist>
- </listitem>
- </varlistentry>
+<para>Values in configuration subsections are specified with
+parameters of the form <literal>TYPE:NAME:PARAMETER</literal>,
+where <literal>TYPE</literal> is the subsection type (one
+of <literal>dumptype</literal>, <literal>tapetype</literal>,
+<literal>interface</literal>, <literal>holdingdisk</literal>,
+<literal>application-tool</literal>, or <literal>script-tool</literal>;
+<literal>NAME</literal> is the name of the subsection (e.g.,
+<literal>user-tar</literal>), and <literal>PARAMETER</literal> is
+the name of the disired parameter within that subsection.</para>
-<varlistentry>
-<term><emphasis remap='B'>-o</emphasis> <replaceable>configoption</replaceable></term>
- <listitem>
-<para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>" section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
- </listitem>
- </varlistentry>
+<para>The <literal>--list</literal> option lists the subsections of
+a certain type, where the type is givein as the parameter.</para>
+
+<para>The <literal>--client</literal> option is equivalent to
+<literal>--execute-where server</literal> (below).</para>
+
+<para>The <literal>--execute-where</literal> option tells amgetconf whether
+to operate on the client or the server; the server is the default.</para>
+
+</refsect2>
+
+<refsect2><title>BUILD CONFIGURATION</title>
+
+<para>If <emphasis remap='I'>parameter</emphasis> begins
+with <literal>build.</literal>, then the following name is a
+build environment variable. Variables without a value (e.g.
+<literal>XFSDUMP</literal> 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. <emphasis
+remap='I'>USE_AMANDAHOSTS</emphasis>) will return <literal>1</literal>
+if the flag is set or an empty string if it is not, while others
+return <literal>yes</literal> or <literal>no</literal>, as indicated
+below (the difference is historical).</para>
+
+<para>Combining the <literal>--list</literal> option with the parameter
+<literal>build</literal> will enumerate all available build parameters.</para>
+
+<variablelist><title>Build Parameters</title>
+ <varlistentry><term><literal>bindir</literal></term>
+ <term><literal>sbindir</literal></term>
+ <term><literal>libexecdir</literal></term>
+ <term><literal>mandir</literal></term>
+ <listitem><para>Install directories</para></listitem>
+ </varlistentry>
+
+ <varlistentry><term><literal>AMANDA_TMPDIR</literal></term>
+ <term><literal>CONFIG_DIR</literal></term>
+ <term><literal>AMANDA_DBGDIR</literal></term>
+ <term><literal>GNUTAR_LISTED_INCREMENTAL_DIR</literal></term>
+ <listitem><para>Runtime directories</para></listitem>
+ </varlistentry>
+ <varlistentry><term><literal>listed_inc_dir</literal></term>
+ <listitem><para>Same as <literal>GNUTAR_LISTED_INCREMENTAL_DIR</literal></para></listitem>
+ </varlistentry>
+
+ <varlistentry><term><literal>CC</literal></term>
+ <term><literal>VERSION</literal></term>
+ <term><literal>ASSERTIONS</literal></term>
+ <term><literal>LOCKING</literal></term>
+ <term><literal>USE_VERSION_SUFFIXES</literal></term>
+ <listitem><para>Build information. <literal>ASSERTIONS</literal>
+ is 1 or empty, while <literal>USE_VERSION_SUFFIXES</literal> is
+ yes/no.</para></listitem>
+ </varlistentry>
+ <varlistentry><term><literal>DUMP</literal></term>
+ <term><literal>RESTORE</literal></term>
+ <term><literal>VDUMP</literal></term>
+ <term><literal>VRESTORE</literal></term>
+ <term><literal>XFSDUMP</literal></term>
+ <term><literal>XFSRESTORE</literal></term>
+ <term><literal>VXDUMP</literal></term>
+ <term><literal>VXRESTORE</literal></term>
+ <term><literal>SAMBA_CLIENT</literal></term>
+ <term><literal>GNUTAR</literal></term>
+ <term><literal>STAR</literal></term>
+ <term><literal>COMPRESS_PATH</literal></term>
+ <term><literal>UNCOMPRESS_PATH</literal></term>
+ <listitem><para>Paths to various utility progarms (empty if they
+ are not found or not used)</para></listitem>
+ </varlistentry>
+
+ <varlistentry><term><literal>AIX_BACKUP</literal></term>
+ <listitem><para>Is <literal>DUMP</literal> the AIX backup program? (empty or 1)</para></listitem>
+ </varlistentry>
+
+ <varlistentry><term><literal>DUMP_RETURNS_1</literal></term>
+ <listitem><para>Does <literal>DUMP</literal> return 1 on success? (empty or 1)</para></listitem>
+ </varlistentry>
+
+ <varlistentry><term><literal>BSD_SECURITY</literal></term>
+ <term><literal>BSDUDP_SECURITY</literal></term>
+ <term><literal>BSDTCP_SECURITY</literal></term>
+ <term><literal>KRB4_SECURITY</literal></term>
+ <term><literal>KRB5_SECURITY</literal></term>
+ <term><literal>SSH_SECURITY</literal></term>
+ <term><literal>RSH_SECURITY</literal></term>
+ <listitem><para>Indicate which authentication mechanisms are
+ available (yes or no).</para></listitem>
+ </varlistentry>
+
+ <varlistentry><term><literal>USE_AMANDAHOSTS</literal></term>
+ <listitem><para>Should the "bsd" authentication mechanism use
+ <filename>amandahosts</filename>? (yes or no).</para></listitem>
+ </varlistentry>
+
+ <varlistentry><term><literal>AMANDA_DEBUG_DAYS</literal></term>
+ <listitem><para>Number of days after which debug logs are deleted.</para></listitem>
+ </varlistentry>
+
+ <varlistentry><term><literal>DEFAULT_SERVER</literal></term>
+ <term><literal>DEFAULT_CONFIG</literal></term>
+ <term><literal>DEFAULT_TAPE_SERVER</literal></term>
+ <term><literal>DEFAULT_TAPE_DEVICE</literal></term>
+ <listitem><para>Default values for configuration parameters</para></listitem>
+ </varlistentry>
+
+ <varlistentry><term><literal>CLIENT_LOGIN</literal></term>
+ <listitem><para>Userid under which the client runs (from
+ <literal>--with-user</literal>).</para></listitem>
+ </varlistentry>
+
+ <varlistentry><term><literal>USE_RUNDUMP</literal></term>
+ <listitem><para>Should Amanda use the <literal>rundump</literal>
+ wrapper? (empty or 1)</para></listitem>
+ </varlistentry>
+
+ <varlistentry><term><literal>CHECK_USERID</literal></term>
+ <listitem><para>Does Amanda check that userids are correct? (empty or 1)</para></listitem>
+ </varlistentry>
+
+ <varlistentry><term><literal>COMPRESS_SUFFIX</literal></term>
+ <term><literal>COMPRESS_FAST_OPT</literal></term>
+ <term><literal>COMPRESS_BEST_OPT</literal></term>
+ <term><literal>UNCOMPRESS_OPT</literal></term>
+ <listitem><para>Command-line options for the compression program.</para></listitem>
+ </varlistentry>
+
+ <varlistentry><term><literal>TICKET_LIFETIME</literal></term>
+ <term><literal>SERVER_HOST_PRINCIPAL</literal></term>
+ <term><literal>SERVER_HOST_INSTANCE</literal></term>
+ <term><literal>SERVER_HOST_KEY_FILE</literal></term>
+ <term><literal>CLIENT_HOST_PRINCIPAL</literal></term>
+ <term><literal>CLIENT_HOST_INSTANCE</literal></term>
+ <term><literal>CLIENT_HOST_KEY_FILE</literal></term>
+ <listitem><para>Kerberos parameters.</para></listitem>
+ </varlistentry>
</variablelist>
+
+</refsect2>
+
+<refsect2><title>DEBUG LOG MANAGEMENT</title>
+
+<note>That this application is responsible for debug logs is a
+historical quirk, but the functionality is widely used.</note>
+
+<para>If <emphasis remap='I'>parameter</emphasis> begins with <emphasis
+remap='I'>dbopen.</emphasis>, 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.</para>
+
+<para>If <emphasis remap='I'>parameter</emphasis> begins with
+<emphasis remap='I'>dbclose.</emphasis>, the string following
+the period is a program name previously used with <emphasis
+remap='I'>dbopen.</emphasis>, followed by a colon (:) and
+the previously opened file name. The name of the logfile is
+returned.</para>
+
+</refsect2>
</refsect1>
-<refsect1><title>EXAMPLE</title>
+
+<refsect1><title>EXAMPLES</title>
<para>Find out the path to the log file directory:</para>
-<!-- .RS -->
-<literallayout remap='.nf'>
+<programlisting remap='.nf'>
% amgetconf daily logdir
-/usr/local/etc/amanda//daily
-</literallayout> <!-- .fi -->
+/usr/local/etc/amanda/daily/logs
+</programlisting>
<para>Find out the current tape type:</para>
-
-<!-- .RS -->
-<literallayout remap='.nf'>
+<programlisting remap='.nf'>
% amgetconf daily tapetype
DLT4000-IV
-</literallayout> <!-- .fi -->
+</programlisting>
-<para>Find out the default configuration directory:</para>
+<para>Find out that tape type's length:</para>
+<programlisting remap='.nf'>
+% amgetconf daily tapetype:DLT4000-IV:length
+1024000
+</programlisting>
-<!-- .RS -->
-<literallayout remap='.nf'>
-% amgetconf daily build.CONFIG_DIR
+<para>List the other available tapetype:</para>
+<programlisting remap='.nf'>
+% amgetconf daily --list tapetype
+DISK
+QIC-60
+DEC-DLT2000
+...
+</programlisting>
+
+<para>Find out the configuration directory:</para>
+<programlisting remap='.nf'>
+% amgetconf build.CONFIG_DIR
/usr/local/etc/amanda/
-</literallayout> <!-- .fi -->
+</programlisting>
-<para>Create, use and close a debug file in a script:</para>
+<para>List all build-time parameters</para>
+<programlisting remap='.nf'>
+% amgetconf --list build
+AIX_BACKUP
+AMANDA_DBGDIR
+AMANDA_DEBUG_DAYS
+...
+</programlisting>
-<!-- .RS -->
-<literallayout remap='.nf'>
-% set debug_file = `amgetconf daily dbopen.myscript`
+<para>Create, use and close a debug file in a script:</para>
+<programlisting remap='.nf'>
+% debug_file=`amgetconf daily dbopen.myscript`
% echo debug information >> $debug_file
% amgetconf daily dbclose.myscript:$debug_file
-</literallayout> <!-- .fi -->
+</programlisting>
</refsect1>
<refsect1><title>MESSAGES</title>
<variablelist remap='TP'>
<varlistentry>
<term>amgetconf: no such parameter <emphasis remap='I'>param</emphasis></term>
- <listitem>
-<para>Parameter
-<emphasis remap='I'>param</emphasis>
-is not a known keyword
-(e.g. not a valid
-<emphasis remap='I'>amanda.conf</emphasis>
-keyword).
-</para>
- </listitem>
+
+ <listitem><para>Parameter <emphasis remap='I'>param</emphasis>
+ is not a known keyword (e.g. not a valid <emphasis
+ remap='I'>amanda.conf</emphasis> keyword).</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
</para>
</refsect1>
</refentry>
-
projects / debian / amanda / blobdiff