- Dokumentation ergaenzt und verbessert.
[ngircd-alex.git] / INSTALL
1
2                      ngIRCd - Next Generation IRC Server
3
4                          (c)2001 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
13 ngIRCd ist fuer UNIXoide-Systeme konzipiert. Dieser Text beschreibt den
14 "Standardfall": ein UNIX bzw. UNIX-aehnliches System, das von GNU automake
15 und GNU autoconf ("configure") unterstuetzt wird.
16
17
18 I. Quick Start
19 ~~~~~~~~~~~~~~
20
21 In der Regel sind folgende Schritte ausreichend:
22
23    1) ./autogen.sh      [nur erforderlich, wenn ueber CVS bezogen]
24    2) ./configure
25    3) make
26
27
28 zu 1) autogen.sh:
29
30 Der erste Schritt, autogen.sh, ist nur notwendig, wenn das configure-Script
31 noch nicht vorhanden ist. Dies ist nie bei offiziellen ("stabilen") Versionen
32 in tar.gz-Archiven der Fall, jedoch nie, wenn der Source-Code ueber CVS
33 bezogen wurde.
34
35 Dieser Absatz ist also eigentlich ausschliesslich fuer Entwickler interessant.
36
37 autogen.sh erzeugt die fuer das configure-Script notwendigen Makefile.in's
38 sowie das configure-Script selber und weitere fuer den make-Lauf erforderliche
39 Dateien. Dazu wird sowohl GNU automake als auch GNU autoconf (in aktuellen
40 Versionen!) benoetigt.
41
42 (nochmal: "Endanwender" mussen diesen Schritt i.d.R. nicht ausfuehren!)
43
44
45 zu 2) ./configure:
46
47 Mit dem configure-Script wird ngIRCd, wie GNU Software meistens, an das
48 lokale System angepasst und die erforderlichen Makefile's erzeugt.
49
50 Im Optimalfall sollte configure alle benoetigten Libraries, Header etc. selber
51 erkennen und entsprechend reagieren. Sollte dies einmal nicht der Fall sein,
52 so zeigt "./configure --help" moegliche Optionen.
53
54
55 zu 3) make:
56
57 Der make-Befehl bearbeitet die vom configure-Script erzeugten Makefile's und
58 uebersetzt die comBase-Library und die Testprogramme.
59
60
61 II. Nuetzliche make-Targets
62 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
63
64 Die vom configure-Script erzeugten Makefile's enthalten immer die folgenden
65 nuetzlichen Targets:
66
67  - clean: alle Erzeugnisse des Compilers/Linkers loeschen.
68    Naechster Schritt: -> make
69
70  - distclean: zusaetzliche alle Makefile's loeschen.
71    Naechster Schritt: -> ./configure
72
73  - maintainer-clean: alle automat. erzeugten Dateien loeschen.
74    Naechster Schritt: -> ./autogen.sh
75