1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
URL: http://www.emacswiki.org/cgi-bin/wiki.pl?ErBot for all erbot
information, and installation help.
The files in the `contrib' directory are optional "third-party"
add-ons that are used for erbot. Not all of them are strictly
required. The versions here are provided for convenience, and are
also the versions known to work with erbot, but you might want to
fetch their latest versions from their respective authors' websites.
The file `examples/dotemacs-mybot' is meant to be the bot's .emacs
file. Copy it to .emacs in your bot's home directory, and then make
any changes you like.
NOTE: A data file for contrib/units.el may be obtained in Debian by
performing "apt-get install units", and adding
(setq units-dat-file "/usr/share/misc/units.dat")
to the bot's .emacs.
To compile the erbot source, edit Makefile and run "make". To install
it, edit Makefile and run "make install".
====================================================
For developers:
Namespaces used by these files: fs-, fs.*-, erb.*-
Next, we attempt to describe the various abbreviations and terms used
in this package.
+---------+------------------------------------------------------------+
|botbbdb |Name of the bbdb database file used by the bots. |
+---------+------------------------------------------------------------+
|erb |ErBot stands for erc robot, and started out from |
| |erc-robot.el. We named the new file erbot, and most |
| |namespaces start with erb. |
+---------+------------------------------------------------------------+
| | |
+---------+------------------------------------------------------------+
|erbc- |This referred to erbot-comands. Functions starting with this|
| |name were availabel to public to frob as they like. Same |
| |for variables. This was replaced by fs- |
+---------+------------------------------------------------------------+
|erbnoc- |This is like erbc-, except that these commands are NOT |
| |available to the general public (at this time). This one is|
| |still in use, unlike fs-. These functions are NOT |
| |world-executable or world-writable, but are maintained |
| |alognside erbc- functions .. erbnoc meansd: erb - |
| |no-commands... We have now shortened it to erbn- |
+---------+------------------------------------------------------------+
|erbn- |Shortening of erbnoc- |
+---------+------------------------------------------------------------+
|fs- |fsbot is a popular instance of erbot. At some point, all |
| |erbc- prefixes were replaced by fs- for easier read. Thus, |
| |to reiterate, these functions are world-readable, weritable |
| |writable and executable. (The only exeptions are those that|
| |are internally converted from fsi-, which are converted to |
| |fs- with a special disabled property.) Summary: rwx for irc|
| |users. |
+---------+------------------------------------------------------------+
|fsi- |Like fs- but these functions and variables are only |
| |world-readable and world-executable, but NOT world-writable.|
| |The "i" stands for immutable (or is it "internal"?). These |
| |functions are internally converted to fs- functionserbot |
| |usage through erbot-install-symbols. Summary: r-x for irc |
| |users. |
+---------+------------------------------------------------------------+
|fsn- |This "fs NOT" would be the logical "---" counterpart for the|
| |fs.* prefixes above, butits similarity to fs will make |
| |reading difficult, so we stick with erbn- |
+---------+------------------------------------------------------------+
|All other|.. are also ---, and the only difference from erbn- is |
|prefixes |aesthetical. |
| | |
+---------+------------------------------------------------------------+
|fsbot | "Free software bot", an instance of fsbot. |
+---------+------------------------------------------------------------+
| | |
| | |
| | |
| | |
| | |
+---------+------------------------------------------------------------+
|
