X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Fconf%2Fhelpop.conf.example;h=a0e90b6cb38980a787e29d0cfd49da5ddad0de4d;hb=493acff4ebc762c480df8e1e5c02ed140a0a81c3;hp=8456346d98dd241da4719a94104e8d1dd618ee93;hpb=4995417f59c91cf62c13f1d1dcfdbf4f67714b83;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/conf/helpop.conf.example b/docs/conf/helpop.conf.example index 8456346d9..a0e90b6cb 100644 --- a/docs/conf/helpop.conf.example +++ b/docs/conf/helpop.conf.example @@ -3,14 +3,18 @@ # or you can customize the responses for your network and/or add more. # # The way the new helpop system works is simple. You use one or more helpop tags. -# . +# # key is what the user is looking for (i.e. /helpop moo), and value is what they get back # (note that it can span multiple lines!). # -- w00t 16/dec/2006 # + + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -USER PASS PING PONG QUIT"> + + + + -SETHOST SETIDENT CHGHOST CHGIDENT CHGNAME -SETIDLE SWHOIS + -SAJOIN SAPART SAMODE SATOPIC SAKICK + -CONNECT SQUIT RCONNECT RSQUIT + +This command will add a global filter when more than one parameter is +given, for messages of the types specified by the flags, with the given +filter pattern, action, duration (when the action is 'gline', 'zline' +or 'shun'), and reason. + +The filter will take effect when a message of any type specified by +the flags and matching the pattern is sent to the server, and +perform the specified action. + +Valid FILTER Actions +-------------------- + +None Does nothing +Warn Lets the message through and informs +s server operators + of the message and all relevant info +Block Blocks message and informs +s server operators of the blocked + message and all relevant info +Silent Blocks message, but does not notify server operators +Kill Kills the user +Gline G-lines the user for the specified duration +Zline Z-lines the user for the specified duration +Shun Shuns the user for the specified duration (requires the shun module) + +Valid FILTER Flags +------------------ + +p Block private and channel messages +n Block private and channel notices +P Block part messages +q Block quit messages +o Don't match against opers +r Don't match against registered users +c Strip all formatting codes from the message before matching +* Represents all of the above flags except r +- Does nothing, a non-op for when you do not want to specify any + flags + +The reason for the filter will be used as the reason for the action, +unless the action is 'none', and is sent to the user when their text is +blocked by 'block' and 'silent' actions. + +A G-line, Z-line or shun 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. + +When only one parameter is provided (the filter pattern) the provided +filter will be removed. Note that if you remove a +configuration-defined filter, it will reappear at next rehash unless +it is also removed from the config file."> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + commonchans module). d Deaf mode. User will not receive any messages or notices from channels they are in (requires the deaf module). - g In combination with /ACCEPT, provides for server side + g In combination with /ACCEPT, provides for server-side ignore (requires the callerid module). - h Marks as 'available for help' in WHOIS (IRCop only, - requires the helpop module). + h Marks as 'available for help' in WHOIS (server operators + only, requires the helpop module). i Makes invisible to /WHO if the user using /WHO is not in a common channel. k Prevents the user from being kicked from channels, or having op modes removed from them (services only, requires the servprotect module). - o Marks as a IRC operator. + o Marks as a server operator. s Receives server notices specified by - (IRCop only). + (server operators only). r Marks as a having a registered nickname (requires the services account module). w Receives wallops messages. @@ -97,20 +850,24 @@ LOCKSERV UNLOCKSERV"> z Only allow private messages from SSL users (requires the sslmode module). B Marks as a bot (requires the botmode module). + D Privdeaf mode. User will not receive any private messages + or notices from users (requires the deaf module). G Censors messages sent to the user based on filters configured for the network (requires the censor module). H Hides an oper's oper status from WHOIS (requires the hideoper module). I Hides a user's entire channel list in WHOIS from - non-IRCops (requires the hidechans module). - L Stops redirections done by m_redirect (mode must be - enabled in the config). + non-server operators (requires the hidechans module). + L Stops redirections done by the redirect module (requires + the redirect module). + O Allows server operators to opt-in to overriding + restrictions (requires the override module). R Blocks private messages from unregistered users (requires the services account module). S Strips formatting codes out of private messages to the user (requires the stripcolor module). - W Receives notification when a user uses WHOIS on them - (IRCop only, requires the showwhois module)."> + W Receives notifications when a user uses WHOIS on them + (server operators only, requires the showwhois module)."> For example, +w o:R:Brain will op anyone identified to the account 'Brain' on join. (requires the autoop module) - z Blocks non-SSL clients from joining the channel. + z Blocks non-SSL clients from joining the channel + (requires the sslmodes module). A Allows anyone to invite users to the channel (normally only chanops can invite, requires @@ -184,10 +942,10 @@ LOCKSERV UNLOCKSERV"> noctcp module). D Delays join messages from users until they message the channel (requires the delayjoin module). - E [~*][lines]:[sec]{[:difference]}{[:backlog]} Allows blocking of similar messages. + E [~|*]:[:][:] Allows blocking of + similar messages (requires the repeat module). Kicks as default, blocks with ~ and bans with * The last two parameters are optional. - F : Blocks nick changes when they equal or exceed the specified rate (requires the nickflood module). G Censors messages to the channel based on the @@ -199,7 +957,8 @@ LOCKSERV UNLOCKSERV"> J Prevents rejoin after kick for the specified number of seconds. This prevents auto-rejoin (requires the kicknorejoin module). - K Blocks /KNOCK on the channel. + K Blocks /KNOCK on the channel (requires the + knock module). L If the channel reaches its limit set by +l, redirect users to (requires the redirect module). @@ -207,14 +966,14 @@ LOCKSERV UNLOCKSERV"> the services account module). N Prevents users on the channel from changing nick (requires the nonicks module). - O Channel is IRCops only (can only be set by IRCops, - requires the operchans module). + O Channel is server operators only (can only be set + by server operators, requires the operchans module). P Makes the channel permanent; Bans, invites, the topic, modes, and such will not be lost when it - empties (can only be set by IRCops, requires - the permchannels module). - Q Only ulined servers and their users can kick - (requires the nokicks module) + empties (can only be set by server operators, + requires the permchannels module). + Q Only U-lined servers and their users can kick + (requires the nokicks module). R Blocks unregistered users from joining (requires the services account module). S Strips formatting codes from messages to the @@ -224,6 +983,26 @@ LOCKSERV UNLOCKSERV"> X : Makes users of or higher exempt to the specified restriction . For example: flood:h (requires the exemptchanops module). + Possible restriction types to exempt with +X are: + + anticaps Channel mode +B + auditorium-see Permission required to see the full user list of + a +u channel (requires the auditorium module). + auditorium-vis Permission required to be visible in a +u channel + (requires the auditorium module). + blockcaps Channel mode +B + blockcolor Channel mode +c + censor Channel mode +G + filter Channel mode +g + flood Channel mode +f + nickflood Channel mode +F + noctcp Channel mode +C + nonick Channel mode +N + nonotice Channel mode +T + regmoderated Channel mode +M + repeat Channel mode +E + stripcolor Channel mode +S + topiclock Channel mode +t ------------- NOTE: A large number of these modes are dependent upon server-side modules @@ -231,6 +1010,45 @@ being loaded by a server/network administrator. The actual modes available on your network may be very different to this list. Please consult your help channel if you have any questions."> + + K Allows receipt of remote kill messages. l Allows receipt of local linking related messages. L Allows receipt of remote linking related messages. - n See local nickname changes (requires the seenicks module). - N See remote nickname changes (requires the seenicks modules). + n Allows receipt of local nickname changes (requires the seenicks module). + N Allows receipt of remote nickname changes (requires the seenicks modules). o Allows receipt of oper-up, oper-down, and oper-failure messages. O Allows receipt of remote oper-up, oper-down, and oper-failure messages. q Allows receipt of local quit messages. @@ -257,9 +1075,9 @@ help channel if you have any questions."> r Allows receipt of local oper commands (requires the operlog module). R Allows receipt of remote oper commands (requires the operlog module). t Allows receipt of attempts to use /STATS (local and remote). - v Allows receipt of oper-override notices (requires the override module). - x Allows receipt of local Xline notices (g/Z/q/k/e/R/shuns). - X Allows receipt of remote Xline notices (g/Z/q/k/e/R/shuns)."> + v Allows receipt of oper override notices (requires the override module). + x Allows receipt of local X-line notices (G/Z/Q/K/E/R/SHUN/CBan). + X Allows receipt of remote X-line notices (G/Z/Q/K/E/R/SHUN/CBan).">