Remove needless headers from typedefs.h

[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 b38b2a3910c60a1f40080b87f8c27f57c72ed32f..7e3295eae2e950cb91601369877a227ab500da57 100644 (file)
--- a/conf/inspircd.helpop-full.example
+++ b/conf/inspircd.helpop-full.example
@@ -28,11 +28,10 @@ PONG      ADMIN    PRIVMSG  INFO       TIME
 WHOIS     NOTICE   JOIN     NAMES      PART
 KICK      MODE     TOPIC    WHO        MOTD
 RULES     OPER     LIST     LUSERS     STATS
 WHOIS     NOTICE   JOIN     NAMES      PART
 KICK      MODE     TOPIC    WHO        MOTD
 RULES     OPER     LIST     LUSERS     STATS

-USERHOST  AWAY     ISON     SUMMON     USERS
-INVITE    PASS     WHOWAS   LINKS      MAP
-COMMANDS  MODULES  KNOCK    SILENCE    DEVOICE
-REMOVE    PARK     UNPARK   UNINVITE   VHOST
-WATCH     USERIP">
+USERHOST  AWAY     ISON     INVITE     PASS
+WHOWAS    LINKS    MAP      COMMANDS   MODULES
+KNOCK     SILENCE  DEVOICE  REMOVE     UNINVITE
+VHOST    WATCH      USERIP">

 
 <helpop key="watch" value="/WATCH [C|S|+/-[NICK]]
 Adds or deletes a user from the watch list. C clears the list
 
 <helpop key="watch" value="/WATCH [C|S|+/-[NICK]]
 Adds or deletes a user from the watch list. C clears the list


@@ -50,11 +49,16 @@ were removed from the channel and by whom.">
 <helpop key="devoice" value="/DEVOICE [channel]
 Devoices yourself from the specified channel.">
 
 <helpop key="devoice" value="/DEVOICE [channel]
 Devoices yourself from the specified channel.">
 

-<helpop key="silence" value="/SILENCE +/-[nick]
-A serverside /ignore of the given nick. It does not follow
-the users nick so if they change their nick you will recieve
-their messages. /SILENCE without a parameter will list the nicks
-that you have silenced.">
+<helpop key="silence" value="/SILENCE [+/-]<hostmask> [p|c|i|n|t|a|x]
+ p        Block private messages
+ c        Block channel messages
+ i        Block invites
+ n        Block private notices
+ t        Block channel notices
+ a        Block all of the above
+ x        Exception
+A serverside /ignore of the given hostmask.
+/SILENCE without a parameter will list the hostmasks that you have silenced.">

 
 <helpop key="knock" value="/KNOCK [channel]
 Sends a notice to a channel indicating you wish to join.">
 
 <helpop key="knock" value="/KNOCK [channel]
 Sends a notice to a channel indicating you wish to join.">


@@ -109,15 +113,46 @@ channels where they are at least a halfoperator.">
 
 <helpop key="topic" value="/TOPIC [channel] {topic}
 Sets or retrieves the channel topic. If a channel topic is
 
 <helpop key="topic" value="/TOPIC [channel] {topic}
 Sets or retrieves the channel topic. If a channel topic is

-given in teh command and the channel is either not +t, or
+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


@@ -131,7 +166,7 @@ sent the MOTD when they connect without having to request it.">
 
 <helpop key="oper" value="/OPER [login] [password]
 Attempts to authenticate a user as an IRC operator.
 
 <helpop key="oper" value="/OPER [login] [password]
 Attempts to authenticate a user as an IRC operator.

-Please be aware that both successful and unsucessful oper attempts
+Please be aware that both successful and unsuccessful oper attempts

 Are logged, and sent to online IRC operators.">
 
 <helpop key="list" value="/LIST [pattern]
 Are logged, and sent to online IRC operators.">
 
 <helpop key="list" value="/LIST [pattern]


@@ -143,7 +178,7 @@ Shows a count of local and remote users, servers and channels.">
 
 <helpop key="userhost" value="/USERHOST [nickname]
 Returns the hostname and nickname of a user, and some other
 
 <helpop key="userhost" value="/USERHOST [nickname]
 Returns the hostname and nickname of a user, and some other

-miscellanious information.">
+miscellaneous information.">

 
 <helpop key="userip" value="/USERIP [nickname]
 Returns the ip and nickname of a user.">
 
 <helpop key="userip" value="/USERIP [nickname]
 Returns the ip and nickname of a user.">


@@ -156,14 +191,6 @@ removes your away status and previous message.">
 Returns a subset of the nicks you give, showing only those
 that are currently online.">
 
 Returns a subset of the nicks you give, showing only those
 that are currently online.">
 

-<helpop key="summon" value="/SUMMON [user]
-Summons a user from the shell where the ircd is running onto irc
-This command is deprecated in the current protocol.">
-
-<helpop key="users" value="/USERS
-Shows users logged into the shell where the ircd is running.
-This command is deprecated in the current protocol.">
-

 <helpop key="invite" value="/INVITE [nick] [channel]
 Invites a user to a channel. If the channel is NOT +i, any
 user, channel op or not, may invite any other user to the
 <helpop key="invite" value="/INVITE [nick] [channel]
 Invites a user to a channel. If the channel is NOT +i, any
 user, channel op or not, may invite any other user to the


@@ -198,13 +225,13 @@ implementation as a tree based network is not in place.">
 -------------
 DIE        RESTART     KILL         REHASH         TRACE
 CONNECT    SQUIT       MODULES      MKPASSWD       SHUN
 -------------
 DIE        RESTART     KILL         REHASH         TRACE
 CONNECT    SQUIT       MODULES      MKPASSWD       SHUN

-KLINE      QLINE       GLINE        ELINE          ZLINE"  
+KLINE      QLINE       GLINE        ELINE          ZLINE

 SAJOIN     SAPART      SAMODE       SAQUIT         SANICK
 SETIDLE    SETHOST     SETNAME      SETIDENT       SWHOIS
 OPERMOTD   CHGHOST     CHGNAME      CHGIDENT       CBAN
 NICKLOCK   NICKUNLOCK  LOADMODULE   UNLOADMODULE   GLOBOPS
 SPYLIST    SPYNAMES    GLOADMODULE  GUNLOADMODULE  MKSHA256
 SAJOIN     SAPART      SAMODE       SAQUIT         SANICK
 SETIDLE    SETHOST     SETNAME      SETIDENT       SWHOIS
 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


@@ -220,9 +247,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.">
 


@@ -266,15 +290,12 @@ Sets your ident to the specified ident.">
 <helpop key="setname" value="/SETNAME [name]
 Sets your name to the specified name.">
 
 <helpop key="setname" value="/SETNAME [name]
 Sets your name to the specified name.">
 

-<helpop key="swhois line="/SWHOIS [nick] [swhois]
+<helpop key="swhois" line="/SWHOIS [nick] [swhois]

 Sets the users swhois field to the given 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.">
 


@@ -318,7 +339,7 @@ This command will disconnect a user from IRC with the given reason.">
 
 <helpop key="rehash" value="/REHASH
 This command will cause the server configuration file to be
 
 <helpop key="rehash" value="/REHASH
 This command will cause the server configuration file to be

-re-read and values re-initialised.">
+re-read and values re-initialized.">

 
 <helpop key="trace" value="/TRACE [nick|user@host|servermask]
 This command will provide a list of all users and servers which
 
 <helpop key="trace" value="/TRACE [nick|user@host|servermask]
 This command will provide a list of all users and servers which


@@ -402,7 +423,7 @@ o                Is an IRC operator
 i                Is invisible to /WHO
 w                Can receive wallops messages
 s                Can receive server notices
 i                Is invisible to /WHO
 w                Can receive wallops messages
 s                Can receive server notices

-n [mask]         Can recieve server notices specified by [mask]
+n [mask]         Can receive server notices specified by [mask]

 x                Cloaked hostname (requires cloaking module)
 g                Can receive globops (requires globops module)
 h                Will receive helpops notification (requires helpop module)
 x                Cloaked hostname (requires cloaking module)
 g                Can receive globops (requires globops module)
 h                Will receive helpops notification (requires helpop module)


@@ -412,7 +433,7 @@ B                Is a bot
 G                Messages are censored to user
 W                Can see when a user uses WHOIS on them
 S                mIRC colour codes are stripped to the user
 G                Messages are censored to user
 W                Can see when a user uses WHOIS on them
 S                mIRC colour codes are stripped to the user

-D                User can not recieve PRIVMSGs">
+D                User can not receive PRIVMSGs">

 
 <helpop key="chmodes" value="Channel Modes
 -------------
 
 <helpop key="chmodes" value="Channel Modes
 -------------


@@ -439,7 +460,7 @@ S                  mIRC colour codes are stripped from the channel
 e [hostmask]       Ban exception on [hostmask]
 K                  No /KNOCK allowed to channel
 L [channel]        If the channel is full, redirect users to [channel]
 e [hostmask]       Ban exception on [hostmask]
 K                  No /KNOCK allowed to channel
 L [channel]        If the channel is full, redirect users to [channel]

-N                  No nickchanges while on the channel
+N                  No nick changes while on the channel

 G                  Censors channel based on network censor config
 g [word]           All messages containing the word are blocked
 I [hostmask]       Invite exception allows user to join a channel with +i
 G                  Censors channel based on network censor config
 g [word]           All messages containing the word are blocked
 I [hostmask]       Invite exception allows user to join a channel with +i