doc: foot{,,client}: document TERMINFO

Closes #691
This commit is contained in:
Daniel Eklöf 2021-08-27 13:16:49 +02:00
parent 88b2808dcd
commit 6e8da20ee2
No known key found for this signature in database
GPG key ID: 5BBD4992C116573F
2 changed files with 46 additions and 0 deletions

View file

@ -402,6 +402,29 @@ The following environment variables are set in the child process:
set according to either the *--term* command-line option or the
*term* config option in *foot.ini*(5).
*TERMINFO*
Path to foot's terminfo definitions. These are typically installed
in a non-standard location (though distributions may override
this), to allow them to co-exist with the foot terminfo
definitions in ncurses. Note that applications will search the
default location(s) if *TERM* does not exist in *TERMINFO*.
Note that applications like sudo and ssh will remove this
environment variable.
For sudo, you can create a file under _/etc/sudoers.d_ (name does
not matter) with the following content:
*Defaults env_keep += "TERMINFO"*
For ssh, you can edit _/etc/ssh/sshd_config_ (on the *server*),
and add:
*SetEnv TERMINFO=*_<path>_
Where path is the location of the terminfo definitions on the
*server*, typically /usr/share/foot/terminfo.
*COLORTERM*
This variable is set to *truecolor*, to indicate to client
applications that 24-bit RGB colors are supported.