src/modcmd.help

   1 "bind" ("/msg $S BIND <service> <bindname> <command> [additional args..]",
   2         "Binds (adds) a command to an existing service.  $bbindname$b is the name of the new command for the service.  $bcommand$b may be one of:",
   3         "  CommandName              To refer to a command on the same service.",
   4         "  ServiceNick.CommandName  To refer to a command bound on a different service such as $O, $C, $N, etc.",
   5         "  *ModuleName.CommandName  To bind a command directly from a module (note the asterisk before the module name).",
   6         "  *ModuleName.*            To bind all commands from the named module, where ModuleName is one of OpServ, NickServ, ChanServ, modcmd, or others.",
   7         "For simplicity, you cannot bind to a command that is itself an alias.  Certain commands will not bound with the last form; you must bind them by name.",
   8         "(A command binding is very similar to an alias, but only pays the speed penalty for alias expansion when there are additional arguments in the binding.)",
   9         "If you want to be able to bind $bfoo bar$b as a command, you need to bind $bfoo$b to modcmd.joiner first.",
  10         "$uSee also:$u unbind, joiner");
  11
  12 "commands" "${index}";
  13
  14 "god" ("/msg $C GOD [on|off]",
  15         "Toggles security override, which grants you complete access to all channels. Please use carefully.");
  16
  17 "help" ("/msg $S HELP [command]",
  18         "Help will show you the information for the given command.",
  19         "All help files will use the same syntax, with optional parameters listed in [] and required parameters listed in <>.",
  20         "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.");
  21
  22 "readhelp" ("/msg $S READHELP <module>",
  23         "Re-reads the module's help file from disk.",
  24         "$uSee Also:$u help");
  25
  26 "unbind" ("/msg $S UNBIND <service> <command>",
  27         "Unbinds a command from a service, so that it is no longer accessible.",
  28         "Some commands (such as $bauth$b and $bbind$b) will not let you unbind their last binding -- for obvious reasons.",
  29         "$uSee Also:$u bind");
  30
  31 "timecmd" ("/msg $S TIMECMD <command and args>",
  32         "Reports how long it takes to run the specified command.");
  33
  34 "command" ("/msg $S COMMAND <command>",
  35         "Shows the restrictions on who can use the named command (and how).");
  36
  37 "modcmd" ("/msg $S MODCMD <command> [<option> <newval> ...]",
  38         "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).",
  39         "Supported options are:",
  40         "  FLAGS          Comma-separated, +/- prefixed list of flags to add or remove.",
  41         "  CHANNEL_ACCESS Minimum ChanServ access.",
  42         "  OPER_ACCESS    Minimum OpServ access.",
  43         "  ACCOUNT_FLAGS  Account flags to require or deny (for example, +R-S)",
  44         "See the $bmodcmd flags$b help entry for a list of supported flags.");
  45
  46 "modcmd flags" ("The following flags are supported for commands:",
  47         "  ACCEPTCHAN     Treat a normal channel name (if specified) as the context for the command",
  48         "  ACCEPTPLUSCHAN Accept modeless channel names as well as normal channel names",
  49         "  AUTHED         Require that the user be authed to use the command",
  50         "  CHANNEL        Require that an existing channel be given as the context",
  51         "  CHANUSER       Require that the user have $C access to the context",
  52         "  DISABLED       Command is disabled",
  53         "  HELPING        Require that the user have security override enabled",
  54         "  IGNORE_CSUSPEND  Allow a +REGCHAN command to work even if the channel is suspended",
  55         "  JOINABLE       Require that the user have $C access to the channel, be in the channel, or be network staff to use the command",
  56         "  KEEPBOUND      Do not let the last instance of the command be removed",
  57         "  LOGHOSTMASK    Log the user's ident, hostname and IP (as well as nick and account name)",
  58         "  NOLOG          Do not log the command at all",
  59         "  NETWORKHELPER  Allow network helpers to use the command",
  60         "  OPER           Allow opers to use the command",
  61         "  QUALIFIED      Require $b/msg Service@$s$b addressing when using the command",
  62         "  REGCHAN        Require a registered channel to be give as the context",
  63         "  SUPPORTHELPER  Allow support helpers to use the command",
  64         "  TOY            Command is a toy (cannot be invoked on a channel from outside the channel)",
  65         "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.");
  66
  67 "joiner" ("/msg $S JOINER [subcmd ...]",
  68         "Magically looks up subcommands and redirects to them.  Use the command by itself to see what subcommands are known.",
  69         "joiner is used with BIND to make complex subcommands.");
  70
  71 "stats modules" ("/msg $S STATS MODULES [modulename]",
  72         "With no module name argument, shows a list of loaded modules and brief statistics for each.",
  73         "When a module name is given, shows commands exported by that module.",
  74         "$uSee Also:$u stats services, command, modcmd, bind");
  75
  76 "stats services" ("/msg $S STATS SERVICES [botnick]",
  77         "With no bot nick argument, shows a list of the service bots using the unified command framework, and brief statistics for each.",
  78         "When a bot nick is given, shows commands bound to that service.",
  79         "$uSee Also:$u stats modules, command, modcmd, bind, unbind");
  80
  81 "showcommands" ("/msg $S SHOWCOMMANDS [opserv-access] [channel-access]",
  82         "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.",
  83         "$uSee Also:$u command");
  84
  85 "helpfiles" ("/msg $S HELPFILES <service> [module list]",
  86         "With only a service nick, shows the helpfiles used by that service.",
  87         "With a list of modules, sets the order that the service will look up non-command help entries.",
  88         "$uSee Also:$u bind, unbind");
  89
  90 "service add" ("/msg $S SERVICE ADD <nick> <hostname> <description>",
  91         "Creates a new service bot.",
  92         "$uSee Also:$u service rename, service trigger, service remove");
  93
  94 "service rename" ("/msg $S SERVICE RENAME <oldnick> <newnick>",
  95         "Renames a service bot.  Currently does not support the default services.",
  96         "$uSee Also:$u service add, service trigger, service remove");
  97
  98 "service trigger" ("/msg $S SERVICE TRIGGER <nick> [remove|<trigger>]",
  99         "Sets or clears the trigger character that the named service uses to identify in-channel messages directed at it.",
 100         "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.",
 101         "If no argument is given, shows the current trigger for the service.",
 102         "$uSee Also:$u service add, service rename, service remove");
 103
 104 "service remove" ("/msg $S SERVICE REMOVE <nick> [<quit reason>]",
 105         "Destroys a service.  If a default service is named, it will be recreated when X3 restarts.",
 106         "$uSee Also:$u service add, service rename, service trigger");
 107
 108 "version" ("/msg $S version",
 109         "Sends you version and copyright information for this software.");