diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/foot.1.scd | 6 | ||||
| -rw-r--r-- | doc/footrc.5.scd (renamed from doc/foot.5.scd) | 24 | ||||
| -rw-r--r-- | doc/meson.build | 2 |
3 files changed, 25 insertions, 7 deletions
diff --git a/doc/foot.1.scd b/doc/foot.1.scd index 883ae8b1..c22eea70 100644 --- a/doc/foot.1.scd +++ b/doc/foot.1.scd @@ -119,7 +119,7 @@ The following keyboard shortcuts are available. ## NORMAL MODE Note that these are just the defaults; they can be changed in the -*footrc*, see *foot*(5). +*footrc*, see *footrc*(5). *shift*+*page up*/*page down* Scroll up/down in history @@ -239,7 +239,7 @@ Finally, pressing *alt* will prefix the transmitted byte with ESC. # CONFIGURATION -See *foot*(5) +See *footrc*(5) # BUGS @@ -256,4 +256,4 @@ The report should contain the following: # SEE ALSO -*foot*(5), *footclient*(1) +*footrc*(5), *footclient*(1) diff --git a/doc/foot.5.scd b/doc/footrc.5.scd index 7c3ab283..6bba164f 100644 --- a/doc/foot.5.scd +++ b/doc/footrc.5.scd @@ -1,7 +1,7 @@ -foot(5) +footrc(5) # NAME -foot - configuration file +footrc - configuration file # DESCRIPTION @@ -68,6 +68,20 @@ in this order: *scrollback* Number of scrollback lines. Default: _1000_. +*scrollback-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 + the window, and *relative* renders the indicator at the position + corresponding to the current scrollback position. Default: + _relative_. + +*scrollback-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 @@ -176,7 +190,7 @@ This section lets you override the default key bindings. The general format is _action=combo1...comboN_. That is, each action may have one or more key combinations, space separated. Each combination is on the form _mod1+mod2+key_. The names of the modifiers -and the key *must* be a valid XKB key name. +and the key *must* be valid XKB key names. Note that if *Shift* is one of the modifiers, the _key_ *must* be in upper case. For example, *Control+Shift+v* will never trigger - @@ -398,3 +412,7 @@ any of these options. Note: this feature is always disabled in 32-bit. Default: _512_. Maximum allowed: _2048_ (2GB). + +# SEE ALSO + +*foot*(1), *footclient*(1) diff --git a/doc/meson.build b/doc/meson.build index 6d3219dc..39697496 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -3,7 +3,7 @@ sh = find_program('sh', native: true) scdoc = dependency('scdoc', native: true) scdoc_prog = find_program(scdoc.get_pkgconfig_variable('scdoc'), native: true) -foreach man_src : ['foot.1.scd', 'foot.5.scd', 'footclient.1.scd'] +foreach man_src : ['foot.1.scd', 'footrc.5.scd', 'footclient.1.scd'] parts = man_src.split('.') name = parts[-3] section = parts[-2] |
