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.
This commit is contained in:
Sam Dodrill 2013-11-14 23:34:42 -05:00
parent 7f3382fe98
commit 9830333e9a
27 changed files with 79 additions and 43 deletions

View file

@ -1,6 +1,6 @@
CHANTRACE <#channel> 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. replaced by the server the users are on.
You must be a member of the channel to perform this command. You must be a member of the channel to perform this command.

View file

@ -9,7 +9,7 @@ NO PARAMETERS:
+s - Secret. Channel will not be shown in /whois and /list etc. +s - Secret. Channel will not be shown in /whois and /list etc.
+p - Private. Disables /knock to the channel. +p - Private. Disables /knock to the channel.
+m - Moderated. Only opped/voiced users may talk in 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. join the channel.
+r - Registered users only. Only users identified to services +r - Registered users only. Only users identified to services
may join. may join.

View file

@ -1,7 +1,7 @@
CONNECT <server_A> [port] [server_B] CONNECT <server_A> [port] [server_B]
When [server_B] is used, CONNECT asks [server_B] to When [server_B] is used, CONNECT asks [server_B] to
connect to <server_A>. Requires Oper Priv: R connect to <server_A>. Requires Oper Priv: oper:routing
The [port] must be specified with [server_B], this is The [port] must be specified with [server_B], this is
usually 6667. To use the default port in the connect usually 6667. To use the default port in the connect

View file

@ -5,6 +5,7 @@ Help files were written by the following people:
disasta David Daley <disasta@go.com> disasta David Daley <disasta@go.com>
Hwy101 W. Campbell <wcampbel@botbay.net> Hwy101 W. Campbell <wcampbel@botbay.net>
larne Edward Brocklesby <ejb@leguin.org.uk> larne Edward Brocklesby <ejb@leguin.org.uk>
lyska Sam Dodrill <shadowh511@gmail.com>
MoeBass anonymous <moe@moebass.com> MoeBass anonymous <moe@moebass.com>
screwedup Jonathan Roes <jroes@magenet.net> screwedup Jonathan Roes <jroes@magenet.net>
zartik Daniel Hemmerich <dan@spot.org> zartik Daniel Hemmerich <dan@spot.org>

View file

@ -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

View file

@ -3,7 +3,7 @@ DLINE [duration] <ip> :[reason] [| oper reason]
Adds a DLINE to the database which will deny any Adds a DLINE to the database which will deny any
connections from the IP address of the banned client. connections from the IP address of the banned client.
The banned client will receive a message saying 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, Duration is optional, and is in minutes. If specified,
the DLINE will not be saved in the database. the DLINE will not be saved in the database.
@ -17,4 +17,4 @@ DLINE [duration] <ip> ON irc.server :[reason] [| oper reason]
will dline the user on irc.server if irc.server accepts will dline the user on irc.server if irc.server accepts
remote dlines. irc.server can contain wildcards. remote dlines. irc.server can contain wildcards.
- Requires Oper Priv: K - Requires Oper Priv: oper:kline

View file

@ -3,5 +3,5 @@ KILL <nick> <reason>
Disconnects user <nick> from the IRC server he/she Disconnects user <nick> from the IRC server he/she
is connected to with reason <reason>. is connected to with reason <reason>.
- Requires Oper Priv: C - Requires Oper Priv: oper:local_kill
- Requires Oper Priv: O for users not on your IRC server - Requires Oper Priv: oper:global_kill for users not on your IRC server

View file

@ -23,4 +23,4 @@ KLINE [duration] <user@host> ON irc.server :[reason] [| oper reason]
will kline the user on irc.server if irc.server accepts will kline the user on irc.server if irc.server accepts
remote klines. irc.server can contain wildcards. remote klines. irc.server can contain wildcards.
- Requires Oper Priv: K - Requires Oper Priv: oper:kline

View file

@ -1,4 +1,4 @@
LOCOPS :<message> LOCOPS :<message>
Sends an LOCOPS message of <message> to all Sends a LOCOPS message of <message> to all
opers on local server who are umode +l opers on local server who are umode +l

View file

@ -1,8 +1,14 @@
MODLIST [match string] MODLIST [match string] [server.name]
-- List the modules that are currently loaded into the -- List the modules that are currently loaded into the
ircd, along with their address and version. ircd, along with their address and version.
When a match string is provided, modlist only prints When a match string is provided, modlist only prints
modules with names matching the match string. 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

View file

@ -1,8 +1,13 @@
MODLOAD <[path/]module.so> MODLOAD <[path/]module.so> [server.name]
-- Load a module into the ircd -- Load a module into the ircd
the optional path can be an absolute path the optional path can be an absolute path
from / or from the IRCD_PREFIX from / or from the IRCD_PREFIX
(ie modules/autoload/m_users.so) (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

View file

@ -1,6 +1,11 @@
MODRELOAD <module.so> MODRELOAD <module.so> [server.name]
-- Reload a module in the ircd -- Reload a module in the ircd
Use just the module name, the path is not needed. 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

View file

@ -1,7 +1,12 @@
MODRESTART MODRESTART [server.name]
-- Reload all modules into the ircd -- Reload all modules into the ircd
All modules are unloaded, then those in modules/autoload All modules are unloaded, then those in modules/autoload
are loaded 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

View file

@ -1,8 +1,13 @@
MODUNLOAD <module.so> MODUNLOAD <module.so> [server.name]
-- Unload a module from the ircd -- Unload a module from the ircd
Use just the module name, the path is not needed. Use just the module name, the path is not needed.
When a module is unloaded, all commands associated When a module is unloaded, all commands associated
with it are unloaded as well. 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

View file

@ -1,11 +1,11 @@
OPERSPY OPERSPY
Opers with the "oper_spy" flag will be allowed uses of the following 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. other servers.
whois !nick - Gives a full output of channels the user is in. 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. server or gecos match the mask.
who !#channel - Gives a full output of users on the channel. who !#channel - Gives a full output of users on the channel.
mode !#channel - Gives the full modes of a channel including any keys. mode !#channel - Gives the full modes of a channel including any keys.

View file

@ -3,4 +3,4 @@ OPERWALL :<message>
Sends an OPERWALL message of <message> to all Sends an OPERWALL message of <message> to all
opers who are umode +z opers who are umode +z
- Requires Oper Priv: L - Requires Oper Priv: oper:operwall

View file

@ -17,11 +17,11 @@ ircd.conf file.
TRESVS - Clears temporary nick and channel resvs TRESVS - Clears temporary nick and channel resvs
TXLINES - Clears temporary X Lines TXLINES - Clears temporary X Lines
- Requires Oper Priv: H - Requires Oper Priv: oper:rehash
REHASH [option] irc.server REHASH [option] irc.server
Rehashes [option], or the config file if none given, on irc.server if Rehashes [option], or the config file if none given, on irc.server if
irc.server accepts remote rehashes. irc.server accepts remote rehashes.
- Requires Oper Priv: HB - Requires Oper Privs: oper:rehash, oper:remoteban

View file

@ -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

View file

@ -1,4 +1,4 @@
SQUIT <server> [reason] SQUIT <server> [reason]
Splits <server> away from your side of the net with [reason]. Splits <server> 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

View file

@ -3,11 +3,11 @@ TRACE [server | nick] [location]
With no argument, TRACE gives a list of all clients connected With no argument, TRACE gives a list of all clients connected
to the local server, both users and operators. 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 to the specified server, and all servers, opers and -i users
on that server. 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. first two forms.
With one argument which is a client, TRACE displays the With one argument which is a client, TRACE displays the

View file

@ -1,12 +1,15 @@
MODE <nick> <+|-><modes> MODE <nick> <+|-><modes>
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 USERMODE DESCRIPTION
----------------------------------------------------------------- -----------------------------------------------------------------
+i - Designates this client 'invisible'. +i - Designates this client 'invisible'.
+g - "caller id" mode only allow accept clients to message you +g - "caller id" mode only allow accept clients to message you
+w - Can see oper and server wallops. +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. +o - Designates this client is an IRC Operator.
Use the /oper command to attain this. Use the /oper command to attain this.
* +a - Is marked as a server admin in whois. * +a - Is marked as a server admin in whois.

View file

@ -2,4 +2,4 @@ UNDLINE <ip>
Will attempt to undline the given <ip> Will attempt to undline the given <ip>
- Requires Oper Priv: U - Requires Oper Priv: oper:unkline

View file

@ -7,4 +7,4 @@ UNKLINE <user@host> ON irc.server will unkline
the user on irc.server if irc.server accepts the user on irc.server if irc.server accepts
remote unklines. remote unklines.
- Requires Oper Priv: U - Requires Oper Priv: oper:unkline

View file

@ -7,4 +7,4 @@ UNXLINE <gecos> ON <server>
Will attempt to unxline the given <gecos> on <server>. Will attempt to unxline the given <gecos> on <server>.
- Requires Oper Priv: X - Requires Oper Priv: oper:xline

View file

@ -5,4 +5,4 @@ who are umode +w (including non-opers).
Server sent WALLOPS go to all opers who are umode +w. Server sent WALLOPS go to all opers who are umode +w.
- Requires Oper Priv: M - Requires Oper Priv: oper:operwall

View file

@ -1,7 +1,7 @@
XLINE [time] <gecos> :<reason> XLINE [time] <gecos> :<reason>
Bans by gecos (aka 'real name') field. If [time] is not specified 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. minutes.
Eg. /quote xline eggdrop?bot :no bots Eg. /quote xline eggdrop?bot :no bots
@ -12,12 +12,12 @@ The <gecos> field contains certain special characters:
@ - Match any letter [A-Za-z] @ - Match any letter [A-Za-z]
# - Match any digit [0-9] # - 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 literal '\' character must also be escaped. You may also insert \s
which will be converted into a space. which will be converted into a space.
If the <gecos> field is purely numeric (ie "123") then the time If the <gecos> 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. numeric XLINE.
XLINE [time] <gecos> ON <server> :<reason> XLINE [time] <gecos> ON <server> :<reason>
@ -25,4 +25,4 @@ XLINE [time] <gecos> ON <server> :<reason>
Will attempt to set the XLINE on <server> if <server> accepts Will attempt to set the XLINE on <server> if <server> accepts
remote xlines. remote xlines.
- Requires Oper Priv: X - Requires Oper Priv: oper:xline

View file

@ -1,12 +1,14 @@
MODE <nick> <+|-><modes> MODE <nick> <+|-><modes>
Usermodes: User modes: (? designates that the umode is provided by an extension
and may not be present on this server)
USERMODE DESCRIPTION USERMODE DESCRIPTION
----------------------------------------------------------------- -----------------------------------------------------------------
+o - Designates this client is an IRC Operator. +o - Designates this client is an IRC Operator.
Use the /oper command to attain this. Use the /oper command to attain this.
+i - Designates this client 'invisible'. +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 +g - "caller id" mode only allow accept clients to message you
+w - Can see oper wallops. +w - Can see oper wallops.
+D - Deaf - ignores all channel messages. +D - Deaf - ignores all channel messages.