Add documentation for new shrink_host feature in bti-shrink-urls.

[gregoa/bti.git] / bti.xml

diff --git a/bti.xml b/bti.xml
index eb93b41f2fc7bf1433e3a384a4a05f5e34ddea28..07ae3debdd56b8f80639fd287607edf2ea694490 100644 (file)
--- a/bti.xml
+++ b/bti.xml
@@ -34,6 +34,7 @@
           <arg><option>--proxy PROXY:PORT</option></arg>
           <arg><option>--logfile LOGFILE</option></arg>
           <arg><option>--config CONFIGFILE</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>--page PAGENUMBER</option></arg>
           <arg><option>--bash</option></arg>
           <arg><option>--shrink-urls</option></arg>
           <arg><option>--page PAGENUMBER</option></arg>
           <arg><option>--bash</option></arg>
           <arg><option>--shrink-urls</option></arg>


@@ -140,6 +141,24 @@
               </para>
             </listitem>
           </varlistentry>
               </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>--shrink-urls</option></term>
             <listitem>
           <varlistentry>
             <term><option>--shrink-urls</option></term>
             <listitem>


@@ -150,7 +169,11 @@
                 more suitable for micro-blogging.
               </para>
               <para>
                 more suitable for micro-blogging.
               </para>
               <para>

-                Currently, only http://2tu.us/ is used as a URL shrinking service.
+                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>
               </para>
             </listitem>
           </varlistentry>


@@ -183,7 +206,7 @@
             <term><option>--verbose</option></term>
             <listitem>
               <para>
             <term><option>--verbose</option></term>
             <listitem>
               <para>

-                Verbose mode
+                Verbose mode. Print status IDs and timestamps.

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


@@ -195,11 +218,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>


@@ -329,6 +361,19 @@
                </para>
              </listitem>
            </varlistentry>
                </para>
              </listitem>
            </varlistentry>

+           <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>
            <varlistentry>
              <term><option>shrink-urls</option></term>
              <listitem>