document the order that config options are handled
authorGreg Kroah-Hartman <gregkh@suse.de>
Mon, 12 Jan 2009 18:34:53 +0000 (10:34 -0800)
committerGreg Kroah-Hartman <gregkh@suse.de>
Mon, 12 Jan 2009 18:34:53 +0000 (10:34 -0800)
bti.1
bti.xml

diff --git a/bti.1 b/bti.1
index e8413d6..3fe86d9 100644 (file)
--- a/bti.1
+++ b/bti.1
@@ -266,6 +266,22 @@ The http proxy needed to send data out to the Internet\&.
 There is an example config file called
 \FCbti\&.example\F[]
 in the source tree that shows the structure of the file if you need an example to work off of\&.
+.PP
+Configuration options have the following priority:
+.PP
+.RS 4
+command line option
+.RE
+.PP
+.RS 4
+config file option
+.RE
+.PP
+.RS 4
+environment variables
+.RE
+.PP
+For example, command line options always override any config file option, or any environment variables\&.
 .SH "AUTHOR"
 .PP
 Written by Greg Kroah\-Hartman
diff --git a/bti.xml b/bti.xml
index 1be3b5b..96f424a 100644 (file)
--- a/bti.xml
+++ b/bti.xml
            <filename>bti.example</filename> in the source tree that shows
            the structure of the file if you need an example to work off of.
          </para>
+         <para>
+           Configuration options have the following priority:
+        </para>
+         <variablelist>
+           <varlistentry>
+             <term></term>
+             <listitem><para>command line option</para></listitem>
+           </varlistentry>
+           <varlistentry>
+            <term></term>
+            <listitem><para>config file option</para></listitem>
+           </varlistentry>
+           <varlistentry>
+             <term></term>
+             <listitem><para>environment variables</para></listitem>
+           </varlistentry>
+         </variablelist>
+        <para>
+          For example, command line options always override any config file
+          option, or any environment variables.
+         </para>
        </refsect1>
 
        <refsect1><title>AUTHOR</title>