aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorCraig Barnes <craigbarnes@protonmail.com>2023-03-20 14:40:36 +0000
committerCraig Barnes <craigbarnes@protonmail.com>2023-03-20 14:40:36 +0000
commit5b2f02d826d8043b6b89860c56802ea5fed0f3bd (patch)
treea08db5e0a927767e975a9da3f37bab095f0f3d32 /doc
parentconfig: apply fontconfig rules if user didn’t set an explicit font size (diff)
slave: set $TERM_PROGRAM and $TERM_PROGRAM_VERSION environment variables
These are already being set by iTerm2, WezTerm, tmux and likely some others. Even though using yet more environment variables seems rather questionable, if we don't set these we run the risk of inheriting them from other terminals. See also: * https://gitlab.com/gnachman/iterm2/-/blob/97a6078df8e822da165e91737a01c0b9e115dd16/sources/PTYSession.m#L2568-2570 * https://github.com/tmux/tmux/blob/1d0f68dee9f71c504e03616fa472a408a6caa49b/environ.c#L263-L264 * https://github.com/search?q=TERM_PROGRAM&type=code
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.1.scd11
-rw-r--r--doc/footclient.1.scd11
2 files changed, 22 insertions, 0 deletions
diff --git a/doc/foot.1.scd b/doc/foot.1.scd
index 6f63d4c8..51c53130 100644
--- a/doc/foot.1.scd
+++ b/doc/foot.1.scd
@@ -546,6 +546,17 @@ In all other cases, the exit code is that of the client application
This variable is set to *truecolor*, to indicate to client
applications that 24-bit RGB colors are supported.
+*TERM_PROGRAM*
+ Always set to *foot*. This can be used by client applications to
+ check which terminal is in use, but with the caveat that it may
+ have been inherited from a parent process in other terminals that
+ aren't known to set the variable.
+
+*TERM_PROGRAM_VERSION*
+ Set to the foot version string, in the format _major_*.*_minor_*.*_patch_
+ or _major_*.*_minor_*.*_patch_*-*_revision_*-\g*_commit_ for inter-release
+ builds. The same caveat as for *TERM_PROGRAM* applies.
+
In addition to the variables listed above, custom environment
variables may be defined in *foot.ini*(5).
diff --git a/doc/footclient.1.scd b/doc/footclient.1.scd
index 63235134..189d9e3c 100644
--- a/doc/footclient.1.scd
+++ b/doc/footclient.1.scd
@@ -158,6 +158,17 @@ terminfo entries manually, by copying *foot* and *foot-direct* to
This variable is set to *truecolor*, to indicate to client
applications that 24-bit RGB colors are supported.
+*TERM_PROGRAM*
+ Always set to *foot*. This can be used by client applications to
+ check which terminal is in use, but with the caveat that it may
+ have been inherited from a parent process in other terminals that
+ aren't known to set the variable.
+
+*TERM_PROGRAM_VERSION*
+ Set to the foot version string, in the format _major_*.*_minor_*.*_patch_
+ or _major_*.*_minor_*.*_patch_*-*_revision_*-\g*_commit_ for inter-release
+ builds. The same caveat as for *TERM_PROGRAM* applies.
+
In addition to the variables listed above, custom environment
variables may be defined in *foot.ini*(5).