From: Alexander Barton Date: Wed, 8 May 2002 15:44:43 +0000 (+0000) Subject: - Dokumentation aktualisiert. X-Git-Tag: rel-0-5-0-pre1~197 X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=commitdiff_plain;h=be54db83c96e76a20097bb10e1d0b8493828feff - Dokumentation aktualisiert. --- diff --git a/INSTALL b/INSTALL index f35fcc68..60fde8a0 100644 --- a/INSTALL +++ b/INSTALL @@ -8,36 +8,35 @@ der GNU General Public License. -- INSTALL / Installation -- + + Ilja Osthoff, -ngIRCd ist fuer UNIXoide-Systeme konzipiert. Dieser Text beschreibt den -"Standardfall": ein UNIX bzw. UNIX-aehnliches System, das von GNU automake -und GNU autoconf ("configure") unterstuetzt wird. + +-----------------------------------------------------------------------+ + | Please note: English translations of some of the german documentation | + | files can be found in the directory "doc/en" -- please have a look! | + +-----------------------------------------------------------------------+ -I. Voraussetzungen -~~~~~~~~~~~~~~~~~~ +I. Standard-Installation +~~~~~~~~~~~~~~~~~~~~~~~~ -ngIRCd benoetigt "Alex' Portability Headers" (portab.h). Diese koennen von -der Homepage heruntergeladen werden: +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: -Vor dem configure-Lauf des ngIRCd muessen dies Header auf dem System in- -stalliert sein, anonsten bricht configure ab. + 1) tar xzf ngircd-.tar.gz + 2) cd ngircd- + 3) ./autogen.sh [nur erforderlich, wenn ueber CVS bezogen] + 4) ./configure + 5) make + 6) make install -II. Quick Start -~~~~~~~~~~~~~~~ - -In der Regel sind folgende Schritte ausreichend: - - 1) ./autogen.sh [nur erforderlich, wenn ueber CVS bezogen] - 2) ./configure - 3) make - - -zu 1) autogen.sh: +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 @@ -54,7 +53,7 @@ Versionen!) benoetigt. (nochmal: "Endanwender" mussen diesen Schritt i.d.R. nicht ausfuehren!) -zu 2) ./configure: +zu 4): "./configure" Mit dem configure-Script wird ngIRCd, wie GNU Software meistens, an das lokale System angepasst und die erforderlichen Makefile's erzeugt. @@ -64,10 +63,22 @@ erkennen und entsprechend reagieren. Sollte dies einmal nicht der Fall sein, so zeigt "./configure --help" moegliche Optionen. -zu 3) make: +zu 5): "make" Der make-Befehl bearbeitet die vom configure-Script erzeugten Makefile's und -uebersetzt die comBase-Library und die Testprogramme. +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 @@ -86,5 +97,52 @@ nuetzlichen Targets: 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 + Der Daemon wird angewiesen, statt der Standard-Konfigurationsdatei + /usr/local/etc/ngircd.conf die Datei 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.5 2002/03/03 13:07:01 alex Exp $ +$Id: INSTALL,v 1.6 2002/05/08 15:44:43 alex Exp $