Merge branch 'master' into oath

[gregoa/bti.git] / bti.xml

diff --git a/bti.xml b/bti.xml
index 08c284dc8dffa94d7b3fc40141144b1d27dde288..eb93b41f2fc7bf1433e3a384a4a05f5e34ddea28 100644 (file)
--- a/bti.xml
+++ b/bti.xml
@@ -33,6 +33,7 @@
           <arg><option>--host HOST_NAME</option></arg>
           <arg><option>--proxy PROXY:PORT</option></arg>
           <arg><option>--logfile LOGFILE</option></arg>
+          <arg><option>--config CONFIGFILE</option></arg>
           <arg><option>--page PAGENUMBER</option></arg>
           <arg><option>--bash</option></arg>
           <arg><option>--shrink-urls</option></arg>
@@ -75,7 +76,7 @@
                are "update" to send a message, "friends" to see your friends
                timeline, "public" to track public timeline, "replies" to see
                replies to your messages and "user" to see a specific user's
-               timeline.
+               timeline.  Default is "update".
               </para>
             </listitem>
           </varlistentry>
@@ -83,7 +84,7 @@
             <term><option>--user screenname</option></term>
             <listitem>
               <para>
-               Specify the user you want to see his/her messages while the
+               Specify the user whose messages you want to see when the
                action is "user".
               </para>
             </listitem>
@@ -128,6 +129,17 @@
               </para>
             </listitem>
           </varlistentry>
+          <varlistentry>
+            <term><option>--config CONFIGFILE</option></term>
+            <listitem>
+              <para>
+               Specify a config file for bti to read from.  By default, bti
+               looks in the ~/.bti file for config values.  This default
+               location can be overridden by setting a specific file with this
+               option.
+              </para>
+            </listitem>
+          </varlistentry>
           <varlistentry>
             <term><option>--shrink-urls</option></term>
             <listitem>
@@ -216,7 +228,7 @@
           out.
         </para>
         <para>
-          It's primary focus is to allow you to log everything that you
+          Its primary focus is to allow you to log everything that you
           type into a bash shell, in a crazy, "this is what I'm doing right
           now!" type of way, letting the world follow along with you
           constant moving between directories and refreshing your email
@@ -241,7 +253,7 @@
          <para>
            The account and password can be stored in a configuration file
            in the users home directory in a file named
-           <filename>.bti</filename>  The structure of this file is as
+           <filename>.bti</filename>.  The structure of this file is as
            follows:
          </para>
          <variablelist>
@@ -361,12 +373,15 @@
          </variablelist>
         <para>
           For example, command line options always override any config file
-          option, or any environment variables.
+          option, or any environment variables.  Unless a config file is
+          specified by the command line.  At that point, the new config file is
+          read, and any previous options set by a command line option, would be
+          overridden.
          </para>
        </refsect1>
 
        <refsect1><title>AUTHOR</title>
-         <para>Written by Greg Kroah-Hartman <email>greg@kroah.com</email>.</para>
+         <para>Written by Greg Kroah-Hartman &lt;<email>greg@kroah.com</email>&gt; and Amir Mohammad Saied &lt;<email>amirsaied@gmail.com</email>&gt;.</para>
        </refsect1>
 
     </refentry>