Added option parsing.

[xavierbot.git] / README

diff --git a/README b/README
index ea53c40..78e0171 100644 (file)
--- a/README
+++ b/README
@@ -35,3 +35,25 @@ Either:
   sudo make install
 or:
   sudo make permissions
+
+RUNNING ---------------------------------------------
+
+You need to do either sudo make install or sudo make permissions in
+order to create the suid wrapper program (see previous section).
+
+To run, simply do:
+
+  ./xavierbot.pl
+
+Default configuration comes from the top of the file xavierbot.pl.in.
+You may also override the defaults on the command line.  For example:
+
+  ./xavierbot.pl --server irc.example.com
+
+The options are:
+
+  --nick <nick>                Change nick (default: xavierbot)
+  --ircname <name>     Change printable name (default: Xavierbot)
+  --server <server>    Change server (default: chat.freenode.net)
+  --port <portnum>     Change port (default: 6667)
+  --channel <chan>     Change channel (default: #ocaml)