Version bump for release.

[irker.git] / irkerd.xml

diff --git a/irkerd.xml b/irkerd.xml
index 00e7bc2ba4e6b86f7c9852258a4b7adc895adf91..fe60c876830f3d0084c450d02bc88bfb217e0b51 100644 (file)
--- a/irkerd.xml
+++ b/irkerd.xml
@@ -20,7 +20,9 @@
   <command>irkerd</command>
      <arg>-c <replaceable>ca-file</replaceable></arg>
      <arg>-d <replaceable>debuglevel</replaceable></arg>
+     <arg>-e <replaceable>cert-file</replaceable></arg>
      <arg>-l <replaceable>logfile</replaceable></arg>
+     <arg>-H <replaceable>host</replaceable></arg>
      <arg>-n <replaceable>nick</replaceable></arg>
      <arg>-p <replaceable>password</replaceable></arg>
      <arg>-i <replaceable>IRC-URL</replaceable></arg>
@@ -60,7 +62,7 @@ Examples:
 <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
+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
@@ -129,13 +131,27 @@ joining a channel to log its traffic.</para>
     non-matches for background processes).  We assume you aren't
     running <application>irkerd</application> in Windows or another OS
     that doesn't support <quote>os.getpgrp</quote> or
-    <quote>tcgetpgrp</quote> or <quote>.  We also assume that you have
-    stdout attached to a TTY (and haven't closed or redirected it).
-    We also assume that if stdout is attached to a TTY associated with
-    the same process group as <application>irkerd</application>, you
-    do intend to log to stderr and not syslog.
+    <quote>tcgetpgrp</quote>.  We assume that if stdout is attached to
+    a TTY associated with the same process group as
+    <application>irkerd</application>, you do intend to log to stderr
+    and not syslog.
   </para>
-</refsect1>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-e</term>
+<listitem><para>Takes a following filename in pem format and uses it
+to authenticate to the IRC server.  You must be connecting to the IRC server
+over SSL for this to function properly.  This is commonly known as
+<quote>CertFP.</quote>
+</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-e</term>
+<listitem><para>Takes a following filename in pem format and uses it
+to authenticate to the IRC server.  You must be connecting to the IRC
+server over SSL for this to function properly.  This is commonly known
+as <quote>CertFP.</quote></para>
 </listitem>
 </varlistentry>
 <varlistentry>
@@ -146,6 +162,15 @@ timestamp in Unix time, the FQDN of the sending server, and the
 message data.</para></listitem>
 </varlistentry>
 <varlistentry>
+<term>-H</term>
+<listitem><para>Takes a following hostname, and binds to that address
+when listening for messages.  <application>irkerd</application> binds
+to localhost by default, but you may want to use your host's public
+address to listen on a local network.  Listening on a public interface
+is not recommended, as it makes spamming IRC channels very
+easy.</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
@@ -174,6 +199,7 @@ terminate.</para></listitem>
 <listitem><para>Print usage instructions and terminate.</para></listitem>
 </varlistentry>
 </variablelist>
+</refsect1>
 
 <refsect1 id='limitations'><title>LIMITATIONS</title>
 <para>Requests via UDP optimizes for lowest latency and network load