2 ngIRCd - Next Generation IRC Server
4 (c)2001,2002 by Alexander Barton,
5 alex@barton.de, http://www.barton.de/
7 ngIRCd ist freie Software und steht unter
8 der GNU General Public License.
10 -- INSTALL / Installation --
12 Ilja Osthoff, <ilja@glide.ath.cx>
15 +-----------------------------------------------------------------------+
16 | Please note: English translations of some of the german documentation |
17 | files can be found in the directory "doc/en" -- please have a look! |
18 +-----------------------------------------------------------------------+
21 I. Standard-Installation
22 ~~~~~~~~~~~~~~~~~~~~~~~~
24 ngIRCd ist fuer UNIXoide-Systeme konzipiert worden, das bedeutet, dass die
25 Installation auf einem modernen UNIX-aehnlichen System kein Problem dar-
26 stellen sollte. Das System muss nur von GNU automake und GNU autoconf
27 ("configure") unterstuetzt werden.
29 Die Standard-Installation sieht so aus:
31 1) tar xzf ngircd-<Version>.tar.gz
32 2) cd ngircd-<Version>
33 3) ./autogen.sh [nur erforderlich, wenn ueber CVS bezogen]
41 Der erste Schritt, autogen.sh, ist nur notwendig, wenn das configure-Script
42 noch nicht vorhanden ist. Dies ist nie bei offiziellen ("stabilen") Versionen
43 in tar.gz-Archiven der Fall, jedoch immer, wenn der Source-Code ueber CVS
46 Dieser Absatz ist also eigentlich ausschliesslich fuer Entwickler interessant.
48 autogen.sh erzeugt die fuer das configure-Script notwendigen Makefile.in's
49 sowie das configure-Script selber und weitere fuer den make-Lauf erforderliche
50 Dateien. Dazu wird sowohl GNU automake als auch GNU autoconf (in aktuellen
51 Versionen!) benoetigt.
53 (nochmal: "Endanwender" mussen diesen Schritt i.d.R. nicht ausfuehren!)
58 Mit dem configure-Script wird ngIRCd, wie GNU Software meistens, an das
59 lokale System angepasst und die erforderlichen Makefile's erzeugt.
61 Im Optimalfall sollte configure alle benoetigten Libraries, Header etc. selber
62 erkennen und entsprechend reagieren. Sollte dies einmal nicht der Fall sein,
63 so zeigt "./configure --help" moegliche Optionen.
68 Der make-Befehl bearbeitet die vom configure-Script erzeugten Makefile's und
69 uebersetzt den ngIRCd.
74 Mit "make install" wird der Server und ggf. eine Beispiels-Konfiguration
75 im System installiert; hierzu sind in der Regel root-Rechte erforderlich.
76 Eine bereits vorhandene Konfigurationsdatei wird nie ueberschrieben.
78 Folgende Dateien werden installiert:
80 - /usr/local/sbin/ngircd: ausfuehrbarer Server
81 - /usr/local/etc/ngircd.conf: Beispiel-Konfiguration, wenn nicht vorhanden
84 II. Nuetzliche make-Targets
85 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
87 Die vom configure-Script erzeugten Makefile's enthalten immer die folgenden
90 - clean: alle Erzeugnisse des Compilers/Linkers loeschen.
91 Naechster Schritt: -> make
93 - distclean: zusaetzliche alle Makefile's loeschen.
94 Naechster Schritt: -> ./configure
96 - maintainer-clean: alle automat. erzeugten Dateien loeschen.
97 Naechster Schritt: -> ./autogen.sh
101 III. Konfigurationsdatei ngircd.conf
102 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104 In der Konfigurationsdatei werden Kommentare durch "#" oder durch ";"
105 eingeleitet. Dieses dient nur der besseren Lesbarkeit.
107 Die Datei ist in drei Abschnitte unterteilt: [Global], [Operator] und
108 [Server]. Im [Global]-Teil werden die grundlegenden Einstellungen vor-
109 genommen, z.B. der Server-Name und die Ports, auf denen er Verbindungen
110 annehmen soll. In [Operator]-Abschnitten werden Server-Operatoren fest-
111 gelegt und unter [Server] werden die Einstellungen fuer die Verbindung
112 mit anderen Servern konfiguriert.
114 Die Bedeutung der einzelnen Variablen ist in der Beispiel-Konfiguration
115 "doc/sample-ngircd.conf" erklaert, die bei "make install" auch als
116 "ngircd.conf" in /usr/local/etc installiert wird, wenn dort noch keine
117 Konfigurationsdatei vorhanden ist.
120 IV. Kommandozeilen-Optionen
121 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
123 Folgende Parameter koennen dem ngIRCd u.a. uebergeben werden:
126 Der Daemon wird angewiesen, statt der Standard-Konfigurationsdatei
127 /usr/local/etc/ngircd.conf die Datei <file> einzulesen.
130 ngIRCd soll im Fordergrund laufen; alle Meldungen werden zusaetzlich
131 zum Syslog auch auf der Konsole ausgegeben.
134 Verbindungen zu anderen Servern (wie in der Konfigurationsdatei in
135 [Server]-Abschnitten definiert) werden nicht automatisch hergestellt.
138 Die Konfigurationsdatei wird eingelesen, ueberprueft und so aus-
139 gegeben, wie sie vom ngIRCd interpretiert wurde. Danach beendet
140 sich der Server wieder.
142 Mit dem Parameter "--help" werden alle unterstuetzten Parameter angezeigt,
143 mit "--version" die Versionsnummer. Bei beiden Parametern beendet sich der
144 Server nach der Ausgabe wieder.
148 $Id: INSTALL,v 1.8 2002/09/16 11:03:05 alex Exp $