Documentation improvements.
authorEric S. Raymond <esr@thyrsus.com>
Tue, 9 Oct 2012 20:31:01 +0000 (16:31 -0400)
committerEric S. Raymond <esr@thyrsus.com>
Tue, 9 Oct 2012 20:31:01 +0000 (16:31 -0400)
install.txt

index 44a5aa5d3971a9bae88192a3881f8ec41fec78a9..3164f988ae2f5b0e375f39966bb464cbf8219325 100644 (file)
@@ -19,14 +19,17 @@ and DoS vulnerabilities related to irker.
 == Installing irkerd ==
 
 irker needs to run constantly, watching for TCP and UDP traffic on
-port 6659.  Install it accordingly.
+port 6659.  Install it accordingly. It has no config file; you can
+just start it up with no arguments.  If you want to see what it's
+doing, give it command-line options -d 1 for sparse messages and -d 2
+to show all traffic with IRC servers.
 
 You should *not* make irker visible from outside the site firewall, as
 it can be used to spam IRC channels while masking the source address.
 
 You will need to have Jason Coombs's irc library where Python can see
-it.  See <http://pypi.python.org/pypi/irc/>; use version 3.0, not the
-older code from SourceForge.
+it.  See <http://pypi.python.org/pypi/irc/>; use version 3.0 or later,
+not the older code from SourceForge.
 
 The file org.catb.irkerd.plist is a Mac OS/X plist that can be
 installed to launch irkerd as a boot-time service on that system.