Rename the project to Halcyon.

[dead/halcyon.git] / doc / man1 / halcyon.1

diff --git a/doc/man1/twat.1 b/doc/man1/halcyon.1
similarity index 62%
rename from doc/man1/twat.1
rename to doc/man1/halcyon.1
index a3e89927eb84bc7ecba4f1d966724a634b6fee88..743b55b086f3edcfd50d0d687e8c03bf832116bd 100644 (file)
--- a/doc/man1/twat.1
+++ b/doc/man1/halcyon.1
@@ -1,17 +1,18 @@
-.TH twat 1
+.TH halcyon 1

 
 .SH NAME
 
 .SH NAME

-twat \- Twat twats tweets so you don't have to Twitter.
+halcyon \- Halcyon monitors a list of Twitter accounts and displays or
+emails any new tweets.

 
 .SH SYNOPSIS
 
 
 .SH SYNOPSIS
 

-\fBtwat\fR [\fBOPTIONS\fR] [\fBUSERNAMES\fR]
+\fBhalcyon\fR [\fBOPTIONS\fR] [\fBUSERNAMES\fR]

 
 .SH INPUT
 
 .P
 
 .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
+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
 users' timelines.
 
 .SH OUTPUT


@@ -19,24 +20,24 @@ users' timelines.
 .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
 .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
+~/.halcyonrc), then sendmail will be used to email the new tweet to the

 specified \fIfrom\fR address.
 
 .SH DESCRIPTION
 
 .P
 specified \fIfrom\fR address.
 
 .SH DESCRIPTION
 
 .P

-Twat watches a list of Twitter timelines, and writes any new tweets to
+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
 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
+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
 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:
+halcyon:

 
 .IP \[bu] 2
 Consumer Key
 
 .IP \[bu] 2
 Consumer Key


@@ -64,8 +65,8 @@ Your Twitter API access secret.
 .SH CONFIGURATION FILE
 
 .P
 .SH CONFIGURATION FILE
 
 .P

-The file ~/.twatrc can contain any of the options (and usernames) that
-would otherwise be specified on the command-line.
+The file ~/.halcyonrc can contain any of the options (and usernames)
+that would otherwise be specified on the command-line.

 
 .SH BUGS
 
 
 .SH BUGS