commit fd4a6b5dd5052ab0bb5b52e0b94ec45f1f1e47d5 from: Alexander Barton date: Tue Mar 04 13:46:53 2003 UTC Updated documentation. commit - b896f8acda3cf53e6d6020c70d551e8bc8c629b0 commit + fd4a6b5dd5052ab0bb5b52e0b94ec45f1f1e47d5 blob - e2d7fe38d8cf32315b57676460547d6c21cda643 blob + d9196d2e8f848379b0dce4bbbf8f984b41f58ed9 --- ChangeLog +++ ChangeLog @@ -36,7 +36,7 @@ ngIRCd CVS-HEAD - Moved tool functions to own library: "libngtool". - New command TRACE (you can trace only servers at the moment). - New command HELP that lists all understood commands. - - There should no longer remain "unknown connections" (see e.g. LUSRS) + - There should no longer remain "unknown connections" (see e.g. LUSERS) if an outgoing server link can't be established. - Added AC_PREREQ(2.50) to configure.in for better autoconf compatibility. - Conn_Close() now handles recurisive calls for the same link correctly. @@ -423,4 +423,4 @@ ngIRCd 0.0.1, 31.12.2001 -- -$Id: ChangeLog,v 1.178 2003/02/23 12:02:39 alex Exp $ +$Id: ChangeLog,v 1.179 2003/03/04 13:46:53 alex Exp $ blob - 2db1b057a94c63266c19ebe08aef181443f189b5 blob + 47b4c377fc4a50bc3e63d0f64ef0ad5148b1a8ca --- INSTALL +++ INSTALL @@ -1,162 +1,145 @@ ngIRCd - Next Generation IRC Server - (c)2001,2002 by Alexander Barton, + (c)2001-2003 by Alexander Barton, alex@barton.de, http://www.barton.de/ - ngIRCd ist freie Software und steht unter - der GNU General Public License. + ngIRCd is free software and published under the + terms of the GNU General Public License. - -- INSTALL / Installation -- + -- INSTALL -- + - Ilja Osthoff, +I. Upgrade Information +~~~~~~~~~~~~~~~~~~~~~~ - +-----------------------------------------------------------------------+ - | Please note: English translations of some of the german documentation | - | files can be found in the directory "doc/en" -- please have a look! | - +-----------------------------------------------------------------------+ +Differences to version 0.5.x +- Starting with version 0.6.0, other servers are identified using asyncronous + passwords: therefore the variable "Password" in [Server]-sections has been + replaced by "MyPassword" and "PeerPassword". -0. Update von frueheren Versionen -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +- New configuration variables, section [Global]: MaxConnections, MaxJoins + (see example configuration file "doc/sample-ngircd.conf"!). -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. +II. Standard Installation +~~~~~~~~~~~~~~~~~~~~~~~~~ -- Neue Konfigurationsvariablen, Sektion [Global]: MaxConnections, MaxJoins - (vgl. auch Beispiel-Konfiguration "doc/sample-ngircd.conf"!) +ngIRCd is developed for UNIX-like systems, which means that the installation +on modern UNIX-like systems witch are supported by GNU autoconf and GNU +automake ("configure") should be no problem. +The normal installation procedure after getting (and expanding) the source +files (using a distribution archive or CVS) is as following: -I. Standard-Installation -~~~~~~~~~~~~~~~~~~~~~~~~ + 1) ./autogen.sh [only necessary when using CVS] + 2) ./configure + 3) make + 4) make install -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" -Die Standard-Installation sieht so aus: +The first step, autogen.sh, is only necessary if the configure-script isn't +already generated. This never happens in official ("stable") releases in +tar.gz-archieves, but when using CVS. - 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 +This step is therefore only interesting for developpers. +autogen.sh produces the Makefile.in's, which are necessary for the configure +script itself, and some more files for make. To run autogen.sh you'll need +GNU autoconf and GNU automake (in recent versions!). -zu 3): "autogen.sh" +Again: "end users" do not need this step! -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 immer, wenn der Source-Code ueber CVS -bezogen wurde. +4): "./configure" -Dieser Absatz ist also eigentlich ausschliesslich fuer Entwickler interessant. +The configure-script is used to detect local system dependancies. -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. +In the perfect case, configure should recognize all needed libraries, header +files and so on. If this shouldn't work, "./configure --help" shows all +possible options. -(nochmal: "Endanwender" mussen diesen Schritt i.d.R. nicht ausfuehren!) +In addition, you can pass some command line options to "configure" to enable +and/or disable some features of ngIRCd. All these options are shown using +"./configure --help", too. +5): "make" -zu 4): "./configure" +The make command uses the Makefiles produced by configure and compiles the +ngIRCd daemon. -Mit dem configure-Script wird ngIRCd, wie GNU Software meistens, an das -lokale System angepasst und die erforderlichen Makefile's erzeugt. +6): "make install" -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. +Use "make install" to install the server and a sample configuration file on +the local system. Normally, root privileges are necessary to complete this +step. If there is already an older configuration file present, it won't be +overwritten. +This files will be installed by default: -zu 5): "make" +- /usr/local/sbin/ngircd: exectable server +- /usr/local/etc/ngircd.conf: sample configuration (if not already present) -Der make-Befehl bearbeitet die vom configure-Script erzeugten Makefile's und -uebersetzt den ngIRCd. +II. Useful make-targets +~~~~~~~~~~~~~~~~~~~~~~~ -zu 6): "make install" +The Makefile produced by the configure-script contains always these useful +targets: -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. + - clean: delete every product from the compiler/linker + next step: -> make -Folgende Dateien werden installiert: + - distclean: the above plus erase all generated Makefiles + next step: -> ./configure -- /usr/local/sbin/ngircd: ausfuehrbarer Server -- /usr/local/etc/ngircd.conf: Beispiel-Konfiguration, wenn nicht vorhanden + - maintainer-clean: erease all automatic generated files + next step: -> ./autogen.sh -II. Nuetzliche make-Targets -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +III. Sample configuration file ngircd.conf +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Die vom configure-Script erzeugten Makefile's enthalten immer die folgenden -nuetzlichen Targets: +In the sample configuration file, there are comments beginning with "#" OR +";" -- this is only for the better understanding of the file. - - clean: alle Erzeugnisse des Compilers/Linkers loeschen. - Naechster Schritt: -> make +The file is seperated in four blocks: [Global], [Operator], [Server], and +[Channel]. In the [Gobal] part, there is the main configuration, like the +server-name and the ports, on which the server should be listening. In the +[Operator] section, the server-operators are defined and [Server] is the +section, where the server-links are configured. Use [Channel] blocks to +configure pre-defined ("persistent") IRC channels. - - distclean: zusaetzliche alle Makefile's loeschen. - Naechster Schritt: -> ./configure +The meaning of the variables in the configuration file is explained in the +"doc/sample-ngircd.conf", which is used as sample configuration file in +/usr/local/etc after running "make install" (if you don't already have one). - - maintainer-clean: alle automat. erzeugten Dateien loeschen. - Naechster Schritt: -> ./autogen.sh +IV. Command line options +~~~~~~~~~~~~~~~~~~~~~~~~ +These parameters could be passed to the ngIRCd: -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. + The daemon uses the file as configuration file rather than + the standard configuration /usr/local/etc/ngircd.conf. -n, --nodaemon - ngIRCd soll im Fordergrund laufen; alle Meldungen werden zusaetzlich - zum Syslog auch auf der Konsole ausgegeben. + ngIRCd should be running as a foreground process. -p, --passive - Verbindungen zu anderen Servern (wie in der Konfigurationsdatei in - [Server]-Abschnitten definiert) werden nicht automatisch hergestellt. + Server-links won't be automatically established. --configtest - Die Konfigurationsdatei wird eingelesen, ueberprueft und so aus- - gegeben, wie sie vom ngIRCd interpretiert wurde. Danach beendet - sich der Server wieder. + Reads, validates and dumps the configuration file as interpreted + by the server. Then exits. -Mit dem Parameter "--help" werden alle unterstuetzten Parameter angezeigt, -mit "--version" die Versionsnummer. Bei beiden Parametern beendet sich der -Server nach der Ausgabe wieder. +Use "--help" to see a short help text describing all available parameters +the server understands, with "--version" the ngIRCd shows its version +number. In both cases the server exits after the output. -- -$Id: INSTALL,v 1.9 2002/12/18 12:19:07 alex Exp $ +$Id: INSTALL,v 1.10 2003/03/04 13:46:53 alex Exp $