bti.xml: docsheet url cleanup
[gregoa/bti.git] / bti.1
1 '\" t
2 .\"     Title: bti
3 .\"    Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5 .\"      Date: May 2008
6 .\"    Manual: bti
7 .\"    Source: bti
8 .\"  Language: English
9 .\"
10 .TH "BTI" "1" "May 2008" "bti" "bti"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
15 .nh
16 .\" disable justification (adjust text to left margin only)
17 .ad l
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
21 .SH "NAME"
22 bti \- send a tweet to twitter\&.com or identi\&.ca from the command line
23 .SH "SYNOPSIS"
24 .HP \w'\fBbti\fR\ 'u
25 \fBbti\fR [\fB\-\-account\ account\fR] [\fB\-\-password\ password\fR] [\fB\-\-action\ action\fR] [\fB\-\-user\ screenname\fR] [\fB\-\-host\ HOST_NAME\fR] [\fB\-\-proxy\ PROXY:PORT\fR] [\fB\-\-logfile\ LOGFILE\fR] [\fB\-\-config\ CONFIGFILE\fR] [\fB\-\-replyto\ ID\fR] [\fB\-\-retweet\ ID\fR] [\fB\-\-page\ PAGENUMBER\fR] [\fB\-\-bash\fR] [\fB\-\-shrink\-urls\fR] [\fB\-\-debug\fR] [\fB\-\-dry\-run\fR] [\fB\-\-verbose\fR] [\fB\-\-version\fR] [\fB\-\-help\fR]
26 .SH "DESCRIPTION"
27 .PP
28 bti sends a tweet message to twitter\&.com or identi\&.ca\&.
29 .SH "OPTIONS"
30 .PP
31 \fB\-\-account account\fR
32 .RS 4
33 Specify the twitter\&.com or identi\&.ca account name\&.
34 .RE
35 .PP
36 \fB\-\-password password\fR
37 .RS 4
38 Specify the password of your twitter\&.com or identi\&.ca account\&.
39 .RE
40 .PP
41 \fB\-\-action action\fR
42 .RS 4
43 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"\&.
44 .RE
45 .PP
46 \fB\-\-user screenname\fR
47 .RS 4
48 Specify the user whose messages you want to see when the action is "user"\&.
49 .RE
50 .PP
51 \fB\-\-host HOST_NAME\fR
52 .RS 4
53 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
54 .sp
55 If no host is specified, the default is to send to twitter\&.com\&.
56 .RE
57 .PP
58 \fB\-\-proxy PROXY:PORT\fR
59 .RS 4
60 Specify a http proxy value\&. This is not a required option, and only needed by systems that are behind a http proxy\&.
61 .sp
62 If \-\-proxy is not specified but the environment variable \'http_proxy\' is set the latter will be used\&.
63 .RE
64 .PP
65 \fB\-\-logfile LOGFILE\fR
66 .RS 4
67 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\&.
68 .RE
69 .PP
70 \fB\-\-config CONFIGFILE\fR
71 .RS 4
72 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\&.
73 .RE
74 .PP
75 \fB\-\-replyto ID\fR
76 .RS 4
77 Status ID of a single post to which you want to create a threaded reply to\&.
78 .sp
79 For twitter, this is ignored unless the message starts with the @name of the owner of the post with the status ID\&.
80 .sp
81 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\&.
82 .RE
83 .PP
84 \fB\-\-retweet ID\fR
85 .RS 4
86 Status ID of a single post which you want to retweet\&.
87 .RE
88 .PP
89 \fB\-\-shrink\-urls\fR
90 .RS 4
91 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\&.
92 .sp
93 The following URL shrinking services are available: http://2tu\&.us/ (default) and http://bit\&.ly / http://j\&.mp
94 .sp
95 See the documentation for bti\-shrink\-urls for the configuration options\&.
96 .RE
97 .PP
98 \fB\-\-debug\fR
99 .RS 4
100 Print a whole bunch of debugging messages to stdout\&.
101 .RE
102 .PP
103 \fB\-\-page PAGENUMBER\fR
104 .RS 4
105 When the action is to retrieve updates, it usually retrieves only one page\&. If this option is used, the page number can be specified\&.
106 .RE
107 .PP
108 \fB\-\-dry\-run\fR
109 .RS 4
110 Performs all steps that would normally be done for a given action, but will not connect to the service to post or retrieve data\&.
111 .RE
112 .PP
113 \fB\-\-verbose\fR
114 .RS 4
115 Verbose mode\&. Print status IDs and timestamps\&.
116 .RE
117 .PP
118 \fB\-\-bash\fR
119 .RS 4
120 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\&.
121 .sp
122 This option implies
123 \fB\-\-background\fR\&.
124 .RE
125 .PP
126 \fB\-\-background\fR
127 .RS 4
128 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\&.
129 .RE
130 .PP
131 \fB\-\-version\fR
132 .RS 4
133 Print version number\&.
134 .RE
135 .PP
136 \fB\-\-help\fR
137 .RS 4
138 Print help text\&.
139 .RE
140 .SH "DESCRIPTION"
141 .PP
142 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\&.
143 .PP
144 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\&.
145 .PP
146 To hook bti up to your bash shell, export the following variable:
147 .PP
148
149 PROMPT_COMMAND=\'history 1 | sed \-e "s/^\es*[0\-9]*\es*//" | bti \-\-bash\'
150 .PP
151 This example assumes that you have the
152 ~/\&.bti
153 set up with your account and password information already in it, otherwise you can specify them as an option\&.
154 .SH "CONFIGURATION"
155 .PP
156 The account and password can be stored in a configuration file in the users home directory in a file named
157 \&.bti\&. The structure of this file is as follows:
158 .PP
159 \fBaccount\fR
160 .RS 4
161 The twitter\&.com or identi\&.ca account name you wish to use to send this message with\&.
162 .RE
163 .PP
164 \fBpassword\fR
165 .RS 4
166 The twitter\&.com or identi\&.ca password for the account you wish to use to send this message with\&.
167 .RE
168 .PP
169 \fB\-\-action action\fR
170 .RS 4
171 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\&.
172 .RE
173 .PP
174 \fB\-\-user screenname\fR
175 .RS 4
176 Specify the user you want to see his/her messages while the action is "user"\&.
177 .RE
178 .PP
179 \fBhost\fR
180 .RS 4
181 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\&.
182 .RE
183 .PP
184 \fBproxy\fR
185 .RS 4
186 The http proxy needed to send data out to the Internet\&.
187 .RE
188 .PP
189 \fBlogfile\fR
190 .RS 4
191 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\&.
192 .RE
193 .PP
194 \fBreplyto\fR
195 .RS 4
196 The status ID to which all notices will be linked to\&.
197 .sp
198 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\&.
199 .RE
200 .PP
201 \fBshrink\-urls\fR
202 .RS 4
203 Setting this variable to \'true\' or \'yes\' will enable the URL shrinking feature\&. This is equivalent to using the \-\-shrink\-urls option\&.
204 .RE
205 .PP
206 \fBverbose\fR
207 .RS 4
208 Setting this variable to \'true\' or \'yes\' will enable the verbose mode\&.
209 .RE
210 .PP
211 There is an example config file called
212 bti\&.example
213 in the source tree that shows the structure of the file if you need an example to work off of\&.
214 .PP
215 Configuration options have the following priority:
216 .PP
217 .RS 4
218 command line option
219 .RE
220 .PP
221 .RS 4
222 config file option
223 .RE
224 .PP
225 .RS 4
226 environment variables
227 .RE
228 .PP
229 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\&.
230 .SH "AUTHOR"
231 .PP
232 Written by Greg Kroah\-Hartman <greg@kroah\&.com> and Amir Mohammad Saied <amirsaied@gmail\&.com>\&.