X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Fconf%2Fhelpop-full.conf.example;h=dec0e23d1125ca1aac745c071d045400d1d7c154;hb=4047a143fc1d16350db70c94b9ea77d79de05714;hp=b5d5813f2d84f0b0695e973335cf04a3321a75d1;hpb=e3f22fcf31cd2e789d1be90cf0edf3e82829b54e;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/conf/helpop-full.conf.example b/docs/conf/helpop-full.conf.example index b5d5813f2..dec0e23d1 100644 --- a/docs/conf/helpop-full.conf.example +++ b/docs/conf/helpop-full.conf.example @@ -2,8 +2,12 @@ # Helpop Standard # ##################### + + + + - - ##################### # User Commands # ##################### @@ -224,49 +225,84 @@ given in the command and either the channel is not +t, or you are at least a halfoperator, the channel topic will be changed to the new one you provide."> - +The following flags use to match against the specified user data: + + A Show users who have an away message matching . + a Show users who have an account name matching . + h Show users who have a hostname matching . If the 'x' modifier + is specified then this will match against the real hostname instead of + the display hostname. + i Show users who have an IP address matching . + m Show users who have the modes listed in . The pattern + should be in the same format as a mode change e.g. +ow-i (server + operators only). + n Show users who have a nickname matching . + p Show users who are connected to a port in the range (server + operators only). + r Show users who have a real name matching . + s Show users who are on a server with a name matching . If the 'x' + modifier is specified then this will match against the real server name + instead of the masked server name. + t Show users who have connected in the last seconds. + u Show users who have an ident (username) matching . + +The following flags filter users by their status: + + f Only show users on remote (far) servers. + l Only show users on the local server. + o Only show server operators. + +The following flags modify the command output: + + x Show sensitive data like real user hostnames and, when hideserver is + enabled, real server hostnames. + +You may combine one flag from the first group and multiple from the others in +one WHO command. + +Valid WHO Fields +---------------- + + a Include the user's account name in the response. + c Include the first common channel name in the response. + d Include the user's server distance from you in the response. + f Include the user's away status, oper status, and highest channel prefix + in the response. + h Include the user's hostname in the response. If the 'x' flag was + specified then this is the real host rather than the display host. + i Include the user's IP address in the response. + l Include the user's idle time in the response. + n Include the user's nickname in the response. + o Include the user's channel operator rank level in the response. + r Include the user's real name in the response. + s Include the user's server name in the response. If the 'x' flag was + specified then this is the real server name rather than the masked server + name. + t Include the query type in the response. + u Include the user's ident in the response. + +"> @@ -398,11 +434,12 @@ LOCKSERV UNLOCKSERV"> Returns the ip and nickname of the given users."> - +(by IP address or by hostname). Mask should be given as either a +nick!user@host or user@IP (wildcards acceptable)."> This command will add a filter when more than one parameter is given, for messages of the types specified by the flags, with the given -filter definition, action, duration (when the action is 'gline' or 'shun'), -and reason. +filter definition, 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 definition is sent to the server, and @@ -449,11 +486,14 @@ 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 Glines the user for the specified duration +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 @@ -464,7 +504,7 @@ n Block private and channel notices P Block part messages q Block quit messages o Don't match against opers -c Strip all color codes from the message before matching +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 @@ -473,8 +513,8 @@ 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 gline duration may be specified in seconds, or in the format -1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5 +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 @@ -661,13 +701,11 @@ Loads the specified module into the local server."> +Unloads a module from the local server."> +Unloads and reloads a module on the local server."> +Unloads a module from all linked servers."> +Unloads and reloads a module on all linked servers."> +be negated by an E-line on *@, bans on *@ can be negated by +E-lines on *@, or *@, and bans on @* or @ +can be negated by any E-line that matches."> - - @@ -790,79 +822,81 @@ using their cloak when they quit."> ---------- c Blocks private messages and notices from users who do - not share a common channel with you (requires + not share a common channel with you (requires the commonchans module). d Deaf mode. User will not receive any messages or notices - from channels they are in (requires deaf module). + from channels they are in (requires the deaf module). g In combination with /ACCEPT, provides for server side - ignore (requires callerid module). + ignore (requires the callerid module). h Marks as 'available for help' in WHOIS (IRCop only, - requires helpop module). + 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 servprotect module). + requires the servprotect module). o Marks as a IRC operator. s Receives server notices specified by (IRCop only). r Marks as a having a registered nickname - (requires services account module). + (requires the services account module). w Receives wallops messages. - x Gives a cloaked hostname (requires cloaking module). - z Only allow private messages from SSL users (requires + x Gives a cloaked hostname (requires the cloaking module). + z Only allow private messages from SSL users (requires the sslmode module). - B Marks as a bot (requires botmode module). + B Marks as a bot (requires the botmode module). G Censors messages sent to the user based on filters - configured for the network (requires censor module). - H Hides an oper's oper status from WHOIS (requires + 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 hidechans module). + non-IRCops (requires the hidechans module). L Stops redirections done by m_redirect (mode must be enabled in the config). R Blocks private messages from unregistered users - (requires services account module). - S Strips mIRC color/bold/underline codes out of private - messages to the user (requires stripcolor module). + (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 showwhois module)."> + (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) + (requires the autoop module) z Blocks non-SSL clients from joining the channel. 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 [~*][lines]:[sec]{[:difference]}{[:backlog]} Allows blocking of similar messages. 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). + (requires the kicknorejoin module). K Blocks /KNOCK on the channel. 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). + the permchannels module). Q Only ulined servers and their users can kick - (requires nokicks module) + (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). - - g Blocks messages matching the given glob mask - (requires chanfilter module). - X Makes channel operators immune to the specified - restrictive mode (requires exemptchanops 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: + + 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 @@ -999,32 +1049,29 @@ Note that all /STATS use is broadcast to online IRC operators."> A Allows receipt of remote announcement messages. c Allows receipt of local connect messages. C Allows receipt of remote connect messages. - d Allows receipt of general (and sometimes random) debug - messages. - f Allows receipt of flooding notices. - g Allows receipt of globops (requires globops module). - j Allows receipt of channel creation notices (requires - chancreate module). - J Allows receipt of remote channel creation notices (requires - chancreate module). + d Allows receipt of local DNSBL messages (requires the dnsbl module). + D Allows receipt of remote DNSBL messages (requires the dnsbl module). + f Allows receipt of local filter messages (requires the filter module). + F Allows receipt of remote filter messages (requires the filter module). + g Allows receipt of globops (requires the globops module). + j Allows receipt of channel creation notices (requires the chancreate module). + J Allows receipt of remote channel creation notices (requires the chancreate module). k Allows receipt of local kill messages. 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 seenicks module). - N See remote nickname changes (requires 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. + 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). + 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. Q Allows receipt of remote quit messages. + 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 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)."> ###################### # EXTBANS # @@ -1046,45 +1093,48 @@ 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 channelban module). - n: Matches users in a matching connect class (requires + 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 + r: Matches users with a matching real name (requires the gecosban module). - s: Matches users on a matching server (requires serverban - module). - z: Matches users with a matching SSL certificate fingerprint - (requires sslmodes 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 operchans module). + an invite exception (requires the operchans module). R: Matches users logged into a matching account (requires - services account module). + the services account module). U: Matches unregistered users matching the given banmask. - (requires services account module). + (requires the services account module). Acting extbans: - c: Blocks any messages that contain color codes from - matching users (requires blockcolor module). - m: Blocks messages from matching users (requires muteban + 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 - nopartmsg module). + the nopartmsg module). A: Blocks invites by matching users even when +A is set - (requires allowinvite module). + (requires the allowinvite module). B: Blocks all capital or nearly all capital messages from - matching users (requires blockcaps module). - C: Blocks CTCPs from matching users (requires noctcp + matching users (requires the blockcaps module). + C: Blocks CTCPs from matching users (requires the noctcp module). N: Blocks nick changes from matching users (requires - nonicks module). - Q: Blocks kicks by matching users (requires nokicks - module). - S: Strips color/bold/underline from messages from matching - users (requires stripcolor module). - T: Blocks notices from matching users (requires nonotice + 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, @@ -1093,4 +1143,4 @@ 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 banredirect module)."> + when they try to join (requires the banredirect module).">