doc/man1/halcyon.1

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