/[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.21 - (hide annotations) (download)
Tue Jan 13 01:30:25 2004 UTC (15 years, 3 months ago) by wcc
Branch: MAIN
Changes since 1.20: +6 -6 lines
* Fixes from select_argtypes.
* Doc updates.
* More small build-process fixes.
* More .cvsignore stuff.

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

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23