diff options
| author | Daniel Eklöf <daniel@ekloef.se> | 2021-05-30 08:53:54 +0000 |
|---|---|---|
| committer | Daniel Eklöf <daniel@ekloef.se> | 2021-06-02 06:10:02 +0000 |
| commit | a1a521b81d489916dc91958a1a1ab7f677887a08 (patch) | |
| tree | 017d924540f9328d26d8884ee56a646c90e3a2fb | |
| parent | doc: foot.1: -t,--term: add references to ENVIRONMENT and TERMINFO sections (diff) | |
doc: footclient.1: add TERMINFO section
| -rw-r--r-- | doc/footclient.1.scd | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/footclient.1.scd b/doc/footclient.1.scd index a66c5765..3afa755e 100644 --- a/doc/footclient.1.scd +++ b/doc/footclient.1.scd @@ -88,6 +88,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* 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 footclient: |
