From: Eric S. Raymond <esr@thyrsus.com>
Date: Mon, 27 Aug 2012 20:18:34 +0000 (-0400)
Subject: Start of a manual page.
X-Git-Tag: 1.0~89
X-Git-Url: http://git.tremily.us/gitweb.cgi?a=commitdiff_plain;h=40447a4bb75ef80b787b79a2393781e999053ca5;p=irker.git

Start of a manual page.
---

diff --git a/irker.xml b/irker.xml
new file mode 100644
index 0000000..ea24347
--- /dev/null
+++ b/irker.xml
@@ -0,0 +1,61 @@
+<!DOCTYPE refentry PUBLIC 
+   "-//OASIS//DTD DocBook XML V4.1.2//EN"
+   "docbook/docbookx.dtd">
+<refentry id='irker.1'>
+<refmeta>
+<refentrytitle>irker</refentrytitle>
+<manvolnum>8</manvolnum>
+<refmiscinfo class='date'>Aug 27 2012</refmiscinfo>
+<refmiscinfo class='source'>irker</refmiscinfo>
+<refmiscinfo class='product'>irker</refmiscinfo>
+<refmiscinfo class='manual'>Commands</refmiscinfo>
+</refmeta>
+<refnamediv id='name'>
+<refname>irker</refname>
+<refpurpose>relay for shipping notifications to IRC servers</refpurpose>
+</refnamediv>
+<refsynopsisdiv id='synopsis'>
+
+<cmdsynopsis>
+  <command>irker</command>
+     <option>-t</option>
+     <option>-p <replaceable>number</replaceable></option>
+     <option>-n <replaceable>namesuffix</replaceable></option>
+     <option>-d <replaceable>debuglevel</replaceable></option>
+     <option>-V</option>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1 id='description'><title>DESCRIPTION</title>
+
+<para><application>irker</application> 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.</para>
+
+<para><application>irker</application> 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:
+
+<programlisting>
+{"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"}
+</programlisting>
+</para>
+
+</refsect1>
+
+<refsect1 id='authors'><title>AUTHORS</title>
+<para>Eric S. Raymond &lt;esr@snark.thyrsus.com&gt;.  See ESR's home
+page at <ulink
+url='http://www.catb.org/~esr/'>http://www.catb.org/~esr/</ulink> for
+updates and other resources.</para>
+</refsect1>
+
+<refsect1 id='bugs'><title>LIMITATIONS</title>
+<para></para>
+</refsect1>
+</refentry>
+