diff options
| author | Daniel Eklöf <daniel@ekloef.se> | 2021-08-27 11:16:49 +0000 |
|---|---|---|
| committer | Daniel Eklöf <daniel@ekloef.se> | 2021-08-27 11:31:15 +0000 |
| commit | 6e8da20ee22e07d271a47a53e43f35ba41e55281 (patch) | |
| tree | 9b4ca558f7ed2c3231d704c401b81a79167d3400 | |
| parent | meson: run generate_version.sh in a C locale (diff) | |
doc: foot{,,client}: document TERMINFO
Closes #691
| -rw-r--r-- | doc/foot.1.scd | 23 | ||||
| -rw-r--r-- | doc/footclient.1.scd | 23 |
2 files changed, 46 insertions, 0 deletions
diff --git a/doc/foot.1.scd b/doc/foot.1.scd index bbe784bc..cbebd087 100644 --- a/doc/foot.1.scd +++ b/doc/foot.1.scd @@ -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. diff --git a/doc/footclient.1.scd b/doc/footclient.1.scd index b252d5e1..155683da 100644 --- a/doc/footclient.1.scd +++ b/doc/footclient.1.scd @@ -146,6 +146,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. |
