releasing package bti version 034-5
[debian/bti.git] / bti.xml
1 <?xml version='1.0'?>
2 <?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
3 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
4   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5
6 <article>
7   <section>
8     <title>bti</title>
9     <refentry>
10       <refentryinfo>
11         <title>bti</title>
12         <date>May 2008</date>
13         <productname>bti</productname>
14       </refentryinfo>
15
16       <refmeta>
17         <refentrytitle>bti</refentrytitle>
18         <manvolnum>1</manvolnum>
19         <refmiscinfo class="version"></refmiscinfo>
20       </refmeta>
21
22       <refnamediv>
23         <refname>bti</refname>
24         <refpurpose>send a tweet to twitter.com from the command line</refpurpose>
25       </refnamediv>
26
27       <refsynopsisdiv>
28         <cmdsynopsis>
29           <command>bti</command>
30           <arg><option>--account account</option></arg>
31           <arg><option>--password password</option></arg>
32            <arg><option>--action action</option></arg>
33            <arg><option>--user screenname</option></arg>
34           <arg><option>--host HOST_NAME</option></arg>
35           <arg><option>--proxy PROXY:PORT</option></arg>
36           <arg><option>--logfile LOGFILE</option></arg>
37           <arg><option>--config CONFIGFILE</option></arg>
38           <arg><option>--replyto ID</option></arg>
39           <arg><option>--retweet ID</option></arg>
40           <arg><option>--page PAGENUMBER</option></arg>
41           <arg><option>--bash</option></arg>
42           <arg><option>--shrink-urls</option></arg>
43           <arg><option>--debug</option></arg>
44           <arg><option>--dry-run</option></arg>
45           <arg><option>--verbose</option></arg>
46           <arg><option>--version</option></arg>
47           <arg><option>--help</option></arg>
48         </cmdsynopsis>
49       </refsynopsisdiv>
50
51       <refsect1><title>DESCRIPTION</title>
52         <para>bti sends a tweet message to twitter.com.
53         </para>
54       </refsect1>
55
56       <refsect1><title>OPTIONS</title>
57         <variablelist>
58           <varlistentry>
59             <term><option>--account account</option></term>
60             <listitem>
61               <para>
62                 Specify the twitter.com account name.
63               </para>
64             </listitem>
65           </varlistentry>
66           <varlistentry>
67             <term><option>--password password</option></term>
68             <listitem>
69               <para>
70                 Specify the password of your twitter.com account.
71               </para>
72             </listitem>
73           </varlistentry>
74           <varlistentry>
75             <term><option>--action action</option></term>
76             <listitem>
77               <para>
78                 Specify the action which you want to perform.  Valid options
79                 are "update" to send a message, "friends" to see your friends
80                 timeline, "public" to track public timeline, "replies" to see
81                 replies to your messages, "user" to see a specific user's
82                 timeline and "direct" to send a direct message to a friend.
83                 Default is "update".
84               </para>
85             </listitem>
86           </varlistentry>
87           <varlistentry>
88             <term><option>--user screenname</option></term>
89             <listitem>
90               <para>
91                 Specify the user whose messages you want to see when the
92                 action is "user", and the reciever of the direct message when
93                 the action is "direct" (the sender must be following the 
94                 receiver).
95               </para>
96             </listitem>
97           </varlistentry>
98           <varlistentry>
99             <term><option>--host HOST_NAME</option></term>
100             <listitem>
101               <para>
102                 Specify the host which you want to send your message to.  Valid
103                 options are "twitter" to send to twitter.com.
104               </para>
105               <para>
106                 If no host is specified, the default is to send to twitter.com.
107               </para>
108             </listitem>
109           </varlistentry>
110           <varlistentry>
111             <term><option>--proxy PROXY:PORT</option></term>
112             <listitem>
113               <para>
114                 Specify a http proxy value.  This is not a required option, and
115                 only needed by systems that are behind a http proxy.
116               </para>
117               <para>
118                 If --proxy is not specified but the environment variable
119                 'http_proxy' is set the latter will be used.
120               </para>
121             </listitem>
122           </varlistentry>
123           <varlistentry>
124             <term><option>--logfile LOGFILE</option></term>
125             <listitem>
126               <para>
127                 Specify a logfile for bti to write status messages to.  LOGFILE
128                 is in relation to the user's home directory, not an absolute
129                 path to a file.
130               </para>
131             </listitem>
132           </varlistentry>
133           <varlistentry>
134             <term><option>--config CONFIGFILE</option></term>
135             <listitem>
136               <para>
137                 Specify a config file for bti to read from.  By default, bti
138                 looks in the ~/.bti file for config values.  This default
139                 location can be overridden by setting a specific file with this
140                 option.
141               </para>
142             </listitem>
143           </varlistentry>
144           <varlistentry>
145             <term><option>--replyto ID</option></term>
146             <listitem>
147               <para>
148                 Status ID of a single post to which you want to create a threaded
149                 reply to.
150               </para>
151               <para>
152                 For twitter, this is ignored unless the message starts with the
153                 @name of the owner of the post with the status ID.
154               </para>
155               <para>
156                 For status.net, this can link any two messages into context with
157                 each other. Status.net will also link a message that contains an
158                 @name without this without regard to context.
159               </para>
160             </listitem>
161           </varlistentry>
162           <varlistentry>
163             <term><option>--retweet ID</option></term>
164             <listitem>
165               <para>
166                 Status ID of a single post which you want to retweet.
167               </para>
168             </listitem>
169           </varlistentry>
170           <varlistentry>
171             <term><option>--shrink-urls</option></term>
172             <listitem>
173               <para>
174                 Scans the tweet text for valid URL patterns and passes each
175                 through the supplied bti-shrink-urls script.  The script will
176                 pass the URL to a web service that shrinks the URLs, making it
177                 more suitable for micro-blogging.
178               </para>
179               <para>
180                 The following URL shrinking services are available:
181                 http://2tu.us/ (default) and http://bit.ly / http://j.mp
182               </para>
183               <para>
184                 See the documentation for bti-shrink-urls for the configuration options.
185               </para>
186             </listitem>
187           </varlistentry>
188           <varlistentry>
189             <term><option>--debug</option></term>
190             <listitem>
191               <para>Print a whole bunch of debugging messages to stdout.</para>
192             </listitem>
193           </varlistentry>
194           <varlistentry>
195             <term><option>--page PAGENUMBER</option></term>
196             <listitem>
197               <para>
198                 When the action is to retrieve updates, it usually retrieves
199                 only one page.  If this option is used, the page number can be
200                 specified.
201               </para>
202             </listitem>
203           </varlistentry>
204           <varlistentry>
205             <term><option>--dry-run</option></term>
206             <listitem>
207               <para>
208                 Performs all steps that would normally be done for a given
209                 action, but will not connect to the service to post or retrieve data.
210               </para>
211             </listitem>
212           </varlistentry>
213           <varlistentry>
214             <term><option>--verbose</option></term>
215             <listitem>
216               <para>
217                 Verbose mode. Print status IDs and timestamps.
218               </para>
219             </listitem>
220           </varlistentry>
221           <varlistentry>
222             <term><option>--bash</option></term>
223             <listitem>
224               <para>
225                  Add the working directory and a '$' in the tweet message to
226                  help specify it is coming from a command line.  Don't put the
227                  working directory and the '$' in the tweet message.
228               </para>
229
230               <para>
231                  This option implies <option>--background</option>.
232               </para>
233             </listitem>
234           </varlistentry>
235           <varlistentry>
236             <term><option>--background</option></term>
237             <listitem>
238               <para>
239                  Do not report back any errors that might have
240                  happened when sending the message, and send it in the
241                  background, returning immediately, allowing the user
242                  to continue on.
243                </para>
244             </listitem>
245           </varlistentry>
246           <varlistentry>
247             <term><option>--version</option></term>
248             <listitem>
249               <para>Print version number.</para>
250             </listitem>
251           </varlistentry>
252           <varlistentry>
253             <term><option>--help</option></term>
254             <listitem>
255               <para>Print help text.</para>
256             </listitem>
257           </varlistentry>
258         </variablelist>
259       </refsect1>
260
261       <refsect1>
262         <title>DESCRIPTION</title>
263         <para>
264           bti provides an easy way to send tweet messages direct from the
265           command line or any script.  It reads the message on standard
266           input and uses the account and password settings either from the
267           command line options, or from a config file, to send the message
268           out.
269         </para>
270         <para>
271           Its primary focus is to allow you to log everything that you
272           type into a bash shell, in a crazy, "this is what I'm doing right
273           now!" type of way, letting the world follow along with you
274           constant moving between directories and refreshing your email
275           queue to see if there's anything interesting going on.
276         </para>
277         <para>
278           To hook bti up to your bash shell, export the following variable:
279         </para>
280         <para>
281             <literal>  PROMPT_COMMAND='history 1 | sed -e "s/^\s*[0-9]*\s*//" | bti --bash'</literal>
282         </para>
283         <para>
284           This example assumes that you have the
285           <filename>~/.bti</filename> set up with your account and password
286           information already in it, otherwise you can specify them as an
287           option.
288         </para>
289        </refsect1>
290
291        <refsect1>
292          <title>CONFIGURATION</title>
293          <para>
294            The account and password can be stored in a configuration file
295            in the users home directory in a file named
296            <filename>.bti</filename>.  The structure of this file is as
297            follows:
298          </para>
299          <variablelist>
300            <varlistentry>
301              <term><option>account</option></term>
302              <listitem>
303                <para>
304                  The twitter.com account name you wish to use to send this
305                  message with.
306                </para>
307              </listitem>
308            </varlistentry>
309            <varlistentry>
310              <term><option>password</option></term>
311              <listitem>
312                <para>
313                  The twitter.com password for the account you wish to use
314                  to send this message with.
315                </para>
316              </listitem>
317            </varlistentry>
318            <varlistentry>
319             <term><option>--action action</option></term>
320             <listitem>
321               <para>
322                 Specify the action which you want to perform.  Valid options
323                 are "update" to send a message, "friends" to see your friends
324                 timeline, "public" to track public timeline, "replies" to see
325                 replies to your messages and "user" to see a specific user's
326                 timeline.
327               </para>
328             </listitem>
329            </varlistentry>
330            <varlistentry>
331             <term><option>--user screenname</option></term>
332             <listitem>
333               <para>
334                 Specify the user you want to see his/her messages while the
335                 action is "user".
336               </para>
337             </listitem>
338            </varlistentry>
339            <varlistentry>
340              <term><option>host</option></term>
341              <listitem>
342                <para>
343                  The host you want to use to send the message to.  Valid
344                  options is "twitter" or "custom" to specify your own server.
345
346                </para>
347              </listitem>
348            </varlistentry>
349            <varlistentry>
350              <term><option>proxy</option></term>
351              <listitem>
352                <para>
353                  The http proxy needed to send data out to the Internet.
354                </para>
355              </listitem>
356            </varlistentry>
357            <varlistentry>
358              <term><option>logfile</option></term>
359              <listitem>
360                <para>
361                  The logfile name for bti to write what happened to.
362                  This file is relative to the user's home directory.  If this
363                  file is not specified here or on the command line, no logging
364                  will be written to the disk.
365                </para>
366              </listitem>
367            </varlistentry>
368            <varlistentry>
369              <term><option>replyto</option></term>
370              <listitem>
371                <para>
372                  The status ID to which all notices will be linked to.
373                </para>
374                <para>
375                  There is no sane reason for a need to have this set in a
376                  config file. One such reason is to have all your messages
377                  as children to a particular status.
378                </para>
379              </listitem>
380            </varlistentry>
381            <varlistentry>
382              <term><option>shrink-urls</option></term>
383              <listitem>
384                <para>
385                  Setting this variable to 'true' or 'yes' will enable the URL
386                  shrinking feature.  This is equivalent to using the
387                  --shrink-urls option.
388                </para>
389              </listitem>
390            </varlistentry>
391            <varlistentry>
392              <term><option>verbose</option></term>
393              <listitem>
394                <para>
395                    Setting this variable to 'true' or 'yes' will enable the
396                    verbose mode.
397                </para>
398              </listitem>
399            </varlistentry>
400         </variablelist>
401          <para>
402            There is an example config file called
403            <filename>bti.example</filename> in the source tree that shows
404            the structure of the file if you need an example to work off of.
405          </para>
406          <para>
407            Configuration options have the following priority:
408          </para>
409          <variablelist>
410            <varlistentry>
411              <term></term>
412              <listitem><para>command line option</para></listitem>
413            </varlistentry>
414            <varlistentry>
415             <term></term>
416             <listitem><para>config file option</para></listitem>
417            </varlistentry>
418            <varlistentry>
419              <term></term>
420              <listitem><para>environment variables</para></listitem>
421            </varlistentry>
422          </variablelist>
423          <para>
424            For example, command line options always override any config file
425            option, or any environment variables.  Unless a config file is
426            specified by the command line.  At that point, the new config file is
427            read, and any previous options set by a command line option, would be
428            overridden.
429          </para>
430        </refsect1>
431
432        <refsect1><title>AUTHOR</title>
433          <para>Written by Greg Kroah-Hartman &lt;<email>greg@kroah.com</email>&gt; and Amir Mohammad Saied &lt;<email>amirsaied@gmail.com</email>&gt;.</para>
434        </refsect1>
435
436     </refentry>
437   </section>
438 </article>