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

doc/Admin.md: add some links

Browse Source
This commit is contained in:
Pragmatic Software 2020-02-04 03:40:01 -08:00
parent 537f6ad5e2
commit 07034cbbfb
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/Admin.md
View File

@ -91,7 +91,7 @@ Parameter | Description
`<account name>` | A unique name to identify this account (usually the `nick` of the user, but it can be any identifier). `<account name>` | A unique name to identify this account (usually the `nick` of the user, but it can be any identifier).
`<channel>` | The channel this user belongs to; use `global` for all channels. This field cannot be changed without removing and re-adding the user. `<channel>` | The channel this user belongs to; use `global` for all channels. This field cannot be changed without removing and re-adding the user.
`<hostmask>` | The hostmask from which this user is recognized/allowed to login from (e.g., `somenick!*@*.somedomain.com` or `*!*@unaffiliated/someuser`). This field cannot be changed without removing and re-adding the user. `<hostmask>` | The hostmask from which this user is recognized/allowed to login from (e.g., `somenick!*@*.somedomain.com` or `*!*@unaffiliated/someuser`). This field cannot be changed without removing and re-adding the user.
`[capabilities]` | A comma-separated list of [user-capabilities](#user-capabilities-list) for this user. `[capabilities]` | A comma-separated list of [user-capabilities](#user-capabilities) for this user.
`[password]` | The password the user will use to login (from `/msg`, obviously). Generates a random password if omitted. Users may view and set their password by using the [`my`](Commands.md#my) command. `[password]` | The password the user will use to login (from `/msg`, obviously). Generates a random password if omitted. Users may view and set their password by using the [`my`](Commands.md#my) command.
### userdel ### userdel
@ -125,7 +125,7 @@ Name | Description
`autovoice` | Give the user `voiced` status when they join the channel. *Note: make sure the user account's hostmask wildcards are as restrictive as possible.* `autovoice` | Give the user `voiced` status when they join the channel. *Note: make sure the user account's hostmask wildcards are as restrictive as possible.*
`location` | Sets your location for using the [`weather`](Commands.md#weather) command without any arguments. `location` | Sets your location for using the [`weather`](Commands.md#weather) command without any arguments.
`timezone` | Sets your timezone for using the [`date`](Commands.md#date) command without any arguments. `timezone` | Sets your timezone for using the [`date`](Commands.md#date) command without any arguments.
[capabilities](#user-capabilities-list) | User capabilities are managed as user metadata. [capabilities](#user-capabilities-list) | [User-capabilities](#user-capabilities) are managed as user metadata.
### Listing users ### Listing users
To list user accounts, use the `list users` command. This is not an admin command, but To list user accounts, use the `list users` command. This is not an admin command, but
@ -472,7 +472,7 @@ Usage: `cmdunset <command> <key>`
Name | Description Name | Description
--- | --- --- | ---
`help` | The text to display for the [`help`](Commands.md#help) command. `help` | The text to display for the [`help`](Commands.md#help) command.
`cap-required` | If this is set to a true value then the command requires that users have the `can-<command name>` capability before they can invoke it. `cap-required` | If this is set to a true value then the command requires that users have the `can-<command name>` [capability](#user-capabilities) before they can invoke it.
## Miscellaneous commands ## Miscellaneous commands