Module: ngircd.git
Branch: master
Commit: b6e6e2e1da632a022abf7530ed028ba79d453614
URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=b6e6e2e1…
Author: Alexander Barton <alex(a)barton.de>
Date: Sun Feb 10 00:23:10 2013 +0100
Commands.txt: Update description of the "TIME" command
---
doc/Commands.txt | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)
diff --git a/doc/Commands.txt b/doc/Commands.txt
index 2ea533a..642dfb0 100644
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -324,9 +324,16 @@ Status and Informational Commands
- RFC 2812, 3.4.4 "Stats message"
- TIME
- TIME [<server>]
+ TIME [<target>]
.
- Show the local time of the current server, or of a specified <server>.
+ Show the local time of an IRC server in the network.
+ .
+ <target> can be a server name, the nickname of a client connected to
+ a specific server, or a mask matching a server name in the network.
+ The server of the current connecion is used when <target> is omitted.
+
+ References
+ - RFC 2812, 3.4.6 "Time message"
- TRACE
TRACE [<server>]
Module: ngircd.git
Branch: master
Commit: 02e24f5d1e6f098f2452f344331871a9d9a64280
URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=02e24f5d…
Author: Alexander Barton <alex(a)barton.de>
Date: Sun Feb 10 00:19:59 2013 +0100
Commands.txt: Update description of the "LINKS" command
---
doc/Commands.txt | 13 ++++++++++---
1 file changed, 10 insertions(+), 3 deletions(-)
diff --git a/doc/Commands.txt b/doc/Commands.txt
index 0f3fdbb..2c35792 100644
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -243,10 +243,17 @@ Status and Informational Commands
- RFC 2812, 4.9 "Ison message"
- LINKS
- LINKS [<remote server> [<server mask>]]
+ LINKS [[<target>] [<mask>]
.
- Lists all server links matching <server mask>, if given,
- on <remote server>, or the current server if omitted.
+ List all servers currently registered in the network matching <mask>,
+ or all servers if <mask> has been omitted, as seen by the server
+ specified by <target> or the local server when <target> is omitted.
+ .
+ <target> can be a server name, the nickname of a client connected to
+ a specific server, or a mask matching a server name in the network.
+
+ References:
+ - RFC 2812, 3.4.5 "Links message"
- LUSERS
LUSERS [<mask> [<server>]]
Module: ngircd.git
Branch: master
Commit: a7023113e7546e3b278f753f0d38161f11afdb79
URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=a7023113…
Author: Alexander Barton <alex(a)barton.de>
Date: Sun Feb 10 00:20:19 2013 +0100
Commands.txt: Update description of the "LUSERS" command
---
doc/Commands.txt | 19 ++++++++++++-------
1 file changed, 12 insertions(+), 7 deletions(-)
diff --git a/doc/Commands.txt b/doc/Commands.txt
index 2c35792..83f811d 100644
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -256,15 +256,20 @@ Status and Informational Commands
- RFC 2812, 3.4.5 "Links message"
- LUSERS
- LUSERS [<mask> [<server>]]
+ LUSERS [<mask> [<target>]]
.
- Return statistics about the size of the network. If called with no
- arguments, the statistics will reflect the entire network.
+ Return statistics about the number of clients (users, servers,
+ services, ...) in the network as seen by the server <target>.
.
- If <mask> is given, it will return only statistics reflecting the
- masked subset of the network.
- If <server> is given, the command will be forwarded to <server>
- for evaluation.
+ <target> can be a server name, the nickname of a client connected to
+ a specific server, or a mask matching a server name in the network.
+ The server of the current connecion is used when <target> is omitted.
+
+ Please note that ngIRCd ignores the <mask> parameter entirely: it
+ is not possible to get information for a part of the network only.
+
+ References:
+ - RFC 2812, 3.4.2 "Lusers message"
- MOTD
MOTD [<server>]
Module: ngircd.git
Branch: master
Commit: e051ea06fc601f8ae8d91b3b3f360e6f6e48db70
URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=e051ea06…
Author: Alexander Barton <alex(a)barton.de>
Date: Sun Feb 10 00:20:41 2013 +0100
Commands.txt: Update description of the "MOTD" command
---
doc/Commands.txt | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)
diff --git a/doc/Commands.txt b/doc/Commands.txt
index 83f811d..e92027b 100644
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -272,9 +272,16 @@ Status and Informational Commands
- RFC 2812, 3.4.2 "Lusers message"
- MOTD
- MOTD [<server>]
+ MOTD [<target>]
.
- Show "Message Of The Day" of the current server or specified <server>.
+ Show the "Message of the Day" (MOTD) of an IRC server in the network.
+ .
+ <target> can be a server name, the nickname of a client connected to
+ a specific server, or a mask matching a server name in the network.
+ The server of the current connecion is used when <target> is omitted.
+
+ References:
+ - RFC 2812, 3.4.1 "Motd message"
- NAMES
NAMES [<channels> [<server>]]
Module: ngircd.git
Branch: master
Commit: 8212b730c707da88dcadd6384a5ecd559a2b393f
URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=8212b730…
Author: Alexander Barton <alex(a)barton.de>
Date: Sun Feb 10 00:19:20 2013 +0100
Commands.txt: Update description of the "INFO" command
---
doc/Commands.txt | 12 +++++++++---
1 file changed, 9 insertions(+), 3 deletions(-)
diff --git a/doc/Commands.txt b/doc/Commands.txt
index 177b22e..ac455b3 100644
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -216,10 +216,16 @@ Status and Informational Commands
- RFC 2812, 3.4.9 "Admin command"
- INFO
- INFO [<server>]
+ INFO [<target>]
.
- Show the version, birth & online time of the current IRC server.
- If <server> has been given, it shows the INFO of the specific <server>.
+ Show the version, birth & online time of an IRC server in the network.
+ .
+ <target> can be a server name, the nickname of a client connected to
+ a specific server, or a mask matching a server name in the network.
+ The server of the current connecion is used when <target> is omitted.
+
+ References:
+ - RFC 2812, 3.4.10 "Info command"
- ISON
ISON <nicknames>
Module: ngircd.git
Branch: master
Commit: 13740c1bf4518c2d82476948f43d675524c42221
URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=13740c1b…
Author: Alexander Barton <alex(a)barton.de>
Date: Sun Feb 10 00:19:41 2013 +0100
Commands.txt: Update description of the "ISON" command
---
doc/Commands.txt | 19 ++++++++++++-------
1 file changed, 12 insertions(+), 7 deletions(-)
diff --git a/doc/Commands.txt b/doc/Commands.txt
index ac455b3..0f3fdbb 100644
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -228,14 +228,19 @@ Status and Informational Commands
- RFC 2812, 3.4.10 "Info command"
- ISON
- ISON <nicknames>
+ ISON <nickname> [<nickname> [...]]
.
- Queries the server to see if the clients in the space-separated list
- <nicknames> are currently on the network.
- .
- The server returns only the <nicknames> that are on the network in a
- space-separated list. If none of the clients are on the network the
- server returns an empty list.
+ Query online status of a list of nicknames. The server replies with
+ a list only containing nicknes actually connected to a server in
+ the network. If no nicknames of the given list are online, an empty
+ list is returned to the client requesting the information.
+
+ Please note that "all" IRC daemons even parse separate nicknames in
+ a single parameter (like ":nick1 nick2"), and therefore ngIRCd
+ implements this behaviour, too.
+
+ References:
+ - RFC 2812, 4.9 "Ison message"
- LINKS
LINKS [<remote server> [<server mask>]]
Module: ngircd.git
Branch: master
Commit: b7690a0add0d46f952cc44ce522bb0e2e802b24c
URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=b7690a0a…
Author: Alexander Barton <alex(a)barton.de>
Date: Sun Feb 3 19:02:42 2013 +0100
Commands.txt: Add description for the "CHARCONV" command
---
doc/Commands.txt | 17 ++++++++++++++++-
1 file changed, 16 insertions(+), 1 deletion(-)
diff --git a/doc/Commands.txt b/doc/Commands.txt
index ac77c65..431a410 100644
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -83,7 +83,22 @@ Connection Handling Commands
- doc/Capabilities.txt
- CHARCONV
- See doc/Protocol.txt
+ CHARCONV <client-charset>
+ .
+ Set client character set encoding to <client-charset>.
+ .
+ After receiving such a command, the server translates all message
+ data received from the client using the set <client-charset> to the
+ server encoding (UTF-8), and all message data which is to be sent to
+ the client from the server encoding (UTF-8) to <client-charset>.
+ .
+ This enables older clients and clients using "strange" character sets
+ to transparently participate in channels and direct messages to
+ clients using UTF-8, which should be the default today.
+
+ References:
+ - <http://ngircd.barton.de/doc/Protocol.txt>
+ - doc/Protocol.txt
- NICK
NICK <nick>
Module: ngircd.git
Branch: master
Commit: a4daa613ae4ce3c87b1f711d7700383fac591f16
URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=a4daa613…
Author: Alexander Barton <alex(a)barton.de>
Date: Sun Feb 10 00:18:36 2013 +0100
Commands.txt: Update description of the "ADMIN" command
---
doc/Commands.txt | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/doc/Commands.txt b/doc/Commands.txt
index 431a410..177b22e 100644
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -204,10 +204,16 @@ Status and Informational Commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- ADMIN
- ADMIN [<server>]
+ ADMIN [<target>]
.
Show administrative information about an IRC server in the network.
- If no server name has been given, the local server will respond.
+ .
+ <target> can be a server name, the nickname of a client connected to
+ a specific server, or a mask matching a server name in the network.
+ The server of the current connecion is used when <target> is omitted.
+
+ References:
+ - RFC 2812, 3.4.9 "Admin command"
- INFO
INFO [<server>]
Module: ngircd.git
Branch: master
Commit: 7630e8ffc636045b94699e36127bdd601137ba0e
URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=7630e8ff…
Author: Alexander Barton <alex(a)barton.de>
Date: Wed Jan 23 15:02:46 2013 +0100
Commands.txt: Reorder some commands
Reorder some commands and introduce new section "Connection Handling".
Idea by DNS <dns(a)rbose.org>, thanks!
---
doc/Commands.txt | 72 ++++++++++++++++++++++++++++--------------------------
1 file changed, 38 insertions(+), 34 deletions(-)
diff --git a/doc/Commands.txt b/doc/Commands.txt
index 8b5425d..c879092 100644
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -42,15 +42,39 @@ used without a command name:
example "HELP quit" or "HELP privmsg".
-General Commands
-~~~~~~~~~~~~~~~~
-
-- AWAY
+Connection Handling Commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- CAP
- CHARCONV
+- NICK
+
+- PASS
+
+- PING
+
+- PONG
+
+- QUIT
+ QUIT [<quit-message>]
+ .
+ End IRC session and disconnect from the server.
+ .
+ If a <quit-message> has been given, it is displayed to all the
+ channels that you are a member of when leaving.
+
+- USER
+
+- WEBIRC
+
+
+General Commands
+~~~~~~~~~~~~~~~~
+
+- AWAY
+
- HELP
HELP [<command>]
.
@@ -70,36 +94,20 @@ General Commands
- MODE
-- NICK
-
- NOTICE
-- PASS
-
-- PING
-
-- PONG
-
- PRIVMSG
-- QUIT
- QUIT [<quit-message>]
- .
- End IRC session and disconnect from the server.
- .
- If a <quit-message> has been given, it is displayed to all the
- channels that you are a member of when leaving.
-
-- USER
-
-- WALLOPS
-
-- WEBIRC
-
Status and Informational Commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+- ADMIN
+ ADMIN [<server>]
+ .
+ Show administrative information about an IRC server in the network.
+ If no server name has been given, the local server will respond.
+
- INFO
- ISON
@@ -108,8 +116,6 @@ Status and Informational Commands
- LUSERS
-- METADATA
-
- MOTD
- NAMES
@@ -150,12 +156,6 @@ Channel Commands
Administrative Commands
~~~~~~~~~~~~~~~~~~~~~~~
-- ADMIN
- ADMIN [<server>]
- .
- Show administartive information about an IRC server in the network.
- If no server name has been given, the local server will respond.
-
- CONNECT
- DIE
@@ -174,6 +174,8 @@ Administrative Commands
- RESTART
+- WALLOPS
+
IRC Service Commands
~~~~~~~~~~~~~~~~~~~~
@@ -201,6 +203,8 @@ Server Protocol Commands
.
This command is silently ignored on non-server and non-service links.
+- METADATA
+
- NJOIN
- SERVER
Module: ngircd.git
Branch: master
Commit: 4552ad5269367be15f3b38adeeb43815bcf1d558
URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=4552ad52…
Author: Alexander Barton <alex(a)barton.de>
Date: Wed Jan 23 14:51:19 2013 +0100
Commands.txt: Fix some wording and spelling
---
doc/Commands.txt | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/doc/Commands.txt b/doc/Commands.txt
index e9b7873..8b5425d 100644
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -13,8 +13,8 @@ This file lists all commands available on ngIRCd. It is written in a format
that is human readable as well as machine parseable and therefore can be used
as "help text file" of the daemon.
-In short, the HELP command parses this file as following when a user user
-issues a "HELP <cmd>" command:
+In short, the daemon reads this file on startup and parses it as following
+when an user issues a "HELP <cmd>" command:
1. Search the file for a line "- <cmd>",
2. Output all subsequent lines that start with a TAB (ASCII 9) character
@@ -25,7 +25,8 @@ issues a "HELP <cmd>" command:
This format allows to have information to each command stored in this file
which will not be sent to an IRC user requesting help which enables us to
have additional annotations stored here which further describe the origin,
-implementation details, or limits of the specific command.
+implementation details, or limits of the specific command which are not
+relevant to an end-user but administrators and developers.
A special "Intro" block is returned to the user when the HELP command is
used without a command name:
@@ -175,7 +176,7 @@ Administrative Commands
IRC Service Commands
-~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~
- SERVICE