2 5b333085 2003-01-04 alex ngIRCd - Next Generation IRC Server
4 5b333085 2003-01-04 alex (c)2001,2002 by Alexander Barton,
5 5b333085 2003-01-04 alex alex@barton.de, http://www.barton.de/
7 5b333085 2003-01-04 alex ngIRCd ist freie Software und steht unter
8 5b333085 2003-01-04 alex der GNU General Public License.
10 5b333085 2003-01-04 alex -- INSTALL / Installation --
12 5b333085 2003-01-04 alex Ilja Osthoff, <ilja@glide.ath.cx>
15 5b333085 2003-01-04 alex 0. Update von frueheren Versionen
16 5b333085 2003-01-04 alex ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 5b333085 2003-01-04 alex Unterschiede zu Version 0.5.x
20 5b333085 2003-01-04 alex - Ab Version 0.6.0 werden asyncrone Passwoerter zur Identifikation anderer
21 5b333085 2003-01-04 alex Server, die Variable "Password" in [Server]-Abschnitten wird nicht mehr
22 5b333085 2003-01-04 alex unterstuetzt. Passwoerter fuer Server-Server-Links werden nun mit den
23 5b333085 2003-01-04 alex Variablen "MyPassword" und "PeerPassword" angegeben.
25 5b333085 2003-01-04 alex - Neue Konfigurationsvariablen, Sektion [Global]: MaxConnections, MaxJoins
26 5b333085 2003-01-04 alex (vgl. auch Beispiel-Konfiguration "doc/sample-ngircd.conf"!)
29 5b333085 2003-01-04 alex I. Standard-Installation
30 5b333085 2003-01-04 alex ~~~~~~~~~~~~~~~~~~~~~~~~
32 5b333085 2003-01-04 alex ngIRCd ist fuer UNIXoide-Systeme konzipiert worden, das bedeutet, dass die
33 5b333085 2003-01-04 alex Installation auf einem modernen UNIX-aehnlichen System kein Problem dar-
34 5b333085 2003-01-04 alex stellen sollte. Das System muss nur von GNU automake und GNU autoconf
35 5b333085 2003-01-04 alex ("configure") unterstuetzt werden.
37 5b333085 2003-01-04 alex Die Standard-Installation sieht so aus:
39 5b333085 2003-01-04 alex 1) tar xzf ngircd-<Version>.tar.gz
40 5b333085 2003-01-04 alex 2) cd ngircd-<Version>
41 5b333085 2003-01-04 alex 3) ./autogen.sh [nur erforderlich, wenn ueber CVS bezogen]
42 5b333085 2003-01-04 alex 4) ./configure
44 5b333085 2003-01-04 alex 6) make install
47 5b333085 2003-01-04 alex zu 3): "autogen.sh"
49 5b333085 2003-01-04 alex Der erste Schritt, autogen.sh, ist nur notwendig, wenn das configure-Script
50 5b333085 2003-01-04 alex noch nicht vorhanden ist. Dies ist nie bei offiziellen ("stabilen") Versionen
51 5b333085 2003-01-04 alex in tar.gz-Archiven der Fall, jedoch immer, wenn der Source-Code ueber CVS
52 5b333085 2003-01-04 alex bezogen wurde.
54 5b333085 2003-01-04 alex Dieser Absatz ist also eigentlich ausschliesslich fuer Entwickler interessant.
56 5b333085 2003-01-04 alex autogen.sh erzeugt die fuer das configure-Script notwendigen Makefile.in's
57 5b333085 2003-01-04 alex sowie das configure-Script selber und weitere fuer den make-Lauf erforderliche
58 5b333085 2003-01-04 alex Dateien. Dazu wird sowohl GNU automake als auch GNU autoconf (in aktuellen
59 5b333085 2003-01-04 alex Versionen!) benoetigt.
61 5b333085 2003-01-04 alex (nochmal: "Endanwender" mussen diesen Schritt i.d.R. nicht ausfuehren!)
64 5b333085 2003-01-04 alex zu 4): "./configure"
66 5b333085 2003-01-04 alex Mit dem configure-Script wird ngIRCd, wie GNU Software meistens, an das
67 5b333085 2003-01-04 alex lokale System angepasst und die erforderlichen Makefile's erzeugt.
69 5b333085 2003-01-04 alex Im Optimalfall sollte configure alle benoetigten Libraries, Header etc. selber
70 5b333085 2003-01-04 alex erkennen und entsprechend reagieren. Sollte dies einmal nicht der Fall sein,
71 5b333085 2003-01-04 alex so zeigt "./configure --help" moegliche Optionen.
74 5b333085 2003-01-04 alex zu 5): "make"
76 5b333085 2003-01-04 alex Der make-Befehl bearbeitet die vom configure-Script erzeugten Makefile's und
77 5b333085 2003-01-04 alex uebersetzt den ngIRCd.
80 5b333085 2003-01-04 alex zu 6): "make install"
82 5b333085 2003-01-04 alex Mit "make install" wird der Server und ggf. eine Beispiels-Konfiguration
83 5b333085 2003-01-04 alex im System installiert; hierzu sind in der Regel root-Rechte erforderlich.
84 5b333085 2003-01-04 alex Eine bereits vorhandene Konfigurationsdatei wird nie ueberschrieben.
86 5b333085 2003-01-04 alex Folgende Dateien werden installiert:
88 5b333085 2003-01-04 alex - /usr/local/sbin/ngircd: ausfuehrbarer Server
89 5b333085 2003-01-04 alex - /usr/local/etc/ngircd.conf: Beispiel-Konfiguration, wenn nicht vorhanden
92 5b333085 2003-01-04 alex II. Nuetzliche make-Targets
93 5b333085 2003-01-04 alex ~~~~~~~~~~~~~~~~~~~~~~~~~~~
95 5b333085 2003-01-04 alex Die vom configure-Script erzeugten Makefile's enthalten immer die folgenden
96 5b333085 2003-01-04 alex nuetzlichen Targets:
98 5b333085 2003-01-04 alex - clean: alle Erzeugnisse des Compilers/Linkers loeschen.
99 5b333085 2003-01-04 alex Naechster Schritt: -> make
101 5b333085 2003-01-04 alex - distclean: zusaetzliche alle Makefile's loeschen.
102 5b333085 2003-01-04 alex Naechster Schritt: -> ./configure
104 5b333085 2003-01-04 alex - maintainer-clean: alle automat. erzeugten Dateien loeschen.
105 5b333085 2003-01-04 alex Naechster Schritt: -> ./autogen.sh
109 5b333085 2003-01-04 alex III. Konfigurationsdatei ngircd.conf
110 5b333085 2003-01-04 alex ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
112 5b333085 2003-01-04 alex In der Konfigurationsdatei werden Kommentare durch "#" oder durch ";"
113 5b333085 2003-01-04 alex eingeleitet. Dieses dient nur der besseren Lesbarkeit.
115 5b333085 2003-01-04 alex Die Datei ist in drei Abschnitte unterteilt: [Global], [Operator] und
116 5b333085 2003-01-04 alex [Server]. Im [Global]-Teil werden die grundlegenden Einstellungen vor-
117 5b333085 2003-01-04 alex genommen, z.B. der Server-Name und die Ports, auf denen er Verbindungen
118 5b333085 2003-01-04 alex annehmen soll. In [Operator]-Abschnitten werden Server-Operatoren fest-
119 5b333085 2003-01-04 alex gelegt und unter [Server] werden die Einstellungen fuer die Verbindung
120 5b333085 2003-01-04 alex mit anderen Servern konfiguriert.
122 5b333085 2003-01-04 alex Die Bedeutung der einzelnen Variablen ist in der Beispiel-Konfiguration
123 5b333085 2003-01-04 alex "doc/sample-ngircd.conf" erklaert, die bei "make install" auch als
124 5b333085 2003-01-04 alex "ngircd.conf" in /usr/local/etc installiert wird, wenn dort noch keine
125 5b333085 2003-01-04 alex Konfigurationsdatei vorhanden ist.
128 5b333085 2003-01-04 alex IV. Kommandozeilen-Optionen
129 5b333085 2003-01-04 alex ~~~~~~~~~~~~~~~~~~~~~~~~~~~
131 5b333085 2003-01-04 alex Folgende Parameter koennen dem ngIRCd u.a. uebergeben werden:
133 5b333085 2003-01-04 alex -f, --config <file>
134 5b333085 2003-01-04 alex Der Daemon wird angewiesen, statt der Standard-Konfigurationsdatei
135 5b333085 2003-01-04 alex /usr/local/etc/ngircd.conf die Datei <file> einzulesen.
137 5b333085 2003-01-04 alex -n, --nodaemon
138 5b333085 2003-01-04 alex ngIRCd soll im Fordergrund laufen; alle Meldungen werden zusaetzlich
139 5b333085 2003-01-04 alex zum Syslog auch auf der Konsole ausgegeben.
141 5b333085 2003-01-04 alex -p, --passive
142 5b333085 2003-01-04 alex Verbindungen zu anderen Servern (wie in der Konfigurationsdatei in
143 5b333085 2003-01-04 alex [Server]-Abschnitten definiert) werden nicht automatisch hergestellt.
145 5b333085 2003-01-04 alex --configtest
146 5b333085 2003-01-04 alex Die Konfigurationsdatei wird eingelesen, ueberprueft und so aus-
147 5b333085 2003-01-04 alex gegeben, wie sie vom ngIRCd interpretiert wurde. Danach beendet
148 5b333085 2003-01-04 alex sich der Server wieder.
150 5b333085 2003-01-04 alex Mit dem Parameter "--help" werden alle unterstuetzten Parameter angezeigt,
151 5b333085 2003-01-04 alex mit "--version" die Versionsnummer. Bei beiden Parametern beendet sich der
152 5b333085 2003-01-04 alex Server nach der Ausgabe wieder.
156 5b333085 2003-01-04 alex $Id: INSTALL,v 1.1 2003/01/04 13:07:54 alex Exp $
