docs/inspircd.helpop.example

   1 # Sample configuration file for m_helpop.so
   2 # You can either copy this into your conf folder and set up the module to use it,
   3 # or you can customize the responses for your network and/or add more.
   4 #
   5 # The way the new helpop system works is simple. You use one or more helpop tags.
   6 #   <helpop key="moo" value="something here">.
   7 # key is what the user is looking for (i.e. /helpop moo), and value is what they get back
   8 # (note that it can span multiple lines!).
   9 #   -- w00t 16/dec/2006
  10 #
  11
  12 <helpop key="start" value="InspIRCd Help System
  13
  14 This system provides help for commands and modes.
  15 Specify your question or a command name as the
  16 parameter for this command.
  17
  18 /HELPOP CUSER    -      To see a list of user commands
  19 /HELPOP COPER    -      To see a list of oper commands
  20 /HELPOP UMODES   -      To see a list of user modes
  21 /HELPOP CHMODES  -      To see a list of channel modes
  22 /HELPOP SNOMASKS -      To see a list of oper snotice masks
  23 /HELPOP EXTBANS  -      To see a list of extended bans">
  24
  25 <helpop key="nohelp" value="There is no help for the topic
  26 you searched for. Please try again.">
  27
  28 <helpop key="cuser" value="User Commands
  29 -------------
  30
  31 PRIVMSG   NOTICE   NICK      JOIN      PART
  32 CYCLE     KNOCK    MODE      DEVOICE   TOPIC
  33 KICK      FPART    REMOVE    TBAN      INVITE
  34 UNINVITE  AWAY     DCCALLOW  SILENCE   ACCEPT
  35 MKPASSWD  VHOST    TITLE
  36
  37 WHOIS     WHOWAS   ISON      USERHOST  WATCH
  38 LIST      NAMES    WHO       MOTD      RULES
  39 ADMIN     MAP      LINKS     LUSERS    TIME
  40 STATS     VERSION  INFO      MODULES   COMMANDS
  41 SSLINFO   FINGERPRINT
  42
  43 USER      PASS     PING     PONG       QUIT
  44
  45 OPER">
  46
  47 <helpop key="coper" value="Oper Commands
  48 -------------
  49
  50 OPERMOTD  CHECK     TAXONOMY    CLONES   USERIP
  51 TLINE     ALLTIME   MODULES     WALLOPS  GLOBOPS
  52
  53 SETHOST   SETIDENT  SETNAME     CHGHOST  CHGIDENT
  54 CHGNAME   SETIDLE   SWHOIS
  55
  56 SANICK    NICKLOCK  NICKUNLOCK
  57
  58 SAJOIN    SAPART    SAMODE      SATOPIC  SAKICK
  59
  60 KILL      SAQUIT    GLINE       ZLINE    QLINE
  61 KLINE     RLINE     ELINE       CBAN     SHUN
  62 FILTER
  63
  64 CONNECT   SQUIT     RCONNECT    RSQUIT
  65
  66 DIE            RESTART      REHASH
  67 CLEARCACHE     LOADMODULE   UNLOADMODULE
  68 RELOADMODULE   GLOADMODULE  GUNLOADMODULE
  69 GRELOADMODULE  RELOAD       CLOSE
  70 LOCKSERV       UNLOCKSERV   JUMPSERVER">
  71
  72 <helpop key="umodes" value="User Modes
  73 ----------
  74
  75  c            Blocks private messages and notices from users who do
  76               not share a common channel with you (requires
  77               commonchans module).
  78  d            Deaf mode. User will not recieve any messages or notices
  79               from channels they are in (requires deaf module).
  80  g            In combination with /allow, provides for server side
  81               ignore (requires callerid module).
  82  h            Marks as 'available for help' in WHOIS (IRCop only,
  83               requires helpop module).
  84  i            Makes invisible to /WHO if the user using /WHO is not in
  85               a common channel.
  86  k            Prevents the user from being kicked from channels, or
  87               having op modes removed from them (services only,
  88               requires servprotect module).
  89  o            Marks as a IRC operator.
  90  s [mask]     Receives server notices specified by [mask]
  91               (IRCop only).
  92  r            Marks as a having a registered nickname
  93               (requires services account module).
  94  w            Receives wallops messages.
  95  x            Gives a cloaked hostname (requires cloaking module).
  96  B            Marks as a bot (requires botmode module).
  97  G            Censors messages sent to the user based on filters
  98               configured for the network (requires censor module).
  99  H            Hides an oper's oper status from WHOIS (requires
 100               hideoper module).
 101  I            Hides a user's entire channel list in WHOIS from
 102               non-IRCops (requires hidechans module).
 103  Q            Makes an operator invisible, preventing users from
 104               seeing their presence, including in channel user lists
 105               (IRCop only, requires invisible module).
 106  R            Blocks private messages from unregistered users
 107               (requires services account module).
 108  S            Strips mIRC colour/bold/underline codes out of private
 109               messages to the user (requires stripcolor module).
 110  W            Receives notification when a user uses WHOIS on them
 111               (IRCop only, requires showwhois module).">
 112
 113 <helpop key="chmodes" value="Channel Modes
 114 -------------
 115
 116  v [nickname]       Gives voice to [nickname], allowing them to speak
 117                     while the channel is +m.
 118  h [nickname]       Gives halfop status to [nickname] (this mode can
 119                     be disabled).
 120  o [nickname]       Gives op status to [nickname].
 121  a [nickname]       Gives protected status to [nickname], preventing
 122                     them from them from being kicked (+q only,
 123                     requires chanprotect module).
 124  q [nickname]       Gives owner status to [nickname], preventing them
 125                     from being kicked (Services or only, requires
 126                     chanprotect module).
 127
 128  b [hostmask]       Bans [hostmask] from the channel.
 129  e [hostmask]       Excepts [hostmask] from bans (requires
 130                     banexception module).
 131  I [hostmask]       Excepts [hostmask] from +i, allowing matching
 132                     users to join while the channel is invite-only
 133                     (requires inviteexception module).
 134
 135  c                  Blocks messages containing mIRC colour codes
 136                     (requires blockcolor module).
 137  f [*][lines]:[sec] Kicks on text flood equal to or above the
 138                     specified rate. With *, the user is banned
 139                     (requires messageflood module).
 140  g [mask]           Blocks messages matching the given blob mask
 141                     (requires chanfilter module).
 142  i                  Makes the channel invite-only.
 143                     Users can only join if an operator
 144                     uses /INVITE to invite them.
 145  j [joins]:[sec]    Limits joins to the specified rate (requires
 146                     joinflood module).
 147  k [key]            Set the channel key (password) to [key].
 148  l [limit]          Set the maximum allowed users to [limit].
 149  m                  Enable moderation. Only users with +v, +h, or +o
 150                     can speak.
 151  n                  Blocks users who are not members of the channel
 152                     from messaging it.
 153  p                  Make channel private, hiding it in user's whoises
 154                     and replacing it with * in /LIST.
 155  r                  Marks the channel as registered with Services
 156                     (requires services account module).
 157  s                  Make channel secret, hiding it in user's whoises
 158                     and /LIST.
 159  t                  Prevents users without +h or +o from changing the
 160                     topic.
 161  u                  Makes the channel an auditorium; normal users only
 162                     see themselves or themselves and the operators,
 163                     while operators see all the users (requires
 164                     auditorium module).
 165  z                  Blocks non-SSL clients from joining the channel.
 166
 167  A                  Allows anyone to invite users to the channel
 168                     (normally only chanops can invite, requires
 169                     allowinvite module).
 170  B                  Blocks messages with too many capital letters,
 171                     as determined by the network configuration
 172                     (requires blockcaps module).
 173  C                  Blocks any CTCPs to the channel (requires noctcp
 174                     module).
 175  D                  Delays join messages from users until they
 176                     message the channel (requires delayjoin module).
 177  F [changes]:[sec]  Blocks nick changes when they equal or exceed the
 178                     specified rate (requires nickflood module).
 179  G                  Censors messages to the channel based on the
 180                     network configuration (requires censor module).
 181  J [seconds]        Prevents rejoin after kick for the specified
 182                     number of seconds. This prevents auto-rejoin
 183                     (requires kicknorejoin module).
 184  K                  Blocks /KNOCK on the channel.
 185  L [channel]        If the channel reaches its limit set by +l,
 186                     redirect users to [channel] (requires redirect
 187                     module).
 188  M                  Blocks unregistered users from speaking (requires
 189                     services account module).
 190  N                  Prevents users on the channel from chainging nick
 191                     (requires nonicks module).
 192  O                  Channel is IRCops only (can only be set by IRCops,
 193                     requires operchans module).
 194  P                  Makes the channel permanent; Bans, invites, the
 195                     topic, modes, and such will not be lost when it
 196                     empties (can only be set by IRCops, requires
 197                     permchannels module).
 198  Q                  Only ulined servers and their users can kick
 199                     (requires nokicks module)
 200  R                  Blocks unregistered users from joining (requires
 201                     services account module).
 202  S                  Strips mIRC colour codes from messages to the
 203                     channel (requirs stripcolor module).
 204  T                  Blocks /NOTICEs to the channel from users who are
 205                     not at least halfop (requires nonotice module).
 206
 207 -------------
 208 NOTE: A large number of these modes are dependent upon server-side modules
 209 being loaded by a server/network administrator. The actual modes available
 210 on your network may be very different to this list. Please consult your
 211 help channel if you have any questions.">
 212
 213 <helpop key="snomasks" value="Server Notice Masks
 214
 215  a      Allows receipt of local announcement messages.
 216  A      Allows receipt of remote announcement messages.
 217  c      Allows receipt of local connect messages.
 218  C      Allows receipt of remote connect messages.
 219  d      Allows receipt of general (and sometimes random) debug
 220         messages.
 221  f      Allows receipt of flooding notices.
 222  g      Allows receipt of globops (requires globops module).
 223  G      Allows receipt of notices of use of oper-override (requires
 224         override module)
 225  j      Allows receipt of channel creation notices (requires
 226         chancreate module).
 227  J      Allows receipt of remote channel creation notices (requires
 228         chancreate module).
 229  k      Allows receipt of local kill messages.
 230  K      Allows receipt of remote kill messages.
 231  l      Allows receipt of local linking related
 232         messages.
 233  L      Allows receipt of remote linking related
 234         messages.
 235  n      See local nickname changes (requires seenicks module).
 236  N      See remote nickname changes (requires seenicks modules).
 237  o      Allows receipt of oper-up, oper-down, and oper-failure
 238         messages.
 239  O      Allows receipt of remote oper-up, oper-down, and oper-failure
 240         messages.
 241  q      Allows receipt of local quit messages.
 242  Q      Allows receipt of remote quit messages.
 243  t      Allows receipt of attempts to use /STATS (local and remote).
 244  x      Allows receipt of Xline notice (g/z/q/k/e).">
 245
 246 <helpop key="extbans" value="Extended Bans
 247 ----------
 248
 249  c:n!u@h      Blocks any messages that contain colour codes from
 250               matching users (requires blockcolor module).
 251  j:#channel   Prevents anyone in #channel from joining the channel
 252               (requires channelban module).
 253  m:n!u@h      Blocks messages from matching users (requires muteban
 254               module).
 255  p:n!u@h      Blocks part messages from matching users (requires
 256               nopartmsg module).
 257  r:realname   Prevents users with a matching realname from joining
 258               the channel (requires gecosban module).
 259  s:server     Prevents users on a matching server from joining the
 260               channel (requires services account).
 261
 262  A:n!u@h      Blocks invites by matching users even when +A is set
 263               (requires allowinvite module).
 264  B:n!u@h      Blocks all capital or nearly all capital messages from
 265               matching users (requires blockcaps module).
 266  C:n!u@h      Blocks CTCPs from matching users (requires noctcp
 267               module).
 268  M:account    Blocks messages from users logged into a matching
 269               account (requires services account module).
 270  N:n!u@h      Blocks nick changes from matching users (requires
 271               nonicks module).
 272  O:opertype   Prevents IRCops of the specified opertype from joining
 273               the channel, mostly useful as an invite exception (IRCop
 274               only, requires operchans module).
 275  Q:n!u@h      Blocks kicks by matching users (requires nokicks
 276               module).
 277  R:account    Prevents users logged into a matching account from
 278               joining the channel (requires services account module).
 279  S:n!u@h      Strips color/bold/underline from messages from matching
 280               users (requires stripcolor module).
 281  T:n!u@h      Blocks notices from matching users (requires nonotice
 282               module).
 283
 284  Redirect     n!u@h#channel will redirect the banned user to #channel
 285               when they try to join (requires banredirect module).
 286
 287 All extbans that prevent users from joining may by used for ban
 288 exceptions and invite exceptions (invex), and extbans blocking
 289 specific actions may be used for ban exceptions to exempt people from
 290 either wider extbans or the restrictive mode matching the extban,
 291 where one exists.">