/[cvs]/eggdrop1.9/README
ViewVC logotype

Contents of /eggdrop1.9/README

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.26 - (show annotations) (download)
Sun Jun 20 21:33:27 2004 UTC (15 years, 5 months ago) by wingman
Branch: MAIN
CVS Tags: HEAD
Changes since 1.25: +10 -10 lines
* 1.7 => 1.9 change (though not all occurrances replaced. Old modules,
  ChangeLogs, etc were kept.)

1 $Id: README,v 1.25 2003/12/11 01:21:48 wcc Exp $
2
3 Readme
4 Last revised: December 10, 2003
5 _________________________________________________________________
6
7 Readme
8
9
10 Please at least SKIM this document before asking questions. In fact, READ IT
11 if you've never successfully set up an Eggdrop bot before. PLEASE! READ IT!
12
13 Contents
14
15 0. Important notice
16 1. What is Eggdrop?
17 2. How do I get Eggdrop?
18 3. Command line
19 4. Boring legal stuff
20 5. Mailing list
21 6. Documentation
22 7. Obtaining help
23
24 _________________________________________________________________
25
26
27 (0) NOTICE
28
29 Please read this file carefully before trying to set up Eggdrop. Also,
30 make SURE that you select your +n (owner) users wisely! They have 100%
31 access to your bot and account! ONLY GIVE THIS POWER TO SOMEONE YOU
32 TRUST COMPLETELY!!
33
34 Remember that this is a DEVELOPMENT VERSION. Everything isn't guaranteed
35 to work. Eggdrop 1.9 should *NOT* be used in a production environment.
36
37
38 (1) WHAT IS EGGDROP?
39
40 Eggdrop is the world's most popular Internet Relay Chat (IRC) bot; it is
41 freely distributable under the GNU General Public License (GPL). Eggdrop
42 is a feature rich program designed to be easily used and expanded upon by
43 both novice and advanced IRC users on a variety of hardware and software
44 platforms.
45
46 An IRC bot is a program that sits on an IRC channel and preforms automated
47 tasks while looking just like a normal user on the channel. Some of these
48 functions include protecting the channel from abuse, allowing privileged
49 users to gain op or voice status, logging channel events, providing
50 information, hosting games, etc.
51
52 One of the features that makes Eggdrop stand out from other bots is module
53 and Tcl scripting support. With scripts and modules, you can make the bot
54 preform almost any task you want. They can do anything from preventing
55 floods to greeting users and banning advertisers from channels.
56
57 You can also link multiple Eggdrop bots together to form a botnet. This
58 can allow bots to op each other securely, control floods efficiently, and
59 even link channels across multiple IRC networks. It also allows the
60 Eggdrops share user lists, ban lists, exempt/invite lists, and ignore
61 lists with other bots if userfile sharing is enabled. This allows users
62 to have the same access on every bot on your botnet. It also allows the
63 bots to distribute tasks such as opping and banning users. See doc/BOTNET
64 for information on setting up a botnet.
65
66 Eggdrop is always being improved and adjusted because there are bugs to
67 be fixed and features to be added (if the users demand them, and they make
68 actually sense). In fact, it existed for several years as v0.7 - v0.9
69 before finally going 1.0. This version of Eggdrop is part of the 1.6 tree.
70 A valiant effort has been made to chase down and destroy bugs.
71
72 This README file contains information about how to get Eggdrop, command
73 line options for Eggdrop, what you may need to do when upgrading from
74 older versions, a list of frequently asked questions, how to set up a
75 crontab, some boring legal stuff, info about the mailing list (a great
76 place to ask questions, and a good place to report bugs, too), some basics
77 about CVS usage, and some channels where you might get help with Eggdrop.
78
79
80 (2) HOW TO GET EGGDROP
81
82 You can obtain the LATEST version of Eggdrop 1.9 by using CVS. CVS means
83 'Concurrent Versions System' and is a tool for developers to always keep
84 source code up to date. Try 'man cvs' on your shell for more information
85 about CVS.
86
87 To obtain Eggdrop 1.9 via CVS, do as follows:
88
89 1. Log into your shell.
90
91 2. Type: 'export
92 CVSROOT=:pserver:anonymous@cvs.eggheads.org:/usr/local/cvsroot'.
93
94 3. Type 'cvs login'.
95
96 4. Press <enter> when prompted for a password.
97
98 5. In your home dir, type 'cvs checkout eggdrop1.9'
99
100 6. In ~/eggdrop1.9, you should have a copy of the latest CVS version
101 of Eggdrop 1.9.
102
103 Notes:
104
105 o You can 'cvs logout', but you don't need to.
106
107 o You don't need to go through this whole process every time. If you
108 want to get a CVS version of Eggdrop at a later time, you can just
109 'cd ~/eggdrop1.9' and type 'cvs update -CdAP'.
110
111 o If you experience errors when using 'export', you might be using tclsh
112 as a shell. If so, try using the command 'setenv' instead of 'export':
113
114 setenv CVSROOT :pserver:anonymous@cvs.eggheads.org:/usr/local/cvsroot
115
116
117 (3) COMMAND LINE
118
119 Eggdrop has some command-line options -- not many, because most things
120 should be defined through the config file. However, sometimes you may
121 want to start up the bot in a different mode, and the command-line
122 options let you do that. Basically, the command line for Eggdrop is:
123
124 % eggdrop [options] [config-file]
125
126 The options available are:
127
128 -n: Don't background. Normally, Eggdrop will move itself into the
129 background when you start it up, meaning you'll get another shell
130 prompt, and you can do other things while the bot is running. With
131 -n, you won't return to the shell prompt until the bot exits (which
132 won't normally happen until it's killed). By default, -n will send
133 all log entries to the console.
134
135 -nt: Don't background, use terminal. This is just like -n, except that
136 instead of seeing log entries, your console will simulate a DCC
137 chat with the bot.
138
139 -nc: Don't background, show channel info. This is just like -n, except
140 that instead of seeing log entries, every 10 seconds your screen
141 will clear and you will see the current channel status, sort of
142 like "top".
143
144 -m: Create userfile. If you don't have a userfile, this will make Eggdrop
145 create one and give owner status to the first person that introduces
146 himself or herself to it. You'll need to do this when you first set
147 up your bot.
148
149 -v: Show version info, then quit.
150
151 Most people never use any of the options except -m, and you usually only
152 need to use that once.
153
154
155 (4) BORING LEGAL STUFF
156
157 The Eggdrop bot is copyright (C) by Robey Pointer. As of January, 1997,
158 Eggdrop is distributed according to the GNU General Public License. There
159 should be a copy of this license in the file 'COPYING'. If not, write to
160 the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
161
162 As of eggdrop1.3.28, all changes made by the Eggheads development team to
163 the Eggdrop source code and any related files are copyright (C) by
164 Eggheads. The source code will still be distributed according to the GNU
165 General Public License as Robey Pointer did in the past.
166
167 Releases previous to 1.0m were made using a different licensing scheme.
168 You may, at your option, use the GNU General Public License on those
169 versions (instead of the license packaged with them) with my blessing.
170 For any versions bearing a copyright date of 1997 or later, you have
171 no choice -- you must use the GNU General Public License.
172
173 The files "match.c", "net.c", and "blowfish.c" are exempt from the above
174 restrictions. "match.c" is original code by Chris Fuller (email:
175 crf@cfox.bchs.uh.edu) and has been placed by him into the public domain.
176 "net.c" is by me, and I [who?] also choose to place it in the public
177 domain. "blowfish.c" is by various sources and is in the public domain
178 as well. All 3 files contain useful functions that could easily be
179 ported to other applications.
180
181 There is no warranty, implied or whatever. You use this software at your
182 own risk, no matter what purpose you put it to.
183
184
185 (5) MAILING LIST
186
187 If you are interested in Eggdrop 1.9, and/or the development of Eggdrop,
188 the eggdev@eggheads.org mailing list focuses on these topics.
189
190 To subscribe to the eggdev mailing list, send an e-mail to wcc@eggheads.org
191 explaining why you would like to be a part of the list. Then visit the
192 following url to subscribe to the list:
193
194 http://scrambled.eggheads.org/mailman/listinfo/eggdev
195
196 NOTE: All subscribe requests not accompanied by an e-mail to
197 wcc@eggheads.org WILL be rejected.
198
199 ### DO NOT SEND ROBEY EMAIL ABOUT EGGDROP! ###
200
201 Robey is no longer developing the Eggdrop code, so don't bother e-mailing
202 him. If you have a serious problem, email the eggheads mailing list and
203 it will get to the coders.
204
205 Please, before posting to this list, see what things are like. When you do
206 post, read over your post for readability, spelling, and grammar mistakes.
207
208 DO NOT SEND HTML E-MAILS TO ANY OF THE EGGHEADS.ORG MAILING LISTS. ANYONE
209 CAUGHT SENDING HTML E-MAILS TO ONE OF THESE LISTS WILL BE REMOVED
210 IMMEDIATELY!
211
212
213 (6) DOCUMENTATION
214
215 We're trying to keep the documentation up to date. If you feel that
216 anything is missing here or that anything should be added, etc, please
217 email docteam@eggheads.org about it. Thank you.
218
219
220 (7) OBTAINING HELP
221
222 See 'MAILING LIST' (5). IRC support is NOT available for Eggdrop 1.9 at
223 this time.
224
225 ________________________________________________________________________
226
227 Copyright (C) 1997 Robey Pointer
228 Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004 Eggheads Development Team
229

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23