X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fman1%2Fhalcyon.1;fp=doc%2Fman1%2Fhalcyon.1;h=743b55b086f3edcfd50d0d687e8c03bf832116bd;hb=f519b55ffe72acd791bdc91b16918603afce1995;hp=0000000000000000000000000000000000000000;hpb=fa3bc2f624f7a7bd6b02e7bfb9fc508150074063;p=dead%2Fhalcyon.git

diff --git a/doc/man1/halcyon.1 b/doc/man1/halcyon.1
new file mode 100644
index 0000000..743b55b
--- /dev/null
+++ b/doc/man1/halcyon.1
@@ -0,0 +1,74 @@
+.TH halcyon 1
+
+.SH NAME
+halcyon \- Halcyon monitors a list of Twitter accounts and displays or
+emails any new tweets.
+
+.SH SYNOPSIS
+
+\fBhalcyon\fR [\fBOPTIONS\fR] [\fBUSERNAMES\fR]
+
+.SH INPUT
+
+.P
+Halcyon takes no input proper; instead, it takes a list of usernames from
+either the command-line or the ~/.halcyonrc file, and watches those
+users' timelines.
+
+.SH OUTPUT
+
+.P
+Any new tweets from watched users are written to stdout. If to/from
+email addresses are provided (either on the command-line or in
+~/.halcyonrc), then sendmail will be used to email the new tweet to the
+specified \fIfrom\fR address.
+
+.SH DESCRIPTION
+
+.P
+Halcyon watches a list of Twitter timelines, and writes any new tweets to
+stdout. It can also optionally email the new tweets to a given email
+address.
+.P
+New tweets are gathered at a fixed interval, specified in seconds by
+the \fB\-\-heartbeat\fR (default: 600) option.
+.P
+Halcyon uses the Twitter API, which now requires you to have a developer
+account. You can sign up for free at https://dev.twitter.com/. Once
+you have done this, you can authorize your own account to access
+itself. You will then be given four tokens, which need to be fed to
+halcyon:
+
+.IP \[bu] 2
+Consumer Key
+.IP \[bu]
+Consumer Secret
+.IP \[bu]
+Access Token
+.IP \[bu]
+Access Secret
+
+.SH OPTIONS
+
+.IP \fB\-\-consumer-key\fR
+Your Twitter API consumer key.
+
+.IP \fB\-\-consumer-secret\fR
+Your Twitter API consumer secret.
+
+.IP \fB\-\-access-token\fR
+Your Twitter API access token.
+
+.IP \fB\-\-access-secret\fR
+Your Twitter API access secret.
+
+.SH CONFIGURATION FILE
+
+.P
+The file ~/.halcyonrc can contain any of the options (and usernames)
+that would otherwise be specified on the command-line.
+
+.SH BUGS
+
+.P
+Send bugs to michael@orlitzky.com.