From 12ad276d1586b2fe3cff9620538e2542773bc0f1 Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Fri, 15 Dec 2017 11:45:22 +0200 Subject: [PATCH] Improve documentation of TERM environment variable * doc/emacs/trouble.texi (Checklist): * doc/emacs/building.texi (Compilation Shell): * doc/emacs/misc.texi (Shell Options): Improve indexing of TERM. * doc/emacs/building.texi (Compilation Shell): Mention 'comint-terminfo-terminal' in conjunction with the TERM value. --- doc/emacs/building.texi | 5 +++++ doc/emacs/misc.texi | 3 ++- doc/emacs/trouble.texi | 2 +- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/emacs/building.texi b/doc/emacs/building.texi index 87ac61bac3b..e108a4e7c10 100644 --- a/doc/emacs/building.texi +++ b/doc/emacs/building.texi @@ -303,6 +303,11 @@ And here's how to do it in csh: if ($?prompt) set prompt = @dots{} @end example +@vindex TERM, environment variable, in compilation mode + If you want to customize the value of the @env{TERM} environment +variable passed to the compilation subshell, customize the variable +@code{comint-terminfo-terminal} (@pxref{Shell Options}). + Emacs does not expect a compiler process to launch asynchronous subprocesses; if it does, and they keep running after the main compiler process has terminated, Emacs may kill them or their output diff --git a/doc/emacs/misc.texi b/doc/emacs/misc.texi index b6b396af8f5..e4be004ae52 100644 --- a/doc/emacs/misc.texi +++ b/doc/emacs/misc.texi @@ -1397,9 +1397,10 @@ directory stack if they are not already on it underlying shell, of course. @vindex comint-terminfo-terminal +@vindex TERM, environment variable, in sub-shell Comint mode sets the @env{TERM} environment variable to a safe default value, but this value disables some useful features. For example, -color is disabled for applications that use @env{TERM} to determine if +color is disabled in applications that use @env{TERM} to determine if color is supported. Therefore, Emacs provides an option @code{comint-terminfo-terminal}, which you can set to a terminal that is present in your system's terminfo database, in order to take diff --git a/doc/emacs/trouble.texi b/doc/emacs/trouble.texi index 4a836c3224b..e98322d74e2 100644 --- a/doc/emacs/trouble.texi +++ b/doc/emacs/trouble.texi @@ -780,7 +780,7 @@ the dribble file. @item @findex open-termscript @cindex termscript file -@cindex @env{TERM} environment variable +@vindex TERM, environment variable, and display bugs For possible display bugs, the terminal type (the value of environment variable @env{TERM}), the complete termcap entry for the terminal from @file{/etc/termcap} (since that file is not identical on all machines), -- 2.39.2