aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2020-07-29 15:41:24 +0000
committerDaniel Eklöf <daniel@ekloef.se>2020-07-29 15:41:24 +0000
commitd11d374252e4a45e98a38b741c74e0eda539deca (patch)
tree456af0676ae7c61dbc67e79c3585565121570046 /doc
parentdoc: footrc.5: add 'uniq | tac' to the pipe-visible example (diff)
config: add scrollback section
* Move 'scrollback' to 'scrollback.lines' * Move (the new) 'scrollback-indicator-*' options to 'scrollback.indicator-*' Log a deprecation warning when the old 'scrollback' option is used, but don't remove it, yet.
Diffstat (limited to 'doc')
-rw-r--r--doc/footrc.5.scd23
1 files changed, 13 insertions, 10 deletions
diff --git a/doc/footrc.5.scd b/doc/footrc.5.scd
index 4ab6f7ce..c148d27f 100644
--- a/doc/footrc.5.scd
+++ b/doc/footrc.5.scd
@@ -65,10 +65,19 @@ in this order:
compositor can use this value to e.g. group multiple windows, or
apply window management rules. Default: _foot_.
-*scrollback*
+*workers*
+ Number of threads to use for rendering. Set to 0 to disable
+ multithreading. Default: the number of available logical CPUs
+ (including SMT). Note that this is not always the best value. In
+ some cases, the number of physical _cores_ is better.
+
+
+# SECTION: scrollback
+
+*lines*
Number of scrollback lines. Default: _1000_.
-*scrollback-indicator-position*
+*indicator-position*
Configures the style of the scrollback position indicator. One of
*none*, *fixed* or *relative*. *none* disables the indicator
completely. *fixed* always renders the indicator near the top at
@@ -76,17 +85,11 @@ in this order:
corresponding to the current scrollback position. Default:
_relative_.
-*scrollback-indicator-format*
+*indicator-format*
Which format to use when displaying the scrollback position
indicator. Either _percentage_, _line_, or a custom fixed
string. This option is ignored if
- *scrollback-indicator-position=none*. Default: _empty string_.
-
-*workers*
- Number of threads to use for rendering. Set to 0 to disable
- multithreading. Default: the number of available logical CPUs
- (including SMT). Note that this is not always the best value. In
- some cases, the number of physical _cores_ is better.
+ *indicator-position=none*. Default: _empty string_.
# SECTION: cursor