Remove extra double quote (")

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

diff --git a/docs/conf/helpop-full.conf.example b/docs/conf/helpop-full.conf.example
index 353270c33ab9cdf4eab9041a298a135474d667db..883ec9b165f0a272effd4bc80125567923a23931 100644 (file)
--- a/docs/conf/helpop-full.conf.example
+++ b/docs/conf/helpop-full.conf.example
@@ -28,7 +28,7 @@ you searched for. Please try again.">
 -------------
 
 PRIVMSG   NOTICE   NICK      JOIN      PART
 -------------
 
 PRIVMSG   NOTICE   NICK      JOIN      PART

-CYCLE     KNOCK    MODE      DEVOICE   TOPIC
+CYCLE     KNOCK    MODE      OPER      TOPIC

 KICK      FPART    REMOVE    TBAN      INVITE
 UNINVITE  AWAY     DCCALLOW  SILENCE   ACCEPT
 MKPASSWD  VHOST    TITLE     SETNAME
 KICK      FPART    REMOVE    TBAN      INVITE
 UNINVITE  AWAY     DCCALLOW  SILENCE   ACCEPT
 MKPASSWD  VHOST    TITLE     SETNAME


@@ -39,9 +39,7 @@ ADMIN     MAP      LINKS     LUSERS    TIME
 STATS     VERSION  INFO      MODULES   COMMANDS
 SSLINFO
 
 STATS     VERSION  INFO      MODULES   COMMANDS
 SSLINFO
 

-USER      PASS     PING     PONG       QUIT
-
-OPER">
+USER      PASS     PING     PONG       QUIT">

 
 <helpop key="sslinfo" value="/SSLINFO <nick>
 
 
 <helpop key="sslinfo" value="/SSLINFO <nick>
 


@@ -115,13 +113,9 @@ E.g. /RMODE #Chan b m:* will remove all mute extbans.">
 
 <helpop key="fpart" value="/FPART <channel> <nick> [<reason>]
 
 
 <helpop key="fpart" value="/FPART <channel> <nick> [<reason>]
 

-This behaves identically to /REMOVE. /REMOVE is a builtin mIRC command
+This behaves identically to /REMOVE. /REMOVE is a built-in mIRC command

 which caused trouble for some users.">
 
 which caused trouble for some users.">
 

-<helpop key="devoice" value="/DEVOICE <channel>
-
-Devoices yourself on the specified channel.">
-

 <helpop key="silence" value="/SILENCE - Shows a list of silenced masks
 /SILENCE +<mask> [<flags>] - Add a mask
 /SILENCE -<mask> - Remove a mask
 <helpop key="silence" value="/SILENCE - Shows a list of silenced masks
 /SILENCE +<mask> [<flags>] - Add a mask
 /SILENCE -<mask> - Remove a mask


@@ -378,7 +372,8 @@ Sets your name to the specified name.">
 -------------
 
 OPERMOTD  CHECK     CLONES      USERIP   TLINE
 -------------
 
 OPERMOTD  CHECK     CLONES      USERIP   TLINE

-ALLTIME   WALLOPS   GLOBOPS
+ALLTIME   WALLOPS   GLOBOPS     MODENOTICE
+CLOAK

 
 SETHOST   SETIDENT  CHGHOST     CHGIDENT CHGNAME
 SETIDLE   SWHOIS
 
 SETHOST   SETIDENT  CHGHOST     CHGIDENT CHGNAME
 SETIDLE   SWHOIS


@@ -409,7 +404,7 @@ This command returns the number of local and global clients matched,
 and the percentage of clients matched, plus how they were matched
 (by IP address or by hostname).">
 
 and the percentage of clients matched, plus how they were matched
 (by IP address or by hostname).">
 

-<helpop key="lockserv" value="/LOCKSERV
+<helpop key="lockserv" value="/LOCKSERV :[<message>]

 
 Locks out all new connections notifying connecting users that the
 service is temporarily closed and to try again later.">
 
 Locks out all new connections notifying connecting users that the
 service is temporarily closed and to try again later.">


@@ -620,17 +615,15 @@ The duration may be specified in seconds, or in the format
 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
 5 minutes and 6 seconds. All fields in this format are optional.">
 
 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
 5 minutes and 6 seconds. All fields in this format are optional.">
 

-<helpop key="die" value="/DIE <password>
+<helpop key="die" value="/DIE <server>

 
 This command shuts down the local server. A single parameter is
 
 This command shuts down the local server. A single parameter is

-required, which must match the password in the configuration for the
-command to function.">
+required, which must match the name of the local server.">

 
 

-<helpop key="restart" value="/RESTART <password>
+<helpop key="restart" value="/RESTART <server>

 
 This command restarts the local server. A single parameter is
 
 This command restarts the local server. A single parameter is

-required, which must match the password in the configuration for the
-command to function.">
+required, which must match the name of the local server.">

 
 <helpop key="commands" value="/COMMANDS
 
 
 <helpop key="commands" value="/COMMANDS
 


@@ -661,30 +654,30 @@ Disconnects the server matching the given server mask from this server.">
 Lists currently loaded modules, their memory offsets, version numbers,
 and flags. If you are not an operator, you will see reduced detail.">
 
 Lists currently loaded modules, their memory offsets, version numbers,
 and flags. If you are not an operator, you will see reduced detail.">
 

-<helpop key="loadmodule" value="/LOADMODULE <filename.so>
+<helpop key="loadmodule" value="/LOADMODULE <modname>

 
 Loads the specified module into the local server.">
 
 
 Loads the specified module into the local server.">
 

-<helpop key="unloadmodule" value="/UNLOADMODULE <filename.so>
+<helpop key="unloadmodule" value="/UNLOADMODULE <modname>

 
 Unloads a module from the local server. The module cannot have the
 static flag set (see the output of /MODULES).">
 
 
 Unloads a module from the local server. The module cannot have the
 static flag set (see the output of /MODULES).">
 

-<helpop key="reloadmodule" value="/RELOADMODULE <filename.so>
+<helpop key="reloadmodule" value="/RELOADMODULE <modname>

 
 Unloads and reloads a module on the local server. This module cannot
 have the static flag set (see the output of /MODULES).">
 
 
 Unloads and reloads a module on the local server. This module cannot
 have the static flag set (see the output of /MODULES).">
 

-<helpop key="gloadmodule" value="/GLOADMODULE <filename.so>
+<helpop key="gloadmodule" value="/GLOADMODULE <modname>

 
 Loads the specified module on all linked servers.">
 
 
 Loads the specified module on all linked servers.">
 

-<helpop key="gunloadmodule" value="/GUNLOADMODULE <filename.so>
+<helpop key="gunloadmodule" value="/GUNLOADMODULE <modname>

 
 Unloads a module from all linked servers. The module cannot have the
 static flag set (see the output of /MODULES).">
 
 
 Unloads a module from all linked servers. The module cannot have the
 static flag set (see the output of /MODULES).">
 

-<helpop key="greloadmodule" value="/GRELOADMODULE <filename.so>
+<helpop key="greloadmodule" value="/GRELOADMODULE <modname>

 
 Unloads and reloads a module on all linked servers. This module cannot
 have the static flag set (see the output of /MODULES).">
 
 Unloads and reloads a module on all linked servers. This module cannot
 have the static flag set (see the output of /MODULES).">


@@ -731,7 +724,7 @@ The duration may be specified in seconds, or in the format
 
 <helpop key="eline" value="/ELINE <user@host> [<duration> :<reason>]
 
 
 <helpop key="eline" value="/ELINE <user@host> [<duration> :<reason>]
 

-Sets or removes a e-line (local ban exception) on host mask.
+Sets or removes a e-line (global ban exception) on host mask.

 You must specify at least 3 parameters to add an exception, and one
 parameter to remove an exception (just the user@host section).
 
 You must specify at least 3 parameters to add an exception, and one
 parameter to remove an exception (just the user@host section).
 


@@ -758,10 +751,9 @@ The duration may be specified in seconds, or in the format
 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
 5 minutes and 6 seconds. All fields in this format are optional.">
 
 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
 5 minutes and 6 seconds. All fields in this format are optional.">
 

-<helpop key="clearcache" value="/CLEARCACHE {servername}
+<helpop key="clearcache" value="/CLEARCACHE

 
 

-This command clears the DNS cache of the specified server. If no
-server is specified, the local server's DNS cache will be cleared.">
+This command clears the DNS cache of the local server.">

 
 <helpop key="close" value="/CLOSE
 
 
 <helpop key="close" value="/CLOSE
 


@@ -777,6 +769,18 @@ while methods G and Z also add G/Z-Lines for all the targets.
 
 When used, the victims won't see each other getting kicked or quitting.">
 
 
 When used, the victims won't see each other getting kicked or quitting.">
 

+<helpop key="modenotice" value="/MODENOTICE <modeletters> <message>
+
+Sends a notice to all users who have the given mode(s) set.
+If multiple mode letters are given, the notice is only sent to users
+who have all of them set.">
+
+<helpop key="cloak" value="/CLOAK <host>
+
+Generate the cloak of a host or IP. This is useful for example when
+trying to get the cloak of a user from /WHOWAS and they were not
+using their cloak when they quit.">
+

 ######################
 # User/Channel Modes #
 ######################
 ######################
 # User/Channel Modes #
 ######################


@@ -812,6 +816,8 @@ When used, the victims won't see each other getting kicked or quitting.">
               hideoper module).
  I            Hides a user's entire channel list in WHOIS from
               non-IRCops (requires hidechans module).
               hideoper module).
  I            Hides a user's entire channel list in WHOIS from
               non-IRCops (requires hidechans module).

