From 9bda78b6de723f0cd67b68eaf268080e3dcf0d21 Mon Sep 17 00:00:00 2001 From: Andy Spencer Date: Mon, 21 Jan 2013 02:40:57 +0000 Subject: [PATCH] Update rhawk page --- tools/rhawk.md | 48 +++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 47 insertions(+), 1 deletion(-) diff --git a/tools/rhawk.md b/tools/rhawk.md index 039d63e..7fac8a8 100644 --- a/tools/rhawk.md +++ b/tools/rhawk.md @@ -1 +1,47 @@ -rhawk is a IRC bot written in.. well.. awk. +rhawk is a IRC bot written in GNU Awk. + +Source Code +----------- +Source code is available in git and [gitweb](/git/?p=~andy/rhawk) + + git clone git://pileus.org/~andy/rhawk + +Components +---------- +
+
rhawk
+
rhawk is the main awk script that starts up the IRC bot. It requires a + network connection as standard input and output. The suggested way to do + this is by using socat as shown in rhawk.sh
+ +
irc.awk
+

IRC protocol handling is done in the irc awk script. In addition to + the pure protocol things, irc.awk also provides some framework code to + handle starting, stopping, and reloading the client.

+ +

When included, the irc script will spawn a child instance of rhawk. + This is done so that the client can be reloaded without dropping the + existing IRC connection.

+ +
json.awk
+
A simple json parser is included, it has no external dependencies, so it + can be used by other awk scripts as well.
+ +
email.awk
+
The email component provides notifications to IRC users if someone says + their name while they are away.
+ +
spades.awk
+
Spades is a great card game. As such, rhawk lets you play spades by + joining the #rhspades channel on freenode.net and issuing the .newgame + command. Note, you'll have to get three other players as well. + The '.help spades' command provides a list of spades commands.
+
+ +rhsed +----- +Awk is a great language for writing an IRC bot. + +Sed, on the other hand, is not so a great at it. + +* [gitweb](/git/?p=~andy/rhawk;f=rhsed;a=blob) -- 2.43.2