aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2021-05-30 08:51:49 +0000
committerDaniel Eklöf <daniel@ekloef.se>2021-06-02 06:09:52 +0000
commitdde31ffaf9bb772e658a6ccf596b8e24fbbf442e (patch)
treea40e509b4203133323a24c69d1cdc1adab9423dc /doc
parentMerge branch 'pua-double-width' (diff)
doc: foot.1: add TERMINFO section
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.1.scd33
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/foot.1.scd b/doc/foot.1.scd
index fc93029b..455b2365 100644
--- a/doc/foot.1.scd
+++ b/doc/foot.1.scd
@@ -325,6 +325,39 @@ numbers, when in _application_ mode.
See *foot.ini*(5)
+# TERMINFO
+
+Client applications use the terminfo identifier specified by the
+environment variable *TERM* (set by foot) to determine terminal
+capabilities.
+
+Foot has two terminfo definitions: *foot* and *foot-direct*, with
+*foot* being the default.
+
+The difference between the two is in the number of colors they
+describe; *foot* describes 256 colors and *foot-direct* 24-bit
+truecolor.
+
+Note that using the *foot* terminfo does not limit the number of
+usable colors to 256; applications can still use 24-bit RGB colors. In
+fact, most applications work best with *foot* (including 24-bit
+colors)). Using *\*-direct* terminfo entries has been known to crash
+some ncurses applications even.
+
+There are nowever applications that need a *\*-direct* terminfo entry
+for 24-bit support. Emacs is one such example.
+
+While using either *foot* or *foot-direct* is strongly recommended, it
+is possible to use e.g. *xterm-256color* as well. This can be useful
+when remoting to a system where foot's terminfo entries cannot easily
+be installed.
+
+Note that terminfo entries can be installed in the user's home
+directory. I.e. if you do not have root access, or if there is no
+distro package for foot's terminfo entries, can install foot's
+terminfo entries manually, by copying *foot* and *foot-direct* to
+*~/.terminfo/f/*.
+
# ENVIRONMENT
The following environment variables are used by foot: