aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2020-07-25 12:31:45 +0000
committerDaniel Eklöf <daniel@ekloef.se>2020-07-25 12:31:45 +0000
commitc4679e474e0546ee8dad6e122c226ece85bdb134 (patch)
tree7621016462ce4d9346b4ed01ff3e06750f15871e /doc
parentconfig: add 'scrollback-indicator-format' option (diff)
config: rename scrollback-indicator to scrollback-indicator-style
And turn it from a boolean to an enum. It can be set to: * `none` - disables the indicator * `static` - always rendered near the top of the window * `moving` - position reflects the scrollback position
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.5.scd12
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/foot.5.scd b/doc/foot.5.scd
index 485886fa..9813741c 100644
--- a/doc/foot.5.scd
+++ b/doc/foot.5.scd
@@ -68,14 +68,18 @@ in this order:
*scrollback*
Number of scrollback lines. Default: _1000_.
-*scrollback-indicator*
- Boolean. Enables a position indicator when the viewport is not at
- the bottom of the scrollback history. Default: _yes_.
+*scrollback-indicator-style*
+ Configures the style of the scrollback position indicator. One of
+ *none*, *static* or *moving*. *none* disables the indicator
+ completely. *static* always renders the indicator near the top at
+ the window, and *moving* renders the indicator at the position
+ corresponding to the current scrollback position. Default:
+ _moving_.
*scrollback-indicator-format*
Which format to use when displaying the scrollback position
indicator. Either _percent_ or _line_. This option is ignored if
- *scrollback-indicator=no*. Default: _percent_.
+ *scrollback-indicator-style=none*. Default: _percent_.
*workers*
Number of threads to use for rendering. Set to 0 to disable