Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tag: 015
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 303 lines (292 sloc) 10.609 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
<?xml version='1.0'?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<article>
  <section>
    <title>bti</title>
    <refentry>
      <refentryinfo>
        <title>bti</title>
        <date>May 2008</date>
        <productname>bti</productname>
      </refentryinfo>

      <refmeta>
        <refentrytitle>bti</refentrytitle>
        <manvolnum>1</manvolnum>
        <refmiscinfo class="version"></refmiscinfo>
      </refmeta>

      <refnamediv>
        <refname>bti</refname>
        <refpurpose>send a tweet to twitter.com or identi.ca from the command line</refpurpose>
      </refnamediv>

      <refsynopsisdiv>
        <cmdsynopsis>
          <command>bti</command>
          <arg><option>--account account</option></arg>
          <arg><option>--password password</option></arg>
<arg><option>--action action</option></arg>
<arg><option>--user screenname</option></arg>
          <arg><option>--host HOST_NAME</option></arg>
          <arg><option>--proxy PROXY:PORT</option></arg>
          <arg><option>--logfile LOGFILE</option></arg>
          <arg><option>--bash</option></arg>
          <arg><option>--debug</option></arg>
          <arg><option>--version</option></arg>
          <arg><option>--help</option></arg>
        </cmdsynopsis>
      </refsynopsisdiv>

      <refsect1><title>DESCRIPTION</title>
        <para>bti sends a tweet message to twitter.com or identi.ca.
        </para>
      </refsect1>

      <refsect1><title>OPTIONS</title>
        <variablelist>
          <varlistentry>
            <term><option>--account account</option></term>
            <listitem>
              <para>
Specify the twitter.com or identi.ca account name.
</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--password password</option></term>
            <listitem>
              <para>
                Specify the password of your twitter.com or identi.ca account.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--action action</option></term>
            <listitem>
              <para>
Specify the action which you want to perform. Valid options
are "update" to send a message, "friends" to see your friends
timeline, "public" to track public timeline, "replies" to see
replies to your messages and "user" to see a specific user's
timeline.
              </para>
            </listitem>
          </varlistentry>
<varlistentry>
            <term><option>--user screenname</option></term>
            <listitem>
              <para>
Specify the user you want to see his/her messages while the
action is "user".
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--host HOST_NAME</option></term>
            <listitem>
              <para>
Specify the host which you want to send your message to. Valid
options are "twitter" to send to twitter.com and "identica" to
send to identi.ca.
              </para>
              <para>
If no host is specified, the default is to send to twitter.com.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--proxy PROXY:PORT</option></term>
            <listitem>
              <para>
Specify a http proxy value. This is not a required option, and
only needed by systems that are behind a http proxy.
              </para>
              <para>
If --proxy is not specified but the environment variable
                'http_proxy' is set the latter will be used.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--logfile LOGFILE</option></term>
            <listitem>
              <para>
Specify a logfile for bti to write status messages to. LOGFILE
is in relation to the user's home directory, not an absolute
path to a file.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--debug</option></term>
            <listitem>
              <para>Print a whole bunch of debugging messages to stdout.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--bash</option></term>
            <listitem>
              <para>
Add the working directory and a '$' in the tweet message to
help specify it is coming from a command line. Don't put the
working directory and the '$' in the tweet message.
</para>
<para>
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.
</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--version</option></term>
            <listitem>
              <para>Print version number.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--help</option></term>
            <listitem>
              <para>Print help text.</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </refsect1>

      <refsect1>
        <title>DESCRIPTION</title>
        <para>
          bti provides an easy way to send tweet 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.
        </para>
        <para>
          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.
        </para>
        <para>
          To hook bti up to your bash shell, export the following variable:
        </para>
        <para>
            <literal> PROMPT_COMMAND='history 1 | sed -e "s/^\s*[0-9]*\s*//" | bti --bash'</literal>
        </para>
        <para>
          This example assumes that you have the
          <filename>~/.bti</filename> set up with your account and password
          information already in it, otherwise you can specify them as an
          option.
        </para>
       </refsect1>

       <refsect1>
         <title>CONFIGURATION</title>
         <para>
           The account and password can be stored in a configuration file
           in the users home directory in a file named
           <filename>.bti</filename> The structure of this file is as
           follows:
         </para>
         <variablelist>
           <varlistentry>
             <term><option>account</option></term>
             <listitem>
               <para>
                 The twitter.com or identi.ca account name you wish to use to send this
                 message with.
               </para>
             </listitem>
           </varlistentry>
           <varlistentry>
             <term><option>password</option></term>
             <listitem>
               <para>
                 The twitter.com or identi.ca password for the account you wish to use
                 to send this message with.
               </para>
             </listitem>
           </varlistentry>
<varlistentry>
            <term><option>--action action</option></term>
            <listitem>
              <para>
Specify the action which you want to perform. Valid options
are "update" to send a message, "friends" to see your friends
timeline, "public" to track public timeline, "replies" to see
replies to your messages and "user" to see a specific user's
timeline.
              </para>
            </listitem>
           </varlistentry>
<varlistentry>
            <term><option>--user screenname</option></term>
            <listitem>
              <para>
Specify the user you want to see his/her messages while the
action is "user".
              </para>
            </listitem>
           </varlistentry>
           <varlistentry>
             <term><option>host</option></term>
             <listitem>
               <para>
The host you want to use to send the message to. Valid
options are either "twitter" or "identica" to send to
twitter.com or identi.ca respectively.
               </para>
             </listitem>
           </varlistentry>
           <varlistentry>
             <term><option>proxy</option></term>
             <listitem>
               <para>
The http proxy needed to send data out to the Internet.
               </para>
             </listitem>
           </varlistentry>
           <varlistentry>
             <term><option>logfile</option></term>
             <listitem>
               <para>
The logfile name for bti to write what happened to.
This file is relative to the user's home directory. If this
file is not specified here or on the command line, no logging
will be written to the disk.
               </para>
             </listitem>
           </varlistentry>
         </variablelist>
         <para>
           There is an example config file called
           <filename>bti.example</filename> in the source tree that shows
           the structure of the file if you need an example to work off of.
         </para>
         <para>
           Configuration options have the following priority:
</para>
         <variablelist>
           <varlistentry>
             <term></term>
             <listitem><para>command line option</para></listitem>
           </varlistentry>
           <varlistentry>
            <term></term>
            <listitem><para>config file option</para></listitem>
           </varlistentry>
           <varlistentry>
             <term></term>
             <listitem><para>environment variables</para></listitem>
           </varlistentry>
         </variablelist>
<para>
For example, command line options always override any config file
option, or any environment variables.
         </para>
       </refsect1>

       <refsect1><title>AUTHOR</title>
         <para>Written by Greg Kroah-Hartman <email>greg@kroah.com</email>.</para>
       </refsect1>

    </refentry>
  </section>
</article>
Something went wrong with that request. Please try again.