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