/[cvs]/eggdrop1.6/INSTALL
ViewVC logotype

Annotation of /eggdrop1.6/INSTALL

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


Revision 1.31 - (hide annotations) (download)
Sun Feb 13 14:19:32 2011 UTC (8 years, 3 months ago) by simple
Branch: MAIN
CVS Tags: HEAD
Changes since 1.30: +2 -2 lines
Freshened Copyrights to 2011

1 simple 1.31 $Id: INSTALL,v 1.30 2010/01/03 13:27:22 pseudo Exp $
2 wcc 1.19
3 fabian 1.3 Compilation and Installation of Eggdrop
4 wcc 1.24 Last revised: July 24, 2004
5     _____________________________________________________________________
6 wcc 1.15
7 wcc 1.24 Compilation and Installation of Eggdrop
8 wcc 1.15
9 fabian 1.3
10 wcc 1.16 This is the quick install guide; if you have had little or no experience
11     with UNIX or Eggdrop, READ THE README FILE NOW! This file is only for
12     experienced users.
13    
14 wcc 1.24 For more information on compiling Eggdrop, see the Compile Guide in
15 wcc 1.25 doc/COMPILE-GUIDE (and of course, the README FILE).
16 wcc 1.24
17 wcc 1.16 Contents:
18 wcc 1.19 1. What is Eggdrop?
19     2. Quick startup
20     3. Modules
21     4. Frequently asked questions
22 wcc 1.16
23    
24     (1) WHAT IS EGGDROP?
25    
26     Please, read the README file before attempting to set up this bot. This
27     file is a quick setup guide, not a miracle worker. If you enter this file
28     without basic Eggdrop knowledge, you will NOT leave with a working bot!
29     Before asking ANY questions, READ THE README FILE OR YOU WILL BE BURNED
30     TO A HORRIBLE DEATH! IF YOU DO NOT READ THAT FILE I WILL PERSONALLY WALK
31     TO YOUR TERMINAL AND BEAT IT WITH A SMELLY SNEAKER! By the way, read the
32     README file.
33 segfault 1.1
34 wcc 1.19 (2) QUICK STARTUP
35 segfault 1.1
36 wcc 1.16 Eggdrop uses the GNU autoconfigure scripts to make things easier.
37 segfault 1.1
38 wcc 1.16 1. Type './configure' from the Eggdrop directory. The configure script
39     will determine how your system is set up and figure out how to
40     correctly compile Eggdrop. It will also try to find Tcl, which is
41     required to compile.
42 fabian 1.3
43 wcc 1.16 2. Type either 'make config' or 'make iconfig' to determine which
44     modules will be compiled. 'make config' compiles the default modules
45     (everything but woobie.mod). If you want to choose which modules to
46     compile, use 'make iconfig'.
47 guppy 1.11
48 wcc 1.16 3. Type 'make' from the Eggdrop directory, or to force a statically
49     linked module bot, type 'make static'. Otherwise, the Makefile will
50     compile whatever type of bot the configure script determined your
51     system will support. Dynamic is always the better way to go if
52     possible. There are also the 'debug' and 'sdebug' (static-debug)
53     options, which will give more detailed output on a (highly unlikely :)
54 wcc 1.21 crash. This will help the development team track down the crash and
55     fix the bug. Debug and sdebug will take a little longer to compile
56     and will enlarge the binary a bit, but it's worth it if you want to
57     support Eggdrop development.
58 fabian 1.3
59 wcc 1.16 4. Eggdrop must be installed in a directory somewhere. This is
60     accomplished by entering the UNIX command:
61 fabian 1.3
62 wcc 1.16 make install
63 guppy 1.11
64 wcc 1.16 This will install the Eggdrop in your home directory in a directory
65     called 'eggdrop' (i.e. /home/user/eggdrop).
66 guppy 1.7
67 wcc 1.16 If you want to install to a different directory, use:
68 guppy 1.7
69 wcc 1.16 make install DEST=<directory>
70 fabian 1.3
71 wcc 1.16 For example:
72 guppy 1.11
73 wcc 1.16 make install DEST=/home/user/otherdir
74 fabian 1.3
75 wcc 1.16 Note that you must use full path for every file to be correctly
76     installed.
77 fabian 1.3
78 wcc 1.16 [The following is performed from the directory installed above.]
79 fabian 1.3
80 wcc 1.17 5. Edit your config file completely.
81 fabian 1.3
82 wcc 1.17 6. Start the bot with the "-m" option to create a user file, i.e. './eggdrop
83 wcc 1.16 -m LamestBot.conf'.
84 fabian 1.3
85 wcc 1.17 7. When starting the bot in the future, drop the "-m". If you have edited
86 wcc 1.16 your config file correctly, you can type:
87 segfault 1.1
88 wcc 1.16 chmod u+x <my-config-file-name>
89 wcc 1.13
90 wcc 1.16 For example:
91 wcc 1.13
92 wcc 1.16 chmod u+x LamestBot.conf
93 wcc 1.13
94 wcc 1.16 From then on, you will be able to use your config file as a shell
95     script. You can just type "./LamestBot.conf" from your shell prompt
96     to start up your bot. For this to work, the top line of your script
97     MUST contain the correct path to the Eggdrop executable.
98 wcc 1.13
99 wcc 1.17 8. It's advisable to run your bot via crontab, so that it will
100 wcc 1.16 automatically restart if the machine goes down or (heaven forbid)
101     the bot should crash. Look at 'scripts/botchk' and 'scripts/autobotchk'
102     for a great start with crontabbing the bot.
103 wcc 1.13
104 wcc 1.17 9. Smile, and if you haven't already read the README file in its
105 wcc 1.16 entirety, go take a long walk off a short pier.
106 segfault 1.1
107 wcc 1.16 (3) MODULES
108 segfault 1.1
109 wcc 1.16 Modules are small pieces of code that can either be compiled into the
110     binary or can be compiled separately into a file. This allows for a much
111     smaller binary.
112 guppy 1.11
113 wcc 1.16 If there are any modules that you have made or downloaded, you can add
114     them to the bot by placing them in the /src/mod directory with a mod
115     extension. They will be automatically compiled during make for you.
116     They must have a valid Makefile and, of course, be compatible with
117     the rest of the Eggdrop source.
118 guppy 1.11
119 wcc 1.16 If you wish to add a module at a later time, follow the same steps in
120     paragraph 2. After you have moved the appropriate files, you will only
121     need to type 'make modules' to compile only the modules portion of the
122     bot.
123 segfault 1.1
124 wcc 1.16 (3) FREQUENTLY ASKED QUESTIONS
125 segfault 1.1
126 wcc 1.16 (Q) What do I do if...?
127 wcc 1.13
128 wcc 1.16 (A) READ THE README FILE!
129 guppy 1.11
130 wcc 1.16 (Q) The readme does not answer...!
131 segfault 1.1
132 wcc 1.16 (A) READ THE README FILE AGAIN!
133 segfault 1.1
134 wcc 1.16 (Q) I still don't know how to...
135 guppy 1.11
136 wcc 1.16 (A) MEMORIZE THE README FILE!
137 guppy 1.11
138 wcc 1.16 (Q) But...
139 guppy 1.11
140 wcc 1.16 (A) Well, go to www.egghelp.org or www.eggheads.org and see if you can
141     find there what you're looking for. There are also lots of IRC help
142 wcc 1.21 channels and various mailing lists, as seen in the README FILE.
143 segfault 1.1
144 wcc 1.16 This is the end. If you read to this point, hopefully you have also read
145     the README file. If not, then READ IT!&@#%@!
146 fabian 1.3
147 wcc 1.24 Have fun with Eggdrop!
148 fabian 1.3
149 wcc 1.24 _____________________________________________________________________
150 guppy 1.11
151 wcc 1.24 Copyright (C) 1997 Robey Pointer
152 simple 1.31 Copyright (C) 1999 - 2011 Eggheads Development Team

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23