mirror of
https://github.com/Mikaela/Limnoria-doc.git
synced 2024-11-23 20:49:43 +01:00
84 lines
1.8 KiB
ReStructuredText
84 lines
1.8 KiB
ReStructuredText
|
|
||
|
|
.. _plugin-config:
|
||
|
|
|
||
|
|
The Config plugin
|
||
|
|
=================
|
||
|
|
|
||
|
|
.. command-help:
|
||
|
|
|
||
|
|
help <name>
|
||
|
|
^^^^^^^^^^^
|
||
|
|
|
||
|
|
Returns the description of the configuration variable *<name>*.
|
||
|
|
|
||
|
|
|
||
|
|
.. command-default:
|
||
|
|
|
||
|
|
default <name>
|
||
|
|
^^^^^^^^^^^^^^
|
||
|
|
|
||
|
|
Returns the default value of the configuration variable *<name>*.
|
||
|
|
|
||
|
|
|
||
|
|
.. command-list:
|
||
|
|
|
||
|
|
list <group>
|
||
|
|
^^^^^^^^^^^^
|
||
|
|
|
||
|
|
Returns the configuration variables available under the given
|
||
|
|
configuration *<group>*. If a variable has values under it, it is
|
||
|
|
preceded by an '@' sign. If a variable is a 'ChannelValue', that is,
|
||
|
|
it can be separately configured for each channel using the 'channel'
|
||
|
|
command in this plugin, it is preceded by an '#' sign.
|
||
|
|
|
||
|
|
|
||
|
|
.. command-search:
|
||
|
|
|
||
|
|
search <word>
|
||
|
|
^^^^^^^^^^^^^
|
||
|
|
|
||
|
|
Searches for *<word>* in the current configuration variables.
|
||
|
|
|
||
|
|
|
||
|
|
.. command-reload:
|
||
|
|
|
||
|
|
reload
|
||
|
|
^^^^^^
|
||
|
|
|
||
|
|
Reloads the various configuration files (user database, channel
|
||
|
|
database, registry, etc.).
|
||
|
|
|
||
|
|
|
||
|
|
.. command-export:
|
||
|
|
|
||
|
|
export <filename>
|
||
|
|
^^^^^^^^^^^^^^^^^
|
||
|
|
|
||
|
|
Exports the public variables of your configuration to *<filename>*.
|
||
|
|
If you want to show someone your configuration file, but you don't
|
||
|
|
want that person to be able to see things like passwords, etc., this
|
||
|
|
command will export a "sanitized" configuration file suitable for
|
||
|
|
showing publicly.
|
||
|
|
|
||
|
|
|
||
|
|
.. command-channel:
|
||
|
|
|
||
|
|
channel [<channel>] <name> [<value>]
|
||
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||
|
|
|
||
|
|
If *<value>* is given, sets the channel configuration variable for *<name>*
|
||
|
|
to *<value>* for *<channel>*. Otherwise, returns the current channel
|
||
|
|
configuration value of *<name>*. *<channel>* is only necessary if the
|
||
|
|
message isn't sent in the channel itself.
|
||
|
|
|
||
|
|
.. command-config:
|
||
|
|
|
||
|
|
config <name> [<value>]
|
||
|
|
^^^^^^^^^^^^^^^^^^^^^^^
|
||
|
|
|
||
|
|
If *<value>* is given, sets the value of *<name>* to *<value>*. Otherwise,
|
||
|
|
returns the current value of *<name>*. You may omit the leading
|
||
|
|
"supybot." in the name if you so choose.
|
||
|
|
|
||
|
|
|