bti.xml

   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>--action action</option></arg>
  32            <arg><option>--user screenname</option></arg>
  33           <arg><option>--host HOST_NAME</option></arg>
  34           <arg><option>--proxy PROXY:PORT</option></arg>
  35           <arg><option>--logfile LOGFILE</option></arg>
  36           <arg><option>--page PAGENUMBER</option></arg>
  37           <arg><option>--bash</option></arg>
  38           <arg><option>--shrink-urls</option></arg>
  39           <arg><option>--debug</option></arg>
  40           <arg><option>--dry-run</option></arg>
  41           <arg><option>--verbose</option></arg>
  42           <arg><option>--version</option></arg>
  43           <arg><option>--help</option></arg>
  44         </cmdsynopsis>
  45       </refsynopsisdiv>
  46
  47       <refsect1><title>DESCRIPTION</title>
  48         <para>bti sends a tweet message to twitter.com or identi.ca.
  49         </para>
  50       </refsect1>
  51
  52       <refsect1><title>OPTIONS</title>
  53         <variablelist>
  54           <varlistentry>
  55             <term><option>--account account</option></term>
  56             <listitem>
  57               <para>
  58                 Specify the twitter.com or identi.ca account name.
  59               </para>
  60             </listitem>
  61           </varlistentry>
  62           <varlistentry>
  63             <term><option>--password password</option></term>
  64             <listitem>
  65               <para>
  66                 Specify the password of your twitter.com or identi.ca account.
  67               </para>
  68             </listitem>
  69           </varlistentry>
  70           <varlistentry>
  71             <term><option>--action action</option></term>
  72             <listitem>
  73               <para>
  74                 Specify the action which you want to perform.  Valid options
  75                 are "update" to send a message, "friends" to see your friends
  76                 timeline, "public" to track public timeline, "replies" to see
  77                 replies to your messages and "user" to see a specific user's
  78                 timeline.
  79               </para>
  80             </listitem>
  81           </varlistentry>
  82           <varlistentry>
  83             <term><option>--user screenname</option></term>
  84             <listitem>
  85               <para>
  86                 Specify the user you want to see his/her messages while the
  87                 action is "user".
  88               </para>
  89             </listitem>
  90           </varlistentry>
  91           <varlistentry>
  92             <term><option>--host HOST_NAME</option></term>
  93             <listitem>
  94               <para>
  95                 Specify the host which you want to send your message to.  Valid
  96                 options are "twitter" to send to twitter.com and "identica" to
  97         send to identi.ca.
  98
  99         If you want to send the message to a custom laconi.ca installation,
 100         you should specify the API URI. For example identi.ca's URI is:
 101         https://identi.ca/api/statuses
 102               </para>
 103             </listitem>
 104           </varlistentry>
 105           <varlistentry>
 106             <term><option>--proxy PROXY:PORT</option></term>
 107             <listitem>
 108               <para>
 109                 Specify a http proxy value.  This is not a required option, and
 110                 only needed by systems that are behind a http proxy.
 111               </para>
 112               <para>
 113                 If --proxy is not specified but the environment variable
 114                 'http_proxy' is set the latter will be used.
 115               </para>
 116             </listitem>
 117           </varlistentry>
 118           <varlistentry>
 119             <term><option>--logfile LOGFILE</option></term>
 120             <listitem>
 121               <para>
 122                 Specify a logfile for bti to write status messages to.  LOGFILE
 123                 is in relation to the user's home directory, not an absolute
 124                 path to a file.
 125               </para>
 126             </listitem>
 127           </varlistentry>
 128           <varlistentry>
 129             <term><option>--shrink-urls</option></term>
 130             <listitem>
 131               <para>
 132                 Scans the tweet text for valid URL patterns and passes each
 133                 through the supplied bti-shrink-urls script.  The script will
 134                 pass the URL to a web service that shrinks the URLs, making it
 135                 more suitable for micro-blogging.
 136               </para>
 137               <para>
 138                 Currently, only http://2tu.us/ is used as a URL shrinking service.
 139               </para>
 140             </listitem>
 141           </varlistentry>
 142           <varlistentry>
 143             <term><option>--debug</option></term>
 144             <listitem>
 145               <para>Print a whole bunch of debugging messages to stdout.</para>
 146             </listitem>
 147           </varlistentry>
 148           <varlistentry>
 149             <term><option>--page PAGENUMBER</option></term>
 150             <listitem>
 151               <para>
 152                 When the action is to retrieve updates, it usually retrieves
 153                 only one page.  If this option is used, the page number can be
 154                 specified.
 155               </para>
 156             </listitem>
 157           </varlistentry>
 158           <varlistentry>
 159             <term><option>--dry-run</option></term>
 160             <listitem>
 161               <para>
 162                 Performs all steps that would normally be done for a given
 163                 action, but will not connect to the service to post or retrieve data.
 164               </para>
 165             </listitem>
 166           </varlistentry>
 167           <varlistentry>
 168             <term><option>--verbose</option></term>
 169             <listitem>
 170               <para>
 171                 Verbose mode
 172               </para>
 173             </listitem>
 174           </varlistentry>
 175           <varlistentry>
 176             <term><option>--bash</option></term>
 177             <listitem>
 178               <para>
 179                  Add the working directory and a '$' in the tweet message to
 180                  help specify it is coming from a command line.  Don't put the
 181                  working directory and the '$' in the tweet message.
 182               </para>
 183               <para>
 184                  This mode also does not report back any errors that might have
 185                  happened when sending the message, and it sends it in the
 186                  background, returning immediately, allowing the process to
 187                  continue on.
 188                </para>
 189             </listitem>
 190           </varlistentry>
 191           <varlistentry>
 192             <term><option>--version</option></term>
 193             <listitem>
 194               <para>Print version number.</para>
 195             </listitem>
 196           </varlistentry>
 197           <varlistentry>
 198             <term><option>--help</option></term>
 199             <listitem>
 200               <para>Print help text.</para>
 201             </listitem>
 202           </varlistentry>
 203         </variablelist>
 204       </refsect1>
 205
 206       <refsect1>
 207         <title>DESCRIPTION</title>
 208         <para>
 209           bti provides an easy way to send tweet messages direct from the
 210           command line or any script.  It reads the message on standard
 211           input and uses the account and password settings either from the
 212           command line options, or from a config file, to send the message
 213           out.
 214         </para>
 215         <para>
 216           It's primary focus is to allow you to log everything that you
 217           type into a bash shell, in a crazy, "this is what I'm doing right
 218           now!" type of way, letting the world follow along with you
 219           constant moving between directories and refreshing your email
 220           queue to see if there's anything interesting going on.
 221         </para>
 222         <para>
 223           To hook bti up to your bash shell, export the following variable:
 224         </para>
 225         <para>
 226             <literal>  PROMPT_COMMAND='history 1 | sed -e "s/^\s*[0-9]*\s*//" | bti --bash'</literal>
 227         </para>
 228         <para>
 229           This example assumes that you have the
 230           <filename>~/.bti</filename> set up with your account and password
 231           information already in it, otherwise you can specify them as an
 232           option.
 233         </para>
 234        </refsect1>
 235
 236        <refsect1>
 237          <title>CONFIGURATION</title>
 238          <para>
 239            The account and password can be stored in a configuration file
 240            in the users home directory in a file named
 241            <filename>.bti</filename>  The structure of this file is as
 242            follows:
 243          </para>
 244          <variablelist>
 245            <varlistentry>
 246              <term><option>account</option></term>
 247              <listitem>
 248                <para>
 249                  The twitter.com or identi.ca account name you wish to use to send this
 250                  message with.
 251                </para>
 252              </listitem>
 253            </varlistentry>
 254            <varlistentry>
 255              <term><option>password</option></term>
 256              <listitem>
 257                <para>
 258                  The twitter.com or identi.ca password for the account you wish to use
 259                  to send this message with.
 260                </para>
 261              </listitem>
 262            </varlistentry>
 263            <varlistentry>
 264             <term><option>--action action</option></term>
 265             <listitem>
 266               <para>
 267                 Specify the action which you want to perform.  Valid options
 268                 are "update" to send a message, "friends" to see your friends
 269                 timeline, "public" to track public timeline, "replies" to see
 270                 replies to your messages and "user" to see a specific user's
 271                 timeline.
 272               </para>
 273             </listitem>
 274            </varlistentry>
 275            <varlistentry>
 276             <term><option>--user screenname</option></term>
 277             <listitem>
 278               <para>
 279                 Specify the user you want to see his/her messages while the
 280                 action is "user".
 281               </para>
 282             </listitem>
 283            </varlistentry>
 284            <varlistentry>
 285              <term><option>host</option></term>
 286              <listitem>
 287                <para>
 288                  The host you want to use to send the message to.  Valid
 289                  options are either "twitter" or "identica" to send to
 290                  twitter.com or identi.ca respectively.
 291
 292          If you want to send the message to a custom laconi.ca installation,
 293          you should specify the API URI. For example identi.ca's URI is:
 294          https://identi.ca/api/statuses.
 295                </para>
 296              </listitem>
 297            </varlistentry>
 298            <varlistentry>
 299              <term><option>proxy</option></term>
 300              <listitem>
 301                <para>
 302                  The http proxy needed to send data out to the Internet.
 303                </para>
 304              </listitem>
 305            </varlistentry>
 306            <varlistentry>
 307              <term><option>logfile</option></term>
 308              <listitem>
 309                <para>
 310                  The logfile name for bti to write what happened to.
 311                  This file is relative to the user's home directory.  If this
 312                  file is not specified here or on the command line, no logging
 313                  will be written to the disk.
 314                </para>
 315              </listitem>
 316            </varlistentry>
 317            <varlistentry>
 318              <term><option>shrink-urls</option></term>
 319              <listitem>
 320                <para>
 321                  Setting this variable to 'true' or 'yes' will enable the URL
 322                  shrinking feature.  This is equivalent to using the
 323                  --shrink-urls option.
 324                </para>
 325              </listitem>
 326            </varlistentry>
 327            <varlistentry>
 328              <term><option>verbose</option></term>
 329              <listitem>
 330                <para>
 331                    Setting this variable to 'true' or 'yes' will enable the
 332                    verbose mode.
 333                </para>
 334              </listitem>
 335            </varlistentry>
 336         </variablelist>
 337          <para>
 338            There is an example config file called
 339            <filename>bti.example</filename> in the source tree that shows
 340            the structure of the file if you need an example to work off of.
 341          </para>
 342          <para>
 343            Configuration options have the following priority:
 344          </para>
 345          <variablelist>
 346            <varlistentry>
 347              <term></term>
 348              <listitem><para>command line option</para></listitem>
 349            </varlistentry>
 350            <varlistentry>
 351             <term></term>
 352             <listitem><para>config file option</para></listitem>
 353            </varlistentry>
 354            <varlistentry>
 355              <term></term>
 356              <listitem><para>environment variables</para></listitem>
 357            </varlistentry>
 358          </variablelist>
 359          <para>
 360            For example, command line options always override any config file
 361            option, or any environment variables.
 362          </para>
 363        </refsect1>
 364
 365        <refsect1><title>AUTHOR</title>
 366          <para>Written by Greg Kroah-Hartman &lt;<email>greg@kroah.com</email>&gt; and Amir Mohammad Saied &lt;<email>amirsaied@gmail.com</email>&gt;.</para>
 367        </refsect1>
 368
 369     </refentry>
 370   </section>
 371 </article>