Mercurial > irccd
changeset 367:b81c6fdec22e
Docs: add documentation about plugin-config command
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Thu, 01 Dec 2016 13:22:58 +0100 |
| parents | 6f4960acb9dc |
| children | d731ce3ae821 |
| files | doc/html/CMakeLists.txt doc/html/irccdctl/command/index.md doc/html/irccdctl/command/plugin-config.md doc/html/irccdctl/index.md irccdctl/cli.cpp |
| diffstat | 5 files changed, 34 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/html/CMakeLists.txt Thu Dec 01 13:22:29 2016 +0100 +++ b/doc/html/CMakeLists.txt Thu Dec 01 13:22:58 2016 +0100 @@ -149,6 +149,7 @@ ${html_SOURCE_DIR}/irccdctl/usage.md ${html_SOURCE_DIR}/irccdctl/command/index.md ${html_SOURCE_DIR}/irccdctl/command/help.md + ${html_SOURCE_DIR}/irccdctl/command/plugin-config.md ${html_SOURCE_DIR}/irccdctl/command/plugin-info.md ${html_SOURCE_DIR}/irccdctl/command/plugin-list.md ${html_SOURCE_DIR}/irccdctl/command/plugin-load.md
--- a/doc/html/irccdctl/command/index.md Thu Dec 01 13:22:29 2016 +0100 +++ b/doc/html/irccdctl/command/index.md Thu Dec 01 13:22:58 2016 +0100 @@ -4,6 +4,7 @@ --- - [help](help.html) + - [plugin-config](plugin-config.html) - [plugin-info](plugin-info.html) - [plugin-list](plugin-list.html) - [plugin-load](plugin-load.html)
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/plugin-config.md Thu Dec 01 13:22:58 2016 +0100 @@ -0,0 +1,26 @@ +--- +title: plugin-config +guide: yes +--- + +# plugin-config + +Get or set a plugin configuration variable. + +If both variable and value are provided, sets the plugin configuration to the +respective variable name and value. + +If only variable is specified, shows its current value. Otherwise, list all +variables and their values. + +## Usage + +````nohighlight +$ irccdctl plugin-config plugin [variable] [value] +```` + +## Example + +````nohighlight +$ irccdctl plugin-config ask +````
--- a/doc/html/irccdctl/index.md Thu Dec 01 13:22:29 2016 +0100 +++ b/doc/html/irccdctl/index.md Thu Dec 01 13:22:58 2016 +0100 @@ -12,6 +12,7 @@ # List of support commands - [help](command/help.html) + - [plugin-config](command/plugin-config.html) - [plugin-info](command/plugin-info.html) - [plugin-list](command/plugin-list.html) - [plugin-load](command/plugin-load.html)
--- a/irccdctl/cli.cpp Thu Dec 01 13:22:29 2016 +0100 +++ b/irccdctl/cli.cpp Thu Dec 01 13:22:58 2016 +0100 @@ -132,7 +132,11 @@ : Cli("plugin-config", "configure a plugin", "plugin-config plugin [variable] [value]", - "Get or set plugin configuration.\n\n" + "Get or set a plugin configuration variable.\n\n" + "If both variable and value are provided, sets the plugin configuration " + "to the\nrespective variable name and value.\n\n" + "If only variable is specified, shows its current value. Otherwise, list " + "all\nvariables and their values.\n\n" "Examples:\n" "\tirccdctl plugin-config ask") {