release 004
[gregoa/bti.git] / bti.1
1 .\"     Title: bti
2 .\"    Author: 
3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
4 .\"      Date: May 2008
5 .\"    Manual: bti
6 .\"    Source: bti
7 .\"
8 .TH "BTI" "1" "May 2008" "bti" "bti"
9 .\" disable hyphenation
10 .nh
11 .\" disable justification (adjust text to left margin only)
12 .ad l
13 .SH "NAME"
14 bti - send a tweet to twitter.com from the command line
15 .SH "SYNOPSIS"
16 .HP 4
17 \fBbti\fR [\fB\-\-account\ account\fR] [\fB\-\-password\ password\fR] [\fB\-\-bash\fR] [\fB\-\-debug\fR] [\fB\-\-version\fR] [\fB\-\-help\fR]
18 .SH "DESCRIPTION"
19 .PP
20 bti sends a twitter message to twitter\.com\.
21 .SH "OPTIONS"
22 .PP
23 \fB\-\-account account\fR
24 .RS 4
25 Specify the twitter\.com account name\.
26 .RE
27 .PP
28 \fB\-\-password password\fR
29 .RS 4
30 Specify the password of your twitter\.com account\.
31 .RE
32 .PP
33 \fB\-\-debug\fR
34 .RS 4
35 Print a whole bunch of debugging messages to stdout\.
36 .RE
37 .PP
38 \fB\-\-bash\fR
39 .RS 4
40 Add the working directory and a \'$\' in the twitter message to help specify it is coming from a command line\. Don\'t put the working directory and the \'$\' in the twitter message\.
41 .sp
42 This mode also does not report back any errors that might have happened when sending the message, and it sends it in the background, returning immediately, allowing the process to continue on\.
43 .RE
44 .PP
45 \fB\-\-version\fR
46 .RS 4
47 Print version number\.
48 .RE
49 .PP
50 \fB\-\-help\fR
51 .RS 4
52 Print help text\.
53 .RE
54 .SH "DESCRIPTION"
55 .PP
56 bti provides an easy way to send twitter 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\.
57 .PP
58 It\'s 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\.
59 .PP
60 To hook bti up to your bash shell, export the following variable:
61 .PP
62
63 PROMPT_COMMAND=\'history 1 | sed \-e "s/^\es*[0\-9]*\es*//" | bti \-\-bash\'
64 .PP
65 This example assumes that you have the
66 \fI~/\.bti\fR
67 set up with your account and password information already in it, otherwise you can specify them as an option\.
68 .SH "CONFIGURATION"
69 .PP
70 The account and password can be stored in a configuration file in the users home directory in a file named
71 \fI\.bti\fR
72 The structure of this file is as follows:
73 .PP
74 \fBaccount\fR
75 .RS 4
76 The twitter\.com account name you wish to use to send this message with\.
77 .RE
78 .PP
79 \fBpassword\fR
80 .RS 4
81 The twitter\.com password for the account you wish to use to send this message with\.
82 .RE
83 .PP
84 There is an example config file called
85 \fIbti\.example\fR
86 in the source tree that shows the structure of the file if you need an example to work off of\.
87 .SH "AUTHOR"
88 .PP
89 Written by Greg Kroah\-Hartman
90 <greg@kroah\.com>\.