From dde31ffaf9bb772e658a6ccf596b8e24fbbf442e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Ekl=C3=B6f?= Date: Sun, 30 May 2021 10:51:49 +0200 Subject: [PATCH 1/5] doc: foot.1: add TERMINFO section --- doc/foot.1.scd | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/doc/foot.1.scd b/doc/foot.1.scd index fc93029b..455b2365 100644 --- a/doc/foot.1.scd +++ b/doc/foot.1.scd @@ -325,6 +325,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* 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 foot: From d6715625e2536a185d3378d468a9934c79e845ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Ekl=C3=B6f?= Date: Sun, 30 May 2021 10:52:01 +0200 Subject: [PATCH 2/5] doc: foot.1: -t,--term: add references to ENVIRONMENT and TERMINFO sections --- doc/foot.1.scd | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/foot.1.scd b/doc/foot.1.scd index 455b2365..cdc6822e 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_. From a1a521b81d489916dc91958a1a1ab7f677887a08 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Ekl=C3=B6f?= Date: Sun, 30 May 2021 10:53:54 +0200 Subject: [PATCH 3/5] doc: footclient.1: add TERMINFO section --- doc/footclient.1.scd | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) 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: From 1321b23567597289ed5d4d5feba777bf2bc0c4d4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Ekl=C3=B6f?= Date: Sun, 30 May 2021 10:54:02 +0200 Subject: [PATCH 4/5] doc: footclient.1: -t,--term: add references to ENVIRONMENT and TERMINFO sections --- doc/footclient.1.scd | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/footclient.1.scd b/doc/footclient.1.scd index 3afa755e..2abab9e2 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_. From 2ffedc708220179e81aa1b2a271f3f91c7adf36b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Ekl=C3=B6f?= Date: Tue, 1 Jun 2021 19:02:53 +0200 Subject: [PATCH 5/5] doc: foot{,client}: updates from feedback from @craigbarnes --- doc/foot.1.scd | 8 ++++---- doc/footclient.1.scd | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/foot.1.scd b/doc/foot.1.scd index cdc6822e..0ba4e4fc 100644 --- a/doc/foot.1.scd +++ b/doc/foot.1.scd @@ -336,8 +336,8 @@ 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. +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 @@ -345,7 +345,7 @@ 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 +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 @@ -355,7 +355,7 @@ 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 +distro package for foot's terminfo entries, you can install foot's terminfo entries manually, by copying *foot* and *foot-direct* to *~/.terminfo/f/*. diff --git a/doc/footclient.1.scd b/doc/footclient.1.scd index 2abab9e2..a9fb8c69 100644 --- a/doc/footclient.1.scd +++ b/doc/footclient.1.scd @@ -99,8 +99,8 @@ 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. +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 @@ -108,7 +108,7 @@ 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 +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 @@ -118,7 +118,7 @@ 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 +distro package for foot's terminfo entries, you can install foot's terminfo entries manually, by copying *foot* and *foot-direct* to *~/.terminfo/f/*.