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

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

Parent Directory Parent Directory | Revision Log Revision Log


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

  ViewVC Help
Powered by ViewVC 1.1.26