/[debian]/bti/branches/upstream/current/bti.1
ViewVC logotype

Diff of /bti/branches/upstream/current/bti.1

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2706 by gregoa, Fri Jan 14 01:14:54 2011 UTC revision 2707 by gregoa, Fri Dec 2 23:53:57 2011 UTC
# Line 1  Line 1 
1  '\" t  '\" t
2  .\"     Title: bti  .\"     Title: bti
3  .\"    Author: [see the "AUTHOR" section]  .\"    Author: [see the "AUTHOR" section]
4  .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>  .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
5  .\"      Date: May 2008  .\"      Date: May 2008
6  .\"    Manual: bti  .\"    Manual: bti
7  .\"    Source: bti  .\"    Source: bti
# Line 9  Line 9 
9  .\"  .\"
10  .TH "BTI" "1" "May 2008" "bti" "bti"  .TH "BTI" "1" "May 2008" "bti" "bti"
11  .\" -----------------------------------------------------------------  .\" -----------------------------------------------------------------
12    .\" * Define some portability stuff
13    .\" -----------------------------------------------------------------
14    .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15    .\" http://bugs.debian.org/507673
16    .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17    .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18    .ie \n(.g .ds Aq \(aq
19    .el       .ds Aq '
20    .\" -----------------------------------------------------------------
21  .\" * set default formatting  .\" * set default formatting
22  .\" -----------------------------------------------------------------  .\" -----------------------------------------------------------------
23  .\" disable hyphenation  .\" disable hyphenation
# Line 40  Specify the password of your twitter\&.c Line 49  Specify the password of your twitter\&.c
49  .PP  .PP
50  \fB\-\-action action\fR  \fB\-\-action action\fR
51  .RS 4  .RS 4
52  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"\&.  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\*(Aqs timeline\&. Default is "update"\&.
53  .RE  .RE
54  .PP  .PP
55  \fB\-\-user screenname\fR  \fB\-\-user screenname\fR
# Line 50  Specify the user whose messages you want Line 59  Specify the user whose messages you want
59  .PP  .PP
60  \fB\-\-host HOST_NAME\fR  \fB\-\-host HOST_NAME\fR
61  .RS 4  .RS 4
62  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  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 StatusNet installation, you should specify the API URI\&. For example identi\&.ca\*(Aqs URI is: https://identi\&.ca/api/statuses
63  .sp  .sp
64  If no host is specified, the default is to send to twitter\&.com\&.  If no host is specified, the default is to send to twitter\&.com\&.
65  .RE  .RE
# Line 59  If no host is specified, the default is Line 68  If no host is specified, the default is
68  .RS 4  .RS 4
69  Specify a http proxy value\&. This is not a required option, and only needed by systems that are behind a http proxy\&.  Specify a http proxy value\&. This is not a required option, and only needed by systems that are behind a http proxy\&.
70  .sp  .sp
71  If \-\-proxy is not specified but the environment variable \'http_proxy\' is set the latter will be used\&.  If \-\-proxy is not specified but the environment variable \*(Aqhttp_proxy\*(Aq is set the latter will be used\&.
72  .RE  .RE
73  .PP  .PP
74  \fB\-\-logfile LOGFILE\fR  \fB\-\-logfile LOGFILE\fR
75  .RS 4  .RS 4
76  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\&.  Specify a logfile for bti to write status messages to\&. LOGFILE is in relation to the user\*(Aqs home directory, not an absolute path to a file\&.
77  .RE  .RE
78  .PP  .PP
79  \fB\-\-config CONFIGFILE\fR  \fB\-\-config CONFIGFILE\fR
# Line 117  Verbose mode\&. Print status IDs and tim Line 126  Verbose mode\&. Print status IDs and tim
126  .PP  .PP
127  \fB\-\-bash\fR  \fB\-\-bash\fR
128  .RS 4  .RS 4
129  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\&.  Add the working directory and a \*(Aq$\*(Aq in the tweet message to help specify it is coming from a command line\&. Don\*(Aqt put the working directory and the \*(Aq$\*(Aq in the tweet message\&.
130  .sp  .sp
131  This option implies  This option implies
132  \fB\-\-background\fR\&.  \fB\-\-background\fR\&.
# Line 141  Print help text\&. Line 150  Print help text\&.
150  .PP  .PP
151  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\&.  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\&.
152  .PP  .PP
153  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\&.  Its primary focus is to allow you to log everything that you type into a bash shell, in a crazy, "this is what I\*(Aqm 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\*(Aqs anything interesting going on\&.
154  .PP  .PP
155  To hook bti up to your bash shell, export the following variable:  To hook bti up to your bash shell, export the following variable:
156  .PP  .PP
157    
158  PROMPT_COMMAND=\'history 1 | sed \-e "s/^\es*[0\-9]*\es*//" | bti \-\-bash\'  PROMPT_COMMAND=\*(Aqhistory 1 | sed \-e "s/^\es*[0\-9]*\es*//" | bti \-\-bash\*(Aq
159  .PP  .PP
160  This example assumes that you have the  This example assumes that you have the
161  ~/\&.bti  ~/\&.bti
# Line 168  The twitter\&.com or identi\&.ca passwor Line 177  The twitter\&.com or identi\&.ca passwor
177  .PP  .PP
178  \fB\-\-action action\fR  \fB\-\-action action\fR
179  .RS 4  .RS 4
180  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\&.  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\*(Aqs timeline\&.
181  .RE  .RE
182  .PP  .PP
183  \fB\-\-user screenname\fR  \fB\-\-user screenname\fR
# Line 178  Specify the user you want to see his/her Line 187  Specify the user you want to see his/her
187  .PP  .PP
188  \fBhost\fR  \fBhost\fR
189  .RS 4  .RS 4
190  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\&.  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 StatusNet installation, you should specify the API URI\&. For example identi\&.ca\*(Aqs URI is: https://identi\&.ca/api/statuses\&.
191  .RE  .RE
192  .PP  .PP
193  \fBproxy\fR  \fBproxy\fR
# Line 188  The http proxy needed to send data out t Line 197  The http proxy needed to send data out t
197  .PP  .PP
198  \fBlogfile\fR  \fBlogfile\fR
199  .RS 4  .RS 4
200  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\&.  The logfile name for bti to write what happened to\&. This file is relative to the user\*(Aqs home directory\&. If this file is not specified here or on the command line, no logging will be written to the disk\&.
201  .RE  .RE
202  .PP  .PP
203  \fBreplyto\fR  \fBreplyto\fR
# Line 200  There is no sane reason for a need to ha Line 209  There is no sane reason for a need to ha
209  .PP  .PP
210  \fBshrink\-urls\fR  \fBshrink\-urls\fR
211  .RS 4  .RS 4
212  Setting this variable to \'true\' or \'yes\' will enable the URL shrinking feature\&. This is equivalent to using the \-\-shrink\-urls option\&.  Setting this variable to \*(Aqtrue\*(Aq or \*(Aqyes\*(Aq will enable the URL shrinking feature\&. This is equivalent to using the \-\-shrink\-urls option\&.
213  .RE  .RE
214  .PP  .PP
215  \fBverbose\fR  \fBverbose\fR
216  .RS 4  .RS 4
217  Setting this variable to \'true\' or \'yes\' will enable the verbose mode\&.  Setting this variable to \*(Aqtrue\*(Aq or \*(Aqyes\*(Aq will enable the verbose mode\&.
218  .RE  .RE
219  .PP  .PP
220  There is an example config file called  There is an example config file called

Legend:
Removed from v.2706  
changed lines
  Added in v.2707

  ViewVC Help
Powered by ViewVC 1.1.26