59ae7656f31599eac976755deaad649f0590b424
[ngircd-alex.git] / doc / en / INSTALL
1
2                      ngIRCd - Next Generation IRC Server
3
4                       (c)2001,2002 by Alexander Barton,
5                     alex@barton.de, http://www.barton.de/
6
7                   ngIRCd ist freie Software und steht unter
8                        der GNU General Public License.
9
10                                 -- INSTALL --
11
12                          
13
14 I. Standard-Installation
15 ~~~~~~~~~~~~~~~~~~~~~~~~
16
17 ngIRCd is developed for UNIX-like systems, which means, that the installation
18 on a modern UNIX-like system should be no problem. The only thing is, that
19 the system should be supported by GNU automake and GNU autoconf ("configure").
20
21 The normal installation is like that:
22
23    1) tar xzf ngircd-<Version>.tar.gz
24    2) cd ngircd-<Version>
25    3) ./autogen.sh      [only necessary when using CVS]
26    4) ./configure
27    5) make
28    6) make install
29
30 3): "autogen.sh"
31
32 The first step, autogen.sh, is only necessary if the configure-script isn't
33 already generated. This never happens in official ("stable") releases in
34 tar.gz-archieves, but when using the CVS system.
35
36 The next is therefore only interesting for developpers.
37
38 autogen.sh produces the makefile.in's, which are necessary for the configure
39 script it self, and some more files for make. For this step, there must be
40 GNU automake and GNU autoconf (in recent versions).
41
42 (again: "end users" do not need this step!)
43
44 to 4): "./configure"
45
46 The configure-script is used to detect local system dependancies.
47
48 In the perfect case, configure should recognize all needed libraries, header
49 and so on. If this shouldn't work, "./configure --help" shows more options.
50
51 to 5): "make"
52
53 The make command uses the Makefiles produced by configure and compiles the
54 ngIRCd daemon.
55
56 to 6): "make install"
57
58 Use "make install" to install the server and a sample configuration file on
59 the local system. For this step, root privileges are necessary. If there is
60 already an older configuration file present, it won't be overwritten.
61
62 This are the files that are installed:
63
64 - /usr/local/sbin/ngircd: exectable server
65 - /usr/local/etc/ngircd.conf: sample configuration, if not there
66
67
68 II. Useful make-targets
69 ~~~~~~~~~~~~~~~~~~~~~~~
70
71 The Makefile produced by the configure-script contain always these useful
72 targets:
73
74  - clean: delete every product from the compiler/linker
75    next step: -> make
76
77  - distclean: plus erase all generated Makefiles
78    next step: -> ./configure
79
80  - maintainer-clean: erease all automatic generated files
81    next step: -> ./autogen.sh
82
83
84 III. Sample configuration file ngircd.conf
85 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
86
87 In the sample configuration file, there are comments beginning with "#" OR
88 ";" -- this is only for the better understanding of the code.
89
90 The file is seperated in three blocks: [Global], [Operator], [Server]. In
91 the [Gobal] part, there is the main configuration, like the server-name
92 and the ports, on which the server should be listening. In the [Operator]
93 section, the server-operators are defined and [Server] is the section,
94 where the server-links are configured.
95
96 The meaning of the variables in the configuration file is explained in the 
97 "doc/sample-ngircd.conf", which is also the sample configuration file in
98 /usr/local/etc after running "make install" (if you don't already have one).
99
100
101 IV. Command line options
102 ~~~~~~~~~~~~~~~~~~~~~~~~
103
104 These parameters could be passed to the ngIRCd:
105
106 -f, --config <file>
107         The daemon uses the file <file> as configuration file rather than
108         the standard configuration /usr/local/etc/ngircd.conf.
109
110 -n, --nodaemon
111         ngIRCd should be running as a foreground process.
112
113 -p, --passive
114         Server-links won't be automatically established.
115
116 --configtest
117         Reads, validates and dumps the configuration file as interpreted
118         by the server. Then exits.
119
120 Use "--help" to see a short help text describing all available parameters
121 the server understands, with "--version" the ngIRCd shows its version
122 number. In both cases the server exits after the output.
123
124
125 -- 
126 $Id: INSTALL,v 1.2 2002/05/20 12:02:58 alex Exp $