- Restructured documentation: now the main language is english.

doc/sample-ngircd.conf

@@ -1,164 +1,138 @@
-# $Id: sample-ngircd.conf,v 1.17 2002/12/18 12:19:07 alex Exp $
+# $Id: sample-ngircd.conf,v 1.18 2003/01/04 13:07:54 alex Exp $
 
 #
-# Das ist eine Beispiel-Konfiguration fuer den ngIRCd, die an die
-# jeweiligen Beduerfnisse angepasst werden kann/muss.
+# This is a sample configuration for the ngIRCd, which must adept to the
+# local preferences and needs.
 #
-# Kommentare werden mit "#" oder ";" eingeleitet.
+# Comments are started with "#" or ";".
 #
-# +-----------------------------------------------------------------------+
-# | Please note: English translations of some of the german documentation |
-# | files can be found in the directory "doc/en" -- please have a look!   |
-# +-----------------------------------------------------------------------+
-#
-# Autor: Alexander Barton, <alex@barton.de>
-# Erweiterungen von Ilja Osthoff, <ilja@glide.ath.cx>
+# Author: Alexander Barton, <alex@barton.de>
+# Initial translation by Ilja Osthoff, <ilja@glide.ath.cx>
 #
 
 [Global]
 
-	#
-	# Im [Global]-Abschnitt der Konfigurationsdatei wird der Server
-	# "an sich" konfiguriert. Notwendig ist nur die Variable "Name",
-	# Info ist in der Regel ebengalls anzupassen. Fuer alle uebrigen
-	# Variablen koennen oft die Defaults benutzt werden, d.h. hier
-	# muss die Variable nicht angegeben werden.
-	#
-
-	# Servername im IRC-Netz
+	# In the [global] section of this file, there is the place of the
+	# main server configuration. Needed is only the variable "Name",
+	# Info you can adjust, if you like to. For all the others variables,
+	# you can use the defaults, this means you can leave it by default.
+	
+	# Server name in the IRC-network
 	Name = irc.the.net
-
-	# Info-Text des Servers. Dieser wird z.B. bei WHOIS- oder LINKS-
-	# Abfragen entsprechend mit ausgegeben.
+	
+	# Info-text of the server. This will be shown i.e. by a WHOIS- or
+	# LINKS-request.
 	Info = Server Info Text
 	
-	# Informationen ueber den Server und Administrator fuer den
-	# ADMIN-Befehl:
-	;AdminInfo1 = Beschreibung
-	;AdminInfo2 = Standort
+	# Information about the server and administrator in the ADMIN-request
+	;AdminInfo1 = Description
+	;AdminInfo2 = Location
 	;AdminEMail = admin@irc.server
-
-	# Ports, auf denen Verbindungen angenommen werden sollen. Es koennen
-	# mehrere Ports mit "," getrennt angegeben werden. (Default: 6667)
-	;Ports = 6667, 6668, 6669
-
-	# Textdatei mit der "Message of the Day" (MOTD). Diese wird aus-
-	# gegeben, wenn sich ein User mit dem Server verbindet.
+ 
+	# Ports, on which the server will listen. There may be more than
+	# one port, separated with ";". (Default: 6667)
+	;Ports = 6667, 6668, 66694
+	
+	# Textfile with the "message of the day" (MOTD). This will be shown
+	# on a user connection with the server.
 	;MotdFile = /usr/local/etc/ngircd.motd
 
-	# User-ID, unter der der Daemon laufen soll (dazu muss der Server
-	# jedoch mit root-Rechten gestartet werden). Es kann der Name oder
-	# die numerische ID angegeben werden.
-	# ACHTUNG: Die Konfigurations- und MOTD-Datei muessen fuer diesen
-	# Benutzer lesbar sein, ansonsten schlaegt ein RESTART fehl!
-	;ServerUID = ircd
+	# User-ID, under which the server is started (for that the server
+	# must be started with root-rights). You can use the name of the
+	# user or the numerical ID.
+	# ATTENTION: the configuration and the MOTD file must be readable
+	# by this user, otherwise RESTART won't work!
+	;ServerUID = 65534
 
-	# Group-ID, zu der der Daemon wechseln soll (hierzu muss der Server
-	# jedoch mit root-Rechten gestartet werden). Es kann der Name oder
-	# die numerische ID angegeben werden.
-	;ServerGID = daemon
+	# Group-ID, under which the server is running (for that the server
+	# must be started with root-rights). You can use the name of the
+	# group or the numerical ID.
+	;ServerGID = 65534
 
-	# Nach <PingTimeout> Sekunden verschickt der Server bei Inaktivitaet
-	# von einem Client diesem ein PING.
+	# After <PingTimeout> seconds, the server will send a ping after
+	# inactivity of this client.
 	;PingTimeout = 120
 
-	# Antwortet ein Client, der ein PING bekam, nicht innerhalb von
-	# <PongTimeout> Sekunden mit einem PONG, so wird er disconnectiert.
+	# If there is an answer of a client, to which the ping was sended,
+	# not after <PongTimeout> seconds, it will be disconnected.
 	;PongTimeout = 20
 
-	# Der Server versucht alle <ConnectRetry> Sekunden, noch nicht bzw.
-	# nicht mehr connectierte Server-Links aufzubauen.
+	# The server tries every <ConnectRetry> seconds, not yet connected
+	# or not anymore connected servers to connect.
 	;ConnectRetry = 60
-	
-	# Sollen IRC-Operatoren immer den MODE-Befehl in Channel benutzen
-	# koennen, auch wenn sie kein(!) Channel-Operator sind?
+
+	# Should IRC-operators be allowed to use the MODE command even if
+	# they are not(!) channel-operators?
 	;OperCanUseMode = no
 
-	# Maximale Anzahl von gleichzeitigen Verbindungen, die dieser
-	# Server annehmen darf (<=0: unlimitiert).
+	# Maximum number of simultanous connection the server is allowed
+	# to accept (<=0: unlimited):
 	;MaxConnections = -1
 
-	# Maximale Anzahl von Channels, in denen ein User zeitgleich
-	# Mitglied sein kann (<=0: unlimitiert).
+	# Maximum number of channels a user can be member of (<=0: no limit):
 	;MaxJoins = 10
 
 [Operator]
-
-	#
-	# Mit einem [Operator]-Block wird der Name und das Passwort eines
-	# IRC-Operators konfiguriert. Es darf mehrere [Operator]-Bloecke
-	# geben (fuer jeden Operator einen).
-	#
-
-	# ID des IRC-Operators (muss nicht mit dem Nick identisch sein).
+	# In this [operator]-section, there will be the configuration of
+	# the name and password of an IRC operator. There may be more than
+	# one operator-block (for each operator one).
+	
+	# ID of the operator (may be different of the nick)
 	;Name = TheOper
 
-	# Passwort des IRC-Operators
+	# Password of the operator
 	;Password = ThePwd
 
 [Server]
-
+	# In this [Server] section, there is the configuration of the
+	# servers, which are allowed to connect to your own server.
+	# There may be more than one server-block.
+	# If you configured a port for the connection, then the ngIRCd
+	# tries to connect to this port. If not, it waits for the other
+	# server.
 	#
-	# In [Server]-Bloecken werden Server konfiguriert, zu denen sich
-	# dieser ngIRCd verbinden soll bzw. von denen Verbindungen angekommen
-	# werden duerfen.
-	# Es koennen mehrere Server konfiguriert werden, d.h. [Server]-
-	# Bloecke koennen mehrfach vorkommen.
-	# Wenn man fuer einen Server einen Port angegeben hat, dann versucht
-	# sich der ngIRCd mit der Gegenseite zu verbinden. Hat man keinen
-	# Port konfiguriert, dann wartet der ngIRCd darauf, dass sich die
-	# Gegenseite mit ihm verbindet.
-	#
-	# Server-Gruppen:
-	# Der ngIRCd unterstuetzt "Server-Gruppen": das bedeutet, man kann
-	# jedem Server, mit dem man sich verbinden will, einer Gruppe zu-
-	# ordnen. Wenn der ngIRCd sich dann mit einem Server aus der Gruppe
-	# verbinden will und keine Antwort erhaelt, dann wird der naechste
-	# Server aus der Gruppe versucht.
-	# Achtung: Gruppen werden nur beachtet, wenn man einen Port fur
-	# die Gegenseite angegeben hat!
-	#
-
-	# IRC-Name des Servers
+	# Server-groups:
+	# The ngIRCd allows "server-groups": that means, that you can assign
+	# server-groups for every server, to which you want the ngIRCd to
+	# connect to. If one server of a server-group won't answer, the
+	# ngIRCd tries the next one of this group.
+	# ATTENTION: Server-groups will only work if you defined a port!
+	
+	# IRC-name of the server
 	;Name = irc2.the.net
-
-	# DNS-Hostname des Servers
+   
+	# Hostname of the server
 	;Host = connect-to-host.the.net
 
-	# Port, zu dem dieser Server eine Verbindung herstellen soll. Wird
-	# kein Port angegeben, so wird auf eine Verbindung der Gegenseite
-	# gewartet.
+	# Port of the server, to which the ngIRCd should connect. If you
+	# assign no port, the ngIRCd waits for an answer of that server.
 	;Port = 6666
 
-	# Eigenes Passwort fuer diese Verbindung. Dieses Passwort muss auf
-	# dem anderen Server als "PeerPassword" konfiguriert werden.
+	# Own password for the connection. This password has to be configured
+	# as "PeerPassword" on the other server.
 	;MyPassword = MySecret
 
-	# Passwort des Peer-Servers fuer diese Verbindung. Dieses Passwort
-	# muss auf dem anderen Server als "MyPassword" konfiguriert sein.
+	# Foreign password for this connection. This password has to be
+	# configured as "MyPassword" on the other server.
 	;PeerPassword = PeerSecret
-
-	# Gruppe, zu der dieser Server gehoert (optional).
+	
+	# Group of that server (optional)
 	;Group = 123
 
 [Channel]
-
-	#
-	# Mit [Channel]-Bloecken werden "persistente Channels" definiert,
-	# die nach dem Start des Servers automatisch erzeugt werden und auch
-	# dann erhalten bleiben, wenn keine User mehr im Channel sind. Es
-	# koennen mehrere solcher Bloecke hier konfiguriert werden.
-	# Gekennzeichnet werden solche Channels mit dem Mode "P", der ganz
-	# normal gesetzt und geloescht werden kann.
-	#
-
-	# Name des Channels
+	# In the [Channel] there can be defined "persistent channels". This
+	# means, that the server creates the channel and even if all users
+	# left this channel, it will persist. There may be more than one
+	# block. Signed with the mode "P", which  can be set or unset, like
+	# normal modes.
+	
+	# Name of the channel
 	;Name = #TheName
 
-	# Topic, das gesetzt werden soll
-	;Topic = Ein tolles Topic
-
-	# Channel-Modes
+	# Topic for the channel
+	;Topic = a great topic
+	
+	# Channel-modes
 	;Modes = tn
 
 # -eof-