From 21e7efdadfa685ac1ddcb0a0a515502bc873302b Mon Sep 17 00:00:00 2001 From: Robby Date: Sun, 17 Feb 2019 15:58:31 +0100 Subject: Various text improvements: consistency, syntax, help and doc updates/fixes. --- docs/conf/helpop.conf.example | 402 ++++++++++++++++++++++++------------------ 1 file changed, 227 insertions(+), 175 deletions(-) (limited to 'docs/conf/helpop.conf.example') diff --git a/docs/conf/helpop.conf.example b/docs/conf/helpop.conf.example index bd184f6ef..3fdff9bee 100644 --- a/docs/conf/helpop.conf.example +++ b/docs/conf/helpop.conf.example @@ -3,7 +3,7 @@ # 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 @@ -34,14 +34,14 @@ parameter for this command. ACCEPT ADMIN AWAY COMMANDS CYCLE DCCALLOW FPART INFO INVITE ISON JOIN KICK KNOCK LINKS LIST LUSERS MAP MKPASSWD -MODE MODULES MOTD NAMES NICK NOTICE -OPER PART PASS PING PONG PRIVMSG -QUIT REMOVE SETNAME SILENCE SQUERY SSLINFO -STATS TBAN TIME TITLE TOPIC UNINVITE -USER USERHOST VERSION VHOST WATCH WHO -WHOIS WHOWAS"> +MODE MODULES MONITOR MOTD NAMES NICK +NOTICE OPER PART PASS PING PONG +PRIVMSG QUIT REMOVE SETNAME SILENCE SQUERY +SSLINFO STATS TBAN TIME TITLE TOPIC +UNINVITE USER USERHOST VERSION VHOST WATCH +WHO WHOIS WHOWAS"> - @@ -57,76 +57,103 @@ Uninvite a user from a channel, same syntax as INVITE."> +form of 1y2w3d4h5m6s - meaning one year, two weeks, three days, +four hours, five minutes and six seconds. All fields in this +format are optional. Alternatively, the ban may just be specified +as a number of seconds. All timed bans appear in the banlist as +normal bans and may be safely removed before their time is up."> - +form of 1y2w3d4h5m6s - meaning one year, two weeks, three days, +four hours, five minutes and six seconds. All fields in this +format are optional."> + + +This command accepts multiple nicks like so: +/ACCEPT +,-,+"> - - - +/WATCH + - +"> + + - - +Removes listmodes from a channel, optionally matching a glob-based pattern. +E.g. '/RMODE #channel b m:*' will remove all mute extbans on the channel."> - - - - - +Change your nickname to ."> - - - - - - - - - +Return a list of users on the channel(s) you provide."> - - - - - - - - - - +can no longer use it to enter the channel. The time can be specified +in the form of 1y2w3d4h5m6s - meaning one year, two weeks, three days, +four hours, five minutes and six seconds. All fields in this format +are optional. Alternatively, the time may just be specified as a number +of seconds. + +/INVITE without a parameter will list pending invitations for channels +you have been invited to."> +Shows all linked servers."> - +etc. If a servername is provided, then a whois is performed from +the server where the user is actually located rather than locally, +showing idle and signon times."> - - - +Sets your real name to the specified real name."> - +Returns the IP address and nickname of the given user(s)."> +nick!user@host or user@IP (wildcards accepted)."> - @@ -440,8 +479,8 @@ Opens the server up again for new connections."> Retrieves a list of users with more clones than the specified limit."> - +specified server, useful especially if used on a nickname that is +online on a remote server."> +Shows the date and time of all servers on the network."> - +The server matching will try to connect to the first +server in the config file matching ."> - - - +1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours, +five minutes and six seconds. All fields in this format are optional."> - - +Forces the user to part the channel(s), with an optional reason."> - - - +Kicks the given user from the specified channel, with an optional reason."> - - - +Sets your idle time to the specified value. + +The time can be specified in the form of 1y2w3d4h5m6s - meaning one year, +two weeks, three days, four hours, five minutes and six seconds. +All fields in this format are optional. Alternatively, the time may +just be specified as a number of seconds."> Sets your ident to the specified ident."> - +To remove this message again, use: +/SWHOIS :"> - - @@ -601,34 +650,34 @@ it to remain as such for the remainder of the session."> Allows a previously locked user to change nicks again."> - +Changes the host of the user to the specified host."> - +Changes the real name of the user to the specified real name."> - +Changes the ident of the user to the specified ident."> - +1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours, +five minutes and six seconds. All fields in this format are optional."> - - @@ -637,11 +686,11 @@ required, which must match the name of the local server."> Shows all currently available commands."> - - Disconnects the server matching the given server mask from this server."> - - - - - - - +1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours, +five minutes and six seconds. All fields in this format are optional."> +1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours, +five minutes and six seconds. All fields in this format are optional."> +1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours, +five minutes and six seconds. All fields in this format are optional."> +1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours, +five minutes and six seconds. All fields in this format are optional."> - +1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours, +five minutes and six seconds. All fields in this format are optional."> - - 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). @@ -810,8 +859,8 @@ using their cloak when they quit."> 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). + L Stops redirections done by the redirect module (requires + the redirect module). R Blocks private messages from unregistered users (requires the services account module). S Strips formatting codes out of private messages @@ -879,7 +928,8 @@ using their cloak when they quit."> 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 @@ -891,7 +941,8 @@ using their cloak when they quit."> 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 @@ -905,7 +956,8 @@ using their cloak when they quit."> 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). @@ -919,8 +971,8 @@ using their cloak when they quit."> 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) + 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 @@ -955,23 +1007,23 @@ 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. -- cgit v1.2.3