bti.xml

   1 <?xml version='1.0'?>
   2 <?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
   3 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   4   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   5
   6 <article>
   7   <section>
   8     <title>bti</title>
   9     <refentry>
  10       <refentryinfo>
  11         <title>bti</title>
  12         <date>May 2008</date>
  13         <productname>bti</productname>
  14       </refentryinfo>
  15
  16       <refmeta>
  17         <refentrytitle>bti</refentrytitle>
  18         <manvolnum>1</manvolnum>
  19         <refmiscinfo class="version"></refmiscinfo>
  20       </refmeta>
  21
  22       <refnamediv>
  23         <refname>bti</refname>
  24         <refpurpose>send a tweet to twitter.com or identi.ca from the command line</refpurpose>
  25       </refnamediv>
  26
  27       <refsynopsisdiv>
  28         <cmdsynopsis>
  29           <command>bti</command>
  30           <arg><option>--account account</option></arg>
  31           <arg><option>--password password</option></arg>
  32            <arg><option>--action action</option></arg>
  33            <arg><option>--user screenname</option></arg>
  34           <arg><option>--host HOST_NAME</option></arg>
  35           <arg><option>--proxy PROXY:PORT</option></arg>
  36           <arg><option>--logfile LOGFILE</option></arg>
  37           <arg><option>--config CONFIGFILE</option></arg>
  38           <arg><option>--replyto ID</option></arg>
  39           <arg><option>--retweet ID</option></arg>
  40           <arg><option>--page PAGENUMBER</option></arg>
  41           <arg><option>--bash</option></arg>
  42           <arg><option>--shrink-urls</option></arg>
  43           <arg><option>--debug</option></arg>
  44           <arg><option>--dry-run</option></arg>
  45           <arg><option>--verbose</option></arg>
  46           <arg><option>--version</option></arg>
  47           <arg><option>--help</option></arg>
  48         </cmdsynopsis>
  49       </refsynopsisdiv>
  50
  51       <refsect1><title>DESCRIPTION</title>
  52         <para>bti sends a tweet message to twitter.com or identi.ca.
  53         </para>
  54       </refsect1>
  55
  56       <refsect1><title>OPTIONS</title>
  57         <variablelist>
  58           <varlistentry>
  59             <term><option>--account account</option></term>
  60             <listitem>
  61               <para>
  62                 Specify the twitter.com or identi.ca account name.
  63               </para>
  64             </listitem>
  65           </varlistentry>
  66           <varlistentry>
  67             <term><option>--password password</option></term>
  68             <listitem>
  69               <para>
  70                 Specify the password of your twitter.com or identi.ca account.
  71               </para>
  72             </listitem>
  73           </varlistentry>
  74           <varlistentry>
  75             <term><option>--action action</option></term>
  76             <listitem>
  77               <para>
  78                 Specify the action which you want to perform.  Valid options
  79                 are "update" to send a message, "friends" to see your friends
  80                 timeline, "public" to track public timeline, "replies" to see
  81                 replies to your messages, "user" to see a specific user's
  82                 timeline and "direct" to send a direct message to a friend.
  83                 Default is "update".
  84               </para>
  85             </listitem>
  86           </varlistentry>
  87           <varlistentry>
  88             <term><option>--user screenname</option></term>
  89             <listitem>
  90               <para>
  91                 Specify the user whose messages you want to see when the
  92                 action is "user", and the reciever of the direct message when
  93                 the action is "direct" (the sender must be following the
  94                 receiver).
  95               </para>
  96             </listitem>
  97           </varlistentry>
  98           <varlistentry>
  99             <term><option>--host HOST_NAME</option></term>
 100             <listitem>
 101               <para>
 102                 Specify the host which you want to send your message to.  Valid
 103                 options are "twitter" to send to twitter.com and "identica" to
 104         send to identi.ca.
 105
 106         If you want to send the message to a custom StatusNet installation,
 107         you should specify the API URI. For example identi.ca's URI is:
 108         https://identi.ca/api/statuses
 109               </para>
 110               <para>
 111                 If no host is specified, the default is to send to twitter.com.
 112               </para>
 113             </listitem>
 114           </varlistentry>
 115           <varlistentry>
 116             <term><option>--proxy PROXY:PORT</option></term>
 117             <listitem>
 118               <para>
 119                 Specify a http proxy value.  This is not a required option, and
 120                 only needed by systems that are behind a http proxy.
 121               </para>
 122               <para>
 123                 If --proxy is not specified but the environment variable
 124                 'http_proxy' is set the latter will be used.
 125               </para>
 126             </listitem>
 127           </varlistentry>
 128           <varlistentry>
 129             <term><option>--logfile LOGFILE</option></term>
 130             <listitem>
 131               <para>
 132                 Specify a logfile for bti to write status messages to.  LOGFILE
 133                 is in relation to the user's home directory, not an absolute
 134                 path to a file.
 135               </para>
 136             </listitem>
 137           </varlistentry>
 138           <varlistentry>
 139             <term><option>--config CONFIGFILE</option></term>
 140             <listitem>
 141               <para>
 142                 Specify a config file for bti to read from.  By default, bti
 143                 looks in the ~/.bti file for config values.  This default
 144                 location can be overridden by setting a specific file with this
 145                 option.
 146               </para>
 147             </listitem>
 148           </varlistentry>
 149           <varlistentry>
 150             <term><option>--replyto ID</option></term>
 151             <listitem>
 152               <para>
 153                 Status ID of a single post to which you want to create a threaded
 154                 reply to.
 155               </para>
 156               <para>
 157                 For twitter, this is ignored unless the message starts with the
 158                 @name of the owner of the post with the status ID.
 159               </para>
 160               <para>
 161                 For status.net, this can link any two messages into context with
 162                 each other. Status.net will also link a message that contains an
 163                 @name without this without regard to context.
 164               </para>
 165             </listitem>
 166           </varlistentry>
 167           <varlistentry>
 168             <term><option>--retweet ID</option></term>
 169             <listitem>
 170               <para>
 171                 Status ID of a single post which you want to retweet.
 172               </para>
 173             </listitem>
 174           </varlistentry>
 175           <varlistentry>
 176             <term><option>--shrink-urls</option></term>
 177             <listitem>
 178               <para>
 179                 Scans the tweet text for valid URL patterns and passes each
 180                 through the supplied bti-shrink-urls script.  The script will
 181                 pass the URL to a web service that shrinks the URLs, making it
 182                 more suitable for micro-blogging.
 183               </para>
 184               <para>
 185                 The following URL shrinking services are available:
 186                 http://2tu.us/ (default) and http://bit.ly / http://j.mp
 187               </para>
 188               <para>
 189                 See the documentation for bti-shrink-urls for the configuration options.
 190               </para>
 191             </listitem>
 192           </varlistentry>
 193           <varlistentry>
 194             <term><option>--debug</option></term>
 195             <listitem>
 196               <para>Print a whole bunch of debugging messages to stdout.</para>
 197             </listitem>
 198           </varlistentry>
 199           <varlistentry>
 200             <term><option>--page PAGENUMBER</option></term>
 201             <listitem>
 202               <para>
 203                 When the action is to retrieve updates, it usually retrieves
 204                 only one page.  If this option is used, the page number can be
 205                 specified.
 206               </para>
 207             </listitem>
 208           </varlistentry>
 209           <varlistentry>
 210             <term><option>--dry-run</option></term>
 211             <listitem>
 212               <para>
 213                 Performs all steps that would normally be done for a given
 214                 action, but will not connect to the service to post or retrieve data.
 215               </para>
 216             </listitem>
 217           </varlistentry>
 218           <varlistentry>
 219             <term><option>--verbose</option></term>
 220             <listitem>
 221               <para>
 222                 Verbose mode. Print status IDs and timestamps.
 223               </para>
 224             </listitem>
 225           </varlistentry>
 226           <varlistentry>
 227             <term><option>--bash</option></term>
 228             <listitem>
 229               <para>
 230                  Add the working directory and a '$' in the tweet message to
 231                  help specify it is coming from a command line.  Don't put the
 232                  working directory and the '$' in the tweet message.
 233               </para>
 234
 235               <para>
 236                  This option implies <option>--background</option>.
 237               </para>
 238             </listitem>
 239           </varlistentry>
 240           <varlistentry>
 241             <term><option>--background</option></term>
 242             <listitem>
 243               <para>
 244                  Do not report back any errors that might have
 245                  happened when sending the message, and send it in the
 246                  background, returning immediately, allowing the user
 247                  to continue on.
 248                </para>
 249             </listitem>
 250           </varlistentry>
 251           <varlistentry>
 252             <term><option>--version</option></term>
 253             <listitem>
 254               <para>Print version number.</para>
 255             </listitem>
 256           </varlistentry>
 257           <varlistentry>
 258             <term><option>--help</option></term>
 259             <listitem>
 260               <para>Print help text.</para>
 261             </listitem>
 262           </varlistentry>
 263         </variablelist>
 264       </refsect1>
 265
 266       <refsect1>
 267         <title>DESCRIPTION</title>
 268         <para>
 269           bti provides an easy way to send tweet messages direct from the
 270           command line or any script.  It reads the message on standard
 271           input and uses the account and password settings either from the
 272           command line options, or from a config file, to send the message
 273           out.
 274         </para>
 275         <para>
 276           Its primary focus is to allow you to log everything that you
 277           type into a bash shell, in a crazy, "this is what I'm doing right
 278           now!" type of way, letting the world follow along with you
 279           constant moving between directories and refreshing your email
 280           queue to see if there's anything interesting going on.
 281         </para>
 282         <para>
 283           To hook bti up to your bash shell, export the following variable:
 284         </para>
 285         <para>
 286             <literal>  PROMPT_COMMAND='history 1 | sed -e "s/^\s*[0-9]*\s*//" | bti --bash'</literal>
 287         </para>
 288         <para>
 289           This example assumes that you have the
 290           <filename>~/.bti</filename> set up with your account and password
 291           information already in it, otherwise you can specify them as an
 292           option.
 293         </para>
 294        </refsect1>
 295
 296        <refsect1>
 297          <title>CONFIGURATION</title>
 298          <para>
 299            The account and password can be stored in a configuration file
 300            in the users home directory in a file named
 301            <filename>.bti</filename>.  The structure of this file is as
 302            follows:
 303          </para>
 304          <variablelist>
 305            <varlistentry>
 306              <term><option>account</option></term>
 307              <listitem>
 308                <para>
 309                  The twitter.com or identi.ca account name you wish to use to send this
 310                  message with.
 311                </para>
 312              </listitem>
 313            </varlistentry>
 314            <varlistentry>
 315              <term><option>password</option></term>
 316              <listitem>
 317                <para>
 318                  The twitter.com or identi.ca password for the account you wish to use
 319                  to send this message with.
 320                </para>
 321              </listitem>
 322            </varlistentry>
 323            <varlistentry>
 324             <term><option>--action action</option></term>
 325             <listitem>
 326               <para>
 327                 Specify the action which you want to perform.  Valid options
 328                 are "update" to send a message, "friends" to see your friends
 329                 timeline, "public" to track public timeline, "replies" to see
 330                 replies to your messages and "user" to see a specific user's
 331                 timeline.
 332               </para>
 333             </listitem>
 334            </varlistentry>
 335            <varlistentry>
 336             <term><option>--user screenname</option></term>
 337             <listitem>
 338               <para>
 339                 Specify the user you want to see his/her messages while the
 340                 action is "user".
 341               </para>
 342             </listitem>
 343            </varlistentry>
 344            <varlistentry>
 345              <term><option>host</option></term>
 346              <listitem>
 347                <para>
 348                  The host you want to use to send the message to.  Valid
 349                  options are either "twitter" or "identica" to send to
 350                  twitter.com or identi.ca respectively.
 351
 352          If you want to send the message to a custom StatusNet installation,
 353          you should specify the API URI. For example identi.ca's URI is:
 354          https://identi.ca/api/statuses.
 355                </para>
 356              </listitem>
 357            </varlistentry>
 358            <varlistentry>
 359              <term><option>proxy</option></term>
 360              <listitem>
 361                <para>
 362                  The http proxy needed to send data out to the Internet.
 363                </para>
 364              </listitem>
 365            </varlistentry>
 366            <varlistentry>
 367              <term><option>logfile</option></term>
 368              <listitem>
 369                <para>
 370                  The logfile name for bti to write what happened to.
 371                  This file is relative to the user's home directory.  If this
 372                  file is not specified here or on the command line, no logging
 373                  will be written to the disk.
 374                </para>
 375              </listitem>
 376            </varlistentry>
 377            <varlistentry>
 378              <term><option>replyto</option></term>
 379              <listitem>
 380                <para>
 381                  The status ID to which all notices will be linked to.
 382                </para>
 383                <para>
 384                  There is no sane reason for a need to have this set in a
 385                  config file. One such reason is to have all your messages
 386                  as children to a particular status.
 387                </para>
 388              </listitem>
 389            </varlistentry>
 390            <varlistentry>
 391              <term><option>shrink-urls</option></term>
 392              <listitem>
 393                <para>
 394                  Setting this variable to 'true' or 'yes' will enable the URL
 395                  shrinking feature.  This is equivalent to using the
 396                  --shrink-urls option.
 397                </para>
 398              </listitem>
 399            </varlistentry>
 400            <varlistentry>
 401              <term><option>verbose</option></term>
 402              <listitem>
 403                <para>
 404                    Setting this variable to 'true' or 'yes' will enable the
 405                    verbose mode.
 406                </para>
 407              </listitem>
 408            </varlistentry>
 409         </variablelist>
 410          <para>
 411            There is an example config file in
 412            <filename>/usr/share/doc/bti/examples/bti.example</filename> that shows
 413            the structure of the file.
 414          </para>
 415          <para>
 416            Configuration options have the following priority:
 417          </para>
 418          <variablelist>
 419            <varlistentry>
 420              <term></term>
 421              <listitem><para>command line option</para></listitem>
 422            </varlistentry>
 423            <varlistentry>
 424             <term></term>
 425             <listitem><para>config file option</para></listitem>
 426            </varlistentry>
 427            <varlistentry>
 428              <term></term>
 429              <listitem><para>environment variables</para></listitem>
 430            </varlistentry>
 431          </variablelist>
 432          <para>
 433            For example, command line options always override any config file
 434            option, or any environment variables.  Unless a config file is
 435            specified by the command line.  At that point, the new config file is
 436            read, and any previous options set by a command line option, would be
 437            overridden.
 438          </para>
 439        </refsect1>
 440
 441        <refsect1><title>AUTHOR</title>
 442          <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>
 443        </refsect1>
 444
 445     </refentry>
 446   </section>
 447 </article>