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 --
- -- INSTALL / Installation --
- Ilja Osthoff, <ilja@glide.ath.cx>
+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.6.x
+- Some options of the configure script have been renamed:
+ --disable-syslog -> --without-syslog
+ --disable-zlib -> --without-zlib
+ Please call "./configure --help" to review the full list of options!
-I. Standard-Installation
-~~~~~~~~~~~~~~~~~~~~~~~~
+Differences to version 0.5.x
+
+- Starting with version 0.6.0, other servers are identified using asynchronous
+ passwords: therefore the variable "Password" in [Server]-sections has been
+ replaced by "MyPassword" and "PeerPassword".
+
+- New configuration variables, section [Global]: MaxConnections, MaxJoins
+ (see example configuration file "doc/sample-ngircd.conf"!).
-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:
+II. Standard Installation
+~~~~~~~~~~~~~~~~~~~~~~~~~
- 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
+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:
-zu 3): "autogen.sh"
+ 1) ./autogen.sh [only necessary when using CVS]
+ 2) ./configure
+ 3) make
+ 4) make install
-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.
-Dieser Absatz ist also eigentlich ausschliesslich fuer Entwickler interessant.
+1): "autogen.sh"
-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.
+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-archives, but when using CVS.
-(nochmal: "Endanwender" mussen diesen Schritt i.d.R. nicht ausfuehren!)
+This step is therefore only interesting for developers.
+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 (use recent versions! autoconf 2.53 and
+automake 1.6.1 are known to work).
-zu 4): "./configure"
+Again: "end users" do not need this step!
-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.
+2): "./configure"
+The configure-script is used to detect local system dependencies.
-zu 5): "make"
+In the perfect case, configure should recognise all needed libraries, header
+files and so on. If this shouldn't work, "./configure --help" shows all
+possible options.
-Der make-Befehl bearbeitet die vom configure-Script erzeugten Makefile's und
-uebersetzt den ngIRCd.
+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.
-zu 6): "make install"
+3): "make"
-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.
+The make command uses the Makefiles produced by configure and compiles the
+ngIRCd daemon.
-Folgende Dateien werden installiert:
-- /usr/local/sbin/ngircd: ausfuehrbarer Server
-- /usr/local/etc/ngircd.conf: Beispiel-Konfiguration, wenn nicht vorhanden
+4): "make install"
+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.
-II. Nuetzliche make-Targets
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+This files will be installed by default:
-Die vom configure-Script erzeugten Makefile's enthalten immer die folgenden
-nuetzlichen Targets:
+- /usr/local/sbin/ngircd: executable server
+- /usr/local/etc/ngircd.conf: sample configuration (if not already present)
- - clean: alle Erzeugnisse des Compilers/Linkers loeschen.
- Naechster Schritt: -> make
- - distclean: zusaetzliche alle Makefile's loeschen.
- Naechster Schritt: -> ./configure
+II. Useful make-targets
+~~~~~~~~~~~~~~~~~~~~~~~
- - maintainer-clean: alle automat. erzeugten Dateien loeschen.
- Naechster Schritt: -> ./autogen.sh
+The Makefile produced by the configure-script contains always these useful
+targets:
+ - clean: delete every product from the compiler/linker
+ next step: -> make
+ - distclean: the above plus erase all generated Makefiles
+ next step: -> ./configure
-III. Konfigurationsdatei ngircd.conf
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ - maintainer-clean: erase all automatic generated files
+ next step: -> ./autogen.sh
-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.
+III. Sample configuration file ngircd.conf
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-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.
+In the sample configuration file, there are comments beginning with "#" OR
+";" -- this is only for the better understanding of the file.
+The file is separated in four blocks: [Global], [Operator], [Server], and
+[Channel]. In the [Global] 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.
-IV. Kommandozeilen-Optionen
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+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
+~~~~~~~~~~~~~~~~~~~~~~~~
-Folgende Parameter koennen dem ngIRCd u.a. uebergeben werden:
+These parameters could be passed to the ngIRCd:
-f, --config <file>
- Der Daemon wird angewiesen, statt der Standard-Konfigurationsdatei
- /usr/local/etc/ngircd.conf die Datei <file> einzulesen.
+ The daemon uses the file <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.8 2002/09/16 11:03:05 alex Exp $
+$Id: INSTALL,v 1.13 2003/03/09 22:03:58 alex Exp $
projects / ngircd-alex.git / blobdiff