Permalink
Browse files

Generate docs with 1.8.4 version

  • Loading branch information...
vanosg committed Dec 11, 2018
1 parent b73ed91 commit 66287c26f397c6f2f62f89ffc0f791dba29ad51e
Showing with 9,325 additions and 10,577 deletions.
  1. +3 −3 FEATURES
  2. +8 −8 INSTALL
  3. +4 −4 README
  4. +6 −6 doc/ABOUT
  5. +8 −8 doc/BANS
  6. +21 −21 doc/BOTNET
  7. +4 −3 doc/FAQ
  8. +2 −2 doc/KNOWN-PROBLEMS
  9. +16 −16 doc/MODULES
  10. +3 −3 doc/PATCH-HOWTO
  11. +28 −31 doc/TEXT-SUBSTITUTIONS
  12. +53 −19 doc/TLS
  13. +2 −2 doc/TRICKS
  14. +4 −6 doc/USERS
  15. +2 −2 doc/WEIRD-MESSAGES
  16. +29 −140 doc/html/_static/basic.css
  17. BIN doc/html/_static/comment-bright.png
  18. BIN doc/html/_static/comment-close.png
  19. BIN doc/html/_static/comment.png
  20. +16 −89 doc/html/_static/doctools.js
  21. BIN doc/html/_static/down-pressed.png
  22. BIN doc/html/_static/down.png
  23. BIN doc/html/_static/file.png
  24. +7,397 −8,246 doc/html/_static/jquery.js
  25. BIN doc/html/_static/minus.png
  26. BIN doc/html/_static/plus.png
  27. +0 −6 doc/html/_static/pygments.css
  28. +16 −155 doc/html/_static/searchtools.js
  29. +306 −439 doc/html/_static/underscore.js
  30. BIN doc/html/_static/up-pressed.png
  31. BIN doc/html/_static/up.png
  32. +16 −16 doc/html/_static/websupport.js
  33. +17 −14 doc/html/appendices/first-script.html
  34. +14 −12 doc/html/appendices/index.html
  35. +16 −13 doc/html/appendices/known-probs.html
  36. +18 −15 doc/html/appendices/text-sub.html
  37. +21 −18 doc/html/appendices/tricks.html
  38. +16 −13 doc/html/appendices/weird-msgs.html
  39. +17 −14 doc/html/coreDocs/assoc.html
  40. +17 −14 doc/html/coreDocs/blowfish.html
  41. +17 −14 doc/html/coreDocs/channels.html
  42. +17 −14 doc/html/coreDocs/compress.html
  43. +17 −14 doc/html/coreDocs/console.html
  44. +34 −31 doc/html/coreDocs/core.html
  45. +17 −14 doc/html/coreDocs/ctcp.html
  46. +17 −14 doc/html/coreDocs/dns.html
  47. +17 −14 doc/html/coreDocs/filesys.html
  48. +14 −12 doc/html/coreDocs/index.html
  49. +17 −14 doc/html/coreDocs/irc.html
  50. +173 −170 doc/html/coreDocs/modules.html
  51. +17 −14 doc/html/coreDocs/notes.html
  52. +17 −14 doc/html/coreDocs/seen.html
  53. +31 −28 doc/html/coreDocs/server.html
  54. +17 −14 doc/html/coreDocs/share.html
  55. +17 −14 doc/html/coreDocs/transfer.html
  56. +17 −14 doc/html/coreDocs/uptime.html
  57. +17 −14 doc/html/coreDocs/woobie.html
  58. +14 −12 doc/html/index.html
  59. +24 −21 doc/html/installAndSetup/faq.html
  60. +14 −12 doc/html/installAndSetup/index.html
  61. +27 −24 doc/html/installAndSetup/install.html
  62. +23 −20 doc/html/installAndSetup/readme.html
  63. +16 −13 doc/html/mainDocs/about.html
  64. +16 −13 doc/html/mainDocs/bans.html
  65. +30 −27 doc/html/mainDocs/botnet.html
  66. +16 −13 doc/html/mainDocs/features.html
  67. +15 −13 doc/html/mainDocs/index.html
  68. +16 −13 doc/html/mainDocs/ipv6.html
  69. +16 −13 doc/html/mainDocs/partyline.html
  70. +31 −28 doc/html/mainDocs/patch.html
  71. +52 −49 doc/html/mainDocs/tcl-commands.html
  72. +59 −33 doc/html/mainDocs/tls.html
  73. +17 −14 doc/html/mainDocs/users.html
  74. BIN doc/html/objects.inv
  75. +14 −12 doc/html/search.html
  76. +1 −1 doc/html/searchindex.js
  77. +59 −83 doc/settings/core.settings
  78. +76 −84 doc/settings/mod.channels
  79. +7 −7 doc/settings/mod.ctcp
  80. +12 −12 doc/settings/mod.irc
  81. +2 −2 doc/settings/mod.notes
  82. +30 −41 doc/settings/mod.server
  83. +3 −2 doc/settings/mod.share
  84. +182 −254 doc/tcl-commands.doc
