docs/conf/helpop.conf.example

   1 # Sample configuration file for the helpop module.
   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="HELP" replace="HELPOP $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 /HELPOP CUSER    -      To see a list of user commands
  21 /HELPOP COPER    -      To see a list of oper commands
  22 /HELPOP UMODES   -      To see a list of user modes
  23 /HELPOP CHMODES  -      To see a list of channel modes
  24 /HELPOP SNOMASKS -      To see a list of oper snotice masks
  25 /HELPOP 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      OPER      TOPIC
  35 KICK      FPART    REMOVE    TBAN      INVITE
  36 UNINVITE  AWAY     DCCALLOW  SILENCE   ACCEPT
  37 MKPASSWD  VHOST    TITLE     SETNAME
  38
  39 WHOIS     WHOWAS   ISON      USERHOST  WATCH
  40 LIST      NAMES    WHO       MOTD
  41 ADMIN     MAP      LINKS     LUSERS    TIME
  42 STATS     VERSION  INFO      MODULES   COMMANDS
  43 SSLINFO
  44
  45 USER      PASS     PING     PONG       QUIT">
  46
  47 <helpop key="coper" value="Oper Commands
  48 -------------
  49
  50 OPERMOTD  CHECK     CLONES      USERIP   TLINE
  51 ALLTIME   WALLOPS   GLOBOPS     MODENOTICE
  52 CLOAK
  53
  54 SETHOST   SETIDENT  CHGHOST     CHGIDENT CHGNAME
  55 SETIDLE   SWHOIS
  56
  57 SANICK    NICKLOCK  NICKUNLOCK
  58
  59 SAJOIN    SAPART    SAMODE      SATOPIC  SAKICK
  60
  61 KILL      SAQUIT    GLINE       ZLINE    QLINE
  62 KLINE     RLINE     ELINE       CBAN     SHUN
  63 FILTER    CLEARCHAN
  64
  65 CONNECT   SQUIT     RCONNECT    RSQUIT
  66
  67 DIE            RESTART      REHASH
  68 CLEARCACHE     LOADMODULE   UNLOADMODULE
  69 RELOADMODULE   GLOADMODULE  GUNLOADMODULE
  70 GRELOADMODULE  CLOSE        JUMPSERVER
  71 LOCKSERV       UNLOCKSERV">
  72
  73 <helpop key="umodes" value="User Modes
  74 ----------
  75
  76  c            Blocks private messages and notices from users who do
  77               not share a common channel with you (requires
  78               commonchans module).
  79  d            Deaf mode. User will not receive any messages or notices
  80               from channels they are in (requires deaf module).
  81  g            In combination with /ACCEPT, provides for server side
  82               ignore (requires callerid module).
  83  h            Marks as 'available for help' in WHOIS (IRCop only,
  84               requires helpop module).
  85  i            Makes invisible to /WHO if the user using /WHO is not in
  86               a common channel.
  87  k            Prevents the user from being kicked from channels, or
  88               having op modes removed from them (services only,
  89               requires servprotect module).
  90  o            Marks as a IRC operator.
  91  s <mask>     Receives server notices specified by <mask>
  92               (IRCop only).
  93  r            Marks as a having a registered nickname
  94               (requires services account module).
  95  w            Receives wallops messages.
  96  x            Gives a cloaked hostname (requires cloaking module).
  97  B            Marks as a bot (requires botmode module).
  98  G            Censors messages sent to the user based on filters
  99               configured for the network (requires censor module).
 100  H            Hides an oper's oper status from WHOIS (requires
 101               hideoper module).
 102  I            Hides a user's entire channel list in WHOIS from
 103               non-IRCops (requires hidechans module).
 104  L            Stops redirections done by m_redirect (mode must be
 105               enabled in the config).
 106  R            Blocks private messages from unregistered users
 107               (requires services account module).
 108  S            Strips mIRC color/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> (requires
 119                     customprefix module).
 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 customprefix module).
 124  q <nickname>       Gives owner status to <nickname>, preventing them
 125                     from being kicked (Services or only, requires
 126                     customprefix 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 color codes
 136                     (requires blockcolor module).
 137  d <time>           Blocks messages to a channel from new users
 138                     until they have been in the channel for <time>
 139                     seconds (requires delaymsg module).
 140  f [*]<lines>:<sec> Kicks on text flood equal to or above the
 141                     specified rate. With *, the user is banned
 142                     (requires messageflood module).
 143  i                  Makes the channel invite-only.
 144                     Users can only join if an operator
 145                     uses /INVITE to invite them.
 146  j <joins>:<sec>    Limits joins to the specified rate (requires
 147                     joinflood module).
 148  k <key>            Set the channel key (password) to <key>.
 149  l <limit>          Set the maximum allowed users to <limit>.
 150  m                  Enable moderation. Only users with +v, +h, or +o
 151                     can speak.
 152  n                  Blocks users who are not members of the channel
 153                     from messaging it.
 154  p                  Make channel private, hiding it in users' whoises
 155                     and replacing it with * in /LIST.
 156  r                  Marks the channel as registered with Services
 157                     (requires services account module).
 158  s                  Make channel secret, hiding it in users' whoises
 159                     and /LIST.
 160  t                  Prevents users without +h or +o from changing the
 161                     topic.
 162  u                  Makes the channel an auditorium; normal users only
 163                     see themselves or themselves and the operators,
 164                     while operators see all the users (requires
 165                     auditorium module).
 166  w <flag>:<banmask> Adds basic channel access controls of <flag> to
 167                     <banmask>, via the +w listmode.
 168                     For example, +w o:R:Brain will op anyone identified
 169                     to the account 'Brain' on join.
 170                     (requires autoop module)
 171  z                  Blocks non-SSL clients from joining the channel.
 172
 173  A                  Allows anyone to invite users to the channel
 174                     (normally only chanops can invite, requires
 175                     allowinvite module).
 176  B                  Blocks messages with too many capital letters,
 177                     as determined by the network configuration
 178                     (requires blockcaps module).
 179  C                  Blocks any CTCPs to the channel (requires noctcp
 180                     module).
 181  D                  Delays join messages from users until they
 182                     message the channel (requires delayjoin module).
 183  E [~*][lines]:[sec]{[:difference]}{[:backlog]} Allows blocking of similar messages.
 184                     Kicks as default, blocks with ~ and bans with *
 185                     The last two parameters are optional.
 186  F <changes>:<sec>  Blocks nick changes when they equal or exceed the
 187                     specified rate (requires nickflood module).
 188  G                  Censors messages to the channel based on the
 189                     network configuration (requires censor module).
 190  H <num>:<duration> Displays the last <num> lines of chat to joining
 191                     users. <duration> is the maximum time to keep
 192                     lines in the history buffer (requires chanhistory
 193                     module).
 194  J <seconds>        Prevents rejoin after kick for the specified
 195                     number of seconds. This prevents auto-rejoin
 196                     (requires kicknorejoin module).
 197  K                  Blocks /KNOCK on the channel.
 198  L <channel>        If the channel reaches its limit set by +l,
 199                     redirect users to <channel> (requires redirect
 200                     module).
 201  M                  Blocks unregistered users from speaking (requires
 202                     services account module).
 203  N                  Prevents users on the channel from changing nick
 204                     (requires nonicks module).
 205  O                  Channel is IRCops only (can only be set by IRCops,
 206                     requires operchans module).
 207  P                  Makes the channel permanent; Bans, invites, the
 208                     topic, modes, and such will not be lost when it
 209                     empties (can only be set by IRCops, requires
 210                     permchannels module).
 211  Q                  Only ulined servers and their users can kick
 212                     (requires nokicks module)
 213  R                  Blocks unregistered users from joining (requires
 214                     services account module).
 215  S                  Strips mIRC color codes from messages to the
 216                     channel (requires stripcolor module).
 217  T                  Blocks /NOTICEs to the channel from users who are
 218                     not at least halfop (requires nonotice module).
 219
 220  g <mask>           Blocks messages matching the given glob mask
 221                     (requires chanfilter module).
 222  X <mode>           Makes channel operators immune to the specified
 223                     restrictive mode (requires exemptchanops module).
 224
 225 -------------
 226 NOTE: A large number of these modes are dependent upon server-side modules
 227 being loaded by a server/network administrator. The actual modes available
 228 on your network may be very different to this list. Please consult your
 229 help channel if you have any questions.">
 230
 231 <helpop key="snomasks" value="Server Notice Masks
 232
 233  a      Allows receipt of local announcement messages.
 234  A      Allows receipt of remote announcement messages.
 235  c      Allows receipt of local connect messages.
 236  C      Allows receipt of remote connect messages.
 237  d      Allows receipt of general (and sometimes random) debug
 238         messages.
 239  f      Allows receipt of flooding notices.
 240  g      Allows receipt of globops (requires globops module).
 241  j      Allows receipt of channel creation notices (requires
 242         chancreate module).
 243  J      Allows receipt of remote channel creation notices (requires
 244         chancreate module).
 245  k      Allows receipt of local kill messages.
 246  K      Allows receipt of remote kill messages.
 247  l      Allows receipt of local linking related
 248         messages.
 249  L      Allows receipt of remote linking related
 250         messages.
 251  n      See local nickname changes (requires seenicks module).
 252  N      See remote nickname changes (requires seenicks modules).
 253  o      Allows receipt of oper-up, oper-down, and oper-failure
 254         messages.
 255  O      Allows receipt of remote oper-up, oper-down, and oper-failure
 256         messages.
 257  q      Allows receipt of local quit messages.
 258  Q      Allows receipt of remote quit messages.
 259  t      Allows receipt of attempts to use /STATS (local and remote).
 260  v      Allows receipt of oper-override notices (requires override module).
 261  x      Allows receipt of local Xline notices (g/Z/q/k/e/R/shuns).
 262  X      Allows receipt of remote Xline notices (g/Z/q/k/e/R/shuns).">
 263
 264 <helpop key="extbans" value="Extended Bans
 265 ----------
 266
 267 Extbans are split into two types; matching extbans, which match on
 268 users in additional ways, and acting extbans, which restrict users
 269 in different ways to a standard ban.
 270
 271 To use an extban, simply set +b <ban> or +e <ban> with it as the ban,
 272 instead of a normal nick!user@host mask, to ban or exempt matching
 273 users. Ban exceptions on acting extbans exempt that user from matching
 274 an extban of that type, and from any channel mode corresponding to the
 275 restriction. Matching extbans may also be used for invite exceptions by
 276 setting +I <extban>.
 277
 278 Matching extbans:
 279
 280  j:<channel>   Matches anyone in the given channel. Does not support
 281                wildcards (requires channelban module).
 282  n:<class>     Matches users in a matching connect class (requires
 283                classban module).
 284  r:<realname>  Matches users with a matching realname (requires gecosban
 285                module).
 286  s:<server>    Matches users on a matching server (requires serverban
 287                module).
 288  z:<certfp>    Matches users having the given SSL certificate
 289                fingerprint (requires sslmodes module).
 290  O:<opertype>  Matches IRCops of a matching type, mostly useful as an
 291                an invite exception (requires operchans module).
 292  R:<account>   Matches users logged into a matching account (requires
 293                services account module).
 294  U:<banmask>   Matches unregistered users matching the given banmask.
 295                (requires services account module).
 296
 297 Acting extbans:
 298
 299  c:<banmask>   Blocks any messages that contain color codes from
 300                matching users (requires blockcolor module).
 301  m:<banmask>   Blocks messages from matching users (requires muteban
 302                module). Users with +v or above are not affected.
 303  p:<banmask>   Blocks part messages from matching users (requires
 304                nopartmsg module).
 305  A:<banmask>   Blocks invites by matching users even when +A is set
 306                (requires allowinvite module).
 307  B:<banmask>   Blocks all capital or nearly all capital messages from
 308                matching users (requires blockcaps module).
 309  C:<banmask>   Blocks CTCPs from matching users (requires noctcp
 310                module).
 311  N:<banmask>   Blocks nick changes from matching users (requires
 312                nonicks module).
 313  Q:<banmask>   Blocks kicks by matching users (requires nokicks
 314                module).
 315  S:<banmask>   Strips color/bold/underline from messages from matching
 316                users (requires stripcolor module).
 317  T:<banmask>   Blocks notices from matching users (requires nonotice
 318                module).
 319
 320 A ban given to an Acting extban may either be a nick!user@host mask
 321 (unless stated otherwise), matched against users as for a normal ban,
 322 or a Matching extban.
 323
 324 There is an additional special type of extended ban, a redirect ban:
 325
 326  Redirect      n!u@h#channel will redirect the banned user to #channel
 327                when they try to join (requires banredirect module).">