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
37       /usr/share/doc/eggdrop/BOTNET 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              By  default Eggdrop will save its user and channel file and die.
75              A script can override the default handler  by  registering  with
76              the EVNT bind and returning 1.
77
78       SIGHUP By  default  Eggdrop  will  rehash  (reload  its config file). A
79              script can override the default handler by registering with  the
80              EVNT bind and returning 1.
81
82       SIGQUIT
83              By  default  Eggdrop  will  restart.  A  script can override the
84              default handler by registering with the EVNT bind and  returning
85              1.
86

ENVIRONMENT VARIABLES

88       EGG_LANG
89              This  variable  can  be  set  to  the language in which you want
90              Eggdrop to speak
91               to you. It defaults to English, but  German,  French,  Finnish,
92              and Danish are supported, too.
93
94       EGG_LANGDIR
95              Specifies  the  directory  where  all  your  language  files are
96              stored.  The default is /usr/share/eggdrop/language.
97

SEE ALSO

99       tclsh(1), irc(1), ircII(1), ircd(8)
100
101       There is extensive online documentation.  Once you get the bot running,
102       open a DCC chat with it, and type: .help
103
104       In addition, the files in the /usr/share/doc/eggdrop/ directory provide
105       detailed information about how Eggdrop works and how to use it.
106

AUTHORS

108       Written by Robey Pointer, the Eggheads  Development  Team  and  various
109       others.  See  the  files  AUTHORS  for a list of Eggdrop developers and
110       major contributors, THANKS for a full list of Eggdrop contributors, and
111       the  /usr/share/doc/eggdrop/Changes files for a list of changes made to
112       each version of Eggdrop.
113

REPORTING BUGS

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