Version 2 vs 6
Version 2 vs 6
Edits
Edits
- Delete by stwalkerster, Version 6
- Jan 28 2022 8:20 PM
- Edit by stwalkerster, Version 2
- Jul 3 2018 10:44 PM
Edit Older Version 2... |
Content Changes
Content Changes
The latest help for all commands can be found using the `=help` command.
### Help ###
Requires: Standard
```
=help
```
```
=help <Command>
```
Returns all available help for the specified command.
```
=help <Command> <Subcommand>
```
Returns the help for the specified subcommand.
Location: `Stwalkerster.Bot.CommandLib.Commands`
### Die ###
Requires: Owner
```
=die
```
Shuts down the bot.
Location: `Stwalkerster.Bot.CommandLib.Commands.BotManagement`
### Command Access ###
Requires: Standard
```
=commandaccess <command>
```
Retrieves the flag required to use the specified command.
Location: `Stwalkerster.Bot.CommandLib.Commands.AccessControl`
### My Flags ###
Requires: Standard
```
=myflags
=myaccess
=whoami
```
Retrieves the flags available to the current user.
Location: `Stwalkerster.Bot.CommandLib.Commands.AccessControl`
### Stalk ###
Requires: Protected
```
=stalk list
```
Lists all configured stalks
```
=stalk report
```
Sends an email listing the configured stalks
```
=stalk add <Flag>
```
Adds a new unconfigured stalk
```
=stalk del <Flag>
```
Deletes a stalk
```
=stalk enabled <Flag> <true|false>
```
Marks a stalk as enabled or disabled
```
=stalk mail <Flag> <true|false>
```
Enables or disables email notifications for each trigger of the specified stalk
```
=stalk description <Flag> <Description...>
```
Sets the description of the specified stalk
```
=stalk expiry <Flag> <Description...>
```
Sets the description of the specified stalk
```
=stalk set <Flag> <user|page|summary|xml> <Match...>
```
Sets the stalk configuration of the specified stalk to specified user, page, or edit summary regex. Alternatively, manually specify an XML tree (advanced).
```
=stalk and <Flag> <user|page|summary|xml> <Match...>
```
Sets the stalk configuration of the specified stalk to the logical AND of the current configuration, and a specified user, page, or edit summary regex; or XML tree (advanced).
```
=stalk or <Flag> <user|page|summary|xml> <Match...>
```
Sets the stalk configuration of the specified stalk to the logical OR of the current configuration, and a specified user, page, or edit summary regex; or XML tree (advanced).
An XML search tree is an XML root element from the list: `and`, `or`, `not`, `xor`, `true`, `false`, `user`, `page`, `summary`, `flag`, `incategory`, `log`, `usergroup`, `x-of`.
`xor` MUST have two child nodes, `not` MUST have one child node, `and`, `or`, and `x-of` can have any number of child nodes, and the rest MUST have zero child nodes.
`user`, `page`, `flag`, `log` and `summary` MUST have an attribute called value containing a regular expression to match.
`incategory`, and `usergroup` MUST have an attribute called value containing an exact string to match.
For example:
```
<and>
<or>
<page value="Wikipedia:New contributors' help page"/>
<page value="Wikipedia:Help Desk"/>
</or>
<not>
<user value="Stwalkerster"/>
</not>
<summary value="/\* New Section \*/"/>
</and>
```
Use the mail option to enable or disable logging of stalk triggers via email. By default, every stalk has it enabled.
### Version ###
Requires: Standard
```
=version
```
Shows the current bot version.
Location: `EyeInTheSky.Commands`
The latest help for all commands can be found using the `=help` command.
### Help ###
Requires: Standard
```
=help
```
```
=help <Command>
```
Returns all available help for the specified command.
```
=help <Command> <Subcommand>
```
Returns the help for the specified subcommand.
Location: `Stwalkerster.Bot.CommandLib.Commands`
### Die ###
Requires: Owner
```
=die
```
Shuts down the bot.
Location: `Stwalkerster.Bot.CommandLib.Commands.BotManagement`
### Command Access ###
Requires: Standard
```
=commandaccess <command>
```
Retrieves the flag required to use the specified command.
Location: `Stwalkerster.Bot.CommandLib.Commands.AccessControl`
### My Flags ###
Requires: Standard
```
=myflags
=myaccess
=whoami
```
Retrieves the flags available to the current user.
Location: `Stwalkerster.Bot.CommandLib.Commands.AccessControl`
### Stalk ###
Requires: Protected
```
=stalk list
```
Lists all configured stalks
```
=stalk report
```
Sends an email listing the configured stalks
```
=stalk add <Flag>
```
Adds a new unconfigured stalk
```
=stalk del <Flag>
```
Deletes a stalk
```
=stalk enabled <Flag> <true|false>
```
Marks a stalk as enabled or disabled
```
=stalk mail <Flag> <true|false>
```
Enables or disables email notifications for each trigger of the specified stalk
```
=stalk description <Flag> <Description...>
```
Sets the description of the specified stalk
```
=stalk expiry <Flag> <Description...>
```
Sets the description of the specified stalk
```
=stalk set <Flag> <user|page|summary|xml> <Match...>
```
Sets the stalk configuration of the specified stalk to specified user, page, or edit summary regex. Alternatively, manually specify an XML tree (advanced).
```
=stalk and <Flag> <user|page|summary|xml> <Match...>
```
Sets the stalk configuration of the specified stalk to the logical AND of the current configuration, and a specified user, page, or edit summary regex; or XML tree (advanced).
```
=stalk or <Flag> <user|page|summary|xml> <Match...>
```
Sets the stalk configuration of the specified stalk to the logical OR of the current configuration, and a specified user, page, or edit summary regex; or XML tree (advanced).
An XML search tree is an XML root element from the list: `and`, `or`, `not`, `xor`, `true`, `false`, `user`, `page`, `summary`, `flag`, `incategory`, `log`, `usergroup`, `x-of`.
`xor` MUST have two child nodes, `not` MUST have one child node, `and`, `or`, and `x-of` can have any number of child nodes, and the rest MUST have zero child nodes.
`user`, `page`, `flag`, `log` and `summary` MUST have an attribute called value containing a regular expression to match.
`incategory`, and `usergroup` MUST have an attribute called value containing an exact string to match.
For example:
```
<and>
<or>
<page value="Wikipedia:New contributors' help page"/>
<page value="Wikipedia:Help Desk"/>
</or>
<not>
<user value="Stwalkerster"/>
</not>
<summary value="/\* New Section \*/"/>
</and>
```
Use the mail option to enable or disable logging of stalk triggers via email. By default, every stalk has it enabled.
### Version ###
Requires: Standard
```
=version
```
Shows the current bot version.
Location: `EyeInTheSky.Commands`