added script
[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>--clean</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>--clean</option></term>
69             <listitem>
70               <para>Don't put the working directory and the '$' in the twitter message.</para>
71             </listitem>
72           </varlistentry>
73           <varlistentry>
74             <term><option>--version</option></term>
75             <listitem>
76               <para>Print version number.</para>
77             </listitem>
78           </varlistentry>
79           <varlistentry>
80             <term><option>--help</option></term>
81             <listitem>
82               <para>Print help text.</para>
83             </listitem>
84           </varlistentry>
85         </variablelist>
86       </refsect1>
87
88       <refsect1>
89         <title>DESCRIPTION</title>
90         <para>
91           bti provides an easy way to send twitter messages direct from the
92           command line or any script.  It reads the message on standard
93           input and uses the account and password settings either from the
94           command line options, or from a config file, to send the message
95           out.
96         </para>
97         <para>
98           It's primary focus is to allow you to log everything that you
99           type into a bash shell, in a crazy, "this is what I'm doing right
100           now!" type of way, letting the world follow along with you
101           constant moving between directories and refreshing your email
102           queue to see if there's anything interesting going on.
103         </para>
104         <para>
105           To hook bti up to your bash shell, export the following variable:
106         </para>
107         <para>
108             <literal>  PROMPT_COMMAND='history 1 | sed -e "s/^\s*[0-9]*\s*//" | bti'</literal>
109         </para>
110         <para>
111           This example assumes that you have the
112           <filename>~/.bti</filename> set up with your account and password
113           information already in it, otherwise you can specify them as an
114           option.
115         </para>
116        </refsect1>
117
118        <refsect1>
119          <title>CONFIGURATION</title>
120          <para>
121            The account and password can be stored in a configuration file
122            in the users home directory in a file named
123            <filename>.bti</filename>  The structure of this file is as
124            follows:
125          </para>
126          <variablelist>
127            <varlistentry>
128              <term><option>account</option></term>
129              <listitem>
130                <para>
131                  The twitter.com account name you wish to use to send this
132                  message with.
133                </para>
134              </listitem>
135            </varlistentry>
136            <varlistentry>
137              <term><option>password</option></term>
138              <listitem>
139                <para>
140                  The twitter.com password for the account you wish to use
141                  to send this message with.
142                </para>
143              </listitem>
144            </varlistentry>
145          </variablelist>
146          <para>
147            There is an example config file called
148            <filename>bti.example</filename> in the source tree that shows
149            the structure of the file if you need an example to work off of.
150          </para>
151        </refsect1>
152
153        <refsect1><title>AUTHOR</title>
154          <para>Written by Greg Kroah-Hartman <email>greg@kroah.com</email>.</para>
155        </refsect1>
156
157     </refentry>
158   </section>
159 </article>