X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Fconf%2Fhelpop.conf.example;h=4f3008c0746b5992783958b5f368e13b738dfcc8;hb=66ecf04088b747c00e7fdf8380fbece7848018be;hp=430b3ffd797234203718366655981ddd00e7c45d;hpb=fc4a935e25fa4e20695da389be70b55f619fe9b0;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/conf/helpop.conf.example b/docs/conf/helpop.conf.example index 430b3ffd7..4f3008c07 100644 --- a/docs/conf/helpop.conf.example +++ b/docs/conf/helpop.conf.example @@ -1,16 +1,20 @@ -# Sample configuration file for m_helpop.so +# Sample configuration file for the helpop module. # You can either copy this into your conf folder and set up the module to use it, # 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -OPER"> + + + + + + -SANICK NICKLOCK NICKUNLOCK + -KILL SAQUIT GLINE ZLINE QLINE -KLINE RLINE ELINE CBAN SHUN -FILTER + +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 IRCops of the message + and all relevant info +Block Blocks message and informs +s IRCops of the blocked message + and all relevant info +Silent Blocks message, but does not notify IRCops +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 +c Strip all formatting codes from the message before matching +* Represents all of the above flags +- 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."> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + (IRCop only, requires the showwhois module)."> p Make channel private, hiding it in users' whoises and replacing it with * in /LIST. r Marks the channel as registered with Services - (requires services account module). + (requires the services account module). s Make channel secret, hiding it in users' whoises and /LIST. t Prevents users without +h or +o from changing the topic. u Makes the channel an auditorium; normal users only see themselves or themselves and the operators, - while operators see all the users (requires + while operators see all the users (requires the auditorium module). w : Adds basic channel access controls of to , via the +w listmode. For example, +w o:R:Brain will op anyone identified to the account 'Brain' on join. - (requires autoop module) - z Blocks non-SSL clients from joining the channel. + (requires the autoop module) + 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 - allowinvite module). + the allowinvite module). B Blocks messages with too many capital letters, as determined by the network configuration - (requires blockcaps module). - C Blocks any CTCPs to the channel (requires noctcp - module). - D Delays join messages from users until they - message the channel (requires delayjoin module). + (requires the blockcaps module). + C Blocks any CTCPs to the channel (requires the + noctcp module). + D Delays join messages from users until they message + the channel (requires the delayjoin module). + 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 nickflood module). + specified rate (requires the nickflood module). G Censors messages to the channel based on the - network configuration (requires censor module). + network configuration (requires the censor module). H : Displays the last lines of chat to joining users. is the maximum time to keep - lines in the history buffer (requires chanhistory - module). + lines in the history buffer (requires the + chanhistory module). J Prevents rejoin after kick for the specified number of seconds. This prevents auto-rejoin - (requires kicknorejoin module). - K Blocks /KNOCK on the channel. + (requires the kicknorejoin module). + K Blocks /KNOCK on the channel (requires the + knock module). L If the channel reaches its limit set by +l, - redirect users to (requires redirect - module). + redirect users to (requires the + redirect module). M Blocks unregistered users from speaking (requires - services account module). + the services account module). N Prevents users on the channel from changing nick - (requires nonicks module). + (requires the nonicks module). O Channel is IRCops only (can only be set by IRCops, - requires operchans module). + 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 - permchannels module). - Q Only ulined servers and their users can kick - (requires nokicks module) + the permchannels module). + Q Only U-lined servers and their users can kick + (requires the nokicks module). R Blocks unregistered users from joining (requires - services account module). - S Strips mIRC color codes from messages to the - channel (requires stripcolor module). + the services account module). + S Strips formatting codes from messages to the + channel (requires the stripcolor module). T Blocks /NOTICEs to the channel from users who are - not at least halfop (requires nonotice module). + not at least halfop (requires the nonotice module). + 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: - g Blocks messages matching the given glob mask - (requires chanfilter module). - X Makes channel operators immune to the specified - restrictive mode (requires exemptchanops module). + 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 + stripcolor Channel mode +S + topiclock Channel mode +t ------------- NOTE: A large number of these modes are dependent upon server-side modules @@ -227,38 +1009,74 @@ 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."> + + + 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)."> + when they try to join (requires the banredirect module).">