Added -p option.

[irker.git] / irkerd.xml

diff --git a/irkerd.xml b/irkerd.xml
index bed806e522b1b00821b0dfc917cd266ee65224c6..345c05363a4b457d3e56a0f17642daa1abd7e6d2 100644 (file)
--- a/irkerd.xml
+++ b/irkerd.xml
@@ -19,6 +19,9 @@
 <cmdsynopsis>
   <command>irkerd</command>
      <arg>-d <replaceable>debuglevel</replaceable></arg>
+     <arg>-l <replaceable>logfile</replaceable></arg>
+     <arg>-n <replaceable>nick</replaceable></arg>
+     <arg>-p <replaceable>password</replaceable></arg>
      <arg>-V</arg>
 </cmdsynopsis>
 </refsynopsisdiv>
@@ -43,14 +46,21 @@ 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
 <application>irkerd</application> sends messages to the the default 6667 IRC
 port of each server.</para>
+
+<para>An empty message is legal and will cause 
+<application>irkerd</application> to join the target channels without
+actually emitting a message.  This may be useful for advertising that
+an instance is up and running.</para>
 </refsect1>
 
 <refsect1 id='options'><title>OPTIONS</title>
@@ -65,6 +75,26 @@ it. This option will generally only be of interest to developers;
 consult the source code for details.</para></listitem>
 </varlistentry>
 <varlistentry>
+<term>-l</term>
+<listitem><para>Takes a following filename, logs traffic to that file.
+Each log line consists of three |-separated fields; a numeric
+timestamp in Unix time, the fqdn of the sending server, and the
+message data.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-n</term>
+<listitem><para>Takes a following value, setting the nick
+to be used. If the nick contains a numeric format element
+(such as %03d) it is used to generate suffixed fallback names
+in the event of a nick collision.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-p</term>
+<listitem><para>Takes a following value, setting a nickserv
+password to be used. If given, this password is shipped to
+authenticate the nick on receipt of a welcom message.</para></listitem>
+</varlistentry>
+<varlistentry>
 <term>-V</term>
 <listitem><para>Write the program version to stdout and
 terminate.</para></listitem>
@@ -91,18 +121,25 @@ 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 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
+<application>irkerd</application> will turn payload strings with
 embedded newlines into multiple IRC sends to avoid having message data
 discarded. </para>
 </refsect1>
 
+<refsect1 id='see_also'><title>SEE ALSO</title>
+<para>
+<citerefentry><refentrytitle>irkerhook</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+</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>
+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>