Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 164 lines (153 sloc) 5.527 kb
6b6fec9 @gregkh initial commit of bti, everything's working now
authored
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>
12768d8 @gregkh lots of manpage updates trying to document how to use bti better
authored
22 <refname>bti</refname>
23 <refpurpose>send a tweet to twitter.com from the command line</refpurpose>
6b6fec9 @gregkh initial commit of bti, everything's working now
authored
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>
884c22f @gregkh change --clean be the default and add --bash to duplicate old method
authored
31 <arg><option>--bash</option></arg>
6b6fec9 @gregkh initial commit of bti, everything's working now
authored
32 <arg><option>--debug</option></arg>
33 <arg><option>--version</option></arg>
34 <arg><option>--help</option></arg>
35 </cmdsynopsis>
36 </refsynopsisdiv>
37
38 <refsect1><title>DESCRIPTION</title>
39 <para>bti sends a twitter message to twitter.com.
12768d8 @gregkh lots of manpage updates trying to document how to use bti better
authored
40 </para>
6b6fec9 @gregkh initial commit of bti, everything's working now
authored
41 </refsect1>
42
43 <refsect1><title>OPTIONS</title>
44 <variablelist>
45 <varlistentry>
46 <term><option>--account account</option></term>
47 <listitem>
48 <para>
49 Specify the twitter.com account name.
50 </para>
51 </listitem>
52 </varlistentry>
53 <varlistentry>
54 <term><option>--password password</option></term>
55 <listitem>
56 <para>
12768d8 @gregkh lots of manpage updates trying to document how to use bti better
authored
57 Specify the password of your twitter.com account.
6b6fec9 @gregkh initial commit of bti, everything's working now
authored
58 </para>
59 </listitem>
60 </varlistentry>
61 <varlistentry>
62 <term><option>--debug</option></term>
63 <listitem>
64 <para>Print a whole bunch of debugging messages to stdout.</para>
65 </listitem>
66 </varlistentry>
67 <varlistentry>
884c22f @gregkh change --clean be the default and add --bash to duplicate old method
authored
68 <term><option>--bash</option></term>
10d5cd1 @gregkh update the man page to reflect the new options
authored
69 <listitem>
884c22f @gregkh change --clean be the default and add --bash to duplicate old method
authored
70 <para>
71 Add the working directory and a '$' in the twitter message to
72 help specify it is coming from a command line. Don't put the
73 working directory and the '$' in the twitter message.
74 </para>
10d5cd1 @gregkh update the man page to reflect the new options
authored
75 </listitem>
76 </varlistentry>
77 <varlistentry>
6b6fec9 @gregkh initial commit of bti, everything's working now
authored
78 <term><option>--version</option></term>
79 <listitem>
80 <para>Print version number.</para>
81 </listitem>
82 </varlistentry>
83 <varlistentry>
84 <term><option>--help</option></term>
85 <listitem>
86 <para>Print help text.</para>
87 </listitem>
88 </varlistentry>
89 </variablelist>
90 </refsect1>
91
12768d8 @gregkh lots of manpage updates trying to document how to use bti better
authored
92 <refsect1>
93 <title>DESCRIPTION</title>
94 <para>
95 bti provides an easy way to send twitter messages direct from the
96 command line or any script. It reads the message on standard
97 input and uses the account and password settings either from the
98 command line options, or from a config file, to send the message
99 out.
100 </para>
101 <para>
102 It's primary focus is to allow you to log everything that you
103 type into a bash shell, in a crazy, "this is what I'm doing right
104 now!" type of way, letting the world follow along with you
105 constant moving between directories and refreshing your email
106 queue to see if there's anything interesting going on.
107 </para>
108 <para>
109 To hook bti up to your bash shell, export the following variable:
110 </para>
111 <para>
884c22f @gregkh change --clean be the default and add --bash to duplicate old method
authored
112 <literal> PROMPT_COMMAND='history 1 | sed -e "s/^\s*[0-9]*\s*//" | bti --bash'</literal>
12768d8 @gregkh lots of manpage updates trying to document how to use bti better
authored
113 </para>
114 <para>
115 This example assumes that you have the
116 <filename>~/.bti</filename> set up with your account and password
117 information already in it, otherwise you can specify them as an
118 option.
119 </para>
120 </refsect1>
121
122 <refsect1>
123 <title>CONFIGURATION</title>
124 <para>
125 The account and password can be stored in a configuration file
126 in the users home directory in a file named
127 <filename>.bti</filename> The structure of this file is as
128 follows:
129 </para>
130 <variablelist>
131 <varlistentry>
132 <term><option>account</option></term>
133 <listitem>
134 <para>
135 The twitter.com account name you wish to use to send this
136 message with.
137 </para>
138 </listitem>
139 </varlistentry>
140 <varlistentry>
141 <term><option>password</option></term>
142 <listitem>
143 <para>
144 The twitter.com password for the account you wish to use
145 to send this message with.
146 </para>
147 </listitem>
148 </varlistentry>
149 </variablelist>
150 <para>
151 There is an example config file called
152 <filename>bti.example</filename> in the source tree that shows
153 the structure of the file if you need an example to work off of.
154 </para>
155 </refsect1>
156
157 <refsect1><title>AUTHOR</title>
158 <para>Written by Greg Kroah-Hartman <email>greg@kroah.com</email>.</para>
159 </refsect1>
6b6fec9 @gregkh initial commit of bti, everything's working now
authored
160
161 </refentry>
162 </section>
163 </article>
Something went wrong with that request. Please try again.