db4ee89cac12cb47fc85ee398cd19e23efe798ca
[clinton/bobotpp.git] / bobot++.texinfo
1 \input texinfo @c -*- texinfo -*-
2 @c %**start of header
3 @setfilename bobot++.info
4 @settitle Bobot++: A Schemeable IRC Bot
5 @setchapternewpage on
6 @c %**end of header
7
8 @ifinfo
9 This file documents Bobot++ by Clinton Ebadi and Etienne Bernard
10 (original author, no longer works on program).
11
12 Copyright 2002 Clinton Ebadi
13
14 Permission is granted to copy, distribute and/or modify this document
15 under the terms of the GNU Free Documentation License, Version 1.1 or
16 any later version published by the Free Software Foundation; with no
17 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
18 Texts.
19
20 @end ifinfo
21
22 @titlepage
23 @title Bobot++: A Schemeable IRC Bot
24 @author Clinton Ebadi
25
26 @page
27 @vskip Opt plus 1filll
28 Copyright @copyright{} 2002 Clinton Ebadi
29
30 Permission is granted to copy, distribute and/or modify this document
31 under the terms of the GNU Free Documentation License, Version 1.1 or
32 any later version published by the Free Software Foundation; with no
33 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
34 Texts.
35
36 @end titlepage
37
38 @node Top, Introduction, (dir), (dir)
39 @comment node-name, next, previous, up
40
41 @ifinfo
42 This document describes Bobot++ by Clinton Ebadi and Etienne Bernard
43 (original author, no longer works on program).
44
45 This document applies to version 2.1.0 of the program named
46 Bobot++
47 @end ifinfo
48
49 @menu
50 * Introduction::
51 * Configuration::
52 * Scripting::
53 * Concept Index::
54 * Function Index::
55 * Variable Index::
56 @end menu
57
58 @node Introduction, Configuration, Top, Top
59 @chapter Introduction
60
61 This manual feels abused and neglected because it has almost no
62 content.
63
64 @node Configuration, Scripting, Introduction, Top
65 @chapter Configuration
66
67 Bobot++ is easy to configure. The configuration file format may be
68 changing in the 2.1 series, so it is not documented for now. See the
69 @file{examples} directory for an example configuration.
70
71 @menu
72 * Configuration File Syntax::
73 * Configure File Placement::
74 @end menu
75
76 @node Configuration File Syntax, Configure File Placement, Configuration, Configuration
77 @section Configuration File Syntax
78
79 Not here yet.
80
81 @node Configure File Placement, , Configuration File Syntax, Configuration
82 @section Configuration File Placement
83
84 Bobot++ will look in @file{/etc/bobotpp/default/} for its default
85 config if none is specified on the command line. Put the configuration
86 files you want to be loaded by default in this directory. If you are
87 not root or you want to have your own personal configration, put it in
88 @file{~/.bobotpp/config/default/}.
89
90 @node Scripting, Concept Index, Configuration, Top
91 @chapter Scripting
92
93 Bobot++'s most powerful feature is its scripting system. You write
94 scripts using Guile Scheme. This manual does not cover how to use
95 Guile or how to learn Scheme. @xref{Top, , Guile Reference Manual,
96 guile, The Guile Reference Manual}, for the Guile reference manual and
97 @url{http://www.ccs.neu.edu/home/dorai/t-y-scheme/t-y-scheme.html} for
98 a good tutorial on Scheme.
99
100 @node Concept Index, Function Index, Scripting, Top
101 @unnumbered Concept Index
102 @printindex cp
103
104 @node Function Index, Variable Index, Concept Index, Top
105 @unnumbered Function Index
106 @printindex fn
107
108 @node Variable Index, , Function Index, Top
109 @unnumbered Variable Index
110 @printindex vr