add new options to bash completion script
[gregoa/bti.git] / bti.xml
diff --git a/bti.xml b/bti.xml
index 1b20586..3b097d0 100644 (file)
--- a/bti.xml
+++ b/bti.xml
           <command>bti</command>
           <arg><option>--account account</option></arg>
           <arg><option>--password password</option></arg>
+          <arg><option>--action action</option></arg>
+          <arg><option>--user screenname</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>--shrink-urls</option></arg>
           <arg><option>--debug</option></arg>
+          <arg><option>--dry-run</option></arg>
           <arg><option>--version</option></arg>
           <arg><option>--help</option></arg>
         </cmdsynopsis>
               </para>
             </listitem>
           </varlistentry>
+          <varlistentry>
+            <term><option>--action action</option></term>
+            <listitem>
+              <para>
+               Specify the action which you want to perform.  Valid options
+               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.
+              </para>
+            </listitem>
+          </varlistentry>
+         <varlistentry>
+            <term><option>--user screenname</option></term>
+            <listitem>
+              <para>
+               Specify the user you want to see his/her messages while the
+               action is "user".
+              </para>
+            </listitem>
+          </varlistentry>
           <varlistentry>
             <term><option>--host HOST_NAME</option></term>
             <listitem>
               </para>
             </listitem>
           </varlistentry>
+          <varlistentry>
+            <term><option>--shrink-urls</option></term>
+            <listitem>
+              <para>
+                Scans the tweet text for valid URL patterns and passes each
+                through the supplied bti-shrink-urls script.  The script will
+                pass the URL to a web service that shrinks the URLs, making it
+                more suitable for micro-blogging.
+              </para>
+              <para>
+                Currently, only http://2tu.us/ is used as a URL shrinking service.
+              </para>
+            </listitem>
+          </varlistentry>
           <varlistentry>
             <term><option>--debug</option></term>
             <listitem>
               <para>Print a whole bunch of debugging messages to stdout.</para>
             </listitem>
           </varlistentry>
+          <varlistentry>
+            <term><option>--dry-run</option></term>
+            <listitem>
+              <para>
+                Performs all steps that would normally be done for a given
+                action, but will not connect to the service to post or retrieve data.
+              </para>
+            </listitem>
+          </varlistentry>
           <varlistentry>
             <term><option>--bash</option></term>
             <listitem>
                </para>
              </listitem>
            </varlistentry>
+          <varlistentry>
+            <term><option>--action action</option></term>
+            <listitem>
+              <para>
+               Specify the action which you want to perform.  Valid options
+               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.
+              </para>
+            </listitem>
+           </varlistentry>
+          <varlistentry>
+            <term><option>--user screenname</option></term>
+            <listitem>
+              <para>
+               Specify the user you want to see his/her messages while the
+               action is "user".
+              </para>
+            </listitem>
+           </varlistentry>
            <varlistentry>
              <term><option>host</option></term>
              <listitem>
                </para>
              </listitem>
            </varlistentry>
+           <varlistentry>
+             <term><option>shrink-urls</option></term>
+             <listitem>
+               <para>
+                 Setting this variable to 'true' or 'yes' will enable the URL
+                 shrinking feature.  This is equivalent to using the
+                 --shrink-urls option.
+               </para>
+             </listitem>
+           </varlistentry>
          </variablelist>
          <para>
            There is an example config file called