New upstream release; from the RELEASE-NOTES:
[debian/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 or identi.ca 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>--action action</option></arg>
32            <arg><option>--user screenname</option></arg>
33           <arg><option>--host HOST_NAME</option></arg>
34           <arg><option>--proxy PROXY:PORT</option></arg>
35           <arg><option>--logfile LOGFILE</option></arg>
36           <arg><option>--bash</option></arg>
37           <arg><option>--debug</option></arg>
38           <arg><option>--version</option></arg>
39           <arg><option>--help</option></arg>
40         </cmdsynopsis>
41       </refsynopsisdiv>
42
43       <refsect1><title>DESCRIPTION</title>
44         <para>bti sends a tweet message to twitter.com or identi.ca.
45         </para>
46       </refsect1>
47
48       <refsect1><title>OPTIONS</title>
49         <variablelist>
50           <varlistentry>
51             <term><option>--account account</option></term>
52             <listitem>
53               <para>
54                 Specify the twitter.com or identi.ca account name.
55               </para>
56             </listitem>
57           </varlistentry>
58           <varlistentry>
59             <term><option>--password password</option></term>
60             <listitem>
61               <para>
62                 Specify the password of your twitter.com or identi.ca account.
63               </para>
64             </listitem>
65           </varlistentry>
66           <varlistentry>
67             <term><option>--action action</option></term>
68             <listitem>
69               <para>
70                 Specify the action which you want to perform.  Valid options
71                 are "update" to send a message, "friends" to see your friends
72                 timeline, "public" to track public timeline, "replies" to see
73                 replies to your messages and "user" to see a specific user's
74                 timeline.
75               </para>
76             </listitem>
77           </varlistentry>
78           <varlistentry>
79             <term><option>--user screenname</option></term>
80             <listitem>
81               <para>
82                 Specify the user you want to see his/her messages while the
83                 action is "user".
84               </para>
85             </listitem>
86           </varlistentry>
87           <varlistentry>
88             <term><option>--host HOST_NAME</option></term>
89             <listitem>
90               <para>
91                 Specify the host which you want to send your message to.  Valid
92                 options are "twitter" to send to twitter.com and "identica" to
93                 send to identi.ca.
94               </para>
95               <para>
96                 If no host is specified, the default is to send to twitter.com.
97               </para>
98             </listitem>
99           </varlistentry>
100           <varlistentry>
101             <term><option>--proxy PROXY:PORT</option></term>
102             <listitem>
103               <para>
104                 Specify a http proxy value.  This is not a required option, and
105                 only needed by systems that are behind a http proxy.
106               </para>
107               <para>
108                 If --proxy is not specified but the environment variable
109                 'http_proxy' is set the latter will be used.
110               </para>
111             </listitem>
112           </varlistentry>
113           <varlistentry>
114             <term><option>--logfile LOGFILE</option></term>
115             <listitem>
116               <para>
117                 Specify a logfile for bti to write status messages to.  LOGFILE
118                 is in relation to the user's home directory, not an absolute
119                 path to a file.
120               </para>
121             </listitem>
122           </varlistentry>
123           <varlistentry>
124             <term><option>--debug</option></term>
125             <listitem>
126               <para>Print a whole bunch of debugging messages to stdout.</para>
127             </listitem>
128           </varlistentry>
129           <varlistentry>
130             <term><option>--bash</option></term>
131             <listitem>
132               <para>
133                  Add the working directory and a '$' in the tweet message to
134                  help specify it is coming from a command line.  Don't put the
135                  working directory and the '$' in the tweet message.
136               </para>
137               <para>
138                  This mode also does not report back any errors that might have
139                  happened when sending the message, and it sends it in the
140                  background, returning immediately, allowing the process to
141                  continue on.
142                </para>
143             </listitem>
144           </varlistentry>
145           <varlistentry>
146             <term><option>--version</option></term>
147             <listitem>
148               <para>Print version number.</para>
149             </listitem>
150           </varlistentry>
151           <varlistentry>
152             <term><option>--help</option></term>
153             <listitem>
154               <para>Print help text.</para>
155             </listitem>
156           </varlistentry>
157         </variablelist>
158       </refsect1>
159
160       <refsect1>
161         <title>DESCRIPTION</title>
162         <para>
163           bti provides an easy way to send tweet messages direct from the
164           command line or any script.  It reads the message on standard
165           input and uses the account and password settings either from the
166           command line options, or from a config file, to send the message
167           out.
168         </para>
169         <para>
170           It's primary focus is to allow you to log everything that you
171           type into a bash shell, in a crazy, "this is what I'm doing right
172           now!" type of way, letting the world follow along with you
173           constant moving between directories and refreshing your email
174           queue to see if there's anything interesting going on.
175         </para>
176         <para>
177           To hook bti up to your bash shell, export the following variable:
178         </para>
179         <para>
180             <literal>  PROMPT_COMMAND='history 1 | sed -e "s/^\s*[0-9]*\s*//" | bti --bash'</literal>
181         </para>
182         <para>
183           This example assumes that you have the
184           <filename>~/.bti</filename> set up with your account and password
185           information already in it, otherwise you can specify them as an
186           option.
187         </para>
188        </refsect1>
189
190        <refsect1>
191          <title>CONFIGURATION</title>
192          <para>
193            The account and password can be stored in a configuration file
194            in the users home directory in a file named
195            <filename>.bti</filename>  The structure of this file is as
196            follows:
197          </para>
198          <variablelist>
199            <varlistentry>
200              <term><option>account</option></term>
201              <listitem>
202                <para>
203                  The twitter.com or identi.ca account name you wish to use to send this
204                  message with.
205                </para>
206              </listitem>
207            </varlistentry>
208            <varlistentry>
209              <term><option>password</option></term>
210              <listitem>
211                <para>
212                  The twitter.com or identi.ca password for the account you wish to use
213                  to send this message with.
214                </para>
215              </listitem>
216            </varlistentry>
217            <varlistentry>
218             <term><option>--action action</option></term>
219             <listitem>
220               <para>
221                 Specify the action which you want to perform.  Valid options
222                 are "update" to send a message, "friends" to see your friends
223                 timeline, "public" to track public timeline, "replies" to see
224                 replies to your messages and "user" to see a specific user's
225                 timeline.
226               </para>
227             </listitem>
228            </varlistentry>
229            <varlistentry>
230             <term><option>--user screenname</option></term>
231             <listitem>
232               <para>
233                 Specify the user you want to see his/her messages while the
234                 action is "user".
235               </para>
236             </listitem>
237            </varlistentry>
238            <varlistentry>
239              <term><option>host</option></term>
240              <listitem>
241                <para>
242                  The host you want to use to send the message to.  Valid
243                  options are either "twitter" or "identica" to send to
244                  twitter.com or identi.ca respectively.
245                </para>
246              </listitem>
247            </varlistentry>
248            <varlistentry>
249              <term><option>proxy</option></term>
250              <listitem>
251                <para>
252                  The http proxy needed to send data out to the Internet.
253                </para>
254              </listitem>
255            </varlistentry>
256            <varlistentry>
257              <term><option>logfile</option></term>
258              <listitem>
259                <para>
260                  The logfile name for bti to write what happened to.
261                  This file is relative to the user's home directory.  If this
262                  file is not specified here or on the command line, no logging
263                  will be written to the disk.
264                </para>
265              </listitem>
266            </varlistentry>
267          </variablelist>
268          <para>
269            There is an example config file called
270            <filename>bti.example</filename> in the source tree that shows
271            the structure of the file if you need an example to work off of.
272          </para>
273          <para>
274            Configuration options have the following priority:
275          </para>
276          <variablelist>
277            <varlistentry>
278              <term></term>
279              <listitem><para>command line option</para></listitem>
280            </varlistentry>
281            <varlistentry>
282             <term></term>
283             <listitem><para>config file option</para></listitem>
284            </varlistentry>
285            <varlistentry>
286              <term></term>
287              <listitem><para>environment variables</para></listitem>
288            </varlistentry>
289          </variablelist>
290          <para>
291            For example, command line options always override any config file
292            option, or any environment variables.
293          </para>
294        </refsect1>
295
296        <refsect1><title>AUTHOR</title>
297          <para>Written by Greg Kroah-Hartman <email>greg@kroah.com</email>.</para>
298        </refsect1>
299
300     </refentry>
301   </section>
302 </article>