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