diff --git a/doc/Admin.md b/doc/Admin.md index 1521ef38..7758f694 100644 --- a/doc/Admin.md +++ b/doc/Admin.md @@ -34,6 +34,10 @@ * [ignore](#ignore) * [unignore](#unignore) * [blacklist](#blacklist) + * [nicklist](Admin.md#nicklist) + * [banlist](Admin.md#banlist) + * [checkban](Admin.md#checkban) + * [checkmute](Admin.md#checkmute) * [op](#op) * [deop](#deop) * [voice](#voice) @@ -417,6 +421,55 @@ Usages: - `blacklist add [channel]` - `blacklist remove [channel]` +### [nicklist](Admin.md#nicklist) +The `nicklist` command displays information about entries in PBot's internal nicklist. + +Usage: `nicklist ( | ) [-sort ] [-hostmask] [-join]` + +Option | Description +--- | --- +`-hostmask` | shows full hostmasks instead of nicks +`-join` | include join timestamps + +Examples: + + nicklist #c + 701 nicks in #c: pragma-: last spoken 1h ago, etc... + + nicklist #c pragma- + Nicklist information for pragma-!~chaos@user/pragmatic-chaos in #c: last spoken 1h ago, etc... + +### [banlist](Admin.md#banlist) +The `banlist` command displays information about entries in PBot's internal banlist. PBot's internal banlist +remembers the original setters and timestamps of ban entries when the IRC server forgets them. PBot's internal +banlist can store extra metadata such as ban-reasons, ban-timeouts, etc. + +Usage: `banlist ` + +Example: + + banlist #c + Ban list for #c: 1 ban: loser!*@* on Tue Aug 31 06:41:24 2021 PDT (14d15h ago) by candide!~pbot3@about/c/bot/candide for chat-flooding (2h remaining); 0 mutes. + +### [checkban](Admin.md#checkban) +The `checkban` command displays information about an entry in PBot's internal banlist. PBot's internal banlist +remembers the original setters and timestamps of ban entries when the IRC server forgets them. PBot's internal +banlist can store extra metadata such as ban-reasons, ban-timeouts, etc. + +Usage: `checkban [channel]` + +If the `[channel]` option is omitted, the channel in which the command is invoked will be used. + +Example: + + checkban loser!*@* + loser!*@* banned in #c on Tue Aug 31 06:41:24 2021 PDT (14d15h ago) by candide!~pbot3@about/c/bot/candide for chat-flooding (2h remaining) + +### [checkmute](Admin.md#checkmute) +The `checkmute` command is identical to the [`checkban`](#checkban) command, except for mutes instead of bans. + +Usage: checkban [channel] + ### op ### deop ### voice diff --git a/doc/Commands.md b/doc/Commands.md index 37d0b857..348cc107 100644 --- a/doc/Commands.md +++ b/doc/Commands.md @@ -14,6 +14,7 @@ * [Background processing](#background-processing) * [Types of commands](#types-of-commands) * [Built-in commands](#built-in-commands) + * [Listing all built-in commands](#listing-all-built-in-commands) * [Creating new built-in commands](#creating-new-built-in-commands) * [Plugins](#plugins) * [Functions](#functions) @@ -58,6 +59,10 @@ * [unban/unmute](Admin.md#unbanunmute) * [invite](Admin.md#invite) * [kick](Admin.md#kick) + * [nicklist](Admin.md#nicklist) + * [banlist](Admin.md#banlist) + * [checkban](Admin.md#checkban) + * [checkmute](Admin.md#checkmute) * [Module-management](#module-management) * [load](Admin.md#load) * [unload](Admin.md#unload) @@ -360,6 +365,12 @@ Built-in commands are commands that are internal and native to PBot. They are executed within PBot's API and context. They have access to PBot internal subroutine and data structures. +#### Listing all built-in commands +To list all built-in commands, use the `list commands` command. + +Commands prefixed with a `+` require the user to have the respective `can-` +user-capability in order to invoke it. + #### Creating new built-in commands Built-in commands are created via the `register()` function of the `Commands` module. Such commands are registered throughout PBot's source code. The owner @@ -540,15 +551,17 @@ to have the command remember your location. ##### [unban/unmute](Admin.md#unbanunmute) ##### [invite](Admin.md#invite) ##### [kick](Admin.md#kick) +##### [nicklist](Admin.md#nicklist) +##### [banlist](Admin.md#banlist) +##### [checkban](Admin.md#checkban) +##### [checkmute](Admin.md#checkmute) #### Module-management - ##### [load](Admin.md#load) ##### [unload](Admin.md#unload) ##### [list modules](Admin.md#listing-modules) #### Plugin-management - ##### [plug](Admin.md#plug) ##### [unplug](Admin.md#unplug) ##### [replug](Admin.md#replug) diff --git a/doc/README.md b/doc/README.md index f6c3fcf9..090b95b7 100644 --- a/doc/README.md +++ b/doc/README.md @@ -57,6 +57,7 @@ * [Background processing](Commands.md#background-processing) * [Types of commands](Commands.md#types-of-commands) * [Built-in commands](Commands.md#built-in-commands) + * [Listing all built-in commands](Commands.md#listing-all-built-in-commands) * [Creating new built-in commands](Commands.md#creating-new-built-in-commands) * [Plugins](Commands.md#plugins) * [Functions](Commands.md#functions) @@ -123,6 +124,10 @@ * [ignore](Admin.md#ignore) * [unignore](Admin.md#unignore) * [blacklist](Admin.md#blacklist) + * [nicklist](Admin.mdAdmin.md#nicklist) + * [banlist](Admin.mdAdmin.md#banlist) + * [checkban](Admin.mdAdmin.md#checkban) + * [checkmute](Admin.mdAdmin.md#checkmute) * [op](Admin.md#op) * [deop](Admin.md#deop) * [voice](Admin.md#voice)