/[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.11 - (hide annotations) (download)
Wed Jan 2 03:46:32 2002 UTC (17 years, 3 months ago) by guppy
Branch: MAIN
Changes since 1.10: +75 -73 lines
added Wcc's even_more_docs patch

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

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23