From 33aacebb0d72724b677447edd179b5f967024450 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Fri, 19 Jul 2013 23:09:25 -0400 Subject: [PATCH] Begin man page. --- doc/man1/twat.1 | 73 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 doc/man1/twat.1 diff --git a/doc/man1/twat.1 b/doc/man1/twat.1 new file mode 100644 index 0000000..a3e8992 --- /dev/null +++ b/doc/man1/twat.1 @@ -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. -- 2.43.2