Change the formatting of --action output
[gregoa/bti.git] / bti.xml
diff --git a/bti.xml b/bti.xml
index f08a7cdf9347857ed819dec1f2120cfe823777e4..1b20586ba0bd0bc6c1cf92d6f7c91b6fd4b85a8b 100644 (file)
--- a/bti.xml
+++ b/bti.xml
@@ -20,7 +20,7 @@
 
       <refnamediv>
         <refname>bti</refname>
-        <refpurpose>send a tweet to twitter.com from the command line</refpurpose>
+        <refpurpose>send a tweet to twitter.com or identi.ca from the command line</refpurpose>
       </refnamediv>
 
       <refsynopsisdiv>
@@ -28,6 +28,9 @@
           <command>bti</command>
           <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>
@@ -36,7 +39,7 @@
       </refsynopsisdiv>
 
       <refsect1><title>DESCRIPTION</title>
-        <para>bti sends a twitter message to twitter.com.
+        <para>bti sends a tweet message to twitter.com or identi.ca.
         </para>
       </refsect1>
 
@@ -46,7 +49,7 @@
             <term><option>--account account</option></term>
             <listitem>
               <para>
-               Specify the twitter.com account name.
+               Specify the twitter.com or identi.ca account name.
              </para>
             </listitem>
           </varlistentry>
             <term><option>--password password</option></term>
             <listitem>
               <para>
-                Specify the password of your twitter.com account.
+                Specify the password of your twitter.com or identi.ca account.
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term><option>--host HOST_NAME</option></term>
+            <listitem>
+              <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.
+              </para>
+              <para>
+               If no host is specified, the default is to send to twitter.com.
+              </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>
             <term><option>--bash</option></term>
             <listitem>
               <para>
-                Add the working directory and a '$' in the twitter message to
+                Add the working directory and a '$' in the tweet message to
                 help specify it is coming from a command line.  Don't put the
-                working directory and the '$' in the twitter message.
+                working directory and the '$' in the tweet message.
              </para>
              <para>
                 This mode also does not report back any errors that might have
       <refsect1>
         <title>DESCRIPTION</title>
         <para>
-          bti provides an easy way to send twitter messages direct from the
+          bti provides an easy way to send tweet messages direct from the
           command line or any script.  It reads the message on standard
           input and uses the account and password settings either from the
           command line options, or from a config file, to send the message
              <term><option>account</option></term>
              <listitem>
                <para>
-                 The twitter.com account name you wish to use to send this
+                 The twitter.com or identi.ca account name you wish to use to send this
                  message with.
                </para>
              </listitem>
              <term><option>password</option></term>
              <listitem>
                <para>
-                 The twitter.com password for the account you wish to use
+                 The twitter.com or identi.ca password for the account you wish to use
                  to send this message with.
                </para>
              </listitem>
            </varlistentry>
+           <varlistentry>
+             <term><option>host</option></term>
+             <listitem>
+               <para>
+                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.
+               </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>
+         <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>