Added -p option.

[irker.git] / irkerd.xml

diff --git a/irkerd.xml b/irkerd.xml
index 30108ed39357c27f10255f7c392d84e99ad6a2ef..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>
@@ -72,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>
@@ -98,7 +121,8 @@ 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 strings with