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

Remove hyphen from "meta-data"

Browse Source
This commit is contained in:
Pragmatic Software 2020-01-21 18:31:13 -08:00
parent 37ce15cf31
commit 2167723190
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/AntiAbuse.md
View File

@ -51,5 +51,5 @@ PBot can detect if someone immediately auto-rejoins after having been kicked.
When such a case is detected, PBot will kickban the offender (with a kick message of "$timeout ban for auto-rejoining after kick") for 5 minutes for the first offense. Each additional offense will result in the offender being banned for a much longer period. The offense counter is decremented once every 24 hours. When such a case is detected, PBot will kickban the offender (with a kick message of "$timeout ban for auto-rejoining after kick") for 5 minutes for the first offense. Each additional offense will result in the offender being banned for a much longer period. The offense counter is decremented once every 24 hours.
## Opping/Deopping ## Opping/Deopping
ChanServ can op and deop PBot as necessary, unless the channel `permop` meta-data is set to a true value. PBot will wait until about 5 minutes have elapsed before requesting a deop from ChanServ. This timeout can be controlled via the `general.deop_timeout` registry value, which can be overriden on a per-channel basis. ChanServ can op and deop PBot as necessary, unless the channel `permop` metadata is set to a true value. PBot will wait until about 5 minutes have elapsed before requesting a deop from ChanServ. This timeout can be controlled via the `general.deop_timeout` registry value, which can be overriden on a per-channel basis.

10
doc/Registry.md
View File

@ -29,7 +29,7 @@ These are represented as `<section>.<key>`. For example, `irc.port` is set to `6
There are two types of registry values: literals and arrays. Literals can be strings, floats or integers. Arrays are comma-separated lists of literals. There are two types of registry values: literals and arrays. Literals can be strings, floats or integers. Arrays are comma-separated lists of literals.
### Creating array values ### Creating array values
Use the [regsetmeta](#regsetmeta) command to change the `type` [meta-data key](#metadata-list) to `array`, and set the registry value to a comma-separated list of values. Use the [regsetmeta](#regsetmeta) command to change the `type` [metadata key](#metadata-list) to `array`, and set the registry value to a comma-separated list of values.
For example, we'll create a fictional Registry key `animals` in fictional section `foo` and then set its `type` to `array`. For example, we'll create a fictional Registry key `animals` in fictional section `foo` and then set its `type` to `array`.
@ -101,13 +101,13 @@ To limit the search to a specific section, use `-section <section>`.
To dump the entire registry, use `regfind -showvalues .*`. To dump the entire registry, use `regfind -showvalues .*`.
### regsetmeta ### regsetmeta
`regsetmeta` sets the meta-data values for a specific registry key. See [registry meta-data list](#metadata-list). `regsetmeta` sets the metadata values for a specific registry key. See [registry metadata list](#metadata-list).
If you omit the `<key>` argument, it will list all the defined keys and values for the registry item. If you specify `<key>` but omit `<value>`, it will show the value for that specific key. If you omit the `<key>` argument, it will list all the defined keys and values for the registry item. If you specify `<key>` but omit `<value>`, it will show the value for that specific key.
Usage: `regsetmeta <section>.<item> [key [value]]` Usage: `regsetmeta <section>.<item> [key [value]]`
For example, this directly sets the `value` meta-data key of `irc.botnick`. For example, this directly sets the `value` metadata key of `irc.botnick`.
<pragma-> !regsetmeta irc.botnick value candide <pragma-> !regsetmeta irc.botnick value candide
* PBot changed nick to candide * PBot changed nick to candide
@ -116,7 +116,7 @@ For example, this directly sets the `value` meta-data key of `irc.botnick`.
That example is equivalent to `regset irc.botnick candide`. That example is equivalent to `regset irc.botnick candide`.
### regunsetmeta ### regunsetmeta
`regunset` deletes a meta-data key from a registry item. `regunset` deletes a metadata key from a registry item.
Usage: `regunset <section>.<item> <key>` Usage: `regunset <section>.<item> <key>`
@ -139,7 +139,7 @@ After editing an entry in the Registry file, you may reload it with the `reload`
<PBot> Registry reloaded. <PBot> Registry reloaded.
## Metadata list ## Metadata list
This is a list of recognized registry meta-data keys. This is a list of recognized registry metadata keys.
Name | Description Name | Description
--- | --- --- | ---