GitHub/pbot
3
0
Fork 0
mirror of https://github.com/pragma-/pbot.git synced 2024-11-22 11:59:43 +01:00
Code Issues Projects Releases Wiki Activity

doc/Admin.md: ban/unmute: add examples

Browse Source
This commit is contained in:
Pragmatic Software 2023-05-04 21:18:25 -07:00
parent db9752c6c0
commit e6149cc35c
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/Admin.md
View File

@ -497,21 +497,25 @@ can do `!mode +o *|dev` in a channel.
Bans or mutes a user. If the argument is a nick instead of a hostmask, it will determine an appropriate banmask for that nick. Bans or mutes a user. If the argument is a nick instead of a hostmask, it will determine an appropriate banmask for that nick.
The argument can be a comma-separated list of multiple nicks or masks. The argument can be a comma-separated list of multiple nicks or masks.
Usages: Usage: `ban/mute <nick/hostmask,...> [timeout (default: 24h) [reason]] [-c <channel>] [-t <timeout>] [-r <reason>]`
- `ban <nick/hostmask,...> [timeout (default: 24h) [reason]] [-c <channel>] [-t <timeout>] [-r <reason>]`
- `mute <nick/hostmask,...> [timeout (default: 24h) [reason]] [-c <channel>] [-t <timeout>] [-r <reason>]`
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`, `forever` and such. 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`, `forever` and such.
If a ban already exists, you may update the timeout or reason at any time. If a ban already exists, you may update the timeout or reason at any time.
Examples:
<pragma-> ban bob 10m being a jerk
<PBot> *!*@user/bob banned in #channel (10 minutes) because being a jerk
<!-- -->
<pragma-> mute joe -r "not very nice"
<PBot> *!*@user/joe muted in #channel (1 day) because not very nice
### unban/unmute ### 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. 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.
The argument can be a comma-separated list of multiple nicks or masks. If the argument is `*` then all bans/mutes for the channel will be removed. The argument can be a comma-separated list of multiple nicks or masks. If the argument is `*` then all bans/mutes for the channel will be removed.
Usages: Usage: `unban/unmute <nick/hostmask,...> [channel]`
- `unban <nick/hostmask,...> [channel]`
- `unmute <nick/hostmask,...> [channel]`
### checkban ### checkban
The `checkban` command displays information about an entry in PBot's internal banlist. PBot's internal banlist The `checkban` command displays information about an entry in PBot's internal banlist. PBot's internal banlist