code formatting cleanups

[gregoa/bti.git] / bti.xml

diff --git a/bti.xml b/bti.xml
index d103228ab79fa2ce3599e19f8f70655f6d4b2ba2..ae08e4f8b47949b6c2267a4f53fd92394de6a552 100644 (file)
--- a/bti.xml
+++ b/bti.xml
@@ -33,8 +33,15 @@
           <arg><option>--host HOST_NAME</option></arg>
           <arg><option>--proxy PROXY:PORT</option></arg>
           <arg><option>--logfile LOGFILE</option></arg>
           <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>--replyto ID</option></arg>
+          <arg><option>--retweet ID</option></arg>
+          <arg><option>--page PAGENUMBER</option></arg>

           <arg><option>--bash</option></arg>
           <arg><option>--bash</option></arg>

+          <arg><option>--shrink-urls</option></arg>

           <arg><option>--debug</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>
           <arg><option>--version</option></arg>
           <arg><option>--help</option></arg>
         </cmdsynopsis>


@@ -71,7 +78,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
                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>
               </para>
             </listitem>
           </varlistentry>


@@ -79,7 +86,7 @@
             <term><option>--user screenname</option></term>
             <listitem>
               <para>
             <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>
                action is "user".
               </para>
             </listitem>


@@ -90,7 +97,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
               <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.
               </para>
               <para>
                If no host is specified, the default is to send to twitter.com.


@@ -120,12 +131,94 @@
               </para>
             </listitem>
           </varlistentry>
               </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>--replyto ID</option></term>
+            <listitem>
+              <para>
+               Status ID of a single post to which you want to create a threaded
+               reply to.
+             </para>
+             <para>
+               For twitter, this is ignored unless the message starts with the
+               @name of the owner of the post with the status ID.
+             </para>
+             <para>
+               For status.net, this can link any two messages into context with
+               each other. Status.net will also link a message that contains an
+               @name without this without regard to context.
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term><option>--retweet ID</option></term>
+            <listitem>
+              <para>
+               Status ID of a single post which you want to retweet.
+             </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>
+                The following URL shrinking services are available:
+                http://2tu.us/ (default) and http://bit.ly / http://j.mp
+              </para>
+              <para>
+                See the documentation for bti-shrink-urls for the configuration options.
+              </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>--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. Print status IDs and timestamps.
+              </para>
+            </listitem>
+          </varlistentry>

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


@@ -134,11 +227,20 @@
                 help specify it is coming from a command line.  Don't put the
                 working directory and the '$' in the tweet message.
              </para>
                 help specify it is coming from a command line.  Don't put the
                 working directory and the '$' in the tweet message.
              </para>

+
+              <para>
+                 This option implies <option>--background</option>.
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term><option>--background</option></term>
+            <listitem>

              <para>
              <para>

-                This mode also does not report back any errors that might have
-                happened when sending the message, and it sends it in the
-                background, returning immediately, allowing the process to
-                continue on.
+                Do not report back any errors that might have
+                happened when sending the message, and send it in the
+                background, returning immediately, allowing the user
+                to continue on.

               </para>
             </listitem>
           </varlistentry>
               </para>
             </listitem>
           </varlistentry>


@@ -167,7 +269,7 @@
           out.
         </para>
         <para>
           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
           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


@@ -192,7 +294,7 @@
          <para>
            The account and password can be stored in a configuration file
            in the users home directory in a file named
          <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>
            follows:
          </para>
          <variablelist>


@@ -242,6 +344,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.
                 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>
                </para>
              </listitem>
            </varlistentry>


@@ -264,7 +370,39 @@
                </para>
              </listitem>
            </varlistentry>
                </para>
              </listitem>
            </varlistentry>

-         </variablelist>
+           <varlistentry>
+             <term><option>replyto</option></term>
+             <listitem>
+               <para>
+                The status ID to which all notices will be linked to.
+               </para>
+              <para>
+                There is no sane reason for a need to have this set in a
+                config file. One such reason is to have all your messages
+                as children to a particular status.
+              </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>
+           <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
          <para>
            There is an example config file called
            <filename>bti.example</filename> in the source tree that shows


@@ -289,12 +427,15 @@
          </variablelist>
         <para>
           For example, command line options always override any config file
          </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>
        </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>
        </refsect1>
 
     </refentry>