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