X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=INSTALL;h=2db1b057a94c63266c19ebe08aef181443f189b5;hp=f35fcc6859c9923142a7ac7a6fc8b5c05bfb4890;hb=9d82635b15acdf26784829674b97d454b741f447;hpb=e7214c151fb7d957c870d1ab169ede460687f034 diff --git a/INSTALL b/INSTALL index f35fcc68..2db1b057 100644 --- a/INSTALL +++ b/INSTALL @@ -8,40 +8,53 @@ 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 -~~~~~~~~~~~~~~~~~~ +0. Update von frueheren Versionen +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -ngIRCd benoetigt "Alex' Portability Headers" (portab.h). Diese koennen von -der Homepage heruntergeladen werden: +Unterschiede zu Version 0.5.x - +- Ab Version 0.6.0 werden asyncrone Passwoerter zur Identifikation anderer + Server, die Variable "Password" in [Server]-Abschnitten wird nicht mehr + unterstuetzt. Passwoerter fuer Server-Server-Links werden nun mit den + Variablen "MyPassword" und "PeerPassword" angegeben. -Vor dem configure-Lauf des ngIRCd muessen dies Header auf dem System in- -stalliert sein, anonsten bricht configure ab. +- Neue Konfigurationsvariablen, Sektion [Global]: MaxConnections, MaxJoins + (vgl. auch Beispiel-Konfiguration "doc/sample-ngircd.conf"!) -II. Quick Start -~~~~~~~~~~~~~~~ +I. Standard-Installation +~~~~~~~~~~~~~~~~~~~~~~~~ -In der Regel sind folgende Schritte ausreichend: +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. - 1) ./autogen.sh [nur erforderlich, wenn ueber CVS bezogen] - 2) ./configure - 3) make +Die Standard-Installation sieht so aus: + 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 -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 -in tar.gz-Archiven der Fall, jedoch nie, wenn der Source-Code ueber CVS +in tar.gz-Archiven der Fall, jedoch immer, wenn der Source-Code ueber CVS bezogen wurde. Dieser Absatz ist also eigentlich ausschliesslich fuer Entwickler interessant. @@ -54,7 +67,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,14 +77,26 @@ 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 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +II. Nuetzliche make-Targets +~~~~~~~~~~~~~~~~~~~~~~~~~~~ Die vom configure-Script erzeugten Makefile's enthalten immer die folgenden nuetzlichen Targets: @@ -86,5 +111,52 @@ nuetzlichen Targets: Naechster Schritt: -> ./autogen.sh + +III. 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. + + +IV. 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.9 2002/12/18 12:19:07 alex Exp $