mirrors/ngircd
1
0
Fork 0
mirror of https://github.com/osmarks/ngircd.git synced 2025-01-22 13:26:52 +00:00
Code Issues Releases Wiki Activity

Commands.txt: Fix some wording and spelling

Browse Source
This commit is contained in:
Alexander Barton 2013-01-23 14:51:19 +01:00
parent 3d49e8ac84
commit 4552ad5269
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/Commands.txt
View File

@ -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 that is human readable as well as machine parseable and therefore can be used
as "help text file" of the daemon. as "help text file" of the daemon.
In short, the HELP command parses this file as following when a user user In short, the daemon reads this file on startup and parses it as following
issues a "HELP <cmd>" command: when an user issues a "HELP <cmd>" command:
1. Search the file for a line "- <cmd>", 1. Search the file for a line "- <cmd>",
2. Output all subsequent lines that start with a TAB (ASCII 9) character 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 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 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, 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 A special "Intro" block is returned to the user when the HELP command is
used without a command name: used without a command name:
@ -175,7 +176,7 @@ Administrative Commands
IRC Service Commands IRC Service Commands
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
- SERVICE - SERVICE