mirrors/foot
1
0
Fork 0
mirror of https://codeberg.org/dnkl/foot.git synced 2026-02-08 10:06:22 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'document-terminfo'

Browse source 
Closes #549
This commit is contained in:
Daniel Eklöf 2021-06-02 08:10:19 +02:00
commit 19429d13a3
No known key found for this signature in database
GPG key ID: 5BBD4992C116573F
2 changed files with 70 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

36
doc/foot.1.scd
View file

@ -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:

36
doc/footclient.1.scd
View file

@ -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: