- Manual-Pages begonnen und in Source-Tree eingebunden.
[ngircd-alex.git] / 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
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. Voraussetzungen
19 ~~~~~~~~~~~~~~~~~~
20
21 ngIRCd benoetigt "Alex' Portability Headers" (portab.h). Diese koennen von
22 der Homepage heruntergeladen werden:
23
24 <http://arthur.ath.cx/~alex/ngircd/#download>
25
26 Vor dem configure-Lauf des ngIRCd muessen dies Header auf dem System in-
27 stalliert sein, anonsten bricht configure ab.
28
29
30 II. Quick Start
31 ~~~~~~~~~~~~~~~
32
33 In der Regel sind folgende Schritte ausreichend:
34
35    1) ./autogen.sh      [nur erforderlich, wenn ueber CVS bezogen]
36    2) ./configure
37    3) make
38
39
40 zu 1) autogen.sh:
41
42 Der erste Schritt, autogen.sh, ist nur notwendig, wenn das configure-Script
43 noch nicht vorhanden ist. Dies ist nie bei offiziellen ("stabilen") Versionen
44 in tar.gz-Archiven der Fall, jedoch nie, wenn der Source-Code ueber CVS
45 bezogen wurde.
46
47 Dieser Absatz ist also eigentlich ausschliesslich fuer Entwickler interessant.
48
49 autogen.sh erzeugt die fuer das configure-Script notwendigen Makefile.in's
50 sowie das configure-Script selber und weitere fuer den make-Lauf erforderliche
51 Dateien. Dazu wird sowohl GNU automake als auch GNU autoconf (in aktuellen
52 Versionen!) benoetigt.
53
54 (nochmal: "Endanwender" mussen diesen Schritt i.d.R. nicht ausfuehren!)
55
56
57 zu 2) ./configure:
58
59 Mit dem configure-Script wird ngIRCd, wie GNU Software meistens, an das
60 lokale System angepasst und die erforderlichen Makefile's erzeugt.
61
62 Im Optimalfall sollte configure alle benoetigten Libraries, Header etc. selber
63 erkennen und entsprechend reagieren. Sollte dies einmal nicht der Fall sein,
64 so zeigt "./configure --help" moegliche Optionen.
65
66
67 zu 3) make:
68
69 Der make-Befehl bearbeitet die vom configure-Script erzeugten Makefile's und
70 uebersetzt die comBase-Library und die Testprogramme.
71
72
73 III. Nuetzliche make-Targets
74 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
75
76 Die vom configure-Script erzeugten Makefile's enthalten immer die folgenden
77 nuetzlichen Targets:
78
79  - clean: alle Erzeugnisse des Compilers/Linkers loeschen.
80    Naechster Schritt: -> make
81
82  - distclean: zusaetzliche alle Makefile's loeschen.
83    Naechster Schritt: -> ./configure
84
85  - maintainer-clean: alle automat. erzeugten Dateien loeschen.
86    Naechster Schritt: -> ./autogen.sh
87
88
89 -- 
90 $Id: INSTALL,v 1.5 2002/03/03 13:07:01 alex Exp $