+ [ I didn't know where to put any of these, so I jsut stuck them in
+ here.
+
+ There probably needs to be several sections added, like dealing
+ with users (kicking, added, etc), dealing with the bot (channels,
+ nickname of the bot, etc), server issues (serverlist), useful
+ tools (nslookup, whois), and do on. ]
+
+ -- Function: bot:adduser nick-or-mask cbannel-mask level prot auto-op
+ Adds an user to the userlist, for a `nick!user@host' matching the
+ one given, on a channel matching the CHANNELMASK given.
+
+ The LEVEL can be: The PROT can be: The AUTO-OP can be:
+ 0 - No level 0 - No protection 0 - No auto-op
+ 1 - User 1 - No ban 1 - Op on join
+ 2 - Trusted User 2 - No kick
+ 3 - Friend 3 - No deop
+ 4 - Master
+
+
+ -- Function: bot:addserver hostname ip-address [portnumber]
+ Adds the server specified by HOSTNAME or IP-ADDRESS to the server
+ list.
+
+ -- Function: bot:addshit nick-or-mask channel-mask level [time reason]
+ Adds an user to the shitlist, for a nick!user@host matching the
+ one given, on a channel matching the CHANNELMASK given.
+
+ The LEVEL can be:
+ 0 - No shit
+ 1 - No op
+ 2 - Kick and Ban on join
+ 3 - Kick and Ban on join, no deban
+
+
+ -- Function: bot:ban channel mask-or-nick
+ Bans MASK or NICK from CHANNEL. You need to be a trusted user to
+ ban with a MASK.
+
+ -- Function: bot:change-command-level nick-or-mask channel-mask
+ new-level
+ Gives NICK or MASK level NEW-LEVEL on channel(s) CHANNEL-MASK.
+ Note that you can not change level for someone whose level is
+ greater than yours, and that you can not give a level greater than
+ yours.
+
+ -- Function: bot:cycle channel
+ Makes the bot leave and join CHANNEL.
+
+ -- Function: bot:deban channel mask-or-nick
+ Debans MASK or NICK from CHANNEL. You need to be a trusted user to
+ deban with a MASK.
+
+ -- Function: bot:delserver server-number
+ Deletes server from server list whose number in the server list is
+ SERVER-NUMBER
+
+ -- Function: bot:deluser nick-or-mask channel-mask
+ Removes NICK or MASK from the userlist.
+
+ -- Function: bot:delshit nick-or-mask channel-mask
+ Removes NICK or MASK from the shitlist.
+
+ -- Function: bot:deop channel mask-or-nick
+ Deops MASK or NICK on CHANNEL.
+
+ -- Function: bot:die reason
+ Makes the bot stop immediately.
+
+ -- Function: bot:do ?
+
+ -- Function: bot:invite channel nick
+ Invites NICK on CHANNEL.
+
+ -- Function: bot:join channel
+ Makes the bot join CHANNEL.
+
+ -- Function: bot:keep channel modes
+ Sets the MODES that the bot will keep for CHANNEL. See also STATS.
+
+ -- Function: bot:kick channel mask-or-nick [reason]
+ Kicks MASK or NICK out of CHANNEL, because of REASON. You need to
+ be a trusted user to use a MASK.
+
+ -- Function: bot:kickban channel mask-or-nick [reason]
+ Bans then kicks MASK or NICK out of CHANNEL, because of REASON.
+ You need to be a trusted user to use a MASK.
+
+ -- Function: bot:lock channel
+ Locks topic on CHANNEL.
+
+ -- Function: bot:logport
+ [ Probably returns the log port? ]
+
+ -- Function: bot:mode channel mode-string
+ Sends MODE-STRING as mode for CHANNEL.
+
+ -- Function: bot:nextserver
+ Makes the bot connect to the next server in its server list.
+
+ -- Function: bot:nick nick
+ Makes the bot use nickname NICK.
+
+ -- Function: bot:op channel nick
+ Ops NICK on CHANNEL.
+
+ -- Function: bot:part channel
+ Makes the bot leave CHANNEL.
+
+ -- Function: bot:reconnect
+ Makes the bot reconnect to its current server.
+
+ -- Function: bot:server server-number
+ Select the server to connect to. SERVER-NUMBER is the number of
+ the server in the serverlist.
+
+ -- Function: bot:setfloodrate ?
+
+ -- Function: bot:setversion ?
+
+ -- Function: bot:tban channel nick-or-mask time
+ Bans NICK or MASK from CHANNEL for TIME seconds.
+
+ -- Function: bot:tkban channel nick-or-mask time [reason]
+ Bans NICK or MASK from CHANNEL for TIME seconds, then kicks
+ him/them because of REASON.
+
+ -- Function: bot:topic channel topic
+ If no TOPIC is given, prints CHANNEL's topic. Otherwise, the bot
+ will change CHANNEL's topic to TOPIC.
+
+ -- Function: bot:unlock channel
+ Makes the bot unlock topic on CHANNEL.
+
+ -- Function: bot:getnickname
+ [ Gets the bot's nickname? ]
+
+ -- Function: bot:getserver
+
+ -- Function: bot:getserverlist
+
+ -- Function: bot:flush
+ [ Flushes the socket to the server? ]
+
+ -- Function: bot:flushport
+ [ Flushes the log port? ]
+
+ -- Function: bot:random ?
+ [ Returns a random number? What range? Why? ]
+
+ -- Function: bot:delcommand
+ [ Probably deletes a command added with `bot:addcommand' ? ]
+
+ -- Function: bot:addtimer ? ?
+
+ -- Function: bot:deltimer ?
+
+ -- Function: bot:dcc-chat-send ? ?
+
+ [ And what about the stuff defined in `bobot-utils.scm' ? I just
+ added it here so it could be somewhere. There should also be a
+ section dealing with modules. How to use them. What module
+ scripts are in. What module bobot++ provided primites are in.
+ And so on. ]
+
+ -- Function: bot:log . messages
+ Write as many MESSAGES as you want to the log. If the arg is a
+ thunk it will be executed and it's output will be written to the
+ log.
+
+ -- Function: bot:load file
+
+ -- Function: bot:load-module module-spec
+
+ -- Function: bot:use-module module-spec
+
+ -- Function: bot:match-not-channel regex
+ match-not-channel adds a prefix regex to your REGEX so it doesn't
+ match the sender or channel in a PUBLIC message
+
+ -- Function: bot:match-to-me regex
+ match-to-me matches text that was addressed to the bot with a ':',
+ ',', or nothing after the bot name.
+
+ -- Function: bot:sent-to-me? message
+
+ -- Function: bot:ctcp-quote message
+ Returns the CTCP quoted message Input _MUST NOT_ contain the
+ trailing `\r\n' (it is added by the message sending code).
+
+ -- Variable: %bot:loadpath
+
+ -- Function: %bot:load-extensions
+