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