aboutsummaryrefslogtreecommitdiff
path: root/doc/toggle_flags.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/toggle_flags.txt')
-rw-r--r--doc/toggle_flags.txt30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/toggle_flags.txt b/doc/toggle_flags.txt
new file mode 100644
index 0000000..81bf04d
--- /dev/null
+++ b/doc/toggle_flags.txt
@@ -0,0 +1,30 @@
+*toggle_flags.txt* For Vim version 6.0 Last change: 2018 July 19
+
+DESCRIPTION *toggle_flags*
+
+ *:ToggleFlag* *:ToggleFlagLocal*
+This plugin provides `:ToggleFlag` and `:ToggleFlagLocal` commands
+to toggle the values of options like |'formatoptions'| or |'complete'| that
+have values comprised of single-character or comma-separated flags. The author
+originally designed it for toggling flags in |'formatoptions'| quickly.
+
+EXAMPLES *toggle_flags-examples*
+>
+ :ToggleFlag formatoptions a
+ :ToggleFlag switchbuf useopen
+ :ToggleFlagLocal shortmess I
+<
+REQUIREMENTS *toggle_flags-requirements*
+
+This plugin is only available if 'compatible' is not set. It also requires the
+|+user_commands| Vim feature.
+
+AUTHOR *toggle_flags-author*
+
+Written and maintained by Tom Ryder <tom@sanctum.geek.nz>.
+
+LICENSE *toggle_flags-license*
+
+Licensed for distribution under the same terms as Vim itself (see |license|).
+
+ vim:tw=78:ts=8:ft=help:norl: