ngircd-tor/INSTALL

                     ngIRCd - Next Generation IRC Server

                      (c)2001,2002 by Alexander Barton,
                    alex@barton.de, http://www.barton.de/

                  ngIRCd ist freie Software und steht unter
                       der GNU General Public License.

                         -- INSTALL / Installation --
                         
                      Ilja Osthoff, <ilja@glide.ath.cx>


 +-----------------------------------------------------------------------+
 | Please note: English translations of some of the german documentation |
 | files can be found in the directory "doc/en" -- please have a look!   |
 +-----------------------------------------------------------------------+


I. Standard-Installation
~~~~~~~~~~~~~~~~~~~~~~~~

ngIRCd ist fuer UNIXoide-Systeme konzipiert worden, das bedeutet, dass die
Installation auf einem modernen UNIX-aehnlichen System kein Problem dar-
stellen sollte. Das System muss nur von GNU automake und GNU autoconf
("configure") unterstuetzt werden.

Die Standard-Installation sieht so aus:

   1) tar xzf ngircd-<Version>.tar.gz
   2) cd ngircd-<Version>
   3) ./autogen.sh	[nur erforderlich, wenn ueber CVS bezogen]
   4) ./configure
   5) make
   6) make install


zu 3): "autogen.sh"

Der erste Schritt, autogen.sh, ist nur notwendig, wenn das configure-Script
noch nicht vorhanden ist. Dies ist nie bei offiziellen ("stabilen") Versionen
in tar.gz-Archiven der Fall, jedoch nie, wenn der Source-Code ueber CVS
bezogen wurde.

Dieser Absatz ist also eigentlich ausschliesslich fuer Entwickler interessant.

autogen.sh erzeugt die fuer das configure-Script notwendigen Makefile.in's
sowie das configure-Script selber und weitere fuer den make-Lauf erforderliche
Dateien. Dazu wird sowohl GNU automake als auch GNU autoconf (in aktuellen
Versionen!) benoetigt.

(nochmal: "Endanwender" mussen diesen Schritt i.d.R. nicht ausfuehren!)


zu 4): "./configure"

Mit dem configure-Script wird ngIRCd, wie GNU Software meistens, an das
lokale System angepasst und die erforderlichen Makefile's erzeugt.

Im Optimalfall sollte configure alle benoetigten Libraries, Header etc. selber
erkennen und entsprechend reagieren. Sollte dies einmal nicht der Fall sein,
so zeigt "./configure --help" moegliche Optionen.


zu 5): "make"

Der make-Befehl bearbeitet die vom configure-Script erzeugten Makefile's und
uebersetzt den ngIRCd.


zu 6): "make install"

Mit "make install" wird der Server und ggf. eine Beispiels-Konfiguration
im System installiert; hierzu sind in der Regel root-Rechte erforderlich.
Eine bereits vorhandene Konfigurationsdatei wird nie ueberschrieben.

Folgende Dateien werden installiert:

- /usr/local/sbin/ngircd: ausfuehrbarer Server
- /usr/local/etc/ngircd.conf: Beispiel-Konfiguration, wenn nicht vorhanden


III. Nuetzliche make-Targets
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Die vom configure-Script erzeugten Makefile's enthalten immer die folgenden
nuetzlichen Targets:

 - clean: alle Erzeugnisse des Compilers/Linkers loeschen.
   Naechster Schritt: -> make

 - distclean: zusaetzliche alle Makefile's loeschen.
   Naechster Schritt: -> ./configure

 - maintainer-clean: alle automat. erzeugten Dateien loeschen.
   Naechster Schritt: -> ./autogen.sh



IV. Konfigurationsdatei ngircd.conf
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In der Konfigurationsdatei werden Kommentare durch "#" oder durch ";"
eingeleitet. Dieses dient nur der besseren Lesbarkeit.

Die Datei ist in drei Abschnitte unterteilt: [Global], [Operator] und
[Server]. Im [Global]-Teil werden die grundlegenden Einstellungen vor-
genommen, z.B. der Server-Name und die Ports, auf denen er Verbindungen
annehmen soll. In [Operator]-Abschnitten werden Server-Operatoren fest-
gelegt und unter [Server] werden die Einstellungen fuer die Verbindung
mit anderen Servern konfiguriert.

Die Bedeutung der einzelnen Variablen ist in der Beispiel-Konfiguration
"doc/sample-ngircd.conf" erklaert, die bei "make install" auch als
"ngircd.conf" in /usr/local/etc installiert wird, wenn dort noch keine
Konfigurationsdatei vorhanden ist.


V. Kommandozeilen-Optionen
~~~~~~~~~~~~~~~~~~~~~~~~~~

Folgende Parameter koennen dem ngIRCd u.a. uebergeben werden:

-f, --config <file>
	Der Daemon wird angewiesen, statt der Standard-Konfigurationsdatei
	/usr/local/etc/ngircd.conf die Datei <file> einzulesen.

-n, --nodaemon
	ngIRCd soll im Fordergrund laufen; alle Meldungen werden zusaetzlich
	zum Syslog auch auf der Konsole ausgegeben.

-p, --passive
	Verbindungen zu anderen Servern (wie in der Konfigurationsdatei in
	[Server]-Abschnitten definiert) werden nicht automatisch hergestellt.

--configtest
	Die Konfigurationsdatei wird eingelesen, ueberprueft und so aus-
	gegeben, wie sie vom ngIRCd interpretiert wurde. Danach beendet
	sich der Server wieder.

Mit dem Parameter "--help" werden alle unterstuetzten Parameter angezeigt,
mit "--version" die Versionsnummer. Bei beiden Parametern beendet sich der
Server nach der Ausgabe wieder.


-- 
$Id: INSTALL,v 1.6 2002/05/08 15:44:43 alex Exp $