aboutsummaryrefslogtreecommitdiff
path: root/doc/footclient.1.scd
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2021-05-30 08:21:44 +0000
committerDaniel Eklöf <daniel@ekloef.se>2021-05-30 08:21:44 +0000
commitd5ff8c5f6f3e47df21d27ebc243089cc59dd60ef (patch)
tree27c0fa7e9260d78afd897afd68fc822f0b595036 /doc/footclient.1.scd
parentMerge branch 'include-directive' (diff)
parentchangelog: add bug ref to ‘environment section added to foot/footclient’ (diff)
Merge branch 'environment-docs'
Closes #556
Diffstat (limited to 'doc/footclient.1.scd')
-rw-r--r--doc/footclient.1.scd24
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)