releasing version 012-1

[debian/bti.git] / bti.xml

diff --git a/bti.xml b/bti.xml
index 0d7767e..1b20586 100644 (file)
--- a/bti.xml
+++ b/bti.xml
@@ -29,6 +29,8 @@
           <arg><option>--account account</option></arg>
           <arg><option>--password password</option></arg>
           <arg><option>--host HOST_NAME</option></arg>
           <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>--logfile LOGFILE</option></arg>

           <arg><option>--bash</option></arg>
           <arg><option>--debug</option></arg>
           <arg><option>--version</option></arg>
           <arg><option>--bash</option></arg>
           <arg><option>--debug</option></arg>
           <arg><option>--version</option></arg>


@@ -72,6 +74,29 @@
               </para>
             </listitem>
           </varlistentry>
               </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>--logfile LOGFILE</option></term>
+            <listitem>
+              <para>
+               Specify a logfile for bti to write status messages to.  LOGFILE
+               is in relation to the user's home directory, not an absolute
+               path to a file.
+              </para>
+            </listitem>
+          </varlistentry>

           <varlistentry>
             <term><option>--debug</option></term>
             <listitem>
           <varlistentry>
             <term><option>--debug</option></term>
             <listitem>


@@ -176,12 +201,52 @@
                </para>
              </listitem>
            </varlistentry>
                </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>
+           <varlistentry>
+             <term><option>logfile</option></term>
+             <listitem>
+               <para>
+                The logfile name for bti to write what happened to.
+                This file is relative to the user's home directory.  If this
+                file is not specified here or on the command line, no logging
+                will be written to the disk.
+               </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>
          </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>
        </refsect1>
 
        <refsect1><title>AUTHOR</title>