diff runtime/doc/terminal.txt @ 11965:a932d3da41c8 v8.0.0863

patch 8.0.0863: a remote command does not work in the terminal window commit https://github.com/vim/vim/commit/69198197fd4b061be7cadcf441cd8a7246a17148 Author: Bram Moolenaar <Bram@vim.org> Date: Sat Aug 5 14:10:48 2017 +0200 patch 8.0.0863: a remote command does not work in the terminal window Problem: A remote command starting with CTRL-\ CTRL-N does not work in the terminal window. (Christian J. Robinson) Solution: Use CTRL-\ CTRL-N as a prefix or a Normal mode command.
author Christian Brabandt <cb@256bit.org>
date Sat, 05 Aug 2017 14:15:04 +0200
parents 4f7081eb1e26
children 12833414cc02
line wrap: on
line diff
--- a/runtime/doc/terminal.txt
+++ b/runtime/doc/terminal.txt
@@ -61,6 +61,11 @@ the job.  For example:
 	'termkey' .	    send a CTRL-W to the job in the terminal
 	'termkey' N  	    go to terminal Normal mode, see below
 	'termkey' CTRL-N    same as CTRL-W N
+							*t_CTRL-\_CTRL-N*
+The special key combination CTRL-\ CTRL-N can be used to prefix one Normal
+mode command.  This is especially useful for remote commands, when you don't
+know whether Vim currently has focus in a terminal window.  Note that only one
+Normal mode command can be used.
 
 
 Size ~
@@ -142,6 +147,23 @@ displayed.
 In Terminal mode the statusline and window title show "(Terminal)".  If the
 job ends while in Terminal mode this changes to "(Terminal-finished)".
 
+Environment variables are used to pass information to the running job:
+    TERM		name of the terminal, 'term'
+    ROWS		number of rows in the terminal initially
+    LINES		same as ROWS
+    COLUMNS		number of columns in the terminal initially
+    COLORS		number of colors, 't_Co' (256*256*256 in the GUI)
+    VIM_SERVERNAME	v:servername
+
+The |client-server| feature can be used to communicate with the Vim instance
+where the job was started.  This only works when v:servername is not empty.
+If needed you can set it with: >
+	call remote_startserver('vim-server')
+
+In the job you can then do something like: >
+	vim --servername $VIM_SERVERNAME --remote +123 some_file.c
+This will open the file "some_file.c" and put the cursor on line 123.
+
 
 Unix ~