1eggdrop(1)                         IRC Tools                        eggdrop(1)
2
3
4

NAME

6       eggdrop - an IRC bot
7

SYNOPSIS

9       eggdrop [options] [config-file]
10

DESCRIPTION

12       Eggdrop  is  the World's most popular Internet Relay Chat (IRC) bot; it
13       is freely distributable under the GNU  General  Public  License  (GPL).
14       Eggdrop  is  a  feature  rich  program  designed  to be easily used and
15       expanded upon by both novice and advanced IRC users  on  a  variety  of
16       hardware and software platforms.
17
18       An  IRC bot is a program that sits on an IRC channel and performs auto‐
19       mated tasks while looking just like a normal user on the channel.  Some
20       of  these functions include protecting the channel from abuse, allowing
21       privileged users to gain op or voice status,  logging  channel  events,
22       providing information, hosting games, etc.
23
24       One  of  the  features  that makes Eggdrop stand out from other bots is
25       module and Tcl scripting support. With scripts  and  modules,  you  can
26       make  the  bot  perform  almost any task you want. They can do anything
27       from preventing floods to greeting users and banning  advertisers  from
28       channels.
29
30       You can also link multiple Eggdrop bots together to form a botnet. This
31       can allow bots to op each other securely, control  floods  efficiently,
32       and even link channels across multiple IRC networks. It also allows the
33       Eggdrops share user lists, ban lists, exempt/invite lists,  and  ignore
34       lists with other bots if userfile sharing is enabled. This allows users
35       to have the same access on every bot on your botnet. It also allows the
36       bots to distribute tasks such as opping and banning users. See doc/BOT‐
37       NET for information on setting up a botnet.
38
39       Eggdrop needs a config file to run. For an  example,  have  a  look  at
40       eggdrop.conf which is distributed with Eggdrop.
41

OPTIONS

43       -h     Display a list of command-line options.
44
45       -n     Don't  background.  Normally,  Eggdrop will move itself into the
46              background when you start it  up,  meaning  you'll  get  another
47              shell  prompt, and you can do other things while the bot is run‐
48              ning. With -n, you won't return to the shell  prompt  until  the
49              bot  exits  (which  won't normally happen until it's killed). By
50              default, -n will send all log entries to the console.
51
52       -nt    Don't background, use terminal. This is  just  like  -n,  except
53              that instead of seeing log entries, your console will simulate a
54              DCC chat with the bot.
55
56       -nc    Don't background, show channel  info.  This  is  just  like  -n,
57              except that instead of seeing log entries, every 10 seconds your
58              screen will clear and you will see the current  channel  status,
59              sort of like "top".
60
61       -m     Create  userfile.  If  you don't have a userfile, this will make
62              Eggdrop create one and give owner status  to  the  first  person
63              that introduces himself or herself to it. You'll need to do this
64              when you first set up your bot.
65
66       -v     Show version info, then quit.
67

SIGNALS

69       SIGCHLD
70              This signal is ignored by Eggdrop and can be used  to  determine
71              whether it's running or not.
72
73       SIGTERM
74              Depending  on  die-on-sigterm  being set to 0 or 1 in the config
75              file, Eggdrop will save its user and channel file and/or die.
76
77       SIGHUP Depending on die-on-sighup being set to 0 or  1  in  the  config
78              file, Eggdrop will rehash (reload its config file) or die.
79

ENVIRONMENT VARIABLES

81       EGG_LANG
82              This  variable  can  be  set  to  the language in which you want
83              Eggdrop to speak
84               to you. It defaults to English, but  German,  French,  Finnish,
85              and Danish are supported, too.
86
87       EGG_LANGDIR
88              Specifies  the  directory  where  all  your  language  files are
89              stored.  The default is ./language.
90

SEE ALSO

92       tclsh(1), irc(1), ircII(1), ircd(8)
93
94       There is extensive online documentation.  Once you get the bot running,
95       open a DCC chat with it, and type: .help
96
97       In  addition, the files in the doc/ directory provide detailed informa‐
98       tion about how Eggdrop works and how to use it.
99

AUTHORS

101       Written by Robey Pointer, the Eggheads  Development  Team  and  various
102       others.  See  the  files  AUTHORS  for a list of Eggdrop developers and
103       major contributors, THANKS for a full list of Eggdrop contributors, and
104       the  doc/Changes  files  for  a list of changes made to each version of
105       Eggdrop.
106

REPORTING BUGS

108       See doc/BUG-REPORT.
109
110       Bugs   can   either   be   reported   directly    to    BugZilla,    at
111       http://bugzilla.eggheads.org, or via e-mail to <bugs@eggheads.org>.
112
114       Copyright (C) 1997 Robey Pointer
115       Copyright (C) 1999 - 2011 Eggheads Development Team
116
117       This program is free software; you can redistribute it and/or modify it
118       under the terms of the GNU General Public License as published  by  the
119       Free  Software Foundation; either version 2 of the License, or (at your
120       option) any later version.
121
122       This program is distributed in the hope that it  will  be  useful,  but
123       WITHOUT  ANY  WARRANTY;  without  even  the  implied  warranty  of MER‐
124       CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU  General
125       Public License for more details.
126
127       You should have received a copy of the GNU General Public License along
128       with this program; if not, write to the Free Software Foundation, Inc.,
129       59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
130
131
132
133
134Eggheads Development Team         August 2004                       eggdrop(1)
Impressum