Commands.txt: Reorder some commands

[ngircd.git] / doc / Commands.txt

diff --git a/doc/Commands.txt b/doc/Commands.txt
index e9b78731080b6a8ed3785e233d4bfa2f551e4bbd..c879092930b1995286cd54c913cdfc82b0637af0 100644 (file)
--- 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:
@@ -41,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>]
        .
@@ -69,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
@@ -107,8 +116,6 @@ Status and Informational Commands
 
 - LUSERS
 
-- METADATA
-
 - MOTD
 
 - NAMES
@@ -149,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
@@ -173,9 +174,11 @@ Administrative Commands
 
 - RESTART
 
+- WALLOPS
+
 
 IRC Service Commands
-~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~
 
 - SERVICE
 
@@ -200,6 +203,8 @@ Server Protocol Commands
        .
        This command is silently ignored on non-server and non-service links.
 
+- METADATA
+
 - NJOIN
 
 - SERVER