bobot++.texinfo.
This file documents Bobot++ by Clinton Ebadi and Etienne Bernard
-(original author, no longer works on program).
+(The original author who no longer works on the program).
Copyright 2002,2004,2005 Clinton Ebadi
File: bobot++.info, Node: Top, Next: Introduction, Prev: (dir), Up: (dir)
This document describes Bobot++ by Clinton Ebadi and Etienne Bernard
-(original author, no longer works on program).
+(The original author who no longer works on the program).
- This document applies to version 2.2 of the program named Bobot++
+ This document applies to version 2.2 of the program named Bobot++.
Copyright 2002,2004,2005 Clinton Ebadi
Bobot++ is easy to configure. See the `examples' directory for an
example configuration.
+ The main configuration file is `bot.conf'. There are several
+auxiliary configuration files (a user list, aliases file, ban list, and
+a script autoexec).
+
* Menu:
* 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
+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/'.
2.2.1 bot.conf
--------------
-* Menu:
-
-* server syntax::
-* channel syntax::
-
- `bot.conf' contains key value pairs separated by `='.
+`bot.conf' contains key value pairs separated by `='.
`<key> = <value>'
configuration variables are listed below in the format "VARIABLE
<default-value>: description"
+ A few of the options have more complex syntax, they are documented in
+their own subsections.
+
+* Menu:
+
+* server syntax::
+* channel syntax::
+
* NICKNAME <Bobot>: The nickname of the bot (NICK is an alias for
NICKNAME)
* USERLIST <bot.users>: Name of the file where the userlist is stored
- * SHITLIST <bot.shit>: Name of the file where the shitlist is stored
+ * SHITLIST <bot.shit>: Name of the file where the shitlist (ban
+ list) is stored
* LOGFILE <$LOGDIR/bot.log>: Location of the bot logfile (set this
to `/dev/null' to disable logging).
- * SERVER <None>: This specifies the server to connect to. Note that
- this has a special syntax.
+ * SERVER <None>: This specifies the server to which the bot will
+ connect. Note that this has a special syntax *note server syntax::.
- * CHANNEL <None>: This specifies a channel the bot will join when it
- starts up. This also has a special syntax.
+ * CHANNEL <None>: This specifies the channels the bot will join when
+ it starts up. This has a special syntax *note channel syntax::.
\1f
2.2.1.1 server syntax
.....................
-SERVER = SERVER_NAME [PORT [PASSWORD]]
+The server syntax in `bot.conf' allows you to specify an alternate port
+to connect on, and a password to send the server.
+
+ You may use more than one server line; Bobot++ will attempt to
+connect to the first one, and will connect to the next one in the list
+if it fails. The bot will continue cycling through the server list
+until it is able to connect to one. There is a command (`!cycle') to
+make the bot to cycle servers.
+
+ SERVER = SERVER_NAME [PORT [PASSWORD]]
This will make Bobot++ attempt to connect to SERVER_NAME on port
PORT with the password PASSWORD. SERVER_NAME should be the address of
-the server. PORT and PASSWORD are optional. You may use more than one
-server line; Bobot++ will attempt to connect to the first one and, if
-it fails, will connect to the next one in the list. There is also a
-command to cause the bot to cycle servers. At the present time Bobot++
-cannot connect to more than one server at a time. This is a planned
-feature of 3.0 (which is a very long way away; the current structure of
-the program would make it very difficult to add support for connecting
-to multiple servers at a time in a usable manner).
+the server. PORT and PASSWORD are optional.
\1f
File: bobot++.info, Node: channel syntax, Prev: server syntax, Up: bot.conf
2.2.1.2 channel syntax
......................
-CHANNEL = NAME:INITIAL_MODES:MODES_TO_KEEP:CHANNEL_KEY
+The channel syntax in `bot.conf' allows you to specify the initial
+modes the bot should set on a channel, the modes the bot should
+maintain, and a key if the channel needs it.
You may have any number of channel lines. When Bobot++ starts it will
-attempt to join and gain ops in every channel listed. It will join NAME
-and set the channel modes to INITIAL_MODES (e.g. "nt") if it is able to
-gain operator status. It will then maintain MODES_TO_KEEP. If the
-channel requires a key to enter simply set CHANNEL_KEY. Every argument
-except for NAME is optional.
+attempt to join and gain operator status in every channel listed.
+
+ CHANNEL = NAME:INITIAL_MODES:MODES_TO_KEEP:CHANNEL_KEY
+
+ The bot will join NAME and set the channel modes to INITIAL_MODES
+(e.g. "nt") if it is able to gain operator status. It will then
+maintain MODES_TO_KEEP. If the channel requires a key to enter simply
+set CHANNEL_KEY. Every argument except for NAME is optional.
A few example lines:
- `CHANNEL = #foo:nt:nt:bar'
+ CHANNEL = #foo:nt:nt:bar
The bot will join `#foo' with the channel key `bar' and will then
maintain the modes `nt'.
- `CHANNEL = #bar:::'
+ CHANNEL = #bar:::
The bot will join `#bar' and will not set any modes nor will it
attempt to maintain any modes.
====================
The bot is usually installed with the binary name `bobotpp'. It accepts
-the following command line arguments:
+the following command line arguments.
* `[--help][-h]' - Shows detailed help and exits
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 has access to commands
-with the level `bot:user-none'.
+Scheme uses the textual name for the level. By default (if the user is
+not found in the userlist) 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
==============
A user added via Scheme, the `bot.users' file, or `!adduser' may be
-protected from being deoped, kicked, or banned. There are currently no
-symbolic levels in Scheme; just use the numeric code.
+protected from being deoped, kicked, or banned. The user list and IRC
+commands use the numeric codes, Scheme uses the symbolic names.
- 0. No protection
+ 0. `bot:protection/none' No protection
- 1. No ban. If a user is banned the bot will unban him..
+ 1. `bot:protection/no-ban' No ban. If a user is banned the bot will
+ unban him..
- 2. No kick. The user may still be kicked but the bot will kickban the
- user who kicked the protected user.
+ 2. `bot:protection/no-kick' No kick. The user may still be kicked but
+ the bot will kickban the user who kicked the protected user.
- 3. No deop. The bot will ensure that the user always maintains
- operator status.
+ 3. `bot:protection/no-deop' No deop. The bot will ensure that the
+ user always maintains operator status.
\1f
File: bobot++.info, Node: Automatic Op, Next: Built-In Commands, Prev: Protection, Up: Using the Bot
================
A user may be automatically given operator status upon entering a
-channel. Set the AOP field to "0" to disable auto-op or "1" to enable
-auto-op.
+channel. Scheme uses the symbolic name, the user list (`bot.users') and
+IRC commands use the numeric value.
+
+ 0. `bot:aop/no' Do not automatically op the user
+
+ 1. `bot:aop/yes' Do automatically op the user
\1f
File: bobot++.info, Node: Built-In Commands, Prev: Automatic Op, Up: Using the Bot
\1f
Tag Table:
-Node: Top\7f527
-Node: Introduction\7f1925
-Node: Configuration\7f2117
-Node: Configuration File Placement\7f2404
-Node: Configuration Files\7f2904
-Node: bot.conf\7f3097
-Node: server syntax\7f4535
-Node: channel syntax\7f5399
-Node: bot.users\7f6242
-Node: Using the Bot\7f7145
-Node: Starting the Bot\7f7395
-Node: User Levels\7f8904
-Node: Protection\7f10306
-Node: Automatic Op\7f10914
-Node: Built-In Commands\7f11203
-Node: Scripting\7f18182
-Node: Adding New Commands\7f19254
-Node: Hooks\7f20575
-Node: Creating a Hook\7f21415
-Node: Hook Types\7f22621
-Node: Received Message Hooks\7f23185
-Node: Sent Message Hooks\7f28412
-Node: DCC CHAT Hooks\7f29809
-Node: Miscellaneous Hooks\7f30849
-Node: Scheme User Levels\7f31298
-Node: Sending Messages\7f32432
-Node: High Level Message Functions\7f33048
-Node: Low Level Message Functions\7f33828
-Node: Misc Scripting Stuff\7f34891
-Node: Concept Index\7f41467
-Node: Function Index\7f41686
-Node: Variable Index\7f52922
+Node: Top\7f538
+Node: Introduction\7f1948
+Node: Configuration\7f2140
+Node: Configuration File Placement\7f2584
+Node: Configuration Files\7f3085
+Node: bot.conf\7f3278
+Node: server syntax\7f4885
+Node: channel syntax\7f5683
+Node: bot.users\7f6727
+Node: Using the Bot\7f7630
+Node: Starting the Bot\7f7880
+Node: User Levels\7f9389
+Node: Protection\7f10777
+Node: Automatic Op\7f11495
+Node: Built-In Commands\7f11914
+Node: Scripting\7f18893
+Node: Adding New Commands\7f19965
+Node: Hooks\7f21286
+Node: Creating a Hook\7f22126
+Node: Hook Types\7f23332
+Node: Received Message Hooks\7f23896
+Node: Sent Message Hooks\7f29123
+Node: DCC CHAT Hooks\7f30520
+Node: Miscellaneous Hooks\7f31560
+Node: Scheme User Levels\7f32009
+Node: Sending Messages\7f33143
+Node: High Level Message Functions\7f33759
+Node: Low Level Message Functions\7f34539
+Node: Misc Scripting Stuff\7f35602
+Node: Concept Index\7f42178
+Node: Function Index\7f42397
+Node: Variable Index\7f53633
\1f
End Tag Table
@ifinfo
This file documents Bobot++ by Clinton Ebadi and Etienne Bernard
-(original author, no longer works on program).
+(The original author who no longer works on the program).
Copyright 2002,2004,2005 Clinton Ebadi
@ifinfo
This document describes Bobot++ by Clinton Ebadi and Etienne Bernard
-(original author, no longer works on program).
+(The original author who no longer works on the program).
This document applies to version 2.2 of the program named
-Bobot++
+Bobot++.
Copyright 2002,2004,2005 Clinton Ebadi
@chapter Configuration
Bobot++ is easy to configure. See the @file{examples} directory for an
-example configuration.
+example configuration.
+
+The main configuration file is @file{bot.conf}. There are several
+auxiliary configuration files (a user list, aliases file, ban list,
+and a script autoexec).
@menu
* Configuration File Placement::
Bobot++ will look in @file{/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
+not root, or you want to have your own personal configuration, put it
in @file{~/.bobotpp/config/default/}.
@node Configuration Files, , Configuration File Placement, Configuration
@node bot.conf, bot.users, Configuration Files, Configuration Files
@subsection bot.conf
-@menu
-* server syntax::
-* channel syntax::
-@end menu
-
@file{bot.conf} contains key value pairs separated by @code{=}.
@code{<key> = <value>}
configuration variables are listed below in the format ``@var{variable}
<default-value>: description''
+A few of the options have more complex syntax, they are documented in
+their own subsections.
+
+@menu
+* server syntax::
+* channel syntax::
+@end menu
+
@itemize @bullet
@item @var{nickname} <Bobot>: The nickname of the bot (@var{nick} is an
the bot (@var{realname} is an alias for @var{ircname})
@item @var{userlist} <bot.users>: Name of the file where the userlist is
stored
-@item @var{shitlist} <bot.shit>: Name of the file where the shitlist is
-stored
+@item @var{shitlist} <bot.shit>: Name of the file where the shitlist
+(ban list) is stored
@item @var{logfile} <$LOGDIR/bot.log>: Location of the bot logfile
(set this to @file{/dev/null} to disable logging).
-@item @var{server} <None>: This specifies the server to connect
-to. Note that this has a special syntax.
-@item @var{channel} <None>: This specifies a channel the bot will join
-when it starts up. This also has a special syntax.
+@item @var{server} <None>: This specifies the server to which the bot
+will connect. Note that this has a special syntax @pxref{server
+syntax}.
+@item @var{channel} <None>: This specifies the channels the bot will join
+when it starts up. This has a special syntax @pxref{channel
+syntax}.
@end itemize
@node server syntax, channel syntax, bot.conf, bot.conf
@subsubsection server syntax
+The server syntax in @file{bot.conf} allows you to specify an
+alternate port to connect on, and a password to send the server.
+
+You may use more than one server line; Bobot++ will attempt to connect
+to the first one, and will connect to the next one in the list if it
+fails. The bot will continue cycling through the server list until it
+is able to connect to one. There is a command (@code{!cycle}) to make
+the bot to cycle servers.
+
@var{server} = @var{server_name} [@var{port} [@var{password}]]
This will make Bobot++ attempt to connect to @var{server_name} on port
@var{port} with the password @var{password}. @var{server_name} should
be the address of the server. @var{port} and @var{password} are
-optional. You may use more than one server line; Bobot++ will attempt
-to connect to the first one and, if it fails, will connect to the next
-one in the list. There is also a command to cause the bot to cycle
-servers. At the present time Bobot++ cannot connect to more than one
-server at a time. This is a planned feature of 3.0 (which is a very
-long way away; the current structure of the program would make it very
-difficult to add support for connecting to multiple servers at a time
-in a usable manner).
+optional.
@node channel syntax, , server syntax, bot.conf
@subsubsection channel syntax
+The channel syntax in @file{bot.conf} allows you to specify the
+initial modes the bot should set on a channel, the modes the bot
+should maintain, and a key if the channel needs it.
+
+You may have any number of channel lines. When Bobot++ starts it will
+attempt to join and gain operator status in every channel listed.
+
@var{channel} =
@var{name}:@var{initial_modes}:@var{modes_to_keep}:@var{channel_key}
-You may have any number of channel lines. When Bobot++ starts it will
-attempt to join and gain ops in every channel listed. It will join
-@var{name} and set the channel modes to @var{initial_modes}
-(e.g. ``nt'') if it is able to gain operator status. It will then
-maintain @var{modes_to_keep}. If the channel requires a key to enter
-simply set @var{channel_key}. Every argument except for @var{name} is
-optional.
+The bot will join @var{name} and set the channel modes to
+@var{initial_modes} (e.g. ``nt'') if it is able to gain operator
+status. It will then maintain @var{modes_to_keep}. If the channel
+requires a key to enter simply set @var{channel_key}. Every argument
+except for @var{name} is optional.
A few example lines:
-@code{@var{channel} = #foo:nt:nt:bar}
+@example
+@var{channel} = #foo:nt:nt:bar
+@end example
The bot will join @code{#foo} with the channel key @code{bar} and will
then maintain the modes @code{nt}.
-@code{@var{channel} = #bar:::}
+@example
+@var{channel} = #bar:::
+@end example
The bot will join @code{#bar} and will not set any modes nor will it
attempt to maintain any modes.
@section Starting the Bot
The bot is usually installed with the binary name @file{bobotpp}. It
-accepts the following command line arguments:
+accepts the following command line arguments.
@itemize
@item @code{[--help][-h]} - Shows detailed help and exits
There are several user levels available in Bobot++ to provide gradated
access to commands. @command{!adduser} and @file{bot.users} use the
numeric code; Scheme uses the textual name for the level. By default
-(if no catch-all setting is found in @xref{bot.users}.) a user has
-access to commands with the level @code{bot:user-none}.
+(if the user is not found in the userlist) a user has access to
+commands with the level @code{bot:user-none}.
@enumerate 0
A user added via Scheme, the @file{bot.users} file, or
@command{!adduser} may be protected from being deoped, kicked, or
-banned. There are currently no symbolic levels in Scheme; just use the
-numeric code.
+banned. The user list and IRC commands use the numeric codes, Scheme
+uses the symbolic names.
@enumerate 0
-@item No protection
-@item No ban. If a user is banned the bot will unban him..
-@item No kick. The user may still be kicked but the bot will kickban
+@item @code{bot:protection/none} No protection
+@item @code{bot:protection/no-ban} No ban. If a user is banned the bot will unban him..
+@item @code{bot:protection/no-kick} No kick. The user may still be kicked but the bot will kickban
the user who kicked the protected user.
-@item No deop. The bot will ensure that the user always maintains
+@item @code{bot:protection/no-deop} No deop. The bot will ensure that the user always maintains
operator status.
@end enumerate
@section Automatic Op
A user may be automatically given operator status upon entering a
-channel. Set the @var{aop} field to ``0'' to disable auto-op or ``1''
-to enable auto-op.
+channel. Scheme uses the symbolic name, the user list
+(@file{bot.users}) and IRC commands use the numeric value.
+
+@enumerate 0
+@item @code{bot:aop/no} Do not automatically op the user
+@item @code{bot:aop/yes} Do automatically op the user
+@end enumerate
@node Built-In Commands, , Automatic Op, Using the Bot
@section Built-In Commands
HCoop / clinton / bobotpp.git / commitdiff