aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2024-01-09 15:50:47 +0000
committerDaniel Eklöf <daniel@ekloef.se>2024-01-11 15:37:17 +0000
commit9da7152f834384a354710fcc8f99a6f83e5dfc12 (patch)
treed5dffcbe9133d87a034bf32d09b3ef25f4ddc610 /doc
parentconfig: fix cloning of env_vars tllist (diff)
slave: don't skip setting environment variables when using a custom environment
When launching footclient with -E,--client-environment the environment variables that should be set by foot, wasn't. Those variables are: * TERM * COLORTERM * PWD * SHELL and all variables defined by the user in the [environment] section in foot.ini. In the same way, we did not *unset* TERM_PROGRAM and TERM_PROGRAM_VERSION. This patch fixes it by "cloning" the custom environment, making it mutable, and then adding/removing the variables above from it. Instead of calling setenv()/unsetenv() directly, we add the wrapper functions add_to_env() and del_from_env(). When *not* using a custom environment, they simply call setenv()/unsetenv(). When we *are* using a custom environment, add_to_env() first loops all existing variables, looking for a match. If a match is found, it's updated with the new value. If it's not found, a new entry is added. del_from_env() loops all entries, and removes it when a match is found. If no match is found, nothing is done. The mutable environment is allocated on the heap, but never free:d. We don't need to free it, since it's only allocated after forking, in the child process. Closes #1568
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.1.scd21
-rw-r--r--doc/footclient.1.scd23
2 files changed, 41 insertions, 3 deletions
diff --git a/doc/foot.1.scd b/doc/foot.1.scd
index 3da6fd7e..385f9721 100644
--- a/doc/foot.1.scd
+++ b/doc/foot.1.scd
@@ -554,16 +554,31 @@ In all other cases, the exit code is that of the client application
set according to either the *--term* command-line option or the
*term* config option in *foot.ini*(5).
-*PWD*
- Current working directory (at the time of launching foot)
-
*COLORTERM*
This variable is set to *truecolor*, to indicate to client
applications that 24-bit RGB colors are supported.
+*PWD*
+ Current working directory (at the time of launching foot)
+
+*SHELL*
+ Set to the launched shell, if the shell is valid (it is listed in
+ */etc/shells*).
+
In addition to the variables listed above, custom environment
variables may be defined in *foot.ini*(5).
+## Variables *unset* in the child process
+
+*TERM_PROGRAM*
+*TERM_PROGRAM_VERSION*
+ These environment variables are set by certain other terminal
+ emulators. We unset them, to prevent applications from
+ misdetecting foot.
+
+In addition to the variables listed above, custom environment
+variables to unset may be defined in *foot.ini*(5).
+
# BUGS
Please report bugs to https://codeberg.org/dnkl/foot/issues
diff --git a/doc/footclient.1.scd b/doc/footclient.1.scd
index 7d89b9ed..365689af 100644
--- a/doc/footclient.1.scd
+++ b/doc/footclient.1.scd
@@ -73,6 +73,11 @@ terminal has terminated.
The child process in the new terminal instance will use
footclient's environment, instead of the server's.
+ Environment variables listed in the *Variables set in the child
+ process* section will be overwritten by the foot server. For
+ example, the new terminal will use *TERM* from the configuration,
+ not footclient's environment.
+
*-d*,*--log-level*={*info*,*warning*,*error*,*none*}
Log level, used both for log output on stderr as well as
syslog. Default: _warning_.
@@ -163,9 +168,27 @@ fallback to the less specific path, with the following priority:
This variable is set to *truecolor*, to indicate to client
applications that 24-bit RGB colors are supported.
+*PWD*
+ Current working directory (at the time of launching foot)
+
+*SHELL*
+ Set to the launched shell, if the shell is valid (it is listed in
+ */etc/shells*).
+
In addition to the variables listed above, custom environment
variables may be defined in *foot.ini*(5).
+## Variables *unset* in the child process
+
+*TERM_PROGRAM*
+*TERM_PROGRAM_VERSION*
+ These environment variables are set by certain other terminal
+ emulators. We unset them, to prevent applications from
+ misdetecting foot.
+
+In addition to the variables listed above, custom environment
+variables to unset may be defined in *foot.ini*(5).
+
# SEE ALSO
*foot*(1)