Good thing we do a smoke test before release.

[irker.git] / irkerd.xml

diff --git a/irkerd.xml b/irkerd.xml
index 1b63d205cd993e1ee99aadf46e8e10a265b21662..0e5b296b47e0e139ae98fbda3c2a8fbd87134457 100644 (file)
--- a/irkerd.xml
+++ b/irkerd.xml
@@ -1,13 +1,13 @@
 <!DOCTYPE refentry PUBLIC 
    "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "docbook/docbookx.dtd">
-<refentry id='irkerd.1'>
+<refentry id='irkerd.8'>
 <refmeta>
 <refentrytitle>irkerd</refentrytitle>
-<manvolnum>1</manvolnum>
+<manvolnum>8</manvolnum>
 <refmiscinfo class='date'>Aug 27 2012</refmiscinfo>
-<refmiscinfo class='source'>irkerd</refmiscinfo>
-<refmiscinfo class='product'>irkerd</refmiscinfo>
+<refmiscinfo class='source'>irker</refmiscinfo>
+<refmiscinfo class='product'>irker</refmiscinfo>
 <refmiscinfo class='manual'>Commands</refmiscinfo>
 </refmeta>
 <refnamediv id='name'>
@@ -34,7 +34,7 @@ notifications from commit hooks in version-control systems.</para>
 listens on for UDP or TCP packets on port 6659 for textual request
 lines containing JSON objects and terminated by a newline. Each JSON
 object must have two members: "to" specifying a destination or
-destination list, and "privmsg" specifying the message test.
+destination list, and "privmsg" specifying the message text.
 Examples:
 
 <programlisting>
@@ -43,9 +43,11 @@ Examples:
 {"to":"irc://chat.hypothetical.net:6668/git-ciabot", "privmsg":"Hello, world!"}
 </programlisting></para>
 
-<para>If the channel part of the URL does not have one of the prefix characters
-<quote>#</quote>, <quote>&amp;</quote>, or <quote>+</quote>, a <quote>#</quote>
-will be prepended to it before shipping.</para>
+<para>If the channel part of the URL does not have one of the prefix
+characters <quote>#</quote>, <quote>&amp;</quote>, or
+<quote>+</quote>, a <quote>#</quote> will be prepended to it before
+shipping - <emphasis>unless</emphasis>the channel part has the suffix
+",isnick" (which is unconditionally removed).</para>
 
 <para>The host part of the URL may have a port-number suffix separated by a
 colon, as shown in the third example; otherwise
@@ -91,16 +93,19 @@ known to spew spam is always a good idea.</para>
 If you think you need to do that, you have a problem better solved at
 your firewall.</para>
 
-<para>IRC has a message length limit of 510 bytes and ignores any text
-after an embedded \n; generate your privmsg attribute values with
-appropriate care.</para> 
+<para>IRC has a message length limit of 510 bytes generate your privmsg attribute values with appropriate care.</para>
+
+<para>IRC ignores any text after an embedded newline. Be aware that
+<application>irkerd</application> will turn payload strungs with
+embedded newlines into multiple IRC sends to avoid having message data
+discarded. </para>
 </refsect1>
 
 <refsect1 id='authors'><title>AUTHOR</title>
 <para>Eric S. Raymond <email>esr@snark.thyrsus.com</email>.  See the
 project page at <ulink
-url='http://www.catb.org/~esr/'>http://www.catb.org/~esr/irker</ulink>
-for updates and other resources, including an insrtallable repository
+url='http://www.catb.org/~esr/irker'>http://www.catb.org/~esr/irker</ulink>
+for updates and other resources, including an installable repository
 hook script. The implementation uses the Python IRC library by Joe
 Rosdahl and Jason R. Coombs.</para>
 </refsect1>