From 9830333e9a986110d775c997dfa5c591ac4fd379 Mon Sep 17 00:00:00 2001 From: Sam Dodrill Date: Thu, 14 Nov 2013 23:34:42 -0500 Subject: [PATCH] helpfiles: fix spelling, grammar remove old information What is done here: 1. All the outdated configuration flag information has been removed and replaced with the more current information. 2. Spellchecking has been done on all helpfiles and the actual errors have been fixed. --- help/opers/chantrace | 2 +- help/opers/cmode | 2 +- help/opers/connect | 2 +- help/opers/credits | 1 + help/opers/die | 8 +++++--- help/opers/dline | 4 ++-- help/opers/kill | 4 ++-- help/opers/kline | 2 +- help/opers/locops | 2 +- help/opers/modlist | 10 ++++++++-- help/opers/modload | 9 +++++++-- help/opers/modreload | 9 +++++++-- help/opers/modrestart | 9 +++++++-- help/opers/modunload | 9 +++++++-- help/opers/operspy | 4 ++-- help/opers/operwall | 2 +- help/opers/rehash | 4 ++-- help/opers/restart | 8 +++++--- help/opers/squit | 2 +- help/opers/trace | 4 ++-- help/opers/umode | 5 ++++- help/opers/undline | 2 +- help/opers/unkline | 2 +- help/opers/unxline | 2 +- help/opers/wallops | 2 +- help/opers/xline | 8 ++++---- help/users/umode | 4 +++- 27 files changed, 79 insertions(+), 43 deletions(-) diff --git a/help/opers/chantrace b/help/opers/chantrace index 7b636010..eea07afe 100644 --- a/help/opers/chantrace +++ b/help/opers/chantrace @@ -1,6 +1,6 @@ CHANTRACE <#channel> -Outputs a list of members in #channel in ETRACE format, with the classname +Outputs a list of members in #channel in ETRACE format, with the class name replaced by the server the users are on. You must be a member of the channel to perform this command. diff --git a/help/opers/cmode b/help/opers/cmode index cce53231..97cbbd8d 100644 --- a/help/opers/cmode +++ b/help/opers/cmode @@ -9,7 +9,7 @@ NO PARAMETERS: +s - Secret. Channel will not be shown in /whois and /list etc. +p - Private. Disables /knock to the channel. +m - Moderated. Only opped/voiced users may talk in channel. - +i - Invite only. Users need to be /invite'd or match a +I to + +i - Invite only. Users need to be invited or match a +I to join the channel. +r - Registered users only. Only users identified to services may join. diff --git a/help/opers/connect b/help/opers/connect index 929bfb8c..c2326fa6 100644 --- a/help/opers/connect +++ b/help/opers/connect @@ -1,7 +1,7 @@ CONNECT [port] [server_B] When [server_B] is used, CONNECT asks [server_B] to -connect to . Requires Oper Priv: R +connect to . Requires Oper Priv: oper:routing The [port] must be specified with [server_B], this is usually 6667. To use the default port in the connect diff --git a/help/opers/credits b/help/opers/credits index 5919ddef..5f2628ed 100644 --- a/help/opers/credits +++ b/help/opers/credits @@ -5,6 +5,7 @@ Help files were written by the following people: disasta David Daley Hwy101 W. Campbell larne Edward Brocklesby +lyska Sam Dodrill MoeBass anonymous screwedup Jonathan Roes zartik Daniel Hemmerich diff --git a/help/opers/die b/help/opers/die index b81cce92..ec816e39 100644 --- a/help/opers/die +++ b/help/opers/die @@ -1,5 +1,7 @@ -DIE server.name +DIE server.name [server.name] -Terminates the IRC server +Terminates the IRC server. If a second server name +is provided, remotely terminate that server. In this +case, both server names must match. -- Requires Oper Priv: D +- Requires Oper Priv: oper:die diff --git a/help/opers/dline b/help/opers/dline index 144c2d2a..e29ea3e5 100644 --- a/help/opers/dline +++ b/help/opers/dline @@ -3,7 +3,7 @@ DLINE [duration] :[reason] [| oper reason] Adds a DLINE to the database which will deny any connections from the IP address of the banned client. The banned client will receive a message saying -he/she is banned with reason [reason]. +they are banned with reason [reason]. Duration is optional, and is in minutes. If specified, the DLINE will not be saved in the database. @@ -17,4 +17,4 @@ DLINE [duration] ON irc.server :[reason] [| oper reason] will dline the user on irc.server if irc.server accepts remote dlines. irc.server can contain wildcards. -- Requires Oper Priv: K +- Requires Oper Priv: oper:kline diff --git a/help/opers/kill b/help/opers/kill index 93153ff6..3e617ffd 100644 --- a/help/opers/kill +++ b/help/opers/kill @@ -3,5 +3,5 @@ KILL Disconnects user from the IRC server he/she is connected to with reason . -- Requires Oper Priv: C -- Requires Oper Priv: O for users not on your IRC server +- Requires Oper Priv: oper:local_kill +- Requires Oper Priv: oper:global_kill for users not on your IRC server diff --git a/help/opers/kline b/help/opers/kline index 705928ba..0895e148 100644 --- a/help/opers/kline +++ b/help/opers/kline @@ -23,4 +23,4 @@ KLINE [duration] ON irc.server :[reason] [| oper reason] will kline the user on irc.server if irc.server accepts remote klines. irc.server can contain wildcards. -- Requires Oper Priv: K +- Requires Oper Priv: oper:kline diff --git a/help/opers/locops b/help/opers/locops index e7ef5d48..c0645181 100644 --- a/help/opers/locops +++ b/help/opers/locops @@ -1,4 +1,4 @@ LOCOPS : -Sends an LOCOPS message of to all +Sends a LOCOPS message of to all opers on local server who are umode +l diff --git a/help/opers/modlist b/help/opers/modlist index 58c5b0da..adb1bce4 100644 --- a/help/opers/modlist +++ b/help/opers/modlist @@ -1,8 +1,14 @@ -MODLIST [match string] +MODLIST [match string] [server.name] -- List the modules that are currently loaded into the ircd, along with their address and version. When a match string is provided, modlist only prints modules with names matching the match string. -- Requires Oper Priv: A +A server name may also be provided to list currently +loaded modules on that server if you have the modules +shared priv on that server. If you're doing modlist +on a remote server, a match string is required, but * +will list all modules. + +- Requires Oper Priv: oper:admin diff --git a/help/opers/modload b/help/opers/modload index 4ad68252..2e47b70a 100644 --- a/help/opers/modload +++ b/help/opers/modload @@ -1,8 +1,13 @@ -MODLOAD <[path/]module.so> +MODLOAD <[path/]module.so> [server.name] -- Load a module into the ircd the optional path can be an absolute path from / or from the IRCD_PREFIX (ie modules/autoload/m_users.so) -- Requires Oper Priv: A +A server name may also be provided to load a module +on a remote server if you have the modules shared priv +on that server. Wildcards for server name may also be +used to load a module on multiple servers. + +- Requires Oper Priv: oper:admin diff --git a/help/opers/modreload b/help/opers/modreload index 96abca29..94fe40ca 100644 --- a/help/opers/modreload +++ b/help/opers/modreload @@ -1,6 +1,11 @@ -MODRELOAD +MODRELOAD [server.name] -- Reload a module in the ircd Use just the module name, the path is not needed. -- Requires Oper Priv: A +A server name may also be provided to reload a module +on a remote server if you have the modules shared priv +on that server. Wildcards for server name may also be +used to reload a module on multiple servers. + +- Requires Oper Priv: oper:admin diff --git a/help/opers/modrestart b/help/opers/modrestart index 12ceb91f..ee279093 100644 --- a/help/opers/modrestart +++ b/help/opers/modrestart @@ -1,7 +1,12 @@ -MODRESTART +MODRESTART [server.name] -- Reload all modules into the ircd All modules are unloaded, then those in modules/autoload are loaded -- Requires Oper Priv: A +A server name may also be provided to reload all modules +on a remote server if you have the modules shared priv +on that server. Wildcards for server name may also be +used to reload all modules on multiple servers. + +- Requires Oper Priv: oper:admin diff --git a/help/opers/modunload b/help/opers/modunload index 4dca1136..5576f879 100644 --- a/help/opers/modunload +++ b/help/opers/modunload @@ -1,8 +1,13 @@ -MODUNLOAD +MODUNLOAD [server.name] -- Unload a module from the ircd Use just the module name, the path is not needed. When a module is unloaded, all commands associated with it are unloaded as well. -- Requires Oper Priv: A +A server name may also be provided to unload a module +from a remote server if you have the modules shared priv +on that server. Wildcards for server name may also be used +to unload a module from multiple servers. + +- Requires Oper Priv: oper:admin diff --git a/help/opers/operspy b/help/opers/operspy index a667d7b9..7209fba9 100644 --- a/help/opers/operspy +++ b/help/opers/operspy @@ -1,11 +1,11 @@ OPERSPY Opers with the "oper_spy" flag will be allowed uses of the following -commands if they are compiled in. Usage will be sent to +Z and all +commands if they are compiled in. Usage will be sent to +Z and all other servers. whois !nick - Gives a full output of channels the user is in. -who !mask - Lists all users networkwide whose nick, ident, host, +who !mask - Lists all users on the network whose nick, ident, host, server or gecos match the mask. who !#channel - Gives a full output of users on the channel. mode !#channel - Gives the full modes of a channel including any keys. diff --git a/help/opers/operwall b/help/opers/operwall index 55f49de0..87d6e3cc 100644 --- a/help/opers/operwall +++ b/help/opers/operwall @@ -3,4 +3,4 @@ OPERWALL : Sends an OPERWALL message of to all opers who are umode +z -- Requires Oper Priv: L +- Requires Oper Priv: oper:operwall diff --git a/help/opers/rehash b/help/opers/rehash index 709a90b0..2226499d 100644 --- a/help/opers/rehash +++ b/help/opers/rehash @@ -17,11 +17,11 @@ ircd.conf file. TRESVS - Clears temporary nick and channel resvs TXLINES - Clears temporary X Lines -- Requires Oper Priv: H +- Requires Oper Priv: oper:rehash REHASH [option] irc.server Rehashes [option], or the config file if none given, on irc.server if irc.server accepts remote rehashes. -- Requires Oper Priv: HB +- Requires Oper Privs: oper:rehash, oper:remoteban diff --git a/help/opers/restart b/help/opers/restart index 868a470a..d8a13fde 100644 --- a/help/opers/restart +++ b/help/opers/restart @@ -1,5 +1,7 @@ -RESTART server.name +RESTART server.name [server.name] -Restarts the IRC server. +Restarts the IRC server. If a second server name +is provided, remotely restart that server. In this +case, both server names must match. -- Requires Oper Priv: D +- Requires Oper Priv: oper:admin diff --git a/help/opers/squit b/help/opers/squit index 30718de6..8b080b7e 100644 --- a/help/opers/squit +++ b/help/opers/squit @@ -1,4 +1,4 @@ SQUIT [reason] Splits away from your side of the net with [reason]. -- Requires Oper Priv: R for servers not connected to you +- Requires Oper Priv: oper:remote for servers not connected to you diff --git a/help/opers/trace b/help/opers/trace index cfcb8716..bbe4232a 100644 --- a/help/opers/trace +++ b/help/opers/trace @@ -3,11 +3,11 @@ TRACE [server | nick] [location] With no argument, TRACE gives a list of all clients connected to the local server, both users and operators. -With one argument which is a server, TRACE displays the path +With one argument which is a server, TRACE displays the path to the specified server, and all servers, opers and -i users on that server. -Nonopers can only see themselves, opers and servers in the +Nonopers can only see themselves, opers, and servers in the first two forms. With one argument which is a client, TRACE displays the diff --git a/help/opers/umode b/help/opers/umode index 788c6254..c7f94a6f 100644 --- a/help/opers/umode +++ b/help/opers/umode @@ -1,12 +1,15 @@ MODE <+|-> -Usermodes: (* designates that the umode is oper only) +User modes: (* designates that the umode is oper only) + (? designates that the umode is provided by an extension + and may not be present on this server) USERMODE DESCRIPTION ----------------------------------------------------------------- +i - Designates this client 'invisible'. +g - "caller id" mode only allow accept clients to message you +w - Can see oper and server wallops. + ? +h - Has a cloaked host. May be +x depending on cloaking module +o - Designates this client is an IRC Operator. Use the /oper command to attain this. * +a - Is marked as a server admin in whois. diff --git a/help/opers/undline b/help/opers/undline index b2b7b106..2f656963 100644 --- a/help/opers/undline +++ b/help/opers/undline @@ -2,4 +2,4 @@ UNDLINE Will attempt to undline the given -- Requires Oper Priv: U +- Requires Oper Priv: oper:unkline diff --git a/help/opers/unkline b/help/opers/unkline index ad1b9e6f..83ee5330 100644 --- a/help/opers/unkline +++ b/help/opers/unkline @@ -7,4 +7,4 @@ UNKLINE ON irc.server will unkline the user on irc.server if irc.server accepts remote unklines. -- Requires Oper Priv: U +- Requires Oper Priv: oper:unkline diff --git a/help/opers/unxline b/help/opers/unxline index fb556b80..3ce3f7e0 100644 --- a/help/opers/unxline +++ b/help/opers/unxline @@ -7,4 +7,4 @@ UNXLINE ON Will attempt to unxline the given on . -- Requires Oper Priv: X +- Requires Oper Priv: oper:xline diff --git a/help/opers/wallops b/help/opers/wallops index 9eec6d23..a4186107 100644 --- a/help/opers/wallops +++ b/help/opers/wallops @@ -5,4 +5,4 @@ who are umode +w (including non-opers). Server sent WALLOPS go to all opers who are umode +w. -- Requires Oper Priv: M +- Requires Oper Priv: oper:operwall diff --git a/help/opers/xline b/help/opers/xline index 7f7d8bf6..68529468 100644 --- a/help/opers/xline +++ b/help/opers/xline @@ -1,7 +1,7 @@ XLINE [time] : Bans by gecos (aka 'real name') field. If [time] is not specified -this is added to the database, otherwise is temporary for [time] +this is added to the database, otherwise is temporary for [time] minutes. Eg. /quote xline eggdrop?bot :no bots @@ -12,12 +12,12 @@ The field contains certain special characters: @ - Match any letter [A-Za-z] # - Match any digit [0-9] -To use a literal one of these characters, escape it with '\'. A +To use a literal one of these characters, escape it with '\'. A literal '\' character must also be escaped. You may also insert \s which will be converted into a space. If the field is purely numeric (ie "123") then the time -field must be specified. "0" must be used to denote a permanent +field must be specified. "0" must be used to denote a permanent numeric XLINE. XLINE [time] ON : @@ -25,4 +25,4 @@ XLINE [time] ON : Will attempt to set the XLINE on if accepts remote xlines. -- Requires Oper Priv: X +- Requires Oper Priv: oper:xline diff --git a/help/users/umode b/help/users/umode index 00b7743b..2e8a254a 100644 --- a/help/users/umode +++ b/help/users/umode @@ -1,12 +1,14 @@ MODE <+|-> -Usermodes: +User modes: (? designates that the umode is provided by an extension + and may not be present on this server) USERMODE DESCRIPTION ----------------------------------------------------------------- +o - Designates this client is an IRC Operator. Use the /oper command to attain this. +i - Designates this client 'invisible'. + ? +h - Has a cloaked host. May be +x depending on cloaking module +g - "caller id" mode only allow accept clients to message you +w - Can see oper wallops. +D - Deaf - ignores all channel messages.