irkerd: Add command-line options for the listener --host and --port

[irker.git] / irkerd.xml

diff --git a/irkerd.xml b/irkerd.xml
index caf36af532aa6cdb648b3936b9add8a04cf60773..b05202b07815d6a871ebbc21f540767196133961 100644 (file)
--- a/irkerd.xml
+++ b/irkerd.xml
@@ -21,6 +21,8 @@
      <arg>-c <replaceable>ca-file</replaceable></arg>
      <arg>-d <replaceable>debuglevel</replaceable></arg>
      <arg>-l <replaceable>logfile</replaceable></arg>
+     <arg>-H <replaceable>host</replaceable></arg>
+     <arg>-P <replaceable>port</replaceable></arg>
      <arg>-n <replaceable>nick</replaceable></arg>
      <arg>-p <replaceable>password</replaceable></arg>
      <arg>-i <replaceable>IRC-URL</replaceable></arg>
@@ -120,6 +122,21 @@ 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>-P</term>
+<listitem><para>Takes a following port number, and binds to that port
+when listening for messages.  <application>irkerd</application> binds
+to port 6659 by default.</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
@@ -165,10 +182,6 @@ socket can be visible from commit-hook code but not exposed to the
 outside world. Priming your firewall with blocklists of IP addresses
 known to spew spam is always a good idea.</para>
 
-<para>The absence of any option to set the service port is deliberate.
-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>