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