@@ -16,9 +16,9 @@ EGGDROP FEATURES
- A "party line" available through dcc chat or telnet, with
multiple channels, giving you the ability to talk to people
without being affected by netsplits.
- A "botnet". A botnet consists of one or more bots linked
together. This can allow bots to op each other securely, control
floods efficiently, and share user lists, ban lists,
- A "botnet". A botnet consists of one or more bots
linked together. This can allow bots to op each other securely,
control floods efficiently, and share user lists, ban lists,
exempt/invite lists, and ignore lists (if sharing is enabled).
- User records are saved on disk and alterable via dcc chat. Each
user can have a password (encrypted), a list of valid hostmasks,
16 INSTALL
@@ -65,8 +65,8 @@ Eggdrop uses the GNU autoconfigure scripts to make things easier.
output on a (highly unlikely :) crash. This will help the
development team track down the crash and fix the bug. Debug and
sdebug will take a little longer to compile and will enlarge the
binary a bit, but it's worth it if you want to support Eggdrop
development.
binary a bit, but it's worth it if you want to support
Eggdrop development.

4.

@@ -87,8 +87,8 @@ Eggdrop uses the GNU autoconfigure scripts to make things easier.

make install DEST=/home/user/otherdir

Note that you must use full path for every file to be correctly
installed.
Note that you must use full path for every file to be
correctly installed.

[The following is performed from the directory installed above.]

@@ -127,8 +127,8 @@ Eggdrop uses the GNU autoconfigure scripts to make things easier.
From then on, you will be able to use your config file as a
shell script. You can just type "./LamestBot.conf" from your
shell prompt to start up your bot. For this to work, the top
line of your script MUST contain the correct path to the Eggdrop
executable.
line of your script MUST contain the correct path to the
Eggdrop executable.

9.

@@ -182,8 +182,8 @@ FREQUENTLY ASKED QUESTIONS
(W) But...
(X) Well, go to www.egghelp.org or www.eggheads.org and see if you can
find there what you're looking for. There are also lots of IRC
help channels and various mailing lists, as seen in the README
FILE.
help channels and various mailing lists, as seen in the
README FILE.

This is the end. If you read to this point, hopefully you have also read
the README file. If not, then READ IT!&@#%@!
8 README
@@ -175,10 +175,10 @@ COMMAND LINE
-n: Don't background. Normally, Eggdrop will move itself into the

background when you start it up, meaning you'll get another
shell prompt and you can do other things while the bot is
running. With -n, you won't return to the shell prompt until the
bot exits (which won't normally happen until it's killed). By
default, -n will send all log entries to the console.
shell prompt and you can do other things while the bot
is running. With -n, you won't return to the shell prompt until
the bot exits (which won't normally happen until it's killed).
By default, -n will send all log entries to the console.

-nt: Don't background, use terminal. This is just like -n, except that

@@ -51,12 +51,12 @@ ABOUT EGGDROP

- Some sort of Unix account
- A pretty good knowledge of IRC and Unix, including how to
compile programs, how to read, and what DCC chat is, at absolute
minimum.
- About 5-7 MB of disk space. The Eggdrop tarball is about 5.4 MB
unpacked.
- Tcl -- Eggdrop cannot compile without Tcl installed on your
shell.
compile programs, how to read, and what DCC chat is, at
absolute minimum.
- About 5-7 MB of disk space. The Eggdrop tarball is about 5.4
MB unpacked.
- Tcl -- Eggdrop cannot compile without Tcl installed on
your shell.

Before starting, ask yourself if you really need a bot. Most IRC
servers allow only a handful of bots, and some forbid them outright.
@@ -15,8 +15,8 @@ BANS, INVITES, AND EXEMPTS

These modes will be active on every channel the bot monitors.
Some will "expire" after a while (be removed automatically).
Others are considered "permanent" and can only be removed by a
master.
Others are considered "permanent" and can only be removed by
a master.

Channel modes

@@ -36,9 +36,9 @@ BANS, INVITES, AND EXEMPTS

Sticky

These modes are usually set by a user using the ".stick"
command. Modes with this attribute are attempted to be kept
active on the channel at all times by the bot, even if the
These modes are usually set by a user using the
".stick" command. Modes with this attribute are attempted to be
kept active on the channel at all times by the bot, even if the
channel is set to use dynamic modes. Obviously, if the channel
isn't set to use dynamic modes, this won't have any effect.

@@ -74,8 +74,8 @@ BANS, INVITES, AND EXEMPTS
If the channel does not support dynamic invites, then they are
set at all times. Otherwise, the invite is set when the channel
is +i and a user requests an invite into the channel. The invite
then remains set for 'invite-time' minutes (defined in config
file) or until the channel goes -i again, whichever happens
last.
then remains set for 'invite-time' minutes (defined in
config file) or until the channel goes -i again, whichever
happens last.

Copyright (C) 1999 - 2018 Eggheads Development Team
@@ -31,8 +31,8 @@ LINK

HUB

A bot is described as a hub-bot if one or more bots are linked to
it.
A bot is described as a hub-bot if one or more bots are linked
to it.

LEAF

@@ -56,14 +56,14 @@ SHARE BOT

AGGRESSIVE SHARE

Aggressive share is a term used to describe the direction of sharing
user-files. Aggressive share bots will SEND userfiles to another
passive bot.
Aggressive share is a term used to describe the direction of
sharing user-files. Aggressive share bots will SEND userfiles to
another passive bot.

PASSIVE SHARE

Passive share is a term used to describe the direction of sharing
user-files. Passive share bots will accept userfiles from an
Passive share is a term used to describe the direction of
sharing user-files. Passive share bots will accept userfiles from an
aggressive share bot.

ADDRESS
@@ -76,8 +76,8 @@ ADDRESS
RELAY PORT

The relay port number of the bot is defined in the config file. Note
that you can define one port for bots and another for user
connections.
that you can define one port for bots and another for
user connections.

RELAY

@@ -115,26 +115,26 @@ Flags can be either global (such as +s) or channel specific (such as |+s

The following is a list of valid bot flags:

------ ---------------------------------------------------------------
s share aggressively (SEND userfile to a passive bot)
------- ----------------------------------------------------------------
s share aggressively (SEND userfile to a passive bot)

p share passively (ACCEPT userfile from an aggressive bot)
p share passively (ACCEPT userfile from an aggressive bot)

g global share (share all channels)
g global share (share all channels)

h hub (automatically link to this bot)
h hub (automatically link to this bot)

a alternate (automatically link to this bot if the hub bot can't
be linked)
a alternate (automatically link to this bot if the hub bot can't
be linked)

l leaf (bot is not allowed to link in other bots)
l leaf (bot is not allowed to link in other bots)

r reject (bot will not be allowed to link)
r reject (bot will not be allowed to link)

i isolate (isolate the party line across a bot link)
i isolate (isolate the party line across a bot link)

0-9 user defined flags
------ ---------------------------------------------------------------
0-9 user defined flags
------- ----------------------------------------------------------------


ADDING AND LINKING BOTS
@@ -90,9 +90,9 @@ WHEN I 'tclsh scripts/weed <userfile> c' IT BARFS CHUNKS AT ME AND DIES.
with '.' generally) and accept the loss of that data.

I GET "ld-elf.so.1: Shared object "libtcl80.so.1" not found" or
"eggdrop: error in loading shared libraries libtcl8.1.so: cannot open
shared object file: No such file or directory" WHEN I TRY TO START MY
BOT.
"eggdrop: error in loading shared libraries libtcl8.1.so:
cannot open shared object file: No such file or directory" WHEN I TRY TO
START MY BOT.

