A ton more clear() and empty() stuff thats been lingering on the long term todo for...

[user/henk/code/inspircd.git] / conf / inspircd.helpop-full.example

diff --git a/conf/inspircd.helpop-full.example b/conf/inspircd.helpop-full.example
index 025bdc7234d80553c3f77dc3462e54f8e1f1fa86..8d38d202301525e0f07ae9f45668cbbf32a9158f 100644 (file)
--- a/conf/inspircd.helpop-full.example
+++ b/conf/inspircd.helpop-full.example
@@ -112,11 +112,42 @@ given in the command and the channel is either not +t, or
 You are at least a halfoperator, the channel topic will be
 changed to the new one you provide.">
 
 You are at least a halfoperator, the channel topic will be
 changed to the new one you provide.">
 

-<helpop key="who" value="/WHO [channel|nick|servermask|o 0]
-Looks up the information of users matching the range you
-provide. You may only /WHO nicknames in channels or on servers
-where you share a common channel with them.
-The syntax '/WHO o 0' shows a list of online IRC operators.">
+<helpop key="who" value="/WHO [ [search-pattern] [ohurmaiMplf] ]
+Looks up the information of users matching the range you provide.
+You may only /WHO nicknames in channels or on servers where you
+share a common channel with them, or ones which are not +i (unless
+you are an IRC operator). The search-pattern may be a special
+sequence of characters determined by the flags given below, or
+it may be one of a nickname, a channel, a hostmask, an ip address
+mask or a server mask.
+-
+Valid WHO flags
+--------------- 
+The following flags after the mask have the following affects:
+-
+ o      Show online IRC operators matching the mask
+ u      Unlimit the results past the maximum /who results value
+        (IRC operators only)
+ r      Show all users whose realnames match the mask. When this
+        flag is set it overrides the meaning of the search-pattern,
+        which must contain a glob pattern intended to match GECOS
+        (realname) fields.
+ h      Show real hostnames rather than masked hostnames (IRC
+        operators only)
+ m      Search for all users with a given set of user modes. When
+        this flag is set it overrides the meaning of the
+        search-pattern, which must contain the mode sequence to
+        search for, for example to find all users with +i and
+        without +s, issue the command WHO +i-s m.
+ a      Show all users who have an away message matching the given mask
+ p      Show all users who are connected on the given port number
+ i      Show all users who have an ident (username) matching the given mask
+ M      Show all users who have metadata attached to them with
+        the given key name
+ l      Show only local users
+ f      Show only remote (far) users
+-
+You may combine multiple flags in one WHO command except where stated in the table above.">

 
 <helpop key="motd" value="/MOTD [server]
 Show the message of the day for [server]. Messages of the
 
 <helpop key="motd" value="/MOTD [server]
 Show the message of the day for [server]. Messages of the


@@ -203,7 +234,7 @@ SETIDLE    SETHOST     SETNAME      SETIDENT       SWHOIS
 OPERMOTD   CHGHOST     CHGNAME      CHGIDENT       CBAN
 NICKLOCK   NICKUNLOCK  LOADMODULE   UNLOADMODULE   GLOBOPS
 SPYLIST    SPYNAMES    GLOADMODULE  GUNLOADMODULE  MKSHA256
 OPERMOTD   CHGHOST     CHGNAME      CHGIDENT       CBAN
 NICKLOCK   NICKUNLOCK  LOADMODULE   UNLOADMODULE   GLOBOPS
 SPYLIST    SPYNAMES    GLOADMODULE  GUNLOADMODULE  MKSHA256

-PARKSTATS  FREEZE      UNFREEZE     OPERPERMS      RCONNECT">
+FREEZE     UNFREEZE    OPERPERMS    RCONNECT">

 
 <helpop key="rconnect" value="/RCONNECT [source mask] [target mask]
 All servers matching [source mask] will try to connect to
 
 <helpop key="rconnect" value="/RCONNECT [source mask] [target mask]
 All servers matching [source mask] will try to connect to


@@ -219,9 +250,6 @@ User is also notified they have been frozen.">
 <helpop key="unfreeze" value="/UNFREEZE [nick]
 Unfreezes a user frozen by the /FREEZE command.">
 
 <helpop key="unfreeze" value="/UNFREEZE [nick]
 Unfreezes a user frozen by the /FREEZE command.">
 

-<helpop key="parkstats" value="/PARKSTATS
-Displays the park module's statistics">
-

 <helpop key="spylist" value="/SPYLIST
 Operates the same as /LIST but includes +s and +p channels.">
 
 <helpop key="spylist" value="/SPYLIST
 Operates the same as /LIST but includes +s and +p channels.">
 


@@ -268,12 +296,9 @@ Sets your name to the specified name.">
 <helpop key="swhois" line="/SWHOIS [nick] [swhois]
 Sets the users swhois field to the given swhois.">
 
 <helpop key="swhois" line="/SWHOIS [nick] [swhois]
 Sets the users swhois field to the given swhois.">
 

-<helpop key="mkpasswd" value="/MKPASSWD [plaintext]
+<helpop key="mkpasswd" value="/MKPASSWD [hashtype] [plaintext]

 Encodes the plaintext to an MD5 hash and displays the result.">
 
 Encodes the plaintext to an MD5 hash and displays the result.">
 

-<helpop key="mksha256" value="/MKSHA256 [plaintext]
-Encodes the plaintext to an SHA-256 hash and displays the result.">
-

 <helpop key="opermotd" value="/OPERMOTD
 Re-displays the Oper MOTD.">
 
 <helpop key="opermotd" value="/OPERMOTD
 Re-displays the Oper MOTD.">