From 6f888c8441c3cd9f680ffabb075c2b89338d9170 Mon Sep 17 00:00:00 2001 From: Pragmatic Software Date: Thu, 9 Jan 2020 23:45:47 -0800 Subject: [PATCH] doc/Admin.md: add mute/unmute --- doc/Admin.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/doc/Admin.md b/doc/Admin.md index aeea80d8..f293bdf3 100644 --- a/doc/Admin.md +++ b/doc/Admin.md @@ -189,17 +189,21 @@ PBot extends the IRC `MODE` command in useful ways. For instance, the ` parameter can contain wildcards. To op everybody whose nick ends with `|dev`, for instance, you can do `!mode +o *|dev`. -#### ban -Bans a user. If the argument is a `nick` instead of a `hostmask`, it will determine an appropriate banmask for that nick. +#### ban/mute +Bans or mutes a user. If the argument is a `nick` instead of a `hostmask`, it will determine an appropriate banmask for that nick. -Usage: `ban [channel [timeout]]` +Usages: +- `ban [channel [timeout]]` +- `mute [channel [timeout]]` If `timeout` is omitted, PBot will ban the user for 24 hours. Timeout can be specified as an relative time in English; for instance, `5 minutes`, `1 month and 2 weeks`, `next thursday`, `friday after next`, and so on. -#### unban -Unbans a user. If the argument is a `nick` instead of a `hostmask`, it will find all bans that match any of that nick's hostmasks or NickServ accounts and unban them. +#### unban/unmute +Unbans or unmutes a user. If the argument is a `nick` instead of a `hostmask`, it will find all bans that match any of that nick's hostmasks or NickServ accounts and unban them. -Usage: `unban [channel]` +Usages: +- `unban [channel]` +- `unmute [channel]` #### kick Removes a user from the channel. `nick` can be a comma-separated list of multiple users, optionally containing wildcards. If `reason` is omitted, a random insult will be used.