[project @ 2002-07-12 03:27:05 by unknown_lamer]

[clinton/bobotpp.git] / bobot++.info

This is bobot++.info, produced by makeinfo version 4.1 from
bobot++.texinfo.

   This file documents Bobot++ by Clinton Ebadi and Etienne Bernard
(original author, no longer works on program).

   Copyright 2002 Clinton Ebadi

   Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts.

\1f
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).

   This document applies to version 2.1.0 of the program named Bobot++

   Copyright 2002 Clinton Ebadi

   Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts.

* Menu:

* Introduction::
* Configuration::
* Scripting::
* Concept Index::
* Function Index::
* Variable Index::

\1f
File: bobot++.info,  Node: Introduction,  Next: Configuration,  Prev: Top,  Up: Top

Introduction
************

   This manual feels abused and neglected because it has almost no
content.

\1f
File: bobot++.info,  Node: Configuration,  Next: Scripting,  Prev: Introduction,  Up: Top

Configuration
*************

   Bobot++ is easy to configure. The configuration file format may be
changing in the 2.1 series, so it is not documented for now. See the
`examples' directory for an example configuration.

* Menu:

* Configuration File Syntax::
* Configure File Placement::

\1f
File: bobot++.info,  Node: Configuration File Syntax,  Next: Configure File Placement,  Prev: Configuration,  Up: Configuration

Configuration File Syntax
=========================

   Not here yet.

\1f
File: bobot++.info,  Node: Configure File Placement,  Prev: Configuration File Syntax,  Up: Configuration

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 configration, put it in
`~/.bobotpp/config/default/'.

\1f
File: bobot++.info,  Node: Scripting,  Next: Concept Index,  Prev: Configuration,  Up: Top

Scripting
*********

   Bobot++'s most powerful feature is its scripting system. You write
scripts using Guile Scheme. This manual does not cover how to use Guile
or how to learn Scheme. *Note Guile Reference Manual: (guile)Top, for
the Guile reference manual and
<http://www.ccs.neu.edu/home/dorai/t-y-scheme/t-y-scheme.html> for a
good tutorial on Scheme.

   Note that in previous versions the scripting commands where in the
form `bot-FUNCTION'. They are now in the form `bot:FUNCTION'. The old
names are still available, but are deprecated and will be removed in
Bobot++ 2.4. The command `perl -pi -e ``s/bot-/bot:/g'' YOUR-FILES'
should be enough to convert your code to use the new functions.

* Menu:

* Adding New Commands::
* Hooks::

\1f
File: bobot++.info,  Node: Adding New Commands,  Next: Hooks,  Prev: Scripting,  Up: Scripting

Adding New Commands
===================

   Not here yet.

\1f
File: bobot++.info,  Node: Hooks,  Prev: Adding New Commands,  Up: Scripting

Hooks
=====

   Hooks are a powerful feature of Bobot++. Hooks are a hybrid of ircII
hooks and tiny fugue (a MUD bot) hooks. The basic idea of a hook if
that you match a text against regular expression and call a function if
text in a message matches that regex. The different types of hooks
provided by Bobot++ correspond to the different classes of messages
that Bobot++ can recieve. A Hook also has several properties, including
its priority and whether or not it is a fallthrough hook. Higher
priority hooks are executed before lower priority hooks and fallthrough
hooks are executed before non-fallthrough hooks. A fallthrough hook can
match and processing of hooks will continue; as soon as the first
non-fallthrough hooks matches processing of hooks stops.

* Menu:

* Creating a Hook::
* Hook Types::

\1f
File: bobot++.info,  Node: Creating a Hook,  Next: Hook Types,  Prev: Hooks,  Up: Hooks

Creating a Hook
---------------

   To add a new hook you use the function `bot:addhook'. `bot:addhook'
is prototyped as `(bot:addhook type regex function pri fall)'. `type'
specifies the type of hook (the types of hooks are listed in *Note Hook
Types::). `regex' is a standard regular expression. If `regex' is
matched, `function' will be called. `function' will take a different
number of args depending on the hook type. `pri' specifies the priority
of the hook-higher priority hooks are executed first. This argument is
optional and defaults to `0'. `fall' is `#t' if the hook is a
fallthrough hook and `#f' is the hook is not a fallthrough hook. This
arg is also optional and default to `#t'.

\1f
File: bobot++.info,  Node: Hook Types,  Prev: Creating a Hook,  Up: Hooks

Hook Types
----------

   Here is a list of the various hooks are notes on each one. The
general format of a hook is:

   * `hooks/name' (this is the Scheme variable name of the hook)
        - Description of the hook

        - # of args
             - `arg1': desc

             - `arg2': desc

             - ...

             - `argN': desc

   That said, here is the list of available hooks:

   * `hooks/action'
        - Description of the hook

        - # of args
             - `arg1': desc


   * `hooks/nickname'
        - Description of the hook

        - # of args
             - `arg1': desc


   * `hooks/signoff'
        - Description of the hook

        - # of args
             - `arg1': desc


   * `hooks/ctcp'
        - Description of the hook

        - # of args
             - `arg1': desc


   * `hooks/ctcp-reply'
        - Description of the hook

        - # of args
             - `arg1': desc


   * `hooks/disconnect'
        - Description of the hook

        - # of args
             - `arg1': desc


   * `hooks/flood'
        - Description of the hook

        - # of args
             - `arg1': desc


   * `hooks/invite'
        - Description of the hook

        - # of args
             - `arg1': desc


   * `hooks/join'
        - Description of the hook

        - # of args
             - `arg1': desc


   * `hooks/kick'
        - Description of the hook

        - # of args
             - `arg1': desc


   * `hooks/part'
        - Description of the hook

        - # of args
             - `arg1': desc


   * `hooks/mode'
        - Description of the hook

        - # of args
             - `arg1': desc


   * `hooks/message'
        - Description of the hook

        - # of args
             - `arg1': desc


   * `hooks/notice'
        - Description of the hook

        - # of args
             - `arg1': desc


   * `hooks/public'
        - Description of the hook

        - # of args
             - `arg1': desc


   * `hooks/public-notice'
        - Description of the hook

        - # of args
             - `arg1': desc


   * `hooks/raw'
        - Description of the hook

        - # of args
             - `arg1': desc


   * `hooks/timer'
        - Description of the hook

        - # of args
             - `arg1': desc


   * `hooks/topic'
        - Description of the hook

        - # of args
             - `arg1': desc


\1f
File: bobot++.info,  Node: Concept Index,  Next: Function Index,  Prev: Scripting,  Up: Top

Concept Index
*************

* Menu:
\1f
File: bobot++.info,  Node: Function Index,  Next: Variable Index,  Prev: Concept Index,  Up: Top

Function Index
**************

* Menu:
\1f
File: bobot++.info,  Node: Variable Index,  Prev: Function Index,  Up: Top

Variable Index
**************

* Menu:

\1f
Tag Table:
Node: Top\7f517
Node: Introduction\7f1228
Node: Configuration\7f1419
Node: Configuration File Syntax\7f1801
Node: Configure File Placement\7f2003
Node: Scripting\7f2477
Node: Adding New Commands\7f3316
Node: Hooks\7f3473
Node: Creating a Hook\7f4363
Node: Hook Types\7f5153
Node: Concept Index\7f7626
Node: Function Index\7f7758
Node: Variable Index\7f7897
\1f
End Tag Table