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 / Installation --
  11
  12                       Ilja Osthoff, <ilja@glide.ath.cx>
  13
  14
  15 I. Standard-Installation
  16 ~~~~~~~~~~~~~~~~~~~~~~~~
  17
  18 ngIRCd ist fuer UNIXoide-Systeme konzipiert worden, das bedeutet, dass die
  19 Installation auf einem modernen UNIX-aehnlichen System kein Problem dar-
  20 stellen sollte. Das System muss nur von GNU automake und GNU autoconf
  21 ("configure") unterstuetzt werden.
  22
  23 Die Standard-Installation sieht so aus:
  24
  25    1) tar xzf ngircd-<Version>.tar.gz
  26    2) cd ngircd-<Version>
  27    3) ./autogen.sh      [nur erforderlich, wenn ueber CVS bezogen]
  28    4) ./configure
  29    5) make
  30    6) make install
  31
  32
  33 zu 3): "autogen.sh"
  34
  35 Der erste Schritt, autogen.sh, ist nur notwendig, wenn das configure-Script
  36 noch nicht vorhanden ist. Dies ist nie bei offiziellen ("stabilen") Versionen
  37 in tar.gz-Archiven der Fall, jedoch nie, wenn der Source-Code ueber CVS
  38 bezogen wurde.
  39
  40 Dieser Absatz ist also eigentlich ausschliesslich fuer Entwickler interessant.
  41
  42 autogen.sh erzeugt die fuer das configure-Script notwendigen Makefile.in's
  43 sowie das configure-Script selber und weitere fuer den make-Lauf erforderliche
  44 Dateien. Dazu wird sowohl GNU automake als auch GNU autoconf (in aktuellen
  45 Versionen!) benoetigt.
  46
  47 (nochmal: "Endanwender" mussen diesen Schritt i.d.R. nicht ausfuehren!)
  48
  49
  50 zu 4): "./configure"
  51
  52 Mit dem configure-Script wird ngIRCd, wie GNU Software meistens, an das
  53 lokale System angepasst und die erforderlichen Makefile's erzeugt.
  54
  55 Im Optimalfall sollte configure alle benoetigten Libraries, Header etc. selber
  56 erkennen und entsprechend reagieren. Sollte dies einmal nicht der Fall sein,
  57 so zeigt "./configure --help" moegliche Optionen.
  58
  59
  60 zu 5): "make"
  61
  62 Der make-Befehl bearbeitet die vom configure-Script erzeugten Makefile's und
  63 uebersetzt den ngIRCd.
  64
  65
  66 zu 6): "make install"
  67
  68 Mit "make install" wird der Server und ggf. eine Beispiels-Konfiguration
  69 im System installiert; hierzu sind in der Regel root-Rechte erforderlich.
  70 Eine bereits vorhandene Konfigurationsdatei wird nie ueberschrieben.
  71
  72 Folgende Dateien werden installiert:
  73
  74 - /usr/local/sbin/ngircd: ausfuehrbarer Server
  75 - /usr/local/etc/ngircd.conf: Beispiel-Konfiguration, wenn nicht vorhanden
  76
  77
  78 III. Nuetzliche make-Targets
  79 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  80
  81 Die vom configure-Script erzeugten Makefile's enthalten immer die folgenden
  82 nuetzlichen Targets:
  83
  84  - clean: alle Erzeugnisse des Compilers/Linkers loeschen.
  85    Naechster Schritt: -> make
  86
  87  - distclean: zusaetzliche alle Makefile's loeschen.
  88    Naechster Schritt: -> ./configure
  89
  90  - maintainer-clean: alle automat. erzeugten Dateien loeschen.
  91    Naechster Schritt: -> ./autogen.sh
  92
  93
  94
  95 IV. Konfigurationsdatei ngircd.conf
  96 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  97
  98 In der Konfigurationsdatei werden Kommentare durch "#" oder durch ";"
  99 eingeleitet. Dieses dient nur der besseren Lesbarkeit.
 100
 101 Die Datei ist in drei Abschnitte unterteilt: [Global], [Operator] und
 102 [Server]. Im [Global]-Teil werden die grundlegenden Einstellungen vor-
 103 genommen, z.B. der Server-Name und die Ports, auf denen er Verbindungen
 104 annehmen soll. In [Operator]-Abschnitten werden Server-Operatoren fest-
 105 gelegt und unter [Server] werden die Einstellungen fuer die Verbindung
 106 mit anderen Servern konfiguriert.
 107
 108 Die Bedeutung der einzelnen Variablen ist in der Beispiel-Konfiguration
 109 "doc/sample-ngircd.conf" erklaert, die bei "make install" auch als
 110 "ngircd.conf" in /usr/local/etc installiert wird, wenn dort noch keine
 111 Konfigurationsdatei vorhanden ist.
 112
 113
 114 V. Kommandozeilen-Optionen
 115 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 116
 117 Folgende Parameter koennen dem ngIRCd u.a. uebergeben werden:
 118
 119 -f, --config <file>
 120         Der Daemon wird angewiesen, statt der Standard-Konfigurationsdatei
 121         /usr/local/etc/ngircd.conf die Datei <file> einzulesen.
 122
 123 -n, --nodaemon
 124         ngIRCd soll im Fordergrund laufen; alle Meldungen werden zusaetzlich
 125         zum Syslog auch auf der Konsole ausgegeben.
 126
 127 -p, --passive
 128         Verbindungen zu anderen Servern (wie in der Konfigurationsdatei in
 129         [Server]-Abschnitten definiert) werden nicht automatisch hergestellt.
 130
 131 --configtest
 132         Die Konfigurationsdatei wird eingelesen, ueberprueft und so aus-
 133         gegeben, wie sie vom ngIRCd interpretiert wurde. Danach beendet
 134         sich der Server wieder.
 135
 136 Mit dem Parameter "--help" werden alle unterstuetzten Parameter angezeigt,
 137 mit "--version" die Versionsnummer. Bei beiden Parametern beendet sich der
 138 Server nach der Ausgabe wieder.
 139
 140
 141 --
 142 $Id: INSTALL,v 1.6.2.1 2002/05/08 15:47:06 alex Exp $