GitHub
/
pbot
mirror of https://github.com/pragma-/pbot.git
3
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: minor improvements

This commit is contained in:
Pragmatic Software 2020-02-04 20:49:56 -08:00
parent eb2e1919ec
commit 735cae5c54
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -190,7 +190,7 @@ There are even a few games!
Plugin | Description
--- | ---
[Spinach](Plugins/Spinach.pm) | An advanced multiplayer Trivia game engine with a twist! A question is shown, everybody privately submits a false answer, all false answers and the true answer is shown, everybody tries to guess the true answer, points are gained when people pick your false answer!
[Spinach](Plugins/Spinach.pm) | An advanced multiplayer Trivia game engine with a twist! A question is shown. Everybody privately submits a false answer. All false answers and the true answer is shown. Everybody tries to guess the true answer. Points are gained when people pick your false answer!
[Battleship](Plugins/Battleship.pm) | The classic Battleship board game, simplified for IRC
[Connect4](Plugins/Connect4.pm) | The classic Connect-4 game.
@ -291,7 +291,7 @@ PBot can perform the typical channel management tasks.
* spam/advertisement detection
* and much, much more!
For more information, see the [Channels documentation](doc/Admin.md#channel-management-commands) and the [AntiAbuse documentation](doc/AntiAbuse.md)
For more information, see the [Channels documentation](doc/Admin.md#channel-management-commands) and the [Anti-abuse documentation](doc/AntiAbuse.md)
### User management

12
doc/Admin.md
View File

@ -167,7 +167,7 @@ can use the [`userset`](#userset) command:
Now alice can use the `ban` command.
User-capabilities can provide fine-grained permissions over various PBot functionality. For example,
User-capabilities provides fine-grained permissions over various PBot functionality. For example,
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
their modes to just a specific subset of all modes. You can do this with user-cabilities. To do so,
@ -307,12 +307,12 @@ Name | Description
`admin` | The admin capability group. Contains the basic administrative capabilities.
`chanop` | Channel operator capability group. Contains the basic channel management capabilities.
`chanmod` | Channel moderator capability group. Grants `can-voice`, `can-devoice` and the use of the `mod` command without being voiced.
`can-<command name>` | If a command `<command name>` has the `cap-required` [command metadata](#command-metadata-list) then the user's account must have the `can-<command name>` capability to invoke it. For example, the `op` command requires users to have the `can-op` capability.
`can-mode-<flag>` | Allows the `mode` command to set mode `<flag>`. For example, to allow a user to set `mode +m` give them the `can-mode` and `can-mode-m` capabilities. `<flag>` is one mode character.
`can-mode-any` | Allows the `mode` command to set any mode flag.
`can-<command name>` | If a command `<command name>` has the `cap-required` [command metadata](#command-metadata-list) then the user's account must have the `can-<command name>` capability to invoke it. For example, the [`op`](#op) command requires users to have the `can-op` capability.
`can-mode-<flag>` | Allows the [`mode`](#mode) command to set mode `<flag>`. For example, to allow a user to set `mode +m` give them the `can-mode` and `can-mode-m` capabilities. `<flag>` is one mode character.
`can-mode-any` | Allows the [`mode`](#mode) command to set any mode flag.
`can-modify-capabilities` | Allows the user to use the [`useradd`](#useradd) or [`userset`](#userset) commands to add or remove capabilities from users.
`can-group-capabilities` | Allows the user to use the `cap group` command to modify capability groups.
`can-ungroup-capabilities` | Allows the user to use the `cap ungroup` command to modify capability groups.
`can-group-capabilities` | Allows the user to use the [`cap group`](#cap) command to modify capability groups.
`can-ungroup-capabilities` | Allows the user to use the [`cap ungroup`](#cap) command to modify capability groups.
## Channel management commands