From 40447a4bb75ef80b787b79a2393781e999053ca5 Mon Sep 17 00:00:00 2001 From: "Eric S. Raymond" Date: Mon, 27 Aug 2012 16:18:34 -0400 Subject: [PATCH] Start of a manual page. --- irker.xml | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 irker.xml diff --git a/irker.xml b/irker.xml new file mode 100644 index 0000000..ea24347 --- /dev/null +++ b/irker.xml @@ -0,0 +1,61 @@ + + + +irker +8 +Aug 27 2012 +irker +irker +Commands + + +irker +relay for shipping notifications to IRC servers + + + + + irker + + + + + + + + +DESCRIPTION + +irker is a specialized write-only IRC +client intended to be used for shipping notification messages to IRC +channels. The use case in mind when it was designed was broadcasting +notifications from commit hooks in version-control systems. + +irker is a socket server that listens +on a UDP or TCP port (normally UDP port 4747) for textual request +lines containing JSON objects and terminated by a newline. Each JSON +object must have exactly two members: "to" specifying a destination or +destination list, and "privmsg" specifying the message test. Examples: + + +{"to":"irc://chat.freenode.net/git-ciabot", "privmsg":"Hello, world!"} +{"to":["irc://chat.freenode.net/git-ciabot","irc://chat.freenode.net/gpsd"],"privmsg":"Multichannel test"} + + + + + +AUTHORS +Eric S. Raymond <esr@snark.thyrsus.com>. See ESR's home +page at http://www.catb.org/~esr/ for +updates and other resources. + + +LIMITATIONS + + + + -- 2.26.2