'./configure' is looking in the wrong place for Tcl; it looks like it
compiled with one version of Tcl and tries to load another. Maybe your
@@ -143,3 +143,4 @@ OTHER SYMBOL) WHEN I TRY TO LOAD A MODULES.
3. If you are of a more aggressive sense of mind, go beat the
stuffing out of your admin for having lame static libraries.
:)

@@ -15,8 +15,8 @@ KNOWN PROBLEMS

- High-bit characters are being filtered from channel names. This
is a fault of the Tcl interpreter, and not Eggdrop. The Tcl
interpreter filters the characters when it reads a file for
interpreting. Update your Tcl to version 8.1 or higher.
interpreter filters the characters when it reads a file
for interpreting. Update your Tcl to version 8.1 or higher.
- Version 8.1 of Tcl doesn't support unicode characters. If those
characters are handled in a script as text, you run into errors.
Eggdrop can't handle these errors at the moment.
@@ -30,8 +30,8 @@ installing a module. Please read any and all directions included with
the module you wish to install.

1. Download and un-tar the Eggdrop source code.
2. Place the new module in its own directory (in the format of
(modulename).mod) in src/mod.
2. Place the new module in its own directory (in the format
of (modulename).mod) in src/mod.
3. Run ./configure (from eggdrop1.8.x/).
4. Type 'make config' or 'make iconfig'.
5. Type 'make'.
@@ -48,16 +48,16 @@ MODULES INCLUDED WITH EGGDROP

assoc

This module provides assoc support, i.e. naming channels on the
botnet.
This module provides assoc support, i.e. naming channels on
the botnet.

blowfish

Eggdrop can encrypt your userfile, so users can have secure
passwords. Please note that when you change your encryption method
later (i.e. using other modules like a md5 module), you can't use
your current userfile anymore. Eggdrop will not start without an
encryption module.
Eggdrop can encrypt your userfile, so users can have
secure passwords. Please note that when you change your encryption
method later (i.e. using other modules like a md5 module), you
can't use your current userfile anymore. Eggdrop will not start
without an encryption module.

channels

@@ -85,14 +85,14 @@ MODULES INCLUDED WITH EGGDROP

This module provides asynchronous dns support. This will avoid
long periods where the bot just hangs there, waiting for a
hostname to resolve, which will often let it timeout on all other
connections.
hostname to resolve, which will often let it timeout on all
other connections.

filesys

This module provides an area within the bot where users can store
and manage files. With this module, the bot is usable as a file
server.
and manage files. With this module, the bot is usable as a
file server.

irc

@@ -109,9 +109,9 @@ MODULES INCLUDED WITH EGGDROP
seen

This module provides very basic seen commands via msg, on channel
or via dcc. This module works only for users in the bot's
userlist. If you are looking for a better and more advanced seen
module, try the gseen module by G'Quann. You can find it at
or via dcc. This module works only for users in the
bot's userlist. If you are looking for a better and more advanced
seen module, try the gseen module by G'Quann. You can find it at
http://www.kreativrauschen.com/gseen.mod/.

server
@@ -18,7 +18,7 @@ APPLYING A PATCH
To apply a patch to an Eggdrop, you have to first obtain the Eggdrop
source code. You should always keep a tar.gz archive with the source
of your current Eggdrop on your shell. In the next step, you have to
change to your source directory (i.e.: /home/user/eggdrop1.8.3/) and
change to your source directory (i.e.: /home/user/eggdrop1.8.4/) and
type the following command:

patch -p1 < ../path.to.the/patch
@@ -105,8 +105,8 @@ To create a patch using the diff tool:
PATCH1.8: my-patch-filename.patch

You should also include the nick/handle, name, and email address
you would like used for attribution in the Changes1.8 and THANKS
files.
you would like used for attribution in the Changes1.8 and
THANKS files.

Never modify src/version.h or one of the Changes files. We will do it.
If your patch includes changes related to autotools (./configure,
Oops, something went wrong.

0 comments on commit 66287c2

Please sign in to comment.