release 005
[gregoa/bti.git] / bti.xml
1 <?xml version='1.0'?>
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4
5 <article>
6   <section>
7     <title>bti</title>
8     <refentry>
9       <refentryinfo>
10         <title>bti</title>
11         <date>May 2008</date>
12         <productname>bti</productname>
13       </refentryinfo>
14
15       <refmeta>
16         <refentrytitle>bti</refentrytitle>
17         <manvolnum>1</manvolnum>
18         <refmiscinfo class="version"></refmiscinfo>
19       </refmeta>
20
21       <refnamediv>
22         <refname>bti</refname>
23         <refpurpose>send a tweet to twitter.com from the command line</refpurpose>
24       </refnamediv>
25
26       <refsynopsisdiv>
27         <cmdsynopsis>
28           <command>bti</command>
29           <arg><option>--account account</option></arg>
30           <arg><option>--password password</option></arg>
31           <arg><option>--bash</option></arg>
32           <arg><option>--debug</option></arg>
33           <arg><option>--version</option></arg>
34           <arg><option>--help</option></arg>
35         </cmdsynopsis>
36       </refsynopsisdiv>
37
38       <refsect1><title>DESCRIPTION</title>
39         <para>bti sends a twitter message to twitter.com.
40         </para>
41       </refsect1>
42
43       <refsect1><title>OPTIONS</title>
44         <variablelist>
45           <varlistentry>
46             <term><option>--account account</option></term>
47             <listitem>
48               <para>
49                 Specify the twitter.com account name.
50               </para>
51             </listitem>
52           </varlistentry>
53           <varlistentry>
54             <term><option>--password password</option></term>
55             <listitem>
56               <para>
57                 Specify the password of your twitter.com account.
58               </para>
59             </listitem>
60           </varlistentry>
61           <varlistentry>
62             <term><option>--debug</option></term>
63             <listitem>
64               <para>Print a whole bunch of debugging messages to stdout.</para>
65             </listitem>
66           </varlistentry>
67           <varlistentry>
68             <term><option>--bash</option></term>
69             <listitem>
70               <para>
71                  Add the working directory and a '$' in the twitter message to
72                  help specify it is coming from a command line.  Don't put the
73                  working directory and the '$' in the twitter message.
74               </para>
75               <para>
76                  This mode also does not report back any errors that might have
77                  happened when sending the message, and it sends it in the
78                  background, returning immediately, allowing the process to
79                  continue on.
80                </para>
81             </listitem>
82           </varlistentry>
83           <varlistentry>
84             <term><option>--version</option></term>
85             <listitem>
86               <para>Print version number.</para>
87             </listitem>
88           </varlistentry>
89           <varlistentry>
90             <term><option>--help</option></term>
91             <listitem>
92               <para>Print help text.</para>
93             </listitem>
94           </varlistentry>
95         </variablelist>
96       </refsect1>
97
98       <refsect1>
99         <title>DESCRIPTION</title>
100         <para>
101           bti provides an easy way to send twitter messages direct from the
102           command line or any script.  It reads the message on standard
103           input and uses the account and password settings either from the
104           command line options, or from a config file, to send the message
105           out.
106         </para>
107         <para>
108           It's primary focus is to allow you to log everything that you
109           type into a bash shell, in a crazy, "this is what I'm doing right
110           now!" type of way, letting the world follow along with you
111           constant moving between directories and refreshing your email
112           queue to see if there's anything interesting going on.
113         </para>
114         <para>
115           To hook bti up to your bash shell, export the following variable:
116         </para>
117         <para>
118             <literal>  PROMPT_COMMAND='history 1 | sed -e "s/^\s*[0-9]*\s*//" | bti --bash'</literal>
119         </para>
120         <para>
121           This example assumes that you have the
122           <filename>~/.bti</filename> set up with your account and password
123           information already in it, otherwise you can specify them as an
124           option.
125         </para>
126        </refsect1>
127
128        <refsect1>
129          <title>CONFIGURATION</title>
130          <para>
131            The account and password can be stored in a configuration file
132            in the users home directory in a file named
133            <filename>.bti</filename>  The structure of this file is as
134            follows:
135          </para>
136          <variablelist>
137            <varlistentry>
138              <term><option>account</option></term>
139              <listitem>
140                <para>
141                  The twitter.com account name you wish to use to send this
142                  message with.
143                </para>
144              </listitem>
145            </varlistentry>
146            <varlistentry>
147              <term><option>password</option></term>
148              <listitem>
149                <para>
150                  The twitter.com password for the account you wish to use
151                  to send this message with.
152                </para>
153              </listitem>
154            </varlistentry>
155          </variablelist>
156          <para>
157            There is an example config file called
158            <filename>bti.example</filename> in the source tree that shows
159            the structure of the file if you need an example to work off of.
160          </para>
161        </refsect1>
162
163        <refsect1><title>AUTHOR</title>
164          <para>Written by Greg Kroah-Hartman <email>greg@kroah.com</email>.</para>
165        </refsect1>
166
167     </refentry>
168   </section>
169 </article>