Configuration
-* Configuration Files::
* Configuration File Placement::
+* Configuration Files::
Configuration Files
* Menu:
-* Configuration Files::
* Configuration File Placement::
+* Configuration Files::
+
+\1f
+File: bobot++.info, Node: Configuration File Placement, Next: Configuration Files, Prev: Configuration, Up: Configuration
+
+2.1 Configuration File Placement
+================================
+
+Bobot++ will look in `/etc/bobotpp/default/' for its default config if
+none is specified on the command line. Put the configuration files you
+want to be loaded by default in this directory. If you are not root or
+you want to have your own personal configuration, put it in
+`~/.bobotpp/config/default/'.
\1f
-File: bobot++.info, Node: Configuration Files, Next: Configuration File Placement, Prev: Configuration, Up: Configuration
+File: bobot++.info, Node: Configuration Files, Prev: Configuration File Placement, Up: Configuration
-2.1 Configuration Files
+2.2 Configuration Files
=======================
* Menu:
\1f
File: bobot++.info, Node: bot.conf, Next: bot.users, Prev: Configuration Files, Up: Configuration Files
-2.1.1 bot.conf
+2.2.1 bot.conf
--------------
* Menu:
\1f
File: bobot++.info, Node: server syntax, Next: channel syntax, Prev: bot.conf, Up: bot.conf
-2.1.1.1 server syntax
+2.2.1.1 server syntax
.....................
SERVER = SERVER_NAME [PORT [PASSWORD]]
\1f
File: bobot++.info, Node: channel syntax, Prev: server syntax, Up: bot.conf
-2.1.1.2 channel syntax
+2.2.1.2 channel syntax
......................
CHANNEL = NAME:INITIAL_MODES:MODES_TO_KEEP:CHANNEL_KEY
\1f
File: bobot++.info, Node: bot.users, Prev: bot.conf, Up: Configuration Files
-2.1.2 bot.users
+2.2.2 bot.users
---------------
`bot.users' is the default file name of the userlist. It may be changed
operator priviliges on channel entry (*Note Automatic Op::).
-\1f
-File: bobot++.info, Node: Configuration File Placement, Prev: Configuration Files, Up: Configuration
-
-2.2 Configuration File Placement
-================================
-
- [ I kinda think this should go before the detailed description of
- the config file. I was didn't see it at first and was very
- frustrated trying to find out _where_ to edit all this wonderful
- stuff. ]
-
- Bobot++ will look in `/etc/bobotpp/default/' for its default config
-if none is specified on the command line. Put the configuration files
-you want to be loaded by default in this directory. If you are not root
-or you want to have your own personal configuration, put it in
-`~/.bobotpp/config/default/'.
-
\1f
File: bobot++.info, Node: Using the Bot, Next: Scripting, Prev: Configuration, Up: Top
There are several user levels available in Bobot++ to provide gradated
access to commands. `!adduser' and `bot.users' use the numeric code;
Scheme uses the textual name for the level. By default (if no catch-all
-setting is found in *Note bot.users::.) a user is not even a
-`bot:user-none' and cannot execute *any* commands, even commands
-available to `bot:user-none'.
+setting is found in *Note bot.users::.) a user has access to commands
+with the level `bot:user-none'.
0. `bot:user-none' - No *built-in* commands may be executed _by
default_ (commands may be added from Scheme that can be executed
----------------
Here is a list of the various hooks funtions and notes on each one. The
-general format of each hook description is as if it was was function to
+general format of each hook description is as if it were a function to
be defined, but these describe the function to be passwd to
`bot:add-hook'. Do _not_ name your functions these names.
- [ Boy, that's clumsy. I want to say that the hook/xx functions
- that are documented below are not funtions that you call. They
- are the functions that needs to be passed to bot:addhook for that
- kind of hook.
-
- Still clumsy. Oh well. ]
-
That said, here is the list of available hooks functions. FIXME:
write docs
`*unspecified*' always, so don't use the return value for anything.
-- Function: bot:send-ctcp to command message
- `to' is the target of your CTCP message, `command' is the CTCP
- command, and `message' is the message (or arguments) of the
- command. Make sure to `bot:ctcp-quote' the message!
+ TO is the target of your CTCP message, COMMAND is the CTCP
+ command, and MESSAGE is the message (or arguments) of the command.
+ Make sure to `bot:ctcp-quote' the message!
-- Function: bot:send-ctcp-reply to command message
- `to' is the target of your CTCP reply, `command' is the CTCP
- command, and `message' is the message (or arguments) of the
- command. Make sure to `bot:ctcp-quote' the message!
+ TO is the target of your CTCP reply, COMMAND is the CTCP command,
+ and MESSAGE is the message (or arguments) of the command. Make
+ sure to `bot:ctcp-quote' the message!
This is used to reply to a ctcp that the bot has received.
bot:exit-hook THUNK' where THUNK is an argumentless procedure (a
thunk). When the bot exits your thunk will be called.
- [ I didn't know where to put any of these, so I jsut stuck them in
+ [ I didn't know where to put any of these, so I just stuck them in
here.
There probably needs to be several sections added, like dealing
(line 145)
* bot:use-module: Misc Scripting Stuff.
(line 188)
-* hooks/action: Hook Types. (line 22)
-* hooks/ctcp: Hook Types. (line 36)
-* hooks/ctcp-reply: Hook Types. (line 38)
-* hooks/dcc/chat-begin: Hook Types. (line 83)
-* hooks/dcc/chat-message: Hook Types. (line 87)
-* hooks/disconnect: Hook Types. (line 40)
-* hooks/flood: Hook Types. (line 46)
-* hooks/invite: Hook Types. (line 48)
-* hooks/join: Hook Types. (line 50)
-* hooks/kick: Hook Types. (line 52)
-* hooks/leave: Hook Types. (line 54)
-* hooks/message: Hook Types. (line 59)
-* hooks/mode: Hook Types. (line 57)
-* hooks/nickname: Hook Types. (line 30)
-* hooks/notice: Hook Types. (line 61)
-* hooks/part: Hook Types. (line 55)
-* hooks/public: Hook Types. (line 63)
-* hooks/public-notice: Hook Types. (line 65)
-* hooks/raw: Hook Types. (line 67)
-* hooks/send/action: Hook Types. (line 79)
-* hooks/send/ctcp: Hook Types. (line 81)
-* hooks/send/message: Hook Types. (line 77)
-* hooks/send/public: Hook Types. (line 75)
-* hooks/signoff: Hook Types. (line 34)
-* hooks/timer: Hook Types. (line 69)
-* hooks/topic: Hook Types. (line 73)
+* hooks/action: Hook Types. (line 15)
+* hooks/ctcp: Hook Types. (line 29)
+* hooks/ctcp-reply: Hook Types. (line 31)
+* hooks/dcc/chat-begin: Hook Types. (line 76)
+* hooks/dcc/chat-message: Hook Types. (line 80)
+* hooks/disconnect: Hook Types. (line 33)
+* hooks/flood: Hook Types. (line 39)
+* hooks/invite: Hook Types. (line 41)
+* hooks/join: Hook Types. (line 43)
+* hooks/kick: Hook Types. (line 45)
+* hooks/leave: Hook Types. (line 47)
+* hooks/message: Hook Types. (line 52)
+* hooks/mode: Hook Types. (line 50)
+* hooks/nickname: Hook Types. (line 23)
+* hooks/notice: Hook Types. (line 54)
+* hooks/part: Hook Types. (line 48)
+* hooks/public: Hook Types. (line 56)
+* hooks/public-notice: Hook Types. (line 58)
+* hooks/raw: Hook Types. (line 60)
+* hooks/send/action: Hook Types. (line 72)
+* hooks/send/ctcp: Hook Types. (line 74)
+* hooks/send/message: Hook Types. (line 70)
+* hooks/send/public: Hook Types. (line 68)
+* hooks/signoff: Hook Types. (line 27)
+* hooks/timer: Hook Types. (line 62)
+* hooks/topic: Hook Types. (line 66)
\1f
File: bobot++.info, Node: Variable Index, Prev: Function Index, Up: Top
Node: Top\7f527
Node: Introduction\7f1816
Node: Configuration\7f2008
-Node: Configuration Files\7f2295
-Node: bot.conf\7f2510
-Node: server syntax\7f3948
-Node: channel syntax\7f4812
-Node: bot.users\7f5655
-Node: Configuration File Placement\7f6558
-Node: Using the Bot\7f7260
-Node: Starting the Bot\7f7510
-Node: User Levels\7f9019
-Node: Protection\7f10475
-Node: Automatic Op\7f11083
-Node: Built-In Commands\7f11372
-Node: Scripting\7f18351
-Node: Adding New Commands\7f19316
-Node: Hooks\7f20639
-Node: Creating a Hook\7f21479
-Node: Hook Types\7f22662
-Node: Scheme User Levels\7f25691
-Node: Sending Messages\7f26825
-Node: High Level Message Functions\7f27441
-Node: Low Level Message Functions\7f28221
-Node: Misc Scripting Stuff\7f29296
-Node: Concept Index\7f35872
-Node: Function Index\7f36091
-Node: Variable Index\7f46222
+Node: Configuration File Placement\7f2295
+Node: Configuration Files\7f2795
+Node: bot.conf\7f2988
+Node: server syntax\7f4426
+Node: channel syntax\7f5290
+Node: bot.users\7f6133
+Node: Using the Bot\7f7036
+Node: Starting the Bot\7f7286
+Node: User Levels\7f8795
+Node: Protection\7f10197
+Node: Automatic Op\7f10805
+Node: Built-In Commands\7f11094
+Node: Scripting\7f18073
+Node: Adding New Commands\7f19038
+Node: Hooks\7f20361
+Node: Creating a Hook\7f21201
+Node: Hook Types\7f22384
+Node: Scheme User Levels\7f25151
+Node: Sending Messages\7f26285
+Node: High Level Message Functions\7f26901
+Node: Low Level Message Functions\7f27681
+Node: Misc Scripting Stuff\7f28744
+Node: Concept Index\7f35320
+Node: Function Index\7f35539
+Node: Variable Index\7f45670
\1f
End Tag Table