README

   1 I am xavierbot, an OCaml toplevel bot for IRC.
   2
   3 <rwmjones>    let hello () = print_endline "hello, world";;
   4 <xavierbot>   val hello : unit -> unit = <fun>
   5 <rwmjones>    hello ();;
   6 <xavierbot>   hello, world
   7 <xavierbot>   - : unit = ()
   8
   9 I am Public Domain.
  10
  11 I was originally written by Richard W.M. Jones <rich@annexia.org>.
  12
  13 DEPENDENCIES ----------------------------------------
  14
  15 To run me, you will need the following packages:
  16
  17   ocaml >= 3.10.0
  18   findlib
  19   perl
  20   POE::Component::IRC
  21   POE::Wheel::Run
  22
  23 INSTALLATION ----------------------------------------
  24
  25 Please read & edit these files:
  26
  27   Makefile.config
  28   xavierbot.pl.in
  29
  30 Do:
  31
  32   make
  33
  34 Either:
  35   sudo make install
  36 or:
  37   sudo make permissions
  38
  39 RUNNING ---------------------------------------------
  40
  41 You need to do either sudo make install or sudo make permissions in
  42 order to create the suid wrapper program (see previous section).
  43
  44 To run, simply do:
  45
  46   ./xavierbot.pl
  47
  48 Default configuration comes from the top of the file xavierbot.pl.in.
  49 You may also override the defaults on the command line.  For example:
  50
  51   ./xavierbot.pl --server irc.example.com
  52
  53 The options are:
  54
  55   --nick <nick>         Change nick (default: xavierbot)
  56   --ircname <name>      Change printable name (default: Xavierbot)
  57   --server <server>     Change server (default: chat.freenode.net)
  58   --port <portnum>      Change port (default: 6667)
  59   --channel <chan>      Change channel (default: #ocaml)