aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2021-06-02 06:10:19 +0000
committerDaniel Eklöf <daniel@ekloef.se>2021-06-02 06:10:19 +0000
commit19429d13a3fbca694a6120c6402c0d3d3f14f34e (patch)
treef95a4064a8593ef66f03f30a17e0d4a240a83e96 /doc
parentMerge branch 'pua-double-width' (diff)
parentdoc: foot{,client}: updates from feedback from @craigbarnes (diff)
Merge branch 'document-terminfo'
Closes #549
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.1.scd36
-rw-r--r--doc/footclient.1.scd36
2 files changed, 70 insertions, 2 deletions
diff --git a/doc/foot.1.scd b/doc/foot.1.scd
index fc93029b..0ba4e4fc 100644
--- a/doc/foot.1.scd
+++ b/doc/foot.1.scd
@@ -52,7 +52,8 @@ the foot command line
Set initial window width and height, in characters. Default: _not set_.
*-t*,*--term*=_TERM_
- Value to set the environment variable *TERM* to. Default: _foot_.
+ Value to set the environment variable *TERM* to (see *TERMINFO*
+ and *ENVIRONMENT*). Default: _foot_.
*-T*,*--title*=_TITLE_
Initial window title. Default: _foot_.
@@ -325,6 +326,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* 16.7 million
+colors (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 however 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, you 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:
diff --git a/doc/footclient.1.scd b/doc/footclient.1.scd
index a66c5765..a9fb8c69 100644
--- a/doc/footclient.1.scd
+++ b/doc/footclient.1.scd
@@ -23,7 +23,8 @@ terminal has terminated.
# OPTIONS
*-t*,*--term*=_TERM_
- Value to set the environment variable *TERM* to. Default: _foot_.
+ Value to set the environment variable *TERM* to (see *TERMINFO*
+ and *ENVIRONMENT*). Default: _foot_.
*-T*,*--title*=_TITLE_
Initial window title. Default: _foot_.
@@ -88,6 +89,39 @@ failure in the foot server.
In all other cases the exit code is that of the client application
(i.e. the shell).
+# 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* 16.7 million
+colors (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 however 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, you can install foot's
+terminfo entries manually, by copying *foot* and *foot-direct* to
+*~/.terminfo/f/*.
+
# ENVIRONMENT
The following environment variables are used by footclient: