/[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.2 by fabian, Mon Nov 15 17:42:31 1999 UTC revision 1.3 by fabian, Wed Mar 22 00:38:21 2000 UTC
# Line 1  Line 1 
1                         _  Compilation and Installation of Eggdrop
2    ___   __ _  __ _  __| |_ __  ___  _ __    ------------------------------------------------------------------------
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         |___/ |___/                 |_|     v1.5  experienced users.
   
 This is the quick install guide, if you have had little or no  
 experience with unix or eggdrop, READ THE README FILE NOW!  
 This file is only for experienced users.  
7    
8  (1) WHAT IS EGGDROP?  (1) WHAT IS EGGDROP?
9    
10      Please, read the file README before attempting to set up this bot. It       Please, read the file README before attempting to set up this
11      is NOT easy to use! This file is a quick setup guide, not a miracle       bot. It is NOT easy to use! This file is a quick setup guide, not
12      worker. If you enter this file without basic eggdrop knowledge, you       a miracle worker. If you enter this file without basic eggdrop
13      will NOT leave with a working bot! Before asking ANY questions, READ       knowledge, you will NOT leave with a working bot! Before asking
14      THE README FILE OR YOU WILL BE BURNED TO A HORRIBLE DEATH! IF YOU DO       ANY questions, READ THE README FILE OR YOU WILL BE BURNED TO A
15      NOT READ THAT FILE I WILL PERSONALLY WALK TO YOUR TERMINAL AND BEAT IT       HORRIBLE DEATH! IF YOU DO NOT READ THAT FILE I WILL PERSONALLY
16      WITH A SMELLY SNEAKER! By the way, read README.       WALK TO YOUR TERMINAL AND BEAT IT WITH A SMELLY SNEAKER! By the
17         way, read README.
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
22         easier.
23    
24      1. Type './configure' from the eggdrop directory.  That script will      1. Type './configure' from the eggdrop directory.  That script will
25         determine how your system is set up, and figure out how to compile         determine how your system is set up, and figure out how to compile
26         eggdrop.  It will also try to find Tcl, which is required to       eggdrop.  It will also try to find Tcl, which is required to compile.
        compile.  
27    
28      2. Type 'make' from the eggdrop directory.  Or to force a statically      2. Type 'make' from the eggdrop directory.  Or to force a statically
29         linked module bot type 'make static'.  Otherwise the Makefile will         linked module bot type 'make static'.  Otherwise the Makefile will
30         determin which type of bot your system will support.  Dynamic is       determin which type of bot your system will support.  Dynamic isalways
31         aways the better way to go if possible.  And for the brave with       the better way to go if possible. There're also the options debug and
32         off the wall operating systems you can type 'make eggmod' but be       sdebug (static-debug) which will give more detailed output on (a
33         warned that it might not work.  If it does please contact the dev       highly unlikely :) crash. This might help the devteam to track down
34         team and let them know it did or/and what you did to make it work.       the crash and fix the bug. Debug and sdebug will take a little longer
35         to compile and will enlarge the binary a bit, but it's worth if you
36         want to support eggdrop development.
37    
38      3. Eggdrop must be installed in a directory somewhere.  This is      3. Eggdrop must be installed in a directory somewhere.  This is
39         accomplished by entering the unix command:         accomplished by entering the unix command:
40    
41          make install DEST=<directory>          make install DEST=<directory>
42          example make install DEST=/home/egguser/eggdrop          example make install DEST=/home/egguser/eggdrop
43         (note you must use full path for every file to be correctly installed)
44    
45      [The following is performed from the directory installed above]      [The following is performed from the directory installed above]
46    
47      4. Copy the file 'eggdrop.conf.dist' to a new file, usually the    4. Copy the file 'eggdrop.conf.dist' to a new file, usually the same name
48         same name as the bot that will use it, e.g. "LamestBot".       as the bot that will use it, e.g. "LamestBot".
49    
50      5. Edit your config file LamestBot completely.
51    
52      5. Start the bot with the "-m" option to create a user file, ie    6. Start the bot with the "-m" option to create a user file, ie 'eggdrop
53         'eggdrop -m LamestBot'.       -m LamestBot'.
54    
55      6. When starting the bot in the future, drop the "-m".  If you have    7. When starting the bot in the future, drop the "-m".  If you have
56         edited your bot script correctly, you can type:         edited your bot script correctly, you can type:
57             chmod u+x <my-bot-script-name>             chmod u+x <my-bot-script-name>
58         e.g.         e.g.
59             chmod u+x LamestBot             chmod u+x LamestBot
60    
61         and from then on, you will be able to run your bot directly from the         and from then on, you will be able to run your bot directly from the
62         script.  So you can just type "LamestBot" from your shell prompt to         script.  So you can just type "LamestBot" from your shell prompt to
63         start up your bot.  For this to work, the top line of your script MUST         start up your bot.  For this to work, the top line of your script MUST
64         contain the correct path to eggdrop.         contain the correct path to eggdrop.
65    
66      7. It's advisable to run your bot via crontab so that it will automatic-    8. It's advisable to run your bot via crontab so that it will
67         ally restart if the machine goes down or (heaven forbid) the bot       automatically restart if the machine goes down or (heaven forbid) the
68         should crash.  Look at the file 'scripts/botchk' for a great start       bot should crash. Look at the file 'scripts/botchk' and
69         with crontabbing the bot.       'scripts/autobotchk' for a great start with crontabbing the bot.
70    
71      8. Smile, and if you haven't already read the README file in its    9. Smile, and if you haven't already read the README file in its
72         entirety, go take a long walk off a short pier.         entirety, go take a long walk off a short pier.
73    
   
74  (3) MODULES  (3) MODULES
75    
76    1.  Modules are small pieces of code that can either be compiled into    1. Modules are small pieces of code that can either be compiled into the
77  the binary or can be compiled seperatly in a file.  This allows for a much       binary or can be compiled seperatly in a file.  This allows for a much
78  smaller binary and a way of choosing which options you want installed in       smaller binary and a way of choosing which options you want installed
79  the bot.  Before you compile the bot you can remove any *.mod directory in       in the bot.  Before you compile the bot you can remove any *.mod
80  the src/mod that you dont wish to be compiled.  Use caution though most of       directory in the src/mod that you dont wish to be compiled.  Use
81  the modules that come with eggdrop the are required.  The exception is       caution though most of the modules that come with eggdrop the are
82  woobie.mod and seen.mod.  If you do not want these modules it is safe       required.  The exception is woobie.mod and seen.mod.  If you do not
83  to delete those directories.       want these modules it is safe to delete those directories.
84    
85    2.  If there are any personal modules that you have made or downloaded    2. If there are any personal modules that you have made or downloaded you
86  you can add them to the bot by placing them in the /src/mod directory with       can add them to the bot by placing them in the /src/mod directory with
87  a mod extension.  They will be automatically compiled during the make for       a mod extension.  They will be automatically compiled during the make
88  you.  They must have a valid make file and of course be compatiable with       for you.  They must have a valid make file and of course be
89  the rest of the eggdrop source.       compatiable with the rest of the eggdrop source.
90    
91    3.  If you wish to add a module at a latter time follow the same steps    3. If you wish to add a module at a latter time follow the same steps in
92  in paragraph 2.  After you have moved the appropriate files you will only       paragraph 2.  After you have moved the appropriate files you will only
93  need to type make modules to compile only the modules portion of the bot.       need to type make modules to compile only the modules portion of the
94         bot.
95    
96  (3) FREQUENTLY ASKED QUESTIONS  (3) FREQUENTLY ASKED QUESTIONS
97    
98      1. WHAT DO I DO IF...?      1. WHAT DO I DO IF...?
99         READ THE README FILE!
100    
101      2. THE README DOES NOT ANSWER...!
102         READ THE README FILE AGAIN!
103    
104         (1a) READ THE README FILE!    3. I still don't know how to....
105         Well, go to www.egghelp.org or www.eggheads.org and see if you can
106         find there what you're looking for. There're also lots of IRC help
107         channels (usually #eggdrop) and various mailinglists. Try Eggheads
108         mailinglist http://scrambled.eggheads.org/mailman/listinfo/eggheads
109    
110  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
111  the README file. If not, then READ IT!&@#%@!  the README file. If not, then READ IT!&@#%@!
112    
113    Have fun with Eggdrop!
114    
115      ------------------------------------------------------------------------
116    (c) 1997 Robey Pointer
117    (c) 2000 Eggheads Development Team

Legend:
Removed from v.1.2  
changed lines
  Added in v.1.3

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23