From 9af0c04b883e6d13057aead956e1893508bce2a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Helleu?= Date: Fri, 30 Mar 2018 05:25:16 +0200 Subject: doc: add fset plugin in quickstart guide --- doc/en/weechat_quickstart.en.adoc | 42 +++++++++++++++++---------------------- 1 file changed, 18 insertions(+), 24 deletions(-) (limited to 'doc/en') diff --git a/doc/en/weechat_quickstart.en.adoc b/doc/en/weechat_quickstart.en.adoc index 9a35aaa2e..a1e9a0d4a 100644 --- a/doc/en/weechat_quickstart.en.adoc +++ b/doc/en/weechat_quickstart.en.adoc @@ -47,44 +47,38 @@ option name). WeeChat immediately uses the new value (you *never* need to restart WeeChat after changes to configuration). -You can use `/set` option with partial name and wildcard "*" at the beginning -or end to display all options containing letters. -For example: - -* Display all options (WeeChat and plugins): +All settings are saved when WeeChat ends (or with `/save` command to force +a write of the options). ----- -/set ----- +[IMPORTANT] +It is *not recommended* to edit configuration files by hand because WeeChat +may write them at any time (for example on `/quit`) and after any change +you must run the command `/reload` (with the risk of losing other changes +that were not yet saved with `/save`). + +You can use the command `/set`, which checks the value and applies immediately +the changes. -* Display WeeChat options: +Help is available for options: ---- -/set weechat.* +/help config.section.option ---- -* Display IRC plugin options: +The plugin _fset_ allows you to easily browse options and change them. + +For example to display WeeChat options: ---- -/set irc.* +/fset weechat.* ---- -You can display help for an option with `/help`, for example: +IRC options: ---- -/help weechat.look.highlight +/fset irc.* ---- -All settings are saved when WeeChat ends (or with `/save` command to force -a write of the options). - -[IMPORTANT] -It is *not recommended* to edit configuration files by hand because WeeChat -may write them at any time (for example on `/quit`) and after any change -you must run the command `/reload` (with the risk of losing other changes -that were not yet saved with `/save`). + -You can use the command `/set`, which checks the value and applies immediately -the changes. +For more information about `/fset` command and keys, see `/help fset`. [[core_vs_plugins]] == Core vs plugins -- cgit debian/1.2.3+git2.25.1-1-2-gaceb0