From f2b7436f58dca4c56a70a9971f1f92b2f08ae888 Mon Sep 17 00:00:00 2001 From: Pragmatic Software Date: Tue, 14 Sep 2021 22:01:13 -0700 Subject: [PATCH] Doc: minor edits --- doc/Admin.md | 50 +++++++++++++++++++++++++------------------------- doc/README.md | 8 ++++---- 2 files changed, 29 insertions(+), 29 deletions(-) diff --git a/doc/Admin.md b/doc/Admin.md index 7758f694..3179adb4 100644 --- a/doc/Admin.md +++ b/doc/Admin.md @@ -34,10 +34,8 @@ * [ignore](#ignore) * [unignore](#unignore) * [blacklist](#blacklist) - * [nicklist](Admin.md#nicklist) - * [banlist](Admin.md#banlist) - * [checkban](Admin.md#checkban) - * [checkmute](Admin.md#checkmute) + * [nicklist](#nicklist) + * [banlist](#banlist) * [op](#op) * [deop](#deop) * [voice](#voice) @@ -45,6 +43,8 @@ * [mode](#mode) * [ban/mute](#banmute) * [unban/unmute](#unbanunmute) + * [checkban](#checkban) + * [checkmute](#checkmute) * [invite](#invite) * [kick](#kick) * [Module-management](#module-management) @@ -421,7 +421,7 @@ Usages: - `blacklist add [channel]` - `blacklist remove [channel]` -### [nicklist](Admin.md#nicklist) +### nicklist The `nicklist` command displays information about entries in PBot's internal nicklist. Usage: `nicklist ( | ) [-sort ] [-hostmask] [-join]` @@ -439,7 +439,7 @@ Examples: nicklist #c pragma- Nicklist information for pragma-!~chaos@user/pragmatic-chaos in #c: last spoken 1h ago, etc... -### [banlist](Admin.md#banlist) +### 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. @@ -451,25 +451,6 @@ 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 @@ -522,6 +503,25 @@ Usages: - `unban [channel]` - `unmute [channel]` +### 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 +The `checkmute` command is identical to the [`checkban`](#checkban) command, except for mutes instead of bans. + +Usage: checkmute [channel] + ### invite Invites a user to a channel. diff --git a/doc/README.md b/doc/README.md index 090b95b7..7abedc43 100644 --- a/doc/README.md +++ b/doc/README.md @@ -124,10 +124,8 @@ * [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) + * [nicklist](Admin.md#nicklist) + * [banlist](Admin.md#banlist) * [op](Admin.md#op) * [deop](Admin.md#deop) * [voice](Admin.md#voice) @@ -135,6 +133,8 @@ * [mode](Admin.md#mode) * [ban/mute](Admin.md#banmute) * [unban/unmute](Admin.md#unbanunmute) + * [checkban](Admin.md#checkban) + * [checkmute](Admin.md#checkmute) * [invite](Admin.md#invite) * [kick](Admin.md#kick) * [Module-management](Admin.md#module-management)