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

Contents of /bti/branches/upstream/current/bti.xml

Parent Directory Parent Directory | Revision Log Revision Log


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

  ViewVC Help
Powered by ViewVC 1.1.26