/[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.18 - (hide annotations) (download)
Tue Dec 24 02:30:01 2002 UTC (16 years, 4 months ago) by wcc
Branch: MAIN
CVS Tags: r1, eggdrop_1_6_15, blah, test
Changes since 1.17: +1 -1 lines
Updated copyright info for 2003.

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

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23