diff options
| author | Jonathan de Boyne Pollard <J.deBoynePollard-newsgroups@NTLWorld.com> | 2017-05-29 16:14:09 +0100 |
|---|---|---|
| committer | Jonathan de Boyne Pollard <J.deBoynePollard-newsgroups@NTLWorld.com> | 2017-06-03 18:53:28 +0100 |
| commit | c2a0fd349efa877e96a70ad49a47827ef0690cc6 (patch) | |
| tree | a4aa2a6929cc9c9fb5ac05314310a807d0bad10c | |
| parent | 533f5c38c4bcc6f6340efeffd1b20e6ea57e28b1 (diff) | |
| download | rneovim-c2a0fd349efa877e96a70ad49a47827ef0690cc6.tar.gz rneovim-c2a0fd349efa877e96a70ad49a47827ef0690cc6.tar.bz2 rneovim-c2a0fd349efa877e96a70ad49a47827ef0690cc6.zip | |
doco: Move TERM help into its own section and expand.
:help TERM previously pointed to a section that no longer even discussed the
variable.
| -rw-r--r-- | runtime/doc/starting.txt | 4 | ||||
| -rw-r--r-- | runtime/doc/term.txt | 16 |
2 files changed, 14 insertions, 6 deletions
diff --git a/runtime/doc/starting.txt b/runtime/doc/starting.txt index 4b3f894cf7..9fbf309847 100644 --- a/runtime/doc/starting.txt +++ b/runtime/doc/starting.txt @@ -214,7 +214,7 @@ argument. :set to display option values. When 'verbose' is non-zero messages are printed (for debugging, to stderr). - $TERM is not used. + $TERM (see |TERM|) is not used. If Vim appears to be stuck try typing "qa!<Enter>". You don't get a prompt thus you can't see Vim is waiting for you to type something. @@ -355,7 +355,7 @@ argument. At startup, Vim checks environment variables and files and sets values accordingly. Vim proceeds in this order: -1. Set the 'shell' option *SHELL* *COMSPEC* *TERM* +1. Set the 'shell' option *SHELL* *COMSPEC* The environment variable SHELL, if it exists, is used to set the 'shell' option. On Windows, the COMSPEC variable is used if SHELL is not set. diff --git a/runtime/doc/term.txt b/runtime/doc/term.txt index b15321e6f2..b6aa37a508 100644 --- a/runtime/doc/term.txt +++ b/runtime/doc/term.txt @@ -24,6 +24,7 @@ the pc terminal, for Unix an ansi terminal. On Unix the terminfo database is used. There is no access to the terminfo settings with |:set|. + *TERM* If you experience terminal difficulties, first ensure that you have set the correct terminal type in your $TERM environment variable so that Nvim is pulling the correct entry from the terminfo database in the first place. @@ -43,6 +44,16 @@ As noted in the commentary in the terminfo source file: incorrect; for starters it does not include tmux's italics and status line capabilities or correctly describe how to set inverse video. +Setting your $TERM environment variable to the correct value also avoids the +problem that SSH does not mirror arbitrary client-end environment variables +such as $COLORTERM, $XTERM_VERSION, $VTE_VERSION, $KONSOLE_PROFILE_NAME, and +$TERM_PROGRAM to the server end, whereas it does send the $TERM environment +variable. + +Note that the Unibilium library (used by Nvim to read terminfo) allows you to +override an out-of-date system terminfo database with one in your +$HOME/.terminfo/ directory, in part or in whole. + *builtin-terms* *builtin_terms* If a |terminfo| database is not available, or no entry for the terminal type is found in that database, Nvim will look up the terminal type in a compiled-in @@ -60,10 +71,7 @@ terminfo record is used as a final fallback. The built-in mini-database is not combined with an external terminfo database, nor can it be used in preference to one. You can thus entirely override any omissions or out-of-date information in the built-in terminfo database by -supplying an external one with entries for the terminal type. Note that the -Unibilium library (used by Nvim to read terminfo) allows you to override an -out-of-date system terminfo database with one in your $HOME/.terminfo/ -directory. +supplying an external one with entries for the terminal type. Settings depending on terminal *term-dependent-settings* |