Module: ngircd.git Branch: master Commit: f173a974bee5181d8131519ed07b3b5261bf6366 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=f173a...

Author: Alexander Barton alex@barton.de Date: Fri Aug 26 16:16:53 2011 +0200

Added doc/Modes.txt: document modes supported by ngIRCd

---

doc/Makefile.am | 19 +++++++-------- doc/Modes.txt | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 76 insertions(+), 10 deletions(-)

diff --git a/doc/Makefile.am b/doc/Makefile.am index 92e5f8f..c153fec 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,13 +1,12 @@ # # ngIRCd -- The Next Generation IRC Daemon -# Copyright (c)2001-2010 Alexander Barton (alex@barton.de) +# Copyright (c)2001-2011 Alexander Barton (alex@barton.de) and Contributors # -# 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. +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# Please read the file COPYING, README and AUTHORS for more information. #

.tmpl: @@ -17,9 +16,9 @@

SUFFIXES = .tmpl

-static_docs = Bopm.txt FAQ.txt GIT.txt HowToRelease.txt PAM.txt Platforms.txt \ - Protocol.txt README-AUX.txt README-BeOS.txt README-Interix.txt RFC.txt \ - SSL.txt Services.txt +static_docs = Bopm.txt FAQ.txt GIT.txt HowToRelease.txt Modes.txt PAM.txt \ + Platforms.txt Protocol.txt README-AUX.txt README-BeOS.txt \ + README-Interix.txt RFC.txt SSL.txt Services.txt

doc_templates = sample-ngircd.conf.tmpl

diff --git a/doc/Modes.txt b/doc/Modes.txt new file mode 100644 index 0000000..d644a48 --- /dev/null +++ b/doc/Modes.txt @@ -0,0 +1,67 @@ + + ngIRCd - Next Generation IRC Server + http://ngircd.barton.de/ + + (c)2001-2011 Alexander Barton and Contributors. + ngIRCd is free software and published under the + terms of the GNU General Public License. + + -- Modes.txt -- + + +This document lists the different user modes, channel modes, and channel +user modes that ngIRCd supports. + + +I. User Modes +~~~~~~~~~~~~~ + +User modes are attributes a user has in the network, regardless of the +channels he is using at the moment. + + mode since description + + a 0.3.0 User is away. + c 17 IRC operator wants to receive connect/disconnect NOTICEs. + i 0.0.1 User is "invisible". + o 0.0.1 User is IRC operator. + r 0.0.1 User is restricted. + R 19 User is registered (e.g. by NickServ). + s 0.4.0 User wants to receive server notices. + w 0.11.0 User wants to receive WALLOPS messages. + x 17 Hostname of this user is "cloaked". + +II. Channel Modes +~~~~~~~~~~~~~~~~~ + +Channel modes are attributes of specific channels which are valid for all +users joined (or trying to join) to this channel. Some modes add and remove +users to lists (e.g. "invite list", "ban list"), others have parameters +(like "channel key"), most are simple flags (like "moderated"). + + mode since description + + b 0.5.0 Add/remove a host mask to the ban list. + i 0.5.0 Channel is "invite only". + I 0.5.0 Add/remove a host mask to the invite list. + k 0.6.0 Channel has a "key" (a password). + l 0.6.0 Channel has a user limit. + m 0.3.0 Channel is moderated, only "voiced" users can send messages. + n 0.3.0 Channel doesn't allow messages of users not being members. + O 18 Only IRC operators are allowed to join this channel. + P 0.5.0 Channel is "persistent". + R 19 Only registered users are allowed to join this channel. + s 0.9.0 Channel is "secret". + t 0.3.0 Only ChanOps are allowed to modify the channel topic. + z 16 Only users connected via SSL are allowed to join the channel. + +III. Channel User Modes +~~~~~~~~~~~~~~~~~~~~~~~ + +Channel user modes are attributes that a particular user has in a specific +channel of which he is a member. + + mode since description + + o 0.2.0 User is channel operator and can op/kick/... other members. + v 0.2.0 User is "voiced" and can speak even if channel is moderated.