+ L            Stops redirections done by m_redirect (mode must be
+              enabled in the config).

  R            Blocks private messages from unregistered users
               (requires services account module).
  S            Strips mIRC color/bold/underline codes out of private
  R            Blocks private messages from unregistered users
               (requires services account module).
  S            Strips mIRC color/bold/underline codes out of private


@@ -889,13 +895,17 @@ When used, the victims won't see each other getting kicked or quitting.">
                     module).
  D                  Delays join messages from users until they
                     message the channel (requires delayjoin module).
                     module).
  D                  Delays join messages from users until they
                     message the channel (requires delayjoin module).

- E [~*][lines]:[sec]{[:difference]}{[:backlog]} Allows blocking of similiar messages.
+ E [~*][lines]:[sec]{[:difference]}{[:backlog]} Allows blocking of similar messages.

                     Kicks as default, blocks with ~ and bans with *
                     The last two parameters are optional.
  F <changes>:<sec>  Blocks nick changes when they equal or exceed the
                     specified rate (requires nickflood module).
  G                  Censors messages to the channel based on the
                     network configuration (requires censor module).
                     Kicks as default, blocks with ~ and bans with *
                     The last two parameters are optional.
  F <changes>:<sec>  Blocks nick changes when they equal or exceed the
                     specified rate (requires nickflood module).
  G                  Censors messages to the channel based on the
                     network configuration (requires censor module).

