Begin man page.
authorMichael Orlitzky <michael@orlitzky.com>
Sat, 20 Jul 2013 03:09:25 +0000 (23:09 -0400)
committerMichael Orlitzky <michael@orlitzky.com>
Sat, 20 Jul 2013 03:09:25 +0000 (23:09 -0400)
doc/man1/twat.1 [new file with mode: 0644]

diff --git a/doc/man1/twat.1 b/doc/man1/twat.1
new file mode 100644 (file)
index 0000000..a3e8992
--- /dev/null
@@ -0,0 +1,73 @@
+.TH twat 1
+
+.SH NAME
+twat \- Twat twats tweets so you don't have to Twitter.
+
+.SH SYNOPSIS
+
+\fBtwat\fR [\fBOPTIONS\fR] [\fBUSERNAMES\fR]
+
+.SH INPUT
+
+.P
+Twat takes no input proper; instead, it takes a list of usernames from
+either the command-line or the ~/.twatrc 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
+~/.twatrc), then sendmail will be used to email the new tweet to the
+specified \fIfrom\fR address.
+
+.SH DESCRIPTION
+
+.P
+Twat 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
+Twat 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
+twat:
+
+.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 ~/.twatrc 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.