BTI should not display password while user types it

[gregoa/bti.git] / bti.xml

diff --git a/bti.xml b/bti.xml
index d103228ab79fa2ce3599e19f8f70655f6d4b2ba2..251f476c054f9434e38a7d0373bf8e17078df378 100644 (file)
--- a/bti.xml
+++ b/bti.xml
@@ -33,8 +33,12 @@
           <arg><option>--host HOST_NAME</option></arg>
           <arg><option>--proxy PROXY:PORT</option></arg>
           <arg><option>--logfile LOGFILE</option></arg>
+          <arg><option>--page PAGENUMBER</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>--verbose</option></arg>
           <arg><option>--version</option></arg>
           <arg><option>--help</option></arg>
         </cmdsynopsis>
@@ -90,7 +94,11 @@
               <para>
                Specify the host which you want to send your message to.  Valid
                options are "twitter" to send to twitter.com and "identica" to
-               send to identi.ca.
+        send to identi.ca.
+
+        If you want to send the message to a custom laconi.ca installation,
+        you should specify the API URI. For example identi.ca's URI is:
+        https://identi.ca/api/statuses
               </para>
               <para>
                If no host is specified, the default is to send to twitter.com.
@@ -120,12 +128,53 @@
               </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>--page PAGENUMBER</option></term>
+            <listitem>
+              <para>
+               When the action is to retrieve updates, it usually retrieves
+               only one page.  If this option is used, the page number can be
+               specified.
+              </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>--verbose</option></term>
+            <listitem>
+              <para>
+                Verbose mode
+              </para>
+            </listitem>
+          </varlistentry>
           <varlistentry>
             <term><option>--bash</option></term>
             <listitem>
@@ -242,6 +291,10 @@
                 The host you want to use to send the message to.  Valid
                 options are either "twitter" or "identica" to send to
                 twitter.com or identi.ca respectively.
+
+         If you want to send the message to a custom laconi.ca installation,
+         you should specify the API URI. For example identi.ca's URI is:
+         https://identi.ca/api/statuses.
                </para>
              </listitem>
            </varlistentry>
@@ -264,7 +317,26 @@
                </para>
              </listitem>
            </varlistentry>
-         </variablelist>
+           <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>
+           <varlistentry>
+             <term><option>verbose</option></term>
+             <listitem>
+               <para>
+                   Setting this variable to 'true' or 'yes' will enable the
+                   verbose mode.
+               </para>
+             </listitem>
+           </varlistentry>
+        </variablelist>
          <para>
            There is an example config file called
            <filename>bti.example</filename> in the source tree that shows
@@ -294,7 +366,7 @@
        </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>