From c7f4abaef64e994854c6dce5d01b61105a448714 Mon Sep 17 00:00:00 2001
From: Florent Le Coz <louiz@louiz.org>
Date: Sat, 15 Dec 2012 03:28:06 +0100
Subject: Add support for /set <option> toggle, which toggles the current value

fix #2184
---
 doc/en/usage.txt | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

(limited to 'doc')

diff --git a/doc/en/usage.txt b/doc/en/usage.txt
index 002585a4..dd9f924f 100644
--- a/doc/en/usage.txt
+++ b/doc/en/usage.txt
@@ -276,14 +276,17 @@ These commands work in *any* tab.
 
 */bookmarks*:: Show the current bookmarks.
 
-*/set [plugin|][section] <option> <value>*:: Set the value to the option in your
- configuration file. You can, for example, change your default nickname by
- doing "/set default_nick toto" or your resource with "/set resource blabla".
- Doing so will write in the main config file, and in the main section
- ([Poezio]). But you can also write to another section, with "/set bindings
- M-i ^i", to a plugin configuration with "/set mpd_client| host main" (notice
- the *|*, it is mandatory to write in a plugin), or even to another section
- in a plugin configuration "/set plugin|other_section option value".
+*/set [plugin|][section] <option> <value>*:: Set the value to the option in
+ your configuration file. You can, for example, change your default nickname
+ by doing "/set default_nick toto" or your resource with "/set resource
+ blabla".  Doing so will write in the main config file, and in the main
+ section ([Poezio]). But you can also write to another section, with "/set
+ bindings M-i ^i", to a plugin configuration with "/set mpd_client| host
+ main" (notice the *|*, it is mandatory to write in a plugin), or even to
+ another section in a plugin configuration "/set plugin|other_section option
+ value".  *toggle* can be used as a special value for a boolean option. It
+ just set the option to true if it’s currently false, and to false if it’s
+ currently true.
 
 */move_tab <source> <destination>*:: Move tab <source> to <destination>. If
 the create_gaps option is true, then it will leave a gap at the <source>
-- 
cgit v1.2.3