/[debian]/bti/trunk/bti.xml
ViewVC logotype

Annotation of /bti/trunk/bti.xml

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1532 - (hide annotations)
Sat Jan 24 16:36:56 2009 UTC (12 years, 6 months ago) by gregoa
File MIME type: text/xml
File size: 9032 byte(s)
New upstream release.
1 gregoa 1473 <?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>
22     <refname>bti</refname>
23     <refpurpose>send a tweet to twitter.com or identi.ca from the command line</refpurpose>
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>
31     <arg><option>--host HOST_NAME</option></arg>
32 gregoa 1509 <arg><option>--proxy PROXY:PORT</option></arg>
33 gregoa 1532 <arg><option>--logfile LOGFILE</option></arg>
34 gregoa 1473 <arg><option>--bash</option></arg>
35     <arg><option>--debug</option></arg>
36     <arg><option>--version</option></arg>
37     <arg><option>--help</option></arg>
38     </cmdsynopsis>
39     </refsynopsisdiv>
40    
41     <refsect1><title>DESCRIPTION</title>
42     <para>bti sends a tweet message to twitter.com or identi.ca.
43     </para>
44     </refsect1>
45    
46     <refsect1><title>OPTIONS</title>
47     <variablelist>
48     <varlistentry>
49     <term><option>--account account</option></term>
50     <listitem>
51     <para>
52     Specify the twitter.com or identi.ca account name.
53     </para>
54     </listitem>
55     </varlistentry>
56     <varlistentry>
57     <term><option>--password password</option></term>
58     <listitem>
59     <para>
60     Specify the password of your twitter.com or identi.ca account.
61     </para>
62     </listitem>
63     </varlistentry>
64     <varlistentry>
65     <term><option>--host HOST_NAME</option></term>
66     <listitem>
67     <para>
68     Specify the host which you want to send your message to. Valid
69     options are "twitter" to send to twitter.com and "identica" to
70     send to identi.ca.
71     </para>
72     <para>
73     If no host is specified, the default is to send to twitter.com.
74     </para>
75     </listitem>
76     </varlistentry>
77     <varlistentry>
78 gregoa 1509 <term><option>--proxy PROXY:PORT</option></term>
79     <listitem>
80     <para>
81     Specify a http proxy value. This is not a required option, and
82     only needed by systems that are behind a http proxy.
83     </para>
84     <para>
85 gregoa 1513 If --proxy is not specified but the environment variable
86     'http_proxy' is set the latter will be used.
87 gregoa 1509 </para>
88     </listitem>
89     </varlistentry>
90     <varlistentry>
91 gregoa 1532 <term><option>--logfile LOGFILE</option></term>
92     <listitem>
93     <para>
94     Specify a logfile for bti to write status messages to. LOGFILE
95     is in relation to the user's home directory, not an absolute
96     path to a file.
97     </para>
98     </listitem>
99     </varlistentry>
100     <varlistentry>
101 gregoa 1473 <term><option>--debug</option></term>
102     <listitem>
103     <para>Print a whole bunch of debugging messages to stdout.</para>
104     </listitem>
105     </varlistentry>
106     <varlistentry>
107     <term><option>--bash</option></term>
108     <listitem>
109     <para>
110     Add the working directory and a '$' in the tweet message to
111     help specify it is coming from a command line. Don't put the
112     working directory and the '$' in the tweet message.
113     </para>
114     <para>
115     This mode also does not report back any errors that might have
116     happened when sending the message, and it sends it in the
117     background, returning immediately, allowing the process to
118     continue on.
119     </para>
120     </listitem>
121     </varlistentry>
122     <varlistentry>
123     <term><option>--version</option></term>
124     <listitem>
125     <para>Print version number.</para>
126     </listitem>
127     </varlistentry>
128     <varlistentry>
129     <term><option>--help</option></term>
130     <listitem>
131     <para>Print help text.</para>
132     </listitem>
133     </varlistentry>
134     </variablelist>
135     </refsect1>
136    
137     <refsect1>
138     <title>DESCRIPTION</title>
139     <para>
140     bti provides an easy way to send tweet messages direct from the
141     command line or any script. It reads the message on standard
142     input and uses the account and password settings either from the
143     command line options, or from a config file, to send the message
144     out.
145     </para>
146     <para>
147     It's primary focus is to allow you to log everything that you
148     type into a bash shell, in a crazy, "this is what I'm doing right
149     now!" type of way, letting the world follow along with you
150     constant moving between directories and refreshing your email
151     queue to see if there's anything interesting going on.
152     </para>
153     <para>
154     To hook bti up to your bash shell, export the following variable:
155     </para>
156     <para>
157     <literal> PROMPT_COMMAND='history 1 | sed -e "s/^\s*[0-9]*\s*//" | bti --bash'</literal>
158     </para>
159     <para>
160     This example assumes that you have the
161     <filename>~/.bti</filename> set up with your account and password
162     information already in it, otherwise you can specify them as an
163     option.
164     </para>
165     </refsect1>
166    
167     <refsect1>
168     <title>CONFIGURATION</title>
169     <para>
170     The account and password can be stored in a configuration file
171     in the users home directory in a file named
172     <filename>.bti</filename> The structure of this file is as
173     follows:
174     </para>
175     <variablelist>
176     <varlistentry>
177     <term><option>account</option></term>
178     <listitem>
179     <para>
180     The twitter.com or identi.ca account name you wish to use to send this
181     message with.
182     </para>
183     </listitem>
184     </varlistentry>
185     <varlistentry>
186     <term><option>password</option></term>
187     <listitem>
188     <para>
189     The twitter.com or identi.ca password for the account you wish to use
190     to send this message with.
191     </para>
192     </listitem>
193     </varlistentry>
194     <varlistentry>
195     <term><option>host</option></term>
196     <listitem>
197     <para>
198     The host you want to use to send the message to. Valid
199     options are either "twitter" or "identica" to send to
200     twitter.com or identi.ca respectively.
201     </para>
202     </listitem>
203     </varlistentry>
204 gregoa 1509 <varlistentry>
205     <term><option>proxy</option></term>
206     <listitem>
207     <para>
208     The http proxy needed to send data out to the Internet.
209     </para>
210     </listitem>
211     </varlistentry>
212 gregoa 1532 <varlistentry>
213     <term><option>logfile</option></term>
214     <listitem>
215     <para>
216     The logfile name for bti to write what happened to.
217     This file is relative to the user's home directory. If this
218     file is not specified here or on the command line, no logging
219     will be written to the disk.
220     </para>
221     </listitem>
222     </varlistentry>
223 gregoa 1473 </variablelist>
224     <para>
225     There is an example config file called
226     <filename>bti.example</filename> in the source tree that shows
227     the structure of the file if you need an example to work off of.
228     </para>
229 gregoa 1513 <para>
230     Configuration options have the following priority:
231     </para>
232     <variablelist>
233     <varlistentry>
234     <term></term>
235     <listitem><para>command line option</para></listitem>
236     </varlistentry>
237     <varlistentry>
238     <term></term>
239     <listitem><para>config file option</para></listitem>
240     </varlistentry>
241     <varlistentry>
242     <term></term>
243     <listitem><para>environment variables</para></listitem>
244     </varlistentry>
245     </variablelist>
246     <para>
247     For example, command line options always override any config file
248     option, or any environment variables.
249     </para>
250 gregoa 1473 </refsect1>
251    
252     <refsect1><title>AUTHOR</title>
253     <para>Written by Greg Kroah-Hartman <email>greg@kroah.com</email>.</para>
254     </refsect1>
255    
256     </refentry>
257     </section>
258     </article>

  ViewVC Help
Powered by ViewVC 1.1.26