update the man page about --bash options
[gregoa/bti.git] / bti.xml
diff --git a/bti.xml b/bti.xml
index 75c9dd96a6e608137cb364336b976d1aef2a2621..f08a7cdf9347857ed819dec1f2120cfe823777e4 100644 (file)
--- a/bti.xml
+++ b/bti.xml
@@ -28,7 +28,7 @@
           <command>bti</command>
           <arg><option>--account account</option></arg>
           <arg><option>--password password</option></arg>
-          <arg><option>--clean</option></arg>
+          <arg><option>--bash</option></arg>
           <arg><option>--debug</option></arg>
           <arg><option>--version</option></arg>
           <arg><option>--help</option></arg>
             </listitem>
           </varlistentry>
           <varlistentry>
-            <term><option>--clean</option></term>
+            <term><option>--bash</option></term>
             <listitem>
-              <para>Don't put the working directory and the '$' in the twitter message.</para>
+              <para>
+                Add the working directory and a '$' in the twitter message to
+                help specify it is coming from a command line.  Don't put the
+                working directory and the '$' in the twitter message.
+             </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.
+              </para>
             </listitem>
           </varlistentry>
           <varlistentry>
           To hook bti up to your bash shell, export the following variable:
         </para>
         <para>
-            <literal>  PROMPT_COMMAND='history 1 | sed -e "s/^\s*[0-9]*\s*//" | bti'</literal>
+            <literal>  PROMPT_COMMAND='history 1 | sed -e "s/^\s*[0-9]*\s*//" | bti --bash'</literal>
         </para>
         <para>
           This example assumes that you have the