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

Diff of /eggdrop1.6/INSTALL

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

revision 1.12 by guppy, Thu Jan 3 01:05:42 2002 UTC revision 1.13 by wcc, Sat Mar 9 21:14:14 2002 UTC
# Line 1  Line 1 
1  Compilation and Installation of Eggdrop  Compilation and Installation of Eggdrop
2  Last revised: December 29, 2001  Last revised: March 08, 2002
3    ________________________________________________________________________    ________________________________________________________________________
4    
5  This is the quick install guide, if you have had little or no experience  This is the quick install guide; if you have had little or no experience
6  with unix or eggdrop, READ THE README FILE NOW! This file is only for  with unix or eggdrop, READ THE README FILE NOW! This file is only for
7  experienced users.  experienced users.
8    
9  (1) WHAT IS EGGDROP?  (1) WHAT IS EGGDROP?
10    
11       Please, read the README file before attempting to set up this bot.       Please, read the README file before attempting to set up this bot.
12       It is NOT easy to use! This file is a quick setup guide, not a miracle       This file is a quick setup guide, not a miracle worker. If you enter
13       worker. If you enter this file without basic eggdrop knowledge, you       this file without basic eggdrop knowledge, you will NOT leave with a
14       will NOT leave with a working bot! Before asking ANY questions, READ       working bot! Before asking ANY questions, READ THE README FILE OR YOU
15       THE README FILE OR YOU WILL BE BURNED TO A HORRIBLE DEATH! IF YOU DO       WILL BE BURNED TO A HORRIBLE DEATH! IF YOU DO NOT READ THAT FILE I WILL
16       NOT READ THAT FILE I WILL PERSONALLY WALK TO YOUR TERMINAL AND BEAT IT       PERSONALLY WALK TO YOUR TERMINAL AND BEAT IT WITH A SMELLY SNEAKER! By
17       WITH A SMELLY SNEAKER! By the way, read the README file.       the way, read the README file.
18    
19  (2) QUICK STARTUP  (2) QUICK STARTUP
20    
21       Eggdrop uses the GNU autoconfigure scripts to make things easier.       Eggdrop uses the GNU autoconfigure scripts to make things easier.
22    
23    1. Type './configure' from the eggdrop directory. The configure script    1. Type './configure' from the eggdrop directory. The configure script
24       will determine how your system is set up and figure out how to correctly          will determine how your system is set up and figure out how to
25       compile eggdrop. It will also try to find Tcl, which is required to          correctly compile eggdrop. It will also try to find Tcl, which is
26       compile.          required to compile.
27    
28    2. Type either 'make config' or 'make iconfig' to determine which modules       2. Type either 'make config' or 'make iconfig' to determine which
29       will be compiled. 'make config' compiles the default modules (everything          modules will be compiled. 'make config' compiles the default modules
30       but woobie.mod). If you want to choose which modules to compile, use          (everything but woobie.mod). If you want to choose which modules to
31       'make iconfig'.          compile, use 'make iconfig'.
32    
33    3. Type 'make' from the eggdrop directory, or, to force a statically       3. Type 'make' from the eggdrop directory, or to force a statically
34       linked module bot, type 'make static'. Otherwise, the Makefile will       linked module bot, type 'make static'. Otherwise, the Makefile will
35       compile whatever type of bot the configure script determined your       compile whatever type of bot the configure script determined your
36       system will support. Dynamic is always the better way to go if possible.          system will support. Dynamic is always the better way to go if
37       There are also the 'debug' and 'sdebug' (static-debug) options, which          possible. There are also the 'debug' and 'sdebug' (static-debug)
38       will give more detailed output on a (highly unlikely :) crash. This          options, which will give more detailed output on a (highly unlikely :)
39       will help the devteam track down the crash and fix the bug. Debug and          crash. This will help the devteam track down the crash and fix the
40       sdebug will take a little longer to compile and will enlarge the binary          bug. Debug and sdebug will take a little longer to compile and will
41       a bit, but it's worth it if you want to support eggdrop development.          enlarge the binary a bit, but it's worth it if you want to support
42            eggdrop development.
43    
44    4. Eggdrop must be installed in a directory somewhere.  This is    4. Eggdrop must be installed in a directory somewhere.  This is
45       accomplished by entering the unix command:       accomplished by entering the unix command:
# Line 52  experienced users. Line 53  experienced users.
53    
54       make install DEST=<directory>       make install DEST=<directory>
55    
56       For example: make install DEST=/home/user/otherdir          For example:
57       Note you must use full path for every file to be correctly installed.  
58              make install DEST=/home/user/otherdir
59    
60            Note that you must use full path for every file to be correctly
61            installed.
62    
63       [The following is performed from the directory installed above.]       [The following is performed from the directory installed above.]
64    
65    5. Copy the file 'eggdrop.complete.conf' to a new file, usually the same name       5. Copy the file 'eggdrop.complete.conf' to a new file, usually the same
66       as the bot that will use it, e.g. "LamestBot.conf".          name as the bot that will use it, e.g. "LamestBot.conf".
67    
68    6. Edit your config file completely.    6. Edit your config file completely.
69    
# Line 66  experienced users. Line 71  experienced users.
71       -m LamestBot.conf'.       -m LamestBot.conf'.
72    
73    8. When starting the bot in the future, drop the "-m". If you have edited    8. When starting the bot in the future, drop the "-m". If you have edited
74       your config file correctly, you can type: chmod u+x <my-config-file-name>          your config file correctly, you can type:
75       For example: chmod u+x LamestBot.conf  
76              chmod u+x <my-config-file-name>
77    
78            For example:
79    
80              chmod u+x LamestBot.conf
81    
82       From then on, you will be able to use your config file as a shell       From then on, you will be able to use your config file as a shell
83       script. You can just type "./LamestBot.conf" from your shell prompt to          script. You can just type "./LamestBot.conf" from your shell prompt
84       start up your bot. For this to work, the top line of your script MUST          to start up your bot. For this to work, the top line of your script
85       contain the correct path to the Eggdrop executable.          MUST contain the correct path to the Eggdrop executable.
86    
87    9. It's advisable to run your bot via crontab, so that it will    9. It's advisable to run your bot via crontab, so that it will
88       automatically restart if the machine goes down or (heaven forbid) the          automatically restart if the machine goes down or (heaven forbid)
89       bot should crash. Look at 'scripts/botchk' and 'scripts/autobotchk'          the bot should crash. Look at 'scripts/botchk' and 'scripts/autobotchk'
90       for a great start with crontabbing the bot.       for a great start with crontabbing the bot.
91    
92   10. Smile, and if you haven't already read the README file in its   10. Smile, and if you haven't already read the README file in its
# Line 113  experienced users. Line 123  experienced users.
123    
124      (A) MEMORIZE THE README FILE!      (A) MEMORIZE THE README FILE!
125    
126      (Q) But...</p>        (Q) But...
127    
128      (A) Well, go to www.egghelp.org or www.eggheads.org and see if you can        (A) Well, go to www.egghelp.org or www.eggheads.org and see if you
129          find there what you&#39;re looking for. There are also lots of IRC            can find there what you're looking for. There are also lots of
130          help channels and various mailing lists, as seen in the README FILE.            IRC help channels and various mailing lists, as seen in the README
131              FILE.
132    
133  This is the end. If you read to this point, hopefully you have also read  This is the end. If you read to this point, hopefully you have also read
134  the README file. If not, then READ IT!&@#%@!  the README file. If not, then READ IT!&@#%@!

Legend:
Removed from v.1.12  
changed lines
  Added in v.1.13

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23