X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Fconf%2Fhelpop.conf.example;h=f8689c7b4ebfe78c4a33c51cd9d57d652238f176;hb=7d84771f49973d7091789a8b5f0f6295d288a673;hp=b4c1e7d67b0e5a7d7000b9a79f49bda2c0c92987;hpb=9a470c5863f796308c8761457cd3e66b8f836380;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/conf/helpop.conf.example b/docs/conf/helpop.conf.example index b4c1e7d67..f8689c7b4 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 # + + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -WHOIS WHOWAS ISON USERHOST WATCH -LIST NAMES WHO MOTD RULES -ADMIN MAP LINKS LUSERS TIME -STATS VERSION INFO MODULES COMMANDS -SSLINFO + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -OPER"> + + + + + + + + -SANICK NICKLOCK NICKUNLOCK + +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)."> + + + 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)."> +Extbans are split into two types; matching extbans, which match on +users in additional ways, and acting extbans, which restrict users +in different ways to a standard ban. + +To use an extban, simply set +b or +e with it as the ban, +instead of a normal nick!user@host mask, to ban or exempt matching +users. Ban exceptions on acting extbans exempt that user from matching +an extban of that type, and from any channel mode corresponding to the +restriction. Matching extbans may also be used for invite exceptions by +setting +I . + +Matching extbans: + + a: Matches user with both a matching banmask and realname, + where is in the format nick!user@host+realname + (requires gecosban module). + j: Matches anyone in the given channel. Does not support + wildcards (requires the channelban module). + n: Matches users in a matching connect class (requires + the classban module). + r: Matches users with a matching real name (requires the + gecosban module). + s: Matches users on a matching server (requires the + serverban module). + z: Matches users having the given SSL certificate + fingerprint (requires the sslmodes module). + O: Matches IRCops of a matching type, mostly useful as an + an invite exception (requires the operchans module). + R: Matches users logged into a matching account (requires + the services account module). + U: Matches unregistered users matching the given banmask. + (requires the services account module). + +Acting extbans: + + c: Blocks any messages that contain formatting codes from + matching users (requires the blockcolor module). + m: Blocks messages from matching users (requires the muteban + module). Users with +v or above are not affected. + p: Blocks part messages from matching users (requires + the nopartmsg module). + A: Blocks invites by matching users even when +A is set + (requires the allowinvite module). + B: Blocks all capital or nearly all capital messages from + matching users (requires the blockcaps module). + C: Blocks CTCPs from matching users (requires the noctcp + module). + N: Blocks nick changes from matching users (requires + the nonicks module). + Q: Blocks kicks by matching users (requires the nokicks + module). + S: Strips formatting codes from messages from matching + users (requires the stripcolor module). + T: Blocks notices from matching users (requires the + nonotice module). + +A ban given to an Acting extban may either be a nick!user@host mask +(unless stated otherwise), matched against users as for a normal ban, +or a Matching extban. + +There is an additional special type of extended ban, a redirect ban: + + Redirect n!u@h#channel will redirect the banned user to #channel + when they try to join (requires the banredirect module).">