aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2020-09-15 17:09:00 +0000
committerDaniel Eklöf <daniel@ekloef.se>2020-09-15 17:12:29 +0000
commitf2497320c68978fb4c25226966c11f115cb88e10 (patch)
tree542a60fb9c16a795955f7c60a4a17cd509d2292d /doc
parentinput: mouse_scroll(): refactor (diff)
config: add mouse.alternate-scroll-mode option
This option controls the initial state of the Alternate Scroll Mode, and defaults to ‘enabled’.
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.ini.5.scd18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/foot.ini.5.scd b/doc/foot.ini.5.scd
index 30c36b51..4513de05 100644
--- a/doc/foot.ini.5.scd
+++ b/doc/foot.ini.5.scd
@@ -143,6 +143,24 @@ applications can change these at runtime.
*hide-when-typing*
Boolean. When enabled, the mouse cursor is hidden while typing.
+*alternate-scroll-mode*
+ Boolean. This option controls the initial value for the _alternate
+ scroll mode_. When this mode is enabled, mouse scroll events are
+ translated to _up_/_down_ key events when displaying the alternate
+ screen.
+
+ This lets you scroll with the mouse in e.g. pagers (like _less_)
+ without enabling native mouse support in them.
+
+ Alternate scrolling is *not* used if the application enables
+ native mouse support.
+
+ This option can be modified by applications at run-time using the
+ escape sequences *CSI ? 1007 h* (enable) and *CSI ? 1007 l`
+ (disable).
+
+ Default: _yes_.
+
# SECTION: colors