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