lots of manpage updates trying to document how to use bti better
authorGreg Kroah-Hartman <gregkh@suse.de>
Tue, 20 May 2008 16:13:51 +0000 (09:13 -0700)
committerGreg Kroah-Hartman <gregkh@suse.de>
Tue, 20 May 2008 16:13:51 +0000 (09:13 -0700)
bti.1
bti.xml

diff --git a/bti.1 b/bti.1
index 6f1066b97e9a519e576669d488e364221c6c452d..4727a974a92c65cc2bd58adf87a42372ced54bab 100644 (file)
--- a/bti.1
+++ b/bti.1
@@ -11,7 +11,7 @@
 .\" disable justification (adjust text to left margin only)
 .ad l
 .SH "NAME"
-bti - send a tweet to twitter.com from stdinput
+bti - send a tweet to twitter.com from the command line
 .SH "SYNOPSIS"
 .HP 4
 \fBbti\fR [\fB\-\-account\ account\fR] [\fB\-\-password\ password\fR] [\fB\-\-clean\fR] [\fB\-\-debug\fR] [\fB\-\-version\fR] [\fB\-\-help\fR]
@@ -49,6 +49,39 @@ Print version number\.
 .RS 4
 Print help text\.
 .RE
+.SH "DESCRIPTION"
+.PP
+bti provides an easy way to send twitter 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 out\.
+.PP
+It\'s 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 queue to see if there\'s anything interesting going on\.
+.PP
+To hook bti up to your bash shell, export the following variable:
+.PP
+
+PROMPT_COMMAND=\'history 1 | sed \-e "s/^\es*[0\-9]*\es*//" | bti\'
+.PP
+This example assumes that you have the
+\fI~/\.bti\fR
+set up with your account and password information already in it, otherwise you can specify them as an option\.
+.SH "CONFIGURATION"
+.PP
+The account and password can be stored in a configuration file in the users home directory in a file named
+\fI\.bti\fR
+The structure of this file is as follows:
+.PP
+\fBaccount\fR
+.RS 4
+The twitter\.com account name you wish to use to send this message with\.
+.RE
+.PP
+\fBpassword\fR
+.RS 4
+The twitter\.com password for the account you wish to use to send this message with\.
+.RE
+.PP
+There is an example config file called
+\fIbti\.example\fR
+in the source tree that shows the structure of the file if you need an example to work off of\.
 .SH "AUTHOR"
 .PP
 Written by Greg Kroah\-Hartman
diff --git a/bti.xml b/bti.xml
index 723330dd83f7ae532abafd846853abd41ee2dce3..75c9dd96a6e608137cb364336b976d1aef2a2621 100644 (file)
--- a/bti.xml
+++ b/bti.xml
@@ -19,7 +19,8 @@
       </refmeta>
 
       <refnamediv>
-        <refname>bti</refname><refpurpose>send a tweet to twitter.com from stdinput</refpurpose>
+        <refname>bti</refname>
+        <refpurpose>send a tweet to twitter.com from the command line</refpurpose>
       </refnamediv>
 
       <refsynopsisdiv>
@@ -27,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>--clean</option></arg>
           <arg><option>--debug</option></arg>
           <arg><option>--version</option></arg>
           <arg><option>--help</option></arg>
@@ -36,7 +37,7 @@
 
       <refsect1><title>DESCRIPTION</title>
         <para>bti sends a twitter message to twitter.com.
-       </para>
+        </para>
       </refsect1>
 
       <refsect1><title>OPTIONS</title>
@@ -53,7 +54,7 @@
             <term><option>--password password</option></term>
             <listitem>
               <para>
-               Specify the password of your twitter.com account.
+                Specify the password of your twitter.com account.
               </para>
             </listitem>
           </varlistentry>
         </variablelist>
       </refsect1>
 
-      <refsect1><title>AUTHOR</title>
-        <para>Written by Greg Kroah-Hartman <email>greg@kroah.com</email>.</para>
-      </refsect1>
+      <refsect1>
+        <title>DESCRIPTION</title>
+        <para>
+          bti provides an easy way to send twitter 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
+          out.
+        </para>
+        <para>
+          It's 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
+          queue to see if there's anything interesting going on.
+        </para>
+        <para>
+          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>
+        </para>
+        <para>
+          This example assumes that you have the
+          <filename>~/.bti</filename> set up with your account and password
+          information already in it, otherwise you can specify them as an
+          option.
+        </para>
+       </refsect1>
+
+       <refsect1>
+         <title>CONFIGURATION</title>
+         <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
+           follows:
+         </para>
+         <variablelist>
+           <varlistentry>
+             <term><option>account</option></term>
+             <listitem>
+               <para>
+                 The twitter.com account name you wish to use to send this
+                 message with.
+               </para>
+             </listitem>
+           </varlistentry>
+           <varlistentry>
+             <term><option>password</option></term>
+             <listitem>
+               <para>
+                 The twitter.com password for the account you wish to use
+                 to send this message with.
+               </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>
+       </refsect1>
+
+       <refsect1><title>AUTHOR</title>
+         <para>Written by Greg Kroah-Hartman <email>greg@kroah.com</email>.</para>
+       </refsect1>
 
     </refentry>
   </section>