]>
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.", | |
c8273589 AS |
21 | " Note: Certain(alias) commands will not bind this way; ", |
22 | " you must bind them by name. ", | |
23 | " See $bREBINDALL$b to rebind everything.", | |
c8ca69a0 AS |
24 | "$b$b", |
25 | "For simplicity, you cannot bind to a command that is an alias.", | |
26 | "$b$b", | |
27 | "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)", | |
28 | "$b$b", | |
29 | "$uExamples$u", | |
30 | " bind X3 autoop *chanserv.uset\\ autoop", | |
31 | " bind O3 murder o3.trace gline nick $$1 duration 1m reason $$2-", | |
32 | " bind X3 * *chanserv.*", | |
33 | "$b$b", | |
c8273589 | 34 | "$uSee also:$u unbind, joiner, modcmd, rebindall"); |
d2dce5ac | 35 | |
a8370a20 AS |
36 | "commands" ("The following commands are available:", |
37 | "${index}", | |
38 | "$uSee Also$u: modcmd, command"); | |
d2dce5ac | 39 | |
c8273589 AS |
40 | "rebindall" ("/msg $S REBINDALL", |
41 | "Rebinds all available delault commands and aliases for each service and module currently loaded.", | |
42 | "Note: this does NOT remove any additional aliases or bindings you may have made, but will replace any you have deleted.", | |
43 | "Good to use after upgrades or after enabling 'email' support to ensure you have all commands bound to a service bot.", | |
44 | "$uSee also:$u bind (esp 'bind nick * *mod.*'), unbind, modcmd"); | |
45 | ||
d76ed9a9 AS |
46 | "god" ("/msg $C GOD [on|off]", |
47 | "Toggles security override, which grants you complete access to all channels. Please use carefully."); | |
d2dce5ac | 48 | |
d76ed9a9 AS |
49 | "help" ("/msg $S HELP [command]", |
50 | "Help will show you the information for the given command.", | |
51 | "All help files will use the same syntax, with optional parameters listed in [] and required parameters listed in <>.", | |
52 | "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 | 53 | |
d76ed9a9 AS |
54 | "readhelp" ("/msg $S READHELP <module>", |
55 | "Re-reads the module's help file from disk.", | |
56 | "$uSee Also:$u help"); | |
d2dce5ac | 57 | |
d76ed9a9 AS |
58 | "unbind" ("/msg $S UNBIND <service> <command>", |
59 | "Unbinds a command from a service, so that it is no longer accessible.", | |
60 | "Some commands (such as $bauth$b and $bbind$b) will not let you unbind their last binding -- for obvious reasons.", | |
61 | "$uSee Also:$u bind"); | |
d2dce5ac | 62 | |
d76ed9a9 AS |
63 | "timecmd" ("/msg $S TIMECMD <command and args>", |
64 | "Reports how long it takes to run the specified command."); | |
d2dce5ac | 65 | |
d76ed9a9 | 66 | "command" ("/msg $S COMMAND <command>", |
c8273589 AS |
67 | "Shows the restrictions on who can use the named command (and how).", |
68 | "$uSee Also:$u modcmd, bind"); | |
d2dce5ac | 69 | |
d76ed9a9 | 70 | "modcmd" ("/msg $S MODCMD <command> [<option> <newval> ...]", |
317ffe36 AS |
71 | "Displays and optionally changes options for the specified command. 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).", |
72 | "Note: For multi-word commands, escape the space with a '\'. Example: trace\ gline", | |
d76ed9a9 AS |
73 | "Supported options are:", |
74 | " FLAGS Comma-separated, +/- prefixed list of flags to add or remove.", | |
75 | " CHANNEL_ACCESS Minimum ChanServ access.", | |
76 | " OPER_ACCESS Minimum OpServ access.", | |
77 | " ACCOUNT_FLAGS Account flags to require or deny (for example, +R-S)", | |
c8273589 AS |
78 | "See the $bmodcmd flags$b help entry for a list of supported flags.", |
79 | "$uSee Also:$u modcmd flags, command, bind"); | |
d2dce5ac | 80 | |
d76ed9a9 AS |
81 | "modcmd flags" ("The following flags are supported for commands:", |
82 | " ACCEPTCHAN Treat a normal channel name (if specified) as the context for the command", | |
83 | " ACCEPTPLUSCHAN Accept modeless channel names as well as normal channel names", | |
84 | " AUTHED Require that the user be authed to use the command", | |
85 | " CHANNEL Require that an existing channel be given as the context", | |
86 | " CHANUSER Require that the user have $C access to the context", | |
87 | " DISABLED Command is disabled", | |
88 | " HELPING Require that the user have security override enabled", | |
89 | " IGNORE_CSUSPEND Allow a +REGCHAN command to work even if the channel is suspended", | |
90 | " JOINABLE Require that the user have $C access to the channel, be in the channel, or be network staff to use the command", | |
91 | " KEEPBOUND Do not let the last instance of the command be removed", | |
92 | " LOGHOSTMASK Log the user's ident, hostname and IP (as well as nick and account name)", | |
93 | " NOLOG Do not log the command at all", | |
94 | " NETWORKHELPER Allow network helpers to use the command", | |
95 | " OPER Allow opers to use the command", | |
96 | " QUALIFIED Require $b/msg Service@$s$b addressing when using the command", | |
97 | " REGCHAN Require a registered channel to be give as the context", | |
98 | " SUPPORTHELPER Allow support helpers to use the command", | |
99 | " TOY Command is a toy (cannot be invoked on a channel from outside the channel)", | |
100 | "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 | 101 | |
d76ed9a9 | 102 | "joiner" ("/msg $S JOINER [subcmd ...]", |
d2dce5ac AS |
103 | "Magically looks up subcommands and redirects to them. Use the command by itself to see what subcommands are known.", |
104 | "joiner is used with BIND to make complex subcommands."); | |
105 | ||
d76ed9a9 AS |
106 | "stats modules" ("/msg $S STATS MODULES [modulename]", |
107 | "With no module name argument, shows a list of loaded modules and brief statistics for each.", | |
108 | "When a module name is given, shows commands exported by that module.", | |
109 | "$uSee Also:$u stats services, command, modcmd, bind"); | |
d2dce5ac | 110 | |
d76ed9a9 AS |
111 | "stats services" ("/msg $S STATS SERVICES [botnick]", |
112 | "With no bot nick argument, shows a list of the service bots using the unified command framework, and brief statistics for each.", | |
113 | "When a bot nick is given, shows commands bound to that service.", | |
114 | "$uSee Also:$u stats modules, command, modcmd, bind, unbind"); | |
d2dce5ac | 115 | |
d76ed9a9 AS |
116 | "showcommands" ("/msg $S SHOWCOMMANDS [opserv-access] [channel-access]", |
117 | "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.", | |
118 | "$uSee Also:$u command"); | |
d2dce5ac | 119 | |
d76ed9a9 AS |
120 | "helpfiles" ("/msg $S HELPFILES <service> [module list]", |
121 | "With only a service nick, shows the helpfiles used by that service.", | |
ed05669c | 122 | "Give a list of modules (seperated by spaces), to set the order that the service will look up non-command help entries.", |
d76ed9a9 | 123 | "$uSee Also:$u bind, unbind"); |
d2dce5ac | 124 | |
d76ed9a9 AS |
125 | "service add" ("/msg $S SERVICE ADD <nick> <hostname> <description>", |
126 | "Creates a new service bot.", | |
127 | "$uSee Also:$u service rename, service trigger, service remove"); | |
d2dce5ac | 128 | |
d76ed9a9 AS |
129 | "service rename" ("/msg $S SERVICE RENAME <oldnick> <newnick>", |
130 | "Renames a service bot. Currently does not support the default services.", | |
131 | "$uSee Also:$u service add, service trigger, service remove"); | |
d2dce5ac | 132 | |
d76ed9a9 AS |
133 | "service trigger" ("/msg $S SERVICE TRIGGER <nick> [remove|<trigger>]", |
134 | "Sets or clears the trigger character that the named service uses to identify in-channel messages directed at it.", | |
135 | "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.", | |
136 | "If no argument is given, shows the current trigger for the service.", | |
137 | "$uSee Also:$u service add, service rename, service remove"); | |
d2dce5ac | 138 | |
d76ed9a9 | 139 | "service remove" ("/msg $S SERVICE REMOVE <nick> [<quit reason>]", |
ceafd592 | 140 | "Destroys a service. If a default service is named, it will be recreated when X3 restarts.", |
d76ed9a9 | 141 | "$uSee Also:$u service add, service rename, service trigger"); |
d2dce5ac | 142 | |
d76ed9a9 AS |
143 | "version" ("/msg $S version", |
144 | "Sends you version and copyright information for this software."); |