about summary refs log tree commit diff
path: root/doc/en
diff options
context:
space:
mode:
authorAlexander Barton <alex@barton.de>2003-01-04 13:07:54 +0000
committerAlexander Barton <alex@barton.de>2003-01-04 13:07:54 +0000
commit5b333085283e1999cb215e619eb77f3817d244bd (patch)
treea0d74e295641e86af109fa814036b889ef7703b2 /doc/en
parent444fdcf9057de8591e96cca07aec6999ed82aa5d (diff)
downloadngircd-5b333085283e1999cb215e619eb77f3817d244bd.tar.gz
ngircd-5b333085283e1999cb215e619eb77f3817d244bd.zip
- Restructured documentation: now the main language is english.
Diffstat (limited to 'doc/en')
-rw-r--r--doc/en/INSTALL139
-rw-r--r--doc/en/Makefile.am20
-rw-r--r--doc/en/README101
-rw-r--r--doc/en/sample-ngircd.conf138
4 files changed, 0 insertions, 398 deletions
diff --git a/doc/en/INSTALL b/doc/en/INSTALL
deleted file mode 100644
index 40704b8b..00000000
--- a/doc/en/INSTALL
+++ /dev/null
@@ -1,139 +0,0 @@
-
-                     ngIRCd - Next Generation IRC Server
-
-                      (c)2001,2002 by Alexander Barton,
-                    alex@barton.de, http://www.barton.de/
-
-                  ngIRCd ist freie Software und steht unter
-                       der GNU General Public License.
-
-                                -- INSTALL --
-
-                         
-
-0. Upgrade Information
-~~~~~~~~~~~~~~~~~~~~~~
-
-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".
-
-- New configuration variables, section [Global]: MaxConnections, MaxJoins
-  (see example configuration file "doc/en/sample-ngircd.conf"!).
-
-
-I. Standard-Installation
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-ngIRCd is developed for UNIX-like systems, which means, that the installation
-on a modern UNIX-like system should be no problem. The only thing is, that
-the system should be supported by GNU automake and GNU autoconf ("configure").
-
-The normal installation is like that:
-
-   1) tar xzf ngircd-<Version>.tar.gz
-   2) cd ngircd-<Version>
-   3) ./autogen.sh	[only necessary when using CVS]
-   4) ./configure
-   5) make
-   6) make install
-
-3): "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 the CVS system.
-
-The next is therefore only interesting for developpers.
-
-autogen.sh produces the makefile.in's, which are necessary for the configure
-script it self, and some more files for make. For this step, there must be
-GNU automake and GNU autoconf (in recent versions).
-
-(again: "end users" do not need this step!)
-
-to 4): "./configure"
-
-The configure-script is used to detect local system dependancies.
-
-In the perfect case, configure should recognize all needed libraries, header
-and so on. If this shouldn't work, "./configure --help" shows more options.
-
-to 5): "make"
-
-The make command uses the Makefiles produced by configure and compiles the
-ngIRCd daemon.
-
-to 6): "make install"
-
-Use "make install" to install the server and a sample configuration file on
-the local system. For this step, root privileges are necessary. If there is
-already an older configuration file present, it won't be overwritten.
-
-This are the files that are installed:
-
-- /usr/local/sbin/ngircd: exectable server
-- /usr/local/etc/ngircd.conf: sample configuration, if not there
-
-
-II. Useful make-targets
-~~~~~~~~~~~~~~~~~~~~~~~
-
-The Makefile produced by the configure-script contain always these useful
-targets:
-
- - clean: delete every product from the compiler/linker
-   next step: -> make
-
- - distclean: 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 code.
-
-The file is seperated in three blocks: [Global], [Operator], [Server]. 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.
-
-The meaning of the variables in the configuration file is explained in the 
-"doc/sample-ngircd.conf", which is also the 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 <file>
-	The daemon uses the file <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.3 2002/12/18 12:19:07 alex Exp $
diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am
deleted file mode 100644
index 8f9215a9..00000000
--- a/doc/en/Makefile.am
+++ /dev/null
@@ -1,20 +0,0 @@
-#
-# ngIRCd -- The Next Generation IRC Daemon
-# Copyright (c)2001,2002 by Alexander Barton (alex@barton.de)
-#
-# Dieses Programm ist freie Software. Sie koennen es unter den Bedingungen
-# der GNU General Public License (GPL), wie von der Free Software Foundation
-# herausgegeben, weitergeben und/oder modifizieren, entweder unter Version 2
-# der Lizenz oder (wenn Sie es wuenschen) jeder spaeteren Version.
-# Naehere Informationen entnehmen Sie bitter der Datei COPYING. Eine Liste
-# der an ngIRCd beteiligten Autoren finden Sie in der Datei AUTHORS.
-#
-# $Id: Makefile.am,v 1.2 2002/11/18 14:06:29 alex Exp $
-#
-
-EXTRA_DIST = INSTALL README sample-ngircd.conf
-
-maintainer-clean-local:
-	rm -f Makefile Makefile.in
-
-# -eof-
diff --git a/doc/en/README b/doc/en/README
deleted file mode 100644
index 4fd9bf68..00000000
--- a/doc/en/README
+++ /dev/null
@@ -1,101 +0,0 @@
-                     ngIRCd - Next Generation IRC Server
-
-                      (c)2001,2002 by Alexander Barton,
-                    alex@barton.de, http://www.barton.de/
-
-               ngIRCd is free software and published under the
-                   terms of the GNU General Public License.
-
-                                -- README --
-                           
-                      Ilja Osthoff, <ilja@glide.ath.cx>
-
-
-I. Introduction
-~~~~~~~~~~~~~~~
-
-ngIRCd is an Open-Source server for the Internet Realy Chat (IRC), which
-is developped and published under the terms of the GNU General Public
-Licence (URL: http://www.gnu.org/licenses/gpl.html). ngIRCd means "next
-generation IRC daemon", it's written from scratch and not deduced from the
-"grandfather of IRC daemons", the daemon of the IRCNet.
-
-
-
-II. Status
-~~~~~~~~~~~
-
-At present, the ngIRCd is under active development, some features are not
-implemented, some only partly.
-
-Till today (more or less complete) implemented IRC-commands:
-
-ADMIN, AWAY, CHANINFO, CONNECT, DIE, ERROR, INVITE, ISON, JOIN, KICK, KILL,
-LINKS, LIST, LUSERS, MODE, MOTD, NAMES, NICK, NJOIN, NOTICE, OPER, PART,
-PASS, PING, PONG, PRIVMSG, QUIT, RESTART, SERVER, SQUIT, TIME, TOPIC,
-USERHOST, USER, VERSION, WHO, WHOIS.
-
-
-III. Features (or: why use ngIRCd?)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-- no problems with servers which have dynamic ip-adresses
-- simple, easy understandable configuration file,
-- freely published C-Sourcecode,
-- ngIRCd will be developed on in the future.
-- supported platforms (tested versions): AIX (3.2.5), A/UX (3.0.1), FreeBSD
-  (4.5), HP-UX (10.20), IRIX (6.5), Linux (2.x), Mac OS X (10.x), NetBSD
-  (1.5.2/i386, 1.5.3/m68k), Solaris (2.5.1, 2.6), and Windows with Cygwin.
-
-
-IV. Documentation
-~~~~~~~~~~~~~~~~~
-
-English documentation:
-
-- doc/en/README: the file that you are reading :-)
-- doc/en/INSTALL: hints for the installation of the ngIRCd
-
-German documentation:
-
-- README: readme text in german
-- INSTALL: german installation instructions
-- NEWS: what do you think? :-) 
-- Changelog: the complete history of the ngIRCd
-- doc/FAQ.txt: frequently asked questions and answers
-- doc/CVS.txt: hints for the CVS-system
-- doc/RFC.txt: information about the RFC's
-- doc/sample-ngircd.conf: sample configuration file
-- doc/README-AUX.txt: installation hints for A/UX
-- doc/README-BeOS.txt: the same for BeOS
-
-
-V. Download
-~~~~~~~~~~~
-
-The homepage of the ngIRCd is: <http://arthur.ath.cx/~alex/ngircd>; you
-will find the newest information about the ngIRCd and the most recent
-("stable") releases there.
-
-If you are interested in the newest developper-versions (which are not
-always stable), then please read the section "CVS" on the homepage and
-the file "doc/CVS.txt" which describes the use of CVS, the "Concurrent
-Versioning System".
-
-
-VI. Bugs
-~~~~~~~~
-
-If you find bugs in the ngIRCd (which might be there :-), please report
-them at the following URL:
-
-<http://arthur.ath.cx/~alex/ngircd/#bugs>
-
-There you can read about kown bugs, too.
-
-If you have critics, patches or something else, please feel yourself free
-to post a mail to: <alex@barton.de> or <alex@arthur.ath.cx>
-
-
--- 
-$Id: README,v 1.7 2002/11/24 18:48:59 alex Exp $
diff --git a/doc/en/sample-ngircd.conf b/doc/en/sample-ngircd.conf
deleted file mode 100644
index 477423e8..00000000
--- a/doc/en/sample-ngircd.conf
+++ /dev/null
@@ -1,138 +0,0 @@
-# $Id: sample-ngircd.conf,v 1.4 2002/12/18 12:19:07 alex Exp $
-
-#
-# This is a sample configuration for the ngIRCd, which must adept to the
-# local preferences and needs.
-#
-# Comments are started with "#" or ";".
-#
-# Author: Alexander Barton, <alex@barton.de>
-# Translation by Ilja Osthoff, <ilja@glide.ath.cx>
-#
-
-[Global]
-
-	# 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 of the server. This will be shown i.e. by a WHOIS- or
-	# LINKS-request.
-	Info = Server Info Text
-	
-	# Information about the server and administrator in the ADMIN-request
-	;AdminInfo1 = Description
-	;AdminInfo2 = Location
-	;AdminEMail = admin@irc.server
- 
-	# 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, 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, 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
-
-	# After <PingTimeout> seconds, the server will send a ping after
-	# inactivity of this client.
-	;PingTimeout = 120
-
-	# If there is an answer of a client, to which the ping was sended,
-	# not after <PongTimeout> seconds, it will be disconnected.
-	;PongTimeout = 20
-
-	# The server tries every <ConnectRetry> seconds, not yet connected
-	# or not anymore connected servers to connect.
-	;ConnectRetry = 60
-
-	# Should IRC-operators be allowed to use the MODE command even if
-	# they are not(!) channel-operators?
-	;OperCanUseMode = no
-
-	# Maximum number of simultanous connection the server is allowed
-	# to accept (<=0: unlimited):
-	;MaxConnections = -1
-
-	# Maximum number of channels a user can be member of (<=0: no limit):
-	;MaxJoins = 10
-
-[Operator]
-	# 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
-
-	# 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.
-	#
-	# 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
-   
-	# Hostname of the server
-	;Host = connect-to-host.the.net
-
-	# 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
-
-	# Own password for the connection. This password has to be configured
-	# as "PeerPassword" on the other server.
-	;MyPassword = MySecret
-
-	# Foreign password for this connection. This password has to be
-	# configured as "MyPassword" on the other server.
-	;PeerPassword = PeerSecret
-	
-	# Group of that server (optional)
-	;Group = 123
-
-[Channel]
-	# 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 for the channel
-	;Topic = a great topic
-	
-	# Channel-modes
-	;Modes = tn
-
-# -eof-