diff options
| author | Daniel Eklöf <daniel@ekloef.se> | 2021-05-30 08:21:44 +0000 |
|---|---|---|
| committer | Daniel Eklöf <daniel@ekloef.se> | 2021-05-30 08:21:44 +0000 |
| commit | d5ff8c5f6f3e47df21d27ebc243089cc59dd60ef (patch) | |
| tree | 27c0fa7e9260d78afd897afd68fc822f0b595036 /doc | |
| parent | Merge branch 'include-directive' (diff) | |
| parent | changelog: add bug ref to ‘environment section added to foot/footclient’ (diff) | |
Merge branch 'environment-docs'
Closes #556
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/foot.1.scd | 43 | ||||
| -rw-r--r-- | doc/footclient.1.scd | 24 |
2 files changed, 67 insertions, 0 deletions
diff --git a/doc/foot.1.scd b/doc/foot.1.scd index 8537ee5f..fc93029b 100644 --- a/doc/foot.1.scd +++ b/doc/foot.1.scd @@ -325,6 +325,49 @@ numbers, when in _application_ mode. See *foot.ini*(5) +# ENVIRONMENT + +The following environment variables are used by foot: + +*SHELL* + The default child process to run, when no _command_ argument is + specified and the *shell* option in *foot.ini*(5) is not set. + +*XDG\_CONFIG\_HOME* + Used to determine the default location of *foot.ini*(5). + +*XDG\_CONFIG\_DIRS* + Used to determine the default fallback location of *foot.ini*(5), + when not found in *${XDG\_CONFIG\_HOME:-~/.config}*. + +*XDG\_RUNTIME\_DIR* + Used to construct the default _PATH_ for the *--server* + option, when no explicit argument is given (see above). + +*WAYLAND\_DISPLAY* + Used to construct the default _PATH_ for the *--server* + option, when no explicit argument is given (see above). + +*XCURSOR\_THEME* + The name of the *Xcursor*(3) theme to use for pointers (typically + set by the Wayland compositor). + +*XCURSOR\_SIZE* + The size to use for *Xcursor*(3) pointers (typically set by the + Wayland compositor). + +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. + # BUGS Please report bugs to https://codeberg.org/dnkl/foot/issues 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) |
