X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=INSTALL;h=47b4c377fc4a50bc3e63d0f64ef0ad5148b1a8ca;hp=f35fcc6859c9923142a7ac7a6fc8b5c05bfb4890;hb=fd4a6b5dd5052ab0bb5b52e0b94ec45f1f1e47d5;hpb=e7214c151fb7d957c870d1ab169ede460687f034 diff --git a/INSTALL b/INSTALL index f35fcc68..47b4c377 100644 --- a/INSTALL +++ b/INSTALL @@ -1,90 +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 -- + -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. +I. Upgrade Information +~~~~~~~~~~~~~~~~~~~~~~ +Differences to version 0.5.x -I. Voraussetzungen -~~~~~~~~~~~~~~~~~~ +- 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". -ngIRCd benoetigt "Alex' Portability Headers" (portab.h). Diese koennen von -der Homepage heruntergeladen werden: +- New configuration variables, section [Global]: MaxConnections, MaxJoins + (see example configuration file "doc/sample-ngircd.conf"!). - -Vor dem configure-Lauf des ngIRCd muessen dies Header auf dem System in- -stalliert sein, anonsten bricht configure ab. +II. Standard Installation +~~~~~~~~~~~~~~~~~~~~~~~~~ +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. -II. Quick Start -~~~~~~~~~~~~~~~ +The normal installation procedure after getting (and expanding) the source +files (using a distribution archive or CVS) is as following: -In der Regel sind folgende Schritte ausreichend: + 1) ./autogen.sh [only necessary when using CVS] + 2) ./configure + 3) make + 4) make install - 1) ./autogen.sh [nur erforderlich, wenn ueber CVS bezogen] - 2) ./configure - 3) make +1): "autogen.sh" +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. -zu 1) autogen.sh: +This step is therefore only interesting for developpers. -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. +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!). -Dieser Absatz ist also eigentlich ausschliesslich fuer Entwickler interessant. +Again: "end users" do not need this step! -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. +4): "./configure" -(nochmal: "Endanwender" mussen diesen Schritt i.d.R. nicht ausfuehren!) +The configure-script is used to detect local system dependancies. +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. -zu 2) ./configure: +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. -Mit dem configure-Script wird ngIRCd, wie GNU Software meistens, an das -lokale System angepasst und die erforderlichen Makefile's erzeugt. +5): "make" -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. +The make command uses the Makefiles produced by configure and compiles the +ngIRCd daemon. +6): "make install" -zu 3) make: +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. -Der make-Befehl bearbeitet die vom configure-Script erzeugten Makefile's und -uebersetzt die comBase-Library und die Testprogramme. +This files will be installed by default: +- /usr/local/sbin/ngircd: exectable server +- /usr/local/etc/ngircd.conf: sample configuration (if not already present) -III. Nuetzliche make-Targets -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Die vom configure-Script erzeugten Makefile's enthalten immer die folgenden -nuetzlichen Targets: +II. Useful make-targets +~~~~~~~~~~~~~~~~~~~~~~~ - - clean: alle Erzeugnisse des Compilers/Linkers loeschen. - Naechster Schritt: -> make +The Makefile produced by the configure-script contains always these useful +targets: - - distclean: zusaetzliche alle Makefile's loeschen. - Naechster Schritt: -> ./configure + - clean: delete every product from the compiler/linker + next step: -> make - - maintainer-clean: alle automat. erzeugten Dateien loeschen. - Naechster Schritt: -> ./autogen.sh + - distclean: the above plus erase all generated Makefiles + next step: -> ./configure + + - maintainer-clean: erease all automatic generated files + next step: -> ./autogen.sh + + +III. Sample configuration file ngircd.conf +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In the sample configuration file, there are comments beginning with "#" OR +";" -- this is only for the better understanding of the file. + +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. + +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). + + +IV. Command line options +~~~~~~~~~~~~~~~~~~~~~~~~ + +These parameters could be passed to the ngIRCd: + +-f, --config + The daemon uses the file as configuration file rather than + the standard configuration /usr/local/etc/ngircd.conf. + +-n, --nodaemon + ngIRCd should be running as a foreground process. + +-p, --passive + Server-links won't be automatically established. + +--configtest + Reads, validates and dumps the configuration file as interpreted + by the server. Then exits. + +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.5 2002/03/03 13:07:01 alex Exp $ +$Id: INSTALL,v 1.10 2003/03/04 13:46:53 alex Exp $