Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 409 lines (396 sloc) 14.894 kb
6b6fec9 @gregkh initial commit of bti, everything's working now
authored
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>
12768d8 @gregkh lots of manpage updates trying to document how to use bti better
authored
22 <refname>bti</refname>
78fd871 @gregkh add identi.ca support to bti
authored
23 <refpurpose>send a tweet to twitter.com or identi.ca from the command line</refpurpose>
6b6fec9 @gregkh initial commit of bti, everything's working now
authored
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>
4ebf8fe @amir Updating documents
amir authored
31 <arg><option>--action action</option></arg>
32 <arg><option>--user screenname</option></arg>
78fd871 @gregkh add identi.ca support to bti
authored
33 <arg><option>--host HOST_NAME</option></arg>
1c6ce5b @gregkh document proxy support
authored
34 <arg><option>--proxy PROXY:PORT</option></arg>
831399e @gregkh document the logfile option
authored
35 <arg><option>--logfile LOGFILE</option></arg>
dada77e @gregkh Add ability to override default config file option
authored
36 <arg><option>--config CONFIGFILE</option></arg>
fd562dd @theappleman Support for replying to notices
theappleman authored
37 <arg><option>--replyto ID</option></arg>
a3654df @gregkh document the --page option
authored
38 <arg><option>--page PAGENUMBER</option></arg>
884c22f @gregkh change --clean be the default and add --bash to duplicate old method
authored
39 <arg><option>--bash</option></arg>
480e84a @bartman bti.xml and bti.example updates
bartman authored
40 <arg><option>--shrink-urls</option></arg>
6b6fec9 @gregkh initial commit of bti, everything's working now
authored
41 <arg><option>--debug</option></arg>
480e84a @bartman bti.xml and bti.example updates
bartman authored
42 <arg><option>--dry-run</option></arg>
7770674 @amir Updating documents, both for the new verbose mode, and custom laconi.…
amir authored
43 <arg><option>--verbose</option></arg>
6b6fec9 @gregkh initial commit of bti, everything's working now
authored
44 <arg><option>--version</option></arg>
45 <arg><option>--help</option></arg>
46 </cmdsynopsis>
47 </refsynopsisdiv>
48
49 <refsect1><title>DESCRIPTION</title>
78fd871 @gregkh add identi.ca support to bti
authored
50 <para>bti sends a tweet message to twitter.com or identi.ca.
12768d8 @gregkh lots of manpage updates trying to document how to use bti better
authored
51 </para>
6b6fec9 @gregkh initial commit of bti, everything's working now
authored
52 </refsect1>
53
54 <refsect1><title>OPTIONS</title>
55 <variablelist>
56 <varlistentry>
57 <term><option>--account account</option></term>
58 <listitem>
59 <para>
78fd871 @gregkh add identi.ca support to bti
authored
60 Specify the twitter.com or identi.ca account name.
6b6fec9 @gregkh initial commit of bti, everything's working now
authored
61 </para>
62 </listitem>
63 </varlistentry>
64 <varlistentry>
65 <term><option>--password password</option></term>
66 <listitem>
67 <para>
78fd871 @gregkh add identi.ca support to bti
authored
68 Specify the password of your twitter.com or identi.ca account.
69 </para>
70 </listitem>
71 </varlistentry>
72 <varlistentry>
4ebf8fe @amir Updating documents
amir authored
73 <term><option>--action action</option></term>
74 <listitem>
75 <para>
76 Specify the action which you want to perform. Valid options
77 are "update" to send a message, "friends" to see your friends
78 timeline, "public" to track public timeline, "replies" to see
79 replies to your messages and "user" to see a specific user's
ac807f1 @rrthomas Typo fixes for bti(1)
rrthomas authored
80 timeline. Default is "update".
4ebf8fe @amir Updating documents
amir authored
81 </para>
82 </listitem>
83 </varlistentry>
84 <varlistentry>
85 <term><option>--user screenname</option></term>
86 <listitem>
87 <para>
ac807f1 @rrthomas Typo fixes for bti(1)
rrthomas authored
88 Specify the user whose messages you want to see when the
4ebf8fe @amir Updating documents
amir authored
89 action is "user".
90 </para>
91 </listitem>
92 </varlistentry>
93 <varlistentry>
78fd871 @gregkh add identi.ca support to bti
authored
94 <term><option>--host HOST_NAME</option></term>
95 <listitem>
96 <para>
97 Specify the host which you want to send your message to. Valid
98 options are "twitter" to send to twitter.com and "identica" to
7770674 @amir Updating documents, both for the new verbose mode, and custom laconi.…
amir authored
99 send to identi.ca.
100
101 If you want to send the message to a custom laconi.ca installation,
102 you should specify the API URI. For example identi.ca's URI is:
103 https://identi.ca/api/statuses
78fd871 @gregkh add identi.ca support to bti
authored
104 </para>
105 <para>
106 If no host is specified, the default is to send to twitter.com.
6b6fec9 @gregkh initial commit of bti, everything's working now
authored
107 </para>
108 </listitem>
109 </varlistentry>
110 <varlistentry>
1c6ce5b @gregkh document proxy support
authored
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>
582800c @gregoa Fix up documentation of proxy option
gregoa authored
118 If --proxy is not specified but the environment variable
119 'http_proxy' is set the latter will be used.
1c6ce5b @gregkh document proxy support
authored
120 </para>
121 </listitem>
122 </varlistentry>
123 <varlistentry>
831399e @gregkh document the logfile option
authored
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>
dada77e @gregkh Add ability to override default config file option
authored
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>
fd562dd @theappleman Support for replying to notices
theappleman authored
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>
dada77e @gregkh Add ability to override default config file option
authored
161 </varlistentry>
162 <varlistentry>
480e84a @bartman bti.xml and bti.example updates
bartman authored
163 <term><option>--shrink-urls</option></term>
164 <listitem>
165 <para>
166 Scans the tweet text for valid URL patterns and passes each
167 through the supplied bti-shrink-urls script. The script will
168 pass the URL to a web service that shrinks the URLs, making it
169 more suitable for micro-blogging.
170 </para>
171 <para>
172 Currently, only http://2tu.us/ is used as a URL shrinking service.
173 </para>
174 </listitem>
175 </varlistentry>
176 <varlistentry>
6b6fec9 @gregkh initial commit of bti, everything's working now
authored
177 <term><option>--debug</option></term>
178 <listitem>
179 <para>Print a whole bunch of debugging messages to stdout.</para>
180 </listitem>
181 </varlistentry>
182 <varlistentry>
a3654df @gregkh document the --page option
authored
183 <term><option>--page PAGENUMBER</option></term>
184 <listitem>
185 <para>
186 When the action is to retrieve updates, it usually retrieves
187 only one page. If this option is used, the page number can be
188 specified.
189 </para>
190 </listitem>
191 </varlistentry>
192 <varlistentry>
480e84a @bartman bti.xml and bti.example updates
bartman authored
193 <term><option>--dry-run</option></term>
194 <listitem>
195 <para>
196 Performs all steps that would normally be done for a given
197 action, but will not connect to the service to post or retrieve data.
198 </para>
199 </listitem>
200 </varlistentry>
201 <varlistentry>
7770674 @amir Updating documents, both for the new verbose mode, and custom laconi.…
amir authored
202 <term><option>--verbose</option></term>
203 <listitem>
204 <para>
40ccc8d @theappleman Verbose mode shows status IDs
theappleman authored
205 Verbose mode. Print status IDs and timestamps.
7770674 @amir Updating documents, both for the new verbose mode, and custom laconi.…
amir authored
206 </para>
207 </listitem>
208 </varlistentry>
209 <varlistentry>
884c22f @gregkh change --clean be the default and add --bash to duplicate old method
authored
210 <term><option>--bash</option></term>
10d5cd1 @gregkh update the man page to reflect the new options
authored
211 <listitem>
884c22f @gregkh change --clean be the default and add --bash to duplicate old method
authored
212 <para>
78fd871 @gregkh add identi.ca support to bti
authored
213 Add the working directory and a '$' in the tweet message to
884c22f @gregkh change --clean be the default and add --bash to duplicate old method
authored
214 help specify it is coming from a command line. Don't put the
78fd871 @gregkh add identi.ca support to bti
authored
215 working directory and the '$' in the tweet message.
884c22f @gregkh change --clean be the default and add --bash to duplicate old method
authored
216 </para>
80f5f0e @gregkh update the man page about --bash options
authored
217 <para>
218 This mode also does not report back any errors that might have
219 happened when sending the message, and it sends it in the
220 background, returning immediately, allowing the process to
221 continue on.
222 </para>
10d5cd1 @gregkh update the man page to reflect the new options
authored
223 </listitem>
224 </varlistentry>
225 <varlistentry>
6b6fec9 @gregkh initial commit of bti, everything's working now
authored
226 <term><option>--version</option></term>
227 <listitem>
228 <para>Print version number.</para>
229 </listitem>
230 </varlistentry>
231 <varlistentry>
232 <term><option>--help</option></term>
233 <listitem>
234 <para>Print help text.</para>
235 </listitem>
236 </varlistentry>
237 </variablelist>
238 </refsect1>
239
12768d8 @gregkh lots of manpage updates trying to document how to use bti better
authored
240 <refsect1>
241 <title>DESCRIPTION</title>
242 <para>
78fd871 @gregkh add identi.ca support to bti
authored
243 bti provides an easy way to send tweet messages direct from the
12768d8 @gregkh lots of manpage updates trying to document how to use bti better
authored
244 command line or any script. It reads the message on standard
245 input and uses the account and password settings either from the
246 command line options, or from a config file, to send the message
247 out.
248 </para>
249 <para>
ac807f1 @rrthomas Typo fixes for bti(1)
rrthomas authored
250 Its primary focus is to allow you to log everything that you
12768d8 @gregkh lots of manpage updates trying to document how to use bti better
authored
251 type into a bash shell, in a crazy, "this is what I'm doing right
252 now!" type of way, letting the world follow along with you
253 constant moving between directories and refreshing your email
254 queue to see if there's anything interesting going on.
255 </para>
256 <para>
257 To hook bti up to your bash shell, export the following variable:
258 </para>
259 <para>
884c22f @gregkh change --clean be the default and add --bash to duplicate old method
authored
260 <literal> PROMPT_COMMAND='history 1 | sed -e "s/^\s*[0-9]*\s*//" | bti --bash'</literal>
12768d8 @gregkh lots of manpage updates trying to document how to use bti better
authored
261 </para>
262 <para>
263 This example assumes that you have the
264 <filename>~/.bti</filename> set up with your account and password
265 information already in it, otherwise you can specify them as an
266 option.
267 </para>
268 </refsect1>
269
270 <refsect1>
271 <title>CONFIGURATION</title>
272 <para>
273 The account and password can be stored in a configuration file
274 in the users home directory in a file named
ac807f1 @rrthomas Typo fixes for bti(1)
rrthomas authored
275 <filename>.bti</filename>. The structure of this file is as
12768d8 @gregkh lots of manpage updates trying to document how to use bti better
authored
276 follows:
277 </para>
278 <variablelist>
279 <varlistentry>
280 <term><option>account</option></term>
281 <listitem>
282 <para>
78fd871 @gregkh add identi.ca support to bti
authored
283 The twitter.com or identi.ca account name you wish to use to send this
12768d8 @gregkh lots of manpage updates trying to document how to use bti better
authored
284 message with.
285 </para>
286 </listitem>
287 </varlistentry>
288 <varlistentry>
289 <term><option>password</option></term>
290 <listitem>
291 <para>
78fd871 @gregkh add identi.ca support to bti
authored
292 The twitter.com or identi.ca password for the account you wish to use
12768d8 @gregkh lots of manpage updates trying to document how to use bti better
authored
293 to send this message with.
294 </para>
295 </listitem>
296 </varlistentry>
4ebf8fe @amir Updating documents
amir authored
297 <varlistentry>
298 <term><option>--action action</option></term>
299 <listitem>
300 <para>
301 Specify the action which you want to perform. Valid options
302 are "update" to send a message, "friends" to see your friends
303 timeline, "public" to track public timeline, "replies" to see
304 replies to your messages and "user" to see a specific user's
305 timeline.
306 </para>
307 </listitem>
308 </varlistentry>
309 <varlistentry>
310 <term><option>--user screenname</option></term>
311 <listitem>
312 <para>
313 Specify the user you want to see his/her messages while the
314 action is "user".
315 </para>
316 </listitem>
317 </varlistentry>
78fd871 @gregkh add identi.ca support to bti
authored
318 <varlistentry>
319 <term><option>host</option></term>
320 <listitem>
321 <para>
322 The host you want to use to send the message to. Valid
323 options are either "twitter" or "identica" to send to
324 twitter.com or identi.ca respectively.
7770674 @amir Updating documents, both for the new verbose mode, and custom laconi.…
amir authored
325
326 If you want to send the message to a custom laconi.ca installation,
327 you should specify the API URI. For example identi.ca's URI is:
328 https://identi.ca/api/statuses.
78fd871 @gregkh add identi.ca support to bti
authored
329 </para>
330 </listitem>
331 </varlistentry>
1c6ce5b @gregkh document proxy support
authored
332 <varlistentry>
333 <term><option>proxy</option></term>
334 <listitem>
335 <para>
336 The http proxy needed to send data out to the Internet.
337 </para>
338 </listitem>
339 </varlistentry>
831399e @gregkh document the logfile option
authored
340 <varlistentry>
341 <term><option>logfile</option></term>
342 <listitem>
343 <para>
344 The logfile name for bti to write what happened to.
345 This file is relative to the user's home directory. If this
346 file is not specified here or on the command line, no logging
347 will be written to the disk.
348 </para>
349 </listitem>
350 </varlistentry>
480e84a @bartman bti.xml and bti.example updates
bartman authored
351 <varlistentry>
352 <term><option>shrink-urls</option></term>
353 <listitem>
354 <para>
355 Setting this variable to 'true' or 'yes' will enable the URL
356 shrinking feature. This is equivalent to using the
357 --shrink-urls option.
358 </para>
359 </listitem>
360 </varlistentry>
7770674 @amir Updating documents, both for the new verbose mode, and custom laconi.…
amir authored
361 <varlistentry>
362 <term><option>verbose</option></term>
363 <listitem>
364 <para>
365 Setting this variable to 'true' or 'yes' will enable the
366 verbose mode.
367 </para>
368 </listitem>
369 </varlistentry>
370 </variablelist>
12768d8 @gregkh lots of manpage updates trying to document how to use bti better
authored
371 <para>
372 There is an example config file called
373 <filename>bti.example</filename> in the source tree that shows
374 the structure of the file if you need an example to work off of.
375 </para>
ba24434 @gregkh document the order that config options are handled
authored
376 <para>
377 Configuration options have the following priority:
378 </para>
379 <variablelist>
380 <varlistentry>
381 <term></term>
382 <listitem><para>command line option</para></listitem>
383 </varlistentry>
384 <varlistentry>
385 <term></term>
386 <listitem><para>config file option</para></listitem>
387 </varlistentry>
388 <varlistentry>
389 <term></term>
390 <listitem><para>environment variables</para></listitem>
391 </varlistentry>
392 </variablelist>
393 <para>
394 For example, command line options always override any config file
dada77e @gregkh Add ability to override default config file option
authored
395 option, or any environment variables. Unless a config file is
396 specified by the command line. At that point, the new config file is
397 read, and any previous options set by a command line option, would be
398 overridden.
ba24434 @gregkh document the order that config options are handled
authored
399 </para>
12768d8 @gregkh lots of manpage updates trying to document how to use bti better
authored
400 </refsect1>
401
402 <refsect1><title>AUTHOR</title>
35f9afd @amir Updating AUTHORs and copyright section
amir authored
403 <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>
12768d8 @gregkh lots of manpage updates trying to document how to use bti better
authored
404 </refsect1>
6b6fec9 @gregkh initial commit of bti, everything's working now
authored
405
406 </refentry>
407 </section>
408 </article>
Something went wrong with that request. Please try again.