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

Author: Alexander Barton alex@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