Limnoria/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Limnoria/Limnoria-doc.git synced 2025-04-08 00:09:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Review and update the layout.

Browse Source
This commit is contained in:
Valentin Lorentz
2011-06-28 17:29:38 +02:00
parent 2ce465adcd
commit b17bd0fac6
63 changed files with 2384 additions and 2323 deletions
Download Patch File Download Diff File Expand all files Collapse all files

85
use/plugins/config.rst
View File

@ -4,26 +4,27 @@
The Config plugin
=================
.. _command-help:
Accessing config
----------------
help <name>
^^^^^^^^^^^
.. _command-config-help:
config help <name>
^^^^^^^^^^^^^^^^^^
Returns the description of the configuration variable *<name>*.
.. _command-config-default:
.. _command-default:
default <name>
^^^^^^^^^^^^^^
config default <name>
^^^^^^^^^^^^^^^^^^^^^
Returns the default value of the configuration variable *<name>*.
.. _command-config-list:
.. _command-list:
list <group>
^^^^^^^^^^^^
config list <group>
^^^^^^^^^^^^^^^^^^^
Returns the configuration variables available under the given
configuration *<group>*. If a variable has values under it, it is
@ -31,53 +32,51 @@ 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-config-search:
.. _command-search:
search <word>
^^^^^^^^^^^^^
config search <word>
^^^^^^^^^^^^^^^^^^^^
Searches for *<word>* in the current configuration variables.
.. _command-config-channel:
.. _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>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
config 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:
.. _command-config-config:
config <name> [<value>]
^^^^^^^^^^^^^^^^^^^^^^^
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.
Maintenance
-----------
.. _command-config-reload:
config reload
^^^^^^^^^^^^^
Reloads the various configuration files (user database, channel
database, registry, etc.).
.. _command-config-export:
config 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.