]>
Commit | Line | Data |
---|---|---|
c8ca69a0 AS |
1 | "bind" ("/msg $S BIND <ServiceNick> <BindName> [Nick|*Module.]<Command> [Arg [Arg[..]]]", |
2 | "Bind creates a command. ", | |
3 | " $bServiceNick$b is which service the new command will work on.", | |
4 | " $bBindName$b is the name of the new command you are making.", | |
5 | " $bCommand$b To refer to a command on the same service.", | |
6 | " $bNick$b To refer to a command on a different ", | |
7 | " service such as $O, $C, $N, etc.", | |
8 | " $b*Module$b To bind a command directly from a module such as", | |
9 | " ChanServ, OpServ, NickServ, modcmd, etc", | |
10 | " (note the asterisk before the module name).", | |
11 | " $barg(s)$b Can be anything, or you can use $$1 $$2 $$3 etc", | |
12 | " which will be replaced with the arguments passed", | |
13 | " to the command. Use a - after ($$2-) to indicate", | |
14 | " that argument and all arguments after it.", | |
15 | "$b$b", | |
16 | "There is a special case to load ALL commands from a module:", | |
17 | "/msg $S bind <serviceNick> * *<Module>.* ", | |
18 | " You may need to run this after installing previously", | |
19 | " missing modules, or making changes such as enabling", | |
20 | " the email features, so all the commands are bound.", | |
21 | " Note: Certain(??) commands will not bind this way; ", | |
22 | " you must bind them by name.", | |
23 | "$b$b", | |
24 | "For simplicity, you cannot bind to a command that is an alias.", | |
25 | "$b$b", | |
26 | "If you want to bind $bfoo bar$b as a command, bind $bfoo$b to $b*modcmd.joiner$b first, unless foo is a builtin command such as uset, in which case use '\\' to escape the space (example: $bbind x3 uset\ autoop x3.uset\ autoop$b)", | |
27 | "$b$b", | |
28 | "$uExamples$u", | |
29 | " bind X3 autoop *chanserv.uset\\ autoop", | |
30 | " bind O3 murder o3.trace gline nick $$1 duration 1m reason $$2-", | |
31 | " bind X3 * *chanserv.*", | |
32 | "$b$b", | |
d2dce5ac AS |
33 | "$uSee also:$u unbind, joiner"); |
34 | ||
d76ed9a9 | 35 | "commands" "${index}"; |
d2dce5ac | 36 | |
d76ed9a9 AS |
37 | "god" ("/msg $C GOD [on|off]", |
38 | "Toggles security override, which grants you complete access to all channels. Please use carefully."); | |
d2dce5ac | 39 | |
d76ed9a9 AS |
40 | "help" ("/msg $S HELP [command]", |
41 | "Help will show you the information for the given command.", | |
42 | "All help files will use the same syntax, with optional parameters listed in [] and required parameters listed in <>.", | |
43 | "To see what commands are available for use with $S, type /msg $S help commands. For help on any specific command or topic, type /msg $S help command."); | |
d2dce5ac | 44 | |
d76ed9a9 AS |
45 | "readhelp" ("/msg $S READHELP <module>", |
46 | "Re-reads the module's help file from disk.", | |
47 | "$uSee Also:$u help"); | |
d2dce5ac | 48 | |
d76ed9a9 AS |
49 | "unbind" ("/msg $S UNBIND <service> <command>", |
50 | "Unbinds a command from a service, so that it is no longer accessible.", | |
51 | "Some commands (such as $bauth$b and $bbind$b) will not let you unbind their last binding -- for obvious reasons.", | |
52 | "$uSee Also:$u bind"); | |
d2dce5ac | 53 | |
d76ed9a9 AS |
54 | "timecmd" ("/msg $S TIMECMD <command and args>", |
55 | "Reports how long it takes to run the specified command."); | |
d2dce5ac | 56 | |
d76ed9a9 AS |
57 | "command" ("/msg $S COMMAND <command>", |
58 | "Shows the restrictions on who can use the named command (and how)."); | |
d2dce5ac | 59 | |
d76ed9a9 AS |
60 | "modcmd" ("/msg $S MODCMD <command> [<option> <newval> ...]", |
61 | "Displays options for the specified command, or changes the options and values listed. The command name may be prefixed with $bServiceNick.$b to specify another service's command (for example, $N.AUTH to refer to the auth command).", | |
62 | "Supported options are:", | |
63 | " FLAGS Comma-separated, +/- prefixed list of flags to add or remove.", | |
64 | " CHANNEL_ACCESS Minimum ChanServ access.", | |
65 | " OPER_ACCESS Minimum OpServ access.", | |
66 | " ACCOUNT_FLAGS Account flags to require or deny (for example, +R-S)", | |
67 | "See the $bmodcmd flags$b help entry for a list of supported flags."); | |
d2dce5ac | 68 | |
d76ed9a9 AS |
69 | "modcmd flags" ("The following flags are supported for commands:", |
70 | " ACCEPTCHAN Treat a normal channel name (if specified) as the context for the command", | |
71 | " ACCEPTPLUSCHAN Accept modeless channel names as well as normal channel names", | |
72 | " AUTHED Require that the user be authed to use the command", | |
73 | " CHANNEL Require that an existing channel be given as the context", | |
74 | " CHANUSER Require that the user have $C access to the context", | |
75 | " DISABLED Command is disabled", | |
76 | " HELPING Require that the user have security override enabled", | |
77 | " IGNORE_CSUSPEND Allow a +REGCHAN command to work even if the channel is suspended", | |
78 | " JOINABLE Require that the user have $C access to the channel, be in the channel, or be network staff to use the command", | |
79 | " KEEPBOUND Do not let the last instance of the command be removed", | |
80 | " LOGHOSTMASK Log the user's ident, hostname and IP (as well as nick and account name)", | |
81 | " NOLOG Do not log the command at all", | |
82 | " NETWORKHELPER Allow network helpers to use the command", | |
83 | " OPER Allow opers to use the command", | |
84 | " QUALIFIED Require $b/msg Service@$s$b addressing when using the command", | |
85 | " REGCHAN Require a registered channel to be give as the context", | |
86 | " SUPPORTHELPER Allow support helpers to use the command", | |
87 | " TOY Command is a toy (cannot be invoked on a channel from outside the channel)", | |
88 | "Note: If any of SUPPORTHELPER, NETWORKHELPER, OPER, any of the specified flags is considered sufficient. For example, NETWORKHELPER and OPER both specified means both network helpers and opers can use the command."); | |
d2dce5ac | 89 | |
d76ed9a9 | 90 | "joiner" ("/msg $S JOINER [subcmd ...]", |
d2dce5ac AS |
91 | "Magically looks up subcommands and redirects to them. Use the command by itself to see what subcommands are known.", |
92 | "joiner is used with BIND to make complex subcommands."); | |
93 | ||
d76ed9a9 AS |
94 | "stats modules" ("/msg $S STATS MODULES [modulename]", |
95 | "With no module name argument, shows a list of loaded modules and brief statistics for each.", | |
96 | "When a module name is given, shows commands exported by that module.", | |
97 | "$uSee Also:$u stats services, command, modcmd, bind"); | |
d2dce5ac | 98 | |
d76ed9a9 AS |
99 | "stats services" ("/msg $S STATS SERVICES [botnick]", |
100 | "With no bot nick argument, shows a list of the service bots using the unified command framework, and brief statistics for each.", | |
101 | "When a bot nick is given, shows commands bound to that service.", | |
102 | "$uSee Also:$u stats modules, command, modcmd, bind, unbind"); | |
d2dce5ac | 103 | |
d76ed9a9 AS |
104 | "showcommands" ("/msg $S SHOWCOMMANDS [opserv-access] [channel-access]", |
105 | "Shows commands which you can execute (with their required access levels). If you give a numeric $O access level or text $C access name, it further restricts output to only show commands which can be executed by users with that access.", | |
106 | "$uSee Also:$u command"); | |
d2dce5ac | 107 | |
d76ed9a9 AS |
108 | "helpfiles" ("/msg $S HELPFILES <service> [module list]", |
109 | "With only a service nick, shows the helpfiles used by that service.", | |
110 | "With a list of modules, sets the order that the service will look up non-command help entries.", | |
111 | "$uSee Also:$u bind, unbind"); | |
d2dce5ac | 112 | |
d76ed9a9 AS |
113 | "service add" ("/msg $S SERVICE ADD <nick> <hostname> <description>", |
114 | "Creates a new service bot.", | |
115 | "$uSee Also:$u service rename, service trigger, service remove"); | |
d2dce5ac | 116 | |
d76ed9a9 AS |
117 | "service rename" ("/msg $S SERVICE RENAME <oldnick> <newnick>", |
118 | "Renames a service bot. Currently does not support the default services.", | |
119 | "$uSee Also:$u service add, service trigger, service remove"); | |
d2dce5ac | 120 | |
d76ed9a9 AS |
121 | "service trigger" ("/msg $S SERVICE TRIGGER <nick> [remove|<trigger>]", |
122 | "Sets or clears the trigger character that the named service uses to identify in-channel messages directed at it.", | |
123 | "To remove a trigger, use the word $bremove$b (or $bnone$b) as the argument. Otherwise, the first letter of the argument will be used as the new trigger.", | |
124 | "If no argument is given, shows the current trigger for the service.", | |
125 | "$uSee Also:$u service add, service rename, service remove"); | |
d2dce5ac | 126 | |
d76ed9a9 | 127 | "service remove" ("/msg $S SERVICE REMOVE <nick> [<quit reason>]", |
ceafd592 | 128 | "Destroys a service. If a default service is named, it will be recreated when X3 restarts.", |
d76ed9a9 | 129 | "$uSee Also:$u service add, service rename, service trigger"); |
d2dce5ac | 130 | |
d76ed9a9 AS |
131 | "version" ("/msg $S version", |
132 | "Sends you version and copyright information for this software."); |