diff options
| author | Craig Barnes <craigbarnes@protonmail.com> | 2021-05-30 02:29:31 +0000 |
|---|---|---|
| committer | Daniel Eklöf <daniel@ekloef.se> | 2021-05-30 08:20:48 +0000 |
| commit | d08096b20166372ff8a811300276c11785553882 (patch) | |
| tree | 3926ec2a67794c15b44a1d316b9e3acb613c5237 /doc/footclient.1.scd | |
| parent | Merge branch 'include-directive' (diff) | |
doc: add ENVIRONMENT section to foot(1) and footclient(1) man pages
Closes #556
Diffstat (limited to 'doc/footclient.1.scd')
| -rw-r--r-- | doc/footclient.1.scd | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/footclient.1.scd b/doc/footclient.1.scd index fcd2f5d1..a66c5765 100644 --- a/doc/footclient.1.scd +++ b/doc/footclient.1.scd @@ -88,6 +88,30 @@ failure in the foot server. In all other cases the exit code is that of the client application (i.e. the shell). +# ENVIRONMENT + +The following environment variables are used by footclient: + +*XDG\_RUNTIME\_DIR* + Used to construct the default _PATH_ for the *--server-socket* + option, when no explicit argument is given (see above). + +*WAYLAND\_DISPLAY* + Used to construct the default _PATH_ for the *--server-socket* + option, when no explicit argument is given (see above). + +The following environment variables are set in the child process: + +*TERM* + terminfo/termcap identifier. This is used by client applications + to determine which capabilities a terminal supports. The value is + set according to either the *--term* command-line option or the + *term* config option in *foot.ini*(5). + +*COLORTERM* + This variable is set to *truecolor*, to indicate to client + applications that 24-bit RGB colors are supported. + # SEE ALSO *foot*(1) |
