GitHub/pbot
3
0
Fork 0
mirror of https://github.com/pragma-/pbot.git synced 2025-10-14 15:07:22 +02:00
Code Issues Projects Releases Wiki Activity

doc/Admin.md: improve capabilities section

Browse Source
This commit is contained in:
Pragmatic Software 2021-06-13 14:41:28 -07:00
parent a6d79b2fc5
commit 41de649880
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/Admin.md
View File

@ -152,7 +152,8 @@ When `[channel]` is omitted and the command is used from private message, it wil
list all users from all channels, including global users. list all users from all channels, including global users.
## User capabilities ## User capabilities
PBot uses a user-capability system to control what users can and cannot do. PBot uses a user-capability system to control what users can and cannot do. User-capabilities
provides fine-grained permissions over various PBot functionality.
### Introduction ### Introduction
For example, imagine a user named alice. alice has no capabilities granted yet. For example, imagine a user named alice. alice has no capabilities granted yet.
@ -173,8 +174,7 @@ can use the [`userset`](#userset) command:
Now alice can use the `ban` command. Now alice can use the `ban` command.
User-capabilities provides fine-grained permissions over various PBot functionality. For example, Let's consider the [`mode`](#mode) command. Channel operators can use their IRC client's `/mode` command to
consider the [`mode`](#mode) command. Channel operators can use their IRC client's `/mode` command to
set any channel modes, including any undesirable modes (such as +k). Suppose you'd prefer to limit set any channel modes, including any undesirable modes (such as +k). Suppose you'd prefer to limit
their modes to just a specific subset of all modes. You can do this with user-cabilities. To do so, their modes to just a specific subset of all modes. You can do this with user-cabilities. To do so,
instead of making them channel operators you can make them PBot users and grant them specific PBot instead of making them channel operators you can make them PBot users and grant them specific PBot
@ -320,7 +320,8 @@ This is a list of built-in capability groups and capabilities. You can create
new custom capability groups with the [`cap group`](#creating-a-new-group-or-adding-to-an-existing-group) command. new custom capability groups with the [`cap group`](#creating-a-new-group-or-adding-to-an-existing-group) command.
Please note that PBot is sometimes updated more frequently than this list is updated. To see the most Please note that PBot is sometimes updated more frequently than this list is updated. To see the most
current list of capabilities, use the [`cap list`](#listing-capabilities) command. current list of capabilities, use the [`cap list`](#listing-capabilities) command or see the
[`data/capabilities`](../data/capabilities) file.
Name | Description | Belongs to group Name | Description | Belongs to group
--- | --- | --- --- | --- | ---