git.gag.com Git - debian/amanda/blob - man/xml-source/amgetconf.8.xml

   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"
   4 [
   5   <!-- entities files to use -->
   6   <!ENTITY % global_entities SYSTEM 'global.entities'>
   7   %global_entities;
   8 ]>
   9
  10 <!-- lifted from troff+man by doclifter -->
  11 <refentry id='amgetconf.8'>
  12
  13 <refmeta>
  14 <refentrytitle>amgetconf</refentrytitle>
  15 <manvolnum>8</manvolnum>
  16 &rmi.source;
  17 &rmi.version;
  18 &rmi.manual.8;
  19 </refmeta>
  20 <refnamediv>
  21 <refname>amgetconf</refname>
  22 <refpurpose>look up configuration parameters and manipulate debug logs</refpurpose>
  23 </refnamediv>
  24 <refentryinfo>
  25 &author.jlm;
  26 </refentryinfo>
  27 <!-- body begins here -->
  28 <refsynopsisdiv>
  29 <cmdsynopsis>
  30   <command>amgetconf</command>
  31     <arg choice='opt'><replaceable>-l|--list</replaceable></arg>
  32     <arg choice='opt'><replaceable>--client</replaceable></arg>
  33     <arg choice='opt'><replaceable>--execute-where client|server</replaceable></arg>
  34     &configoverride.synopsis;
  35     <arg choice='opt'><replaceable>config</replaceable></arg>
  36     <arg choice='plain'><replaceable>parameter</replaceable></arg>
  37 </cmdsynopsis>
  38 </refsynopsisdiv>
  39
  40 <refsect1><title>DESCRIPTION</title>
  41
  42 <para><emphasis remap='B'>Amgetconf</emphasis> has three main jobs:
  43 <!-- itemizedlist doesn't work in translation to a manpage.. --> to
  44 fetch configuration information from the Amanda configuration; to fetch
  45 build-time configuration values; and to open and close debug logs for
  46 shell scripts.  Each is treated in its own subsection, below.</para>
  47
  48 <para>If <emphasis remap='I'>config</emphasis> is not
  49 specified, <command>amgetconf</command> assumes it is
  50 being run from the configuration directory and that <emphasis
  51 remap='I'>amanda.conf</emphasis> is present. The order of options and
  52 arguments does not matter.  <emphasis remap='I'>parameter</emphasis>
  53 is always case-insensitive, and '-' and '_' are treated as identical, just
  54 as in <manref name="amanda.conf" vol="5"/>.</para>
  55
  56 <para>See the "<emphasis
  57 remap='B'>CONFIGURATION OVERRIDE</emphasis>" section in
  58 <manref name="amanda" vol="8"/>
  59 for information on the <literal>-o</literal> option.</para>
  60
  61 <refsect2><title>AMANDA CONFIGURATION</title>
  62
  63 <para>If <emphasis remap='I'>parameter</emphasis> is a configuration
  64 keyword (from <manref name="amanda.conf" vol="5"/>), then amgetconf will return
  65 the corresponding value.  For keywords which can take multiple values,
  66 amgetconf will return all values, one on each line.</para>
  67
  68 <para>Values in configuration subsections are specified with
  69 parameters of the form <literal>TYPE:NAME:PARAMETER</literal>,
  70 where <literal>TYPE</literal> is the subsection type (one
  71 of <literal>dumptype</literal>, <literal>tapetype</literal>,
  72 <literal>interface</literal>, <literal>holdingdisk</literal>,
  73 <literal>application-tool</literal>, or <literal>script-tool</literal>;
  74 <literal>NAME</literal> is the name of the subsection (e.g.,
  75 <literal>user-tar</literal>), and <literal>PARAMETER</literal> is
  76 the name of the disired parameter within that subsection.</para>
  77
  78 <para>The <literal>--list</literal> option lists the subsections of
  79 a certain type, where the type is givein as the parameter.</para>
  80
  81 <para>The <literal>--client</literal> option is equivalent to
  82 <literal>--execute-where server</literal> (below).</para>
  83
  84 <para>The <literal>--execute-where</literal> option tells amgetconf whether
  85 to operate on the client or the server; the server is the default.</para>
  86
  87 </refsect2>
  88
  89 <refsect2><title>BUILD CONFIGURATION</title>
  90
  91 <para>If <emphasis remap='I'>parameter</emphasis> begins
  92 with <literal>build.</literal>, then the following name is a
  93 build environment variable.  Variables without a value (e.g.
  94 <literal>XFSDUMP</literal> on a system that does not support that
  95 type of file system) will not report an error and will return an
  96 empty string as the value.  Some boolean variables (e.g.  <emphasis
  97 remap='I'>USE_AMANDAHOSTS</emphasis>) will return <literal>1</literal>
  98 if the flag is set or an empty string if it is not, while others
  99 return <literal>yes</literal> or <literal>no</literal>, as indicated
 100 below (the difference is historical).</para>
 101
 102 <para>Combining the <literal>--list</literal> option with the parameter
 103 <literal>build</literal> will enumerate all available build parameters.</para>
 104
 105 <variablelist><title>Build Parameters</title>
 106  <varlistentry><term><literal>bindir</literal></term>
 107                <term><literal>sbindir</literal></term>
 108                <term><literal>libexecdir</literal></term>
 109                <term><literal>mandir</literal></term>
 110   <listitem><para>Install directories</para></listitem>
 111  </varlistentry>
 112
 113  <varlistentry><term><literal>AMANDA_TMPDIR</literal></term>
 114                <term><literal>CONFIG_DIR</literal></term>
 115                <term><literal>AMANDA_DBGDIR</literal></term>
 116                <term><literal>GNUTAR_LISTED_INCREMENTAL_DIR</literal></term>
 117   <listitem><para>Runtime directories</para></listitem>
 118  </varlistentry>
 119  <varlistentry><term><literal>listed_inc_dir</literal></term>
 120   <listitem><para>Same as <literal>GNUTAR_LISTED_INCREMENTAL_DIR</literal></para></listitem>
 121  </varlistentry>
 122
 123  <varlistentry><term><literal>CC</literal></term>
 124                <term><literal>VERSION</literal></term>
 125                <term><literal>ASSERTIONS</literal></term>
 126                <term><literal>LOCKING</literal></term>
 127
 128   <listitem><para>Build information.  <literal>ASSERTIONS</literal>
 129   is 1 or empty.</para></listitem>
 130  </varlistentry>
 131
 132  <varlistentry><term><literal>DUMP</literal></term>
 133                <term><literal>RESTORE</literal></term>
 134                <term><literal>VDUMP</literal></term>
 135                <term><literal>VRESTORE</literal></term>
 136                <term><literal>XFSDUMP</literal></term>
 137                <term><literal>XFSRESTORE</literal></term>
 138                <term><literal>VXDUMP</literal></term>
 139                <term><literal>VXRESTORE</literal></term>
 140                <term><literal>SAMBA_CLIENT</literal></term>
 141                <term><literal>GNUTAR</literal></term>
 142                <term><literal>STAR</literal></term>
 143                <term><literal>COMPRESS_PATH</literal></term>
 144                <term><literal>UNCOMPRESS_PATH</literal></term>
 145   <listitem><para>Paths to various utility progarms (empty if they
 146   are not found or not used)</para></listitem>
 147  </varlistentry>
 148
 149  <varlistentry><term><literal>AIX_BACKUP</literal></term>
 150   <listitem><para>Is <literal>DUMP</literal> the AIX backup program? (empty or 1)</para></listitem>
 151  </varlistentry>
 152
 153  <varlistentry><term><literal>DUMP_RETURNS_1</literal></term>
 154   <listitem><para>Does <literal>DUMP</literal> return 1 on success? (empty or 1)</para></listitem>
 155  </varlistentry>
 156
 157  <varlistentry><term><literal>BSD_SECURITY</literal></term>
 158                <term><literal>BSDUDP_SECURITY</literal></term>
 159                <term><literal>BSDTCP_SECURITY</literal></term>
 160                <term><literal>KRB5_SECURITY</literal></term>
 161                <term><literal>SSH_SECURITY</literal></term>
 162                <term><literal>RSH_SECURITY</literal></term>
 163   <listitem><para>Indicate which authentication mechanisms are
 164   available (yes or no).</para></listitem>
 165  </varlistentry>
 166
 167  <varlistentry><term><literal>USE_AMANDAHOSTS</literal></term>
 168   <listitem><para>Should the "bsd" authentication mechanism use
 169   <filename>amandahosts</filename>?  (yes or no).</para></listitem>
 170  </varlistentry>
 171
 172  <varlistentry><term><literal>AMANDA_DEBUG_DAYS</literal></term>
 173   <listitem><para>Number of days after which debug logs are deleted.</para></listitem>
 174  </varlistentry>
 175
 176  <varlistentry><term><literal>DEFAULT_SERVER</literal></term>
 177                <term><literal>DEFAULT_CONFIG</literal></term>
 178                <term><literal>DEFAULT_TAPE_SERVER</literal></term>
 179                <term><literal>DEFAULT_TAPE_DEVICE</literal></term>
 180   <listitem><para>Default values for configuration parameters</para></listitem>
 181  </varlistentry>
 182
 183  <varlistentry><term><literal>CLIENT_LOGIN</literal></term>
 184   <listitem><para>Userid under which the client runs (from
 185   <literal>--with-user</literal>).</para></listitem>
 186  </varlistentry>
 187
 188  <varlistentry><term><literal>USE_RUNDUMP</literal></term>
 189   <listitem><para>Should Amanda use the <literal>rundump</literal>
 190   wrapper? (empty or 1)</para></listitem>
 191  </varlistentry>
 192
 193  <varlistentry><term><literal>CHECK_USERID</literal></term>
 194   <listitem><para>Does Amanda check that userids are correct? (empty or 1)</para></listitem>
 195  </varlistentry>
 196
 197  <varlistentry><term><literal>COMPRESS_SUFFIX</literal></term>
 198                <term><literal>COMPRESS_FAST_OPT</literal></term>
 199                <term><literal>COMPRESS_BEST_OPT</literal></term>
 200                <term><literal>UNCOMPRESS_OPT</literal></term>
 201   <listitem><para>Command-line options for the compression program.</para></listitem>
 202  </varlistentry>
 203
 204  <varlistentry><term><literal>TICKET_LIFETIME</literal></term>
 205                <term><literal>SERVER_HOST_PRINCIPAL</literal></term>
 206                <term><literal>SERVER_HOST_INSTANCE</literal></term>
 207                <term><literal>SERVER_HOST_KEY_FILE</literal></term>
 208                <term><literal>CLIENT_HOST_PRINCIPAL</literal></term>
 209                <term><literal>CLIENT_HOST_INSTANCE</literal></term>
 210                <term><literal>CLIENT_HOST_KEY_FILE</literal></term>
 211   <listitem><para>Kerberos parameters.</para></listitem>
 212  </varlistentry>
 213 </variablelist>
 214
 215 </refsect2>
 216
 217 <refsect2><title>DEBUG LOG MANAGEMENT</title>
 218
 219 <note>That this application is responsible for debug logs is a
 220 historical quirk, but the functionality is widely used.
 221 </note>
 222
 223 <para>If <emphasis remap='I'>parameter</emphasis> begins with <emphasis
 224 remap='I'>dbopen.</emphasis>, the string following the period is a
 225 program name and an Amanda debug file will be created for the caller.
 226 The name of the logfile is returned.</para>
 227
 228 <para>If <emphasis remap='I'>parameter</emphasis> begins with
 229 <emphasis remap='I'>dbclose.</emphasis>, the string following
 230 the period is a program name previously used with <emphasis
 231 remap='I'>dbopen.</emphasis>, followed by a colon (:) and
 232 the previously opened file name.  The name of the logfile is
 233 returned.</para>
 234
 235 </refsect2>
 236 </refsect1>
 237
 238
 239 <refsect1><title>EXAMPLES</title>
 240 <para>Find out the path to the log file directory:</para>
 241
 242 <programlisting remap='.nf'>
 243 % amgetconf daily logdir
 244 /usr/local/etc/amanda/daily/logs
 245 </programlisting>
 246
 247 <para>Find out the current tape type:</para>
 248 <programlisting remap='.nf'>
 249 % amgetconf daily tapetype
 250 DLT4000-IV
 251 </programlisting>
 252
 253 <para>Find out that tape type's length:</para>
 254 <programlisting remap='.nf'>
 255 % amgetconf daily tapetype:DLT4000-IV:length
 256 1024000
 257 </programlisting>
 258
 259 <para>List the other available tapetype:</para>
 260 <programlisting remap='.nf'>
 261 % amgetconf daily --list tapetype
 262 DISK
 263 QIC-60
 264 DEC-DLT2000
 265 ...
 266 </programlisting>
 267
 268 <para>Find out the configuration directory:</para>
 269 <programlisting remap='.nf'>
 270 % amgetconf build.CONFIG_DIR
 271 /usr/local/etc/amanda/
 272 </programlisting>
 273
 274 <para>List all build-time parameters</para>
 275 <programlisting remap='.nf'>
 276 % amgetconf --list build
 277 AIX_BACKUP
 278 AMANDA_DBGDIR
 279 AMANDA_DEBUG_DAYS
 280 ...
 281 </programlisting>
 282
 283 <para>Create, use and close a debug file in a script:</para>
 284 <programlisting remap='.nf'>
 285 % debug_file=`amgetconf daily dbopen.myscript`
 286 % echo debug information &gt;&gt; $debug_file
 287 % amgetconf daily dbclose.myscript:$debug_file
 288 </programlisting>
 289 </refsect1>
 290
 291 <refsect1><title>MESSAGES</title>
 292 <variablelist remap='TP'>
 293   <varlistentry>
 294   <term>amgetconf: no such parameter <emphasis remap='I'>param</emphasis></term>
 295
 296   <listitem><para>Parameter <emphasis remap='I'>param</emphasis>
 297   is not a known keyword (e.g. not a valid <emphasis
 298   remap='I'>amanda.conf</emphasis> keyword).</para></listitem>
 299   </varlistentry>
 300 </variablelist>
 301 </refsect1>
 302
 303 <seealso>
 304 <manref name="amanda.conf" vol="5"/>,
 305 <manref name="amanda-client.conf" vol="5"/>
 306 </seealso>
 307
 308 </refentry>