doc/man1/twat.1

   1 .TH twat 1
   2
   3 .SH NAME
   4 twat \- Twat twats tweets so you don't have to Twitter.
   5
   6 .SH SYNOPSIS
   7
   8 \fBtwat\fR [\fBOPTIONS\fR] [\fBUSERNAMES\fR]
   9
  10 .SH INPUT
  11
  12 .P
  13 Twat takes no input proper; instead, it takes a list of usernames from
  14 either the command-line or the ~/.twatrc file, and watches those
  15 users' timelines.
  16
  17 .SH OUTPUT
  18
  19 .P
  20 Any new tweets from watched users are written to stdout. If to/from
  21 email addresses are provided (either on the command-line or in
  22 ~/.twatrc), then sendmail will be used to email the new tweet to the
  23 specified \fIfrom\fR address.
  24
  25 .SH DESCRIPTION
  26
  27 .P
  28 Twat watches a list of Twitter timelines, and writes any new tweets to
  29 stdout. It can also optionally email the new tweets to a given email
  30 address.
  31 .P
  32 New tweets are gathered at a fixed interval, specified in seconds by
  33 the \fB\-\-heartbeat\fR (default: 600) option.
  34 .P
  35 Twat uses the Twitter API, which now requires you to have a developer
  36 account. You can sign up for free at https://dev.twitter.com/. Once
  37 you have done this, you can authorize your own account to access
  38 itself. You will then be given four tokens, which need to be fed to
  39 twat:
  40
  41 .IP \[bu] 2
  42 Consumer Key
  43 .IP \[bu]
  44 Consumer Secret
  45 .IP \[bu]
  46 Access Token
  47 .IP \[bu]
  48 Access Secret
  49
  50 .SH OPTIONS
  51
  52 .IP \fB\-\-consumer-key\fR
  53 Your Twitter API consumer key.
  54
  55 .IP \fB\-\-consumer-secret\fR
  56 Your Twitter API consumer secret.
  57
  58 .IP \fB\-\-access-token\fR
  59 Your Twitter API access token.
  60
  61 .IP \fB\-\-access-secret\fR
  62 Your Twitter API access secret.
  63
  64 .SH CONFIGURATION FILE
  65
  66 .P
  67 The file ~/.twatrc can contain any of the options (and usernames) that
  68 would otherwise be specified on the command-line.
  69
  70 .SH BUGS
  71
  72 .P
  73 Send bugs to michael@orlitzky.com.