1eggdrop(1) IRC Tools eggdrop(1)
2
6 eggdrop - an IRC bot
7
9 eggdrop [options] [config-file]
10
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 ex‐
15 panded upon by both novice and advanced IRC users on a variety of hard‐
16 ware and software platforms.
17 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 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 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 Eggdrop needs a config file to run. For an example, have a look at
40 eggdrop.conf which is distributed with Eggdrop.
41
43 -h Display a list of command-line options.
44 -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 -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 -nc Don't background, show channel info. This is just like -n, ex‐
57 cept 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 -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 -v Show version info, then quit.
67
69 SIGCHLD
70 This signal is ignored by Eggdrop and can be used to determine
71 whether it's running or not.
72 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 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 SIGQUIT
83 By default Eggdrop will restart. A script can override the de‐
84 fault handler by registering with the EVNT bind and returning 1.
85
87 EGG_LANG
88 This variable can be set to the language in which you want
89 Eggdrop to speak
90 to you. It defaults to English, but German, French, Finnish,
91 and Danish are supported, too.
92 EGG_LANGDIR
94 Specifies the directory where all your language files are
95 stored. The default is /usr/share/eggdrop/language.
96
98 tclsh(1), irc(1), ircII(1), ircd(8)
99 There is extensive online documentation. Once you get the bot running,
101 open a DCC chat with it, and type: .help
102 In addition, the files in the /usr/share/doc/eggdrop/ directory provide
104 detailed information about how Eggdrop works and how to use it.
105
107 Written by Robey Pointer, the Eggheads Development Team and various
108 others. See the files AUTHORS for a list of Eggdrop developers and ma‐
109 jor contributors, THANKS for a full list of Eggdrop contributors, and
110 the /usr/share/doc/eggdrop/Changes files for a list of changes made to
111 each version of Eggdrop.
112
114 See /usr/share/doc/eggdrop/BUG-REPORT.
115 Bugs can either be reported directly via GitHub at
117 https://github.com/eggheads/eggdrop/issues.
118
120 Copyright (C) 1997 Robey Pointer
121 Copyright (C) 1999 - 2023 Eggheads Development Team
122 This program is free software; you can redistribute it and/or modify it
124 under the terms of the GNU General Public License as published by the
125 Free Software Foundation; either version 2 of the License, or (at your
126 option) any later version.
127 This program is distributed in the hope that it will be useful, but
129 WITHOUT ANY WARRANTY; without even the implied warranty of MER‐
130 CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
131 Public License for more details.
132 You should have received a copy of the GNU General Public License along
134 with this program; if not, write to the Free Software Foundation, Inc.,
135 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
136Eggheads Development Team August 2004 eggdrop(1)