+ H <num>:<duration> Displays the last <num> lines of chat to joining
+                    users. <duration> is the maximum time to keep
+                    lines in the history buffer (requires chanhistory
+                    module).

  J <seconds>        Prevents rejoin after kick for the specified
                     number of seconds. This prevents auto-rejoin
                     (requires kicknorejoin module).
  J <seconds>        Prevents rejoin after kick for the specified
                     number of seconds. This prevents auto-rejoin
                     (requires kicknorejoin module).


@@ -905,7 +915,7 @@ When used, the victims won't see each other getting kicked or quitting.">
                     module).
  M                  Blocks unregistered users from speaking (requires
                     services account module).
                     module).
  M                  Blocks unregistered users from speaking (requires
                     services account module).

- N                  Prevents users on the channel from chainging nick
+ N                  Prevents users on the channel from changing nick

                     (requires nonicks module).
  O                  Channel is IRCops only (can only be set by IRCops,
                     requires operchans module).
                     (requires nonicks module).
  O                  Channel is IRCops only (can only be set by IRCops,
                     requires operchans module).


@@ -1035,6 +1045,8 @@ Matching extbans:
 
  j:<channel>   Matches anyone in the given channel. Does not support
                wildcards (requires channelban module).
 
  j:<channel>   Matches anyone in the given channel. Does not support
                wildcards (requires channelban module).

+ n:<class>     Matches users in a matching connect class (requires
+               classban module).

  r:<realname>  Matches users with a matching realname (requires gecosban
                module).
  s:<server>    Matches users on a matching server (requires serverban
  r:<realname>  Matches users with a matching realname (requires gecosban
                module).
  s:<server>    Matches users on a matching server (requires serverban


@@ -1045,6 +1057,8 @@ Matching extbans:
                an invite exception (requires operchans module).
  R:<account>   Matches users logged into a matching account (requires
                services account module).
                an invite exception (requires operchans module).
  R:<account>   Matches users logged into a matching account (requires
                services account module).

+ U:<banmask>   Matches unregistered users matching the given banmask.
+               (requires services account module).

 
 Acting extbans:
 
 
 Acting extbans:
 


@@ -1060,8 +1074,6 @@ Acting extbans:
                matching users (requires blockcaps module).
  C:<banmask>   Blocks CTCPs from matching users (requires noctcp
                module).
                matching users (requires blockcaps module).
  C:<banmask>   Blocks CTCPs from matching users (requires noctcp
                module).

- M:<account>   Blocks messages from users logged into a matching
-               account (requires services account module).

  N:<banmask>   Blocks nick changes from matching users (requires
                nonicks module).
  Q:<banmask>   Blocks kicks by matching users (requires nokicks
  N:<banmask>   Blocks nick changes from matching users (requires
                nonicks module).
  Q:<banmask>   Blocks kicks by matching users (requires nokicks


@@ -1070,12 +1082,10 @@ Acting extbans:
                users (requires stripcolor module).
  T:<banmask>   Blocks notices from matching users (requires nonotice
                module).
                users (requires stripcolor module).
  T:<banmask>   Blocks notices from matching users (requires nonotice
                module).

- U:<banmask>   Blocks unregistered users matching the given banmask.
-               (requires services account).

 
 A ban given to an Acting extban may either be a nick!user@host mask
 
 A ban given to an Acting extban may either be a nick!user@host mask

-(unless stated otherwise, for example M: taking an account name),
-matched against users as for a normal ban, or a Matching extban.
+(unless stated otherwise), matched against users as for a normal ban,
+or a Matching extban.

 
 There is an additional special type of extended ban, a redirect ban:
 
 
 There is an additional special type of extended ban, a redirect ban: