[svn-upgrade] Integrating new upstream version, bti (010)
[debian/bti.git] / bti.xml
diff --git a/bti.xml b/bti.xml
index 0d7767e956316196cf99d07d95b99120a554e1e0..96f424a67ac80cd358e68b1cc94b73cc956b0240 100644 (file)
--- a/bti.xml
+++ b/bti.xml
@@ -29,6 +29,7 @@
           <arg><option>--account account</option></arg>
           <arg><option>--password password</option></arg>
           <arg><option>--host HOST_NAME</option></arg>
+          <arg><option>--proxy PROXY:PORT</option></arg>
           <arg><option>--bash</option></arg>
           <arg><option>--debug</option></arg>
           <arg><option>--version</option></arg>
               </para>
             </listitem>
           </varlistentry>
+          <varlistentry>
+            <term><option>--proxy PROXY:PORT</option></term>
+            <listitem>
+              <para>
+               Specify a http proxy value.  This is not a required option, and
+               only needed by systems that are behind a http proxy.
+              </para>
+              <para>
+               If --proxy is not specified but the environment variable
+                'http_proxy' is set the latter will be used.
+              </para>
+            </listitem>
+          </varlistentry>
           <varlistentry>
             <term><option>--debug</option></term>
             <listitem>
                </para>
              </listitem>
            </varlistentry>
+           <varlistentry>
+             <term><option>proxy</option></term>
+             <listitem>
+               <para>
+                The http proxy needed to send data out to the Internet.
+               </para>
+             </listitem>
+           </varlistentry>
          </variablelist>
          <para>
            There is an example config file called
            <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>