Skip to content

Commit

Permalink
Updated runtime files
Browse files Browse the repository at this point in the history
  • Loading branch information
brammool committed Aug 1, 2017
1 parent 20e6cd0 commit f55e4c8
Show file tree
Hide file tree
Showing 23 changed files with 3,474 additions and 2,776 deletions.
9 changes: 5 additions & 4 deletions runtime/doc/develop.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*develop.txt* For Vim version 8.0. Last change: 2017 Jan 05
*develop.txt* For Vim version 8.0. Last change: 2017 Jul 31


VIM REFERENCE MANUAL by Bram Moolenaar
Expand Down Expand Up @@ -143,9 +143,10 @@ and its environment.

VIM IS... NOT *design-not*

- Vim is not a shell or an Operating System. You will not be able to run a
shell inside Vim or use it to control a debugger. This should work the
other way around: Use Vim as a component from a shell or in an IDE.
- Vim is not a shell or an Operating System. It does provide a terminal
window, in which you can run a shell or debugger. E.g. to be able to do
this over an ssh connection. But if you don't need a text editor with that
it is out of scope (use something like screen or tmux instead).
A satirical way to say this: "Unlike Emacs, Vim does not attempt to include
everything but the kitchen sink, but some people say that you can clean one
with it. ;-)"
Expand Down
4 changes: 2 additions & 2 deletions runtime/doc/editing.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*editing.txt* For Vim version 8.0. Last change: 2017 Jul 16
*editing.txt* For Vim version 8.0. Last change: 2017 Aug 01


VIM REFERENCE MANUAL by Bram Moolenaar
Expand Down Expand Up @@ -1737,7 +1737,7 @@ There are three different types of searching:
This searches the same directories, but in a different order.

Note that completion for ":find", ":sfind", and ":tabfind" commands do not
currently work with 'path' items that contain a url or use the double star
currently work with 'path' items that contain a URL or use the double star
with depth limiter (/usr/**2) or upward search (;) notations.

vim:tw=78:ts=8:ft=help:norl:
6 changes: 3 additions & 3 deletions runtime/doc/ft_rust.txt
Original file line number Diff line number Diff line change
Expand Up @@ -116,13 +116,13 @@ g:rustfmt_options~

*g:rust_playpen_url*
g:rust_playpen_url~
Set this option to override the url for the playpen to use: >
Set this option to override the URL for the playpen to use: >
let g:rust_playpen_url = 'https://play.rust-lang.org/'
<

*g:rust_shortener_url*
g:rust_shortener_url~
Set this option to override the url for the url shortener: >
Set this option to override the URL for the URL shortener: >
let g:rust_shortener_url = 'https://is.gd/'
<

Expand Down Expand Up @@ -199,7 +199,7 @@ COMMANDS *rust-commands*
|g:rust_playpen_url| is the base URL to the playpen, by default
"https://play.rust-lang.org/".

|g:rust_shortener_url| is the base url for the shorterner, by
|g:rust_shortener_url| is the base URL for the shorterner, by
default "https://is.gd/"

:RustFmt *:RustFmt*
Expand Down
4 changes: 2 additions & 2 deletions runtime/doc/gui_x11.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*gui_x11.txt* For Vim version 8.0. Last change: 2017 Jun 27
*gui_x11.txt* For Vim version 8.0. Last change: 2017 Jul 28


VIM REFERENCE MANUAL by Bram Moolenaar
Expand Down Expand Up @@ -673,7 +673,7 @@ Of these three, Vim uses PRIMARY when reading and writing the "* register
register. Vim does not access the SECONDARY selection.

Examples: (assuming the default option values)
- Select an URL in Visual mode in Vim. Go to your browser and click the
- Select a URL in Visual mode in Vim. Go to your browser and click the
middle mouse button in the URL text field. The selected text will be
inserted (hopefully!). Note: in Firefox you can set the
middlemouse.contentLoadURL preference to true in about:config, then the
Expand Down
5 changes: 4 additions & 1 deletion runtime/doc/index.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*index.txt* For Vim version 8.0. Last change: 2017 Jul 16
*index.txt* For Vim version 8.0. Last change: 2017 Jul 30


VIM REFERENCE MANUAL by Bram Moolenaar
Expand Down Expand Up @@ -528,8 +528,10 @@ tag command action in Normal mode ~
|CTRL-W_CTRL-]| CTRL-W CTRL-] same as "CTRL-W ]"
|CTRL-W_CTRL-^| CTRL-W CTRL-^ same as "CTRL-W ^"
|CTRL-W_CTRL-_| CTRL-W CTRL-_ same as "CTRL-W _"
|CTRL-W_quote| CTRL-W " terminal window: paste register
|CTRL-W_+| CTRL-W + increase current window height N lines
|CTRL-W_-| CTRL-W - decrease current window height N lines
|CTRL-W_.| CTRL-W . terminal window: type CTRL-W
|CTRL-W_:| CTRL-W : same as |:|, edit a command line
|CTRL-W_<| CTRL-W < decrease current window width N columns
|CTRL-W_=| CTRL-W = make all windows the same height & width
Expand All @@ -538,6 +540,7 @@ tag command action in Normal mode ~
|CTRL-W_J| CTRL-W J move current window to the very bottom
|CTRL-W_K| CTRL-W K move current window to the very top
|CTRL-W_L| CTRL-W L move current window to the far right
|CTRL-W_N| CTRL-W N terminal window: go to Terminal mode
|CTRL-W_P| CTRL-W P go to preview window
|CTRL-W_R| CTRL-W R rotate windows upwards N times
|CTRL-W_S| CTRL-W S same as "CTRL-W s"
Expand Down
9 changes: 7 additions & 2 deletions runtime/doc/intro.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*intro.txt* For Vim version 8.0. Last change: 2017 Jul 17
*intro.txt* For Vim version 8.0. Last change: 2017 Jul 30


VIM REFERENCE MANUAL by Bram Moolenaar
Expand Down Expand Up @@ -566,7 +566,7 @@ Ex mode Like Command-line mode, but after entering a command
you remain in Ex mode. Very limited editing of the
command line. |Ex-mode|

There are six ADDITIONAL modes. These are variants of the BASIC modes:
There are seven ADDITIONAL modes. These are variants of the BASIC modes:

*Operator-pending* *Operator-pending-mode*
Operator-pending mode This is like Normal mode, but after an operator
Expand All @@ -592,6 +592,11 @@ Insert Normal mode Entered when CTRL-O given in Insert mode. This is
If the 'showmode' option is on "-- (insert) --" is
shown at the bottom of the window.

Terminal Normal mode Using Normal mode in a terminal window. Making
changes is impossible. Use a insert command, such as
"a" or "i", to return control to the job running in
the terminal. Also called |Terminal-mode|.

Insert Visual mode Entered when starting a Visual selection from Insert
mode, e.g., by using CTRL-O and then "v", "V" or
CTRL-V. When the Visual selection ends, Vim returns
Expand Down
18 changes: 11 additions & 7 deletions runtime/doc/options.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*options.txt* For Vim version 8.0. Last change: 2017 Jul 23
*options.txt* For Vim version 8.0. Last change: 2017 Jul 31


VIM REFERENCE MANUAL by Bram Moolenaar
Expand Down Expand Up @@ -4040,7 +4040,8 @@ A jump table for the options with a short description can be found at |Q_op|.
L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel,
x:PmenuSbar,X:PmenuThumb,*:TabLine,
#:TabLineSel,_:TabLineFill,!:CursorColumn,
.:CursorLine,o:ColorColumn,q:QuickFixLine")
.:CursorLine,o:ColorColumn,q:QuickFixLine,
$:StatusLineTerm")
global
{not in Vi}
This option can be used to set highlighting mode for various
Expand Down Expand Up @@ -7753,14 +7754,17 @@ A jump table for the options with a short description can be found at |Q_op|.
NOTE: This option is reset when 'compatible' is set.

*'termkey'* *'tk'*
'termkey' 'tk' string (default "CTRL-W")
'termkey' 'tk' string (default "")
local to window
{not in Vi}
The key that precedes a Vim command in a terminal window. Other keys
The key that starts a CTRL-W command in a terminal window. Other keys
are sent to the job running in the window.
The string must be one key stroke but can be multiple bytes.
NOT IMPLEMENTED YET

The <> notation can be used, e.g.: >
:set termkey=<C-L>
< The string must be one key stroke but can be multiple bytes.
When not set CTRL-W is used, so that CTRL-W : gets you to the command
line. If 'termkey' is set to CTRL-L then CTRL-L : gets you to the
command line.

*'termsize'* *'tms'*
'termsize' 'tms' string (default "")
Expand Down
4 changes: 2 additions & 2 deletions runtime/doc/pi_getscript.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*pi_getscript.txt* For Vim version 7.0. Last change: 2013 Nov 29
*pi_getscript.txt* For Vim version 7.0. Last change: 2017 Aug 01
>
GETSCRIPT REFERENCE MANUAL by Charles E. Campbell
<
Expand Down Expand Up @@ -389,7 +389,7 @@ v36 Apr 22, 2013 : * (glts) suggested use of plugin/**/*.vim instead of
plugin/*.vim in globpath() call.
* (Andy Wokula) got warning message when setting
g:loaded_getscriptPlugin
v35 Apr 07, 2012 : * (MengHuan Yu) pointed out that the script url has
v35 Apr 07, 2012 : * (MengHuan Yu) pointed out that the script URL has
changed (somewhat). However, it doesn't work, and
the original one does (under Linux). I'll make it
yet-another-option.
Expand Down
3 changes: 2 additions & 1 deletion runtime/doc/quickref.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*quickref.txt* For Vim version 8.0. Last change: 2017 Jul 15
*quickref.txt* For Vim version 8.0. Last change: 2017 Aug 01


VIM REFERENCE MANUAL by Bram Moolenaar
Expand Down Expand Up @@ -954,6 +954,7 @@ Short explanation of each option: *option-list*
'viewdir' 'vdir' directory where to store files with :mkview
'viewoptions' 'vop' specifies what to save for :mkview
'viminfo' 'vi' use .viminfo file upon startup and exiting
'viminfofile' 'vif' file name used for the viminfo file
'virtualedit' 've' when to use virtual editing
'visualbell' 'vb' use visual bell instead of beeping
'warn' warn for shell command when buffer was changed
Expand Down
4 changes: 2 additions & 2 deletions runtime/doc/remote.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*remote.txt* For Vim version 8.0. Last change: 2017 Mar 18
*remote.txt* For Vim version 8.0. Last change: 2017 Aug 01


VIM REFERENCE MANUAL by Bram Moolenaar
Expand Down Expand Up @@ -99,7 +99,7 @@ Tell the remote server "BLA" to write all files and exit: >
vim --servername BLA --remote-send '<C-\><C-N>:wqa<CR>'
SERVER NAME
SERVER NAME *client-server-name*

By default Vim will try to register the name under which it was invoked (gvim,
egvim ...). This can be overridden with the --servername argument. If the
Expand Down
16 changes: 14 additions & 2 deletions runtime/doc/tags
Original file line number Diff line number Diff line change
Expand Up @@ -3535,6 +3535,7 @@ CTRL-V-alternative gui_w32.txt /*CTRL-V-alternative*
CTRL-W index.txt /*CTRL-W*
CTRL-W_+ windows.txt /*CTRL-W_+*
CTRL-W_- windows.txt /*CTRL-W_-*
CTRL-W_. terminal.txt /*CTRL-W_.*
CTRL-W_: windows.txt /*CTRL-W_:*
CTRL-W_< windows.txt /*CTRL-W_<*
CTRL-W_<BS> windows.txt /*CTRL-W_<BS>*
Expand Down Expand Up @@ -3574,6 +3575,7 @@ CTRL-W_H windows.txt /*CTRL-W_H*
CTRL-W_J windows.txt /*CTRL-W_J*
CTRL-W_K windows.txt /*CTRL-W_K*
CTRL-W_L windows.txt /*CTRL-W_L*
CTRL-W_N terminal.txt /*CTRL-W_N*
CTRL-W_P windows.txt /*CTRL-W_P*
CTRL-W_R windows.txt /*CTRL-W_R*
CTRL-W_S windows.txt /*CTRL-W_S*
Expand Down Expand Up @@ -3601,6 +3603,7 @@ CTRL-W_n windows.txt /*CTRL-W_n*
CTRL-W_o windows.txt /*CTRL-W_o*
CTRL-W_p windows.txt /*CTRL-W_p*
CTRL-W_q windows.txt /*CTRL-W_q*
CTRL-W_quote terminal.txt /*CTRL-W_quote*
CTRL-W_r windows.txt /*CTRL-W_r*
CTRL-W_s windows.txt /*CTRL-W_s*
CTRL-W_t windows.txt /*CTRL-W_t*
Expand Down Expand Up @@ -4531,6 +4534,7 @@ E942 eval.txt /*E942*
E943 message.txt /*E943*
E944 pattern.txt /*E944*
E945 pattern.txt /*E945*
E946 terminal.txt /*E946*
E95 message.txt /*E95*
E96 diff.txt /*E96*
E97 diff.txt /*E97*
Expand Down Expand Up @@ -4772,6 +4776,7 @@ TabNew autocmd.txt /*TabNew*
Tcl if_tcl.txt /*Tcl*
TermChanged autocmd.txt /*TermChanged*
TermResponse autocmd.txt /*TermResponse*
Terminal-mode terminal.txt /*Terminal-mode*
TextChanged autocmd.txt /*TextChanged*
TextChangedI autocmd.txt /*TextChangedI*
Transact-SQL ft_sql.txt /*Transact-SQL*
Expand Down Expand Up @@ -5409,6 +5414,7 @@ cinoptions-values indent.txt /*cinoptions-values*
clear-undo undo.txt /*clear-undo*
clearmatches() eval.txt /*clearmatches()*
client-server remote.txt /*client-server*
client-server-name remote.txt /*client-server-name*
clientserver remote.txt /*clientserver*
clipboard gui.txt /*clipboard*
clipboard-autoselect options.txt /*clipboard-autoselect*
Expand Down Expand Up @@ -8791,11 +8797,17 @@ tempname() eval.txt /*tempname()*
term-dependent-settings term.txt /*term-dependent-settings*
term-list syntax.txt /*term-list*
term.txt term.txt /*term.txt*
term_getattr() eval.txt /*term_getattr()*
term_getcursor() eval.txt /*term_getcursor()*
term_getjob() eval.txt /*term_getjob()*
term_getline() eval.txt /*term_getline()*
term_getsize() eval.txt /*term_getsize()*
term_open() eval.txt /*term_open()*
term_getstatus() eval.txt /*term_getstatus()*
term_gettitle() eval.txt /*term_gettitle()*
term_list() eval.txt /*term_list()*
term_scrape() eval.txt /*term_scrape()*
term_sendkeys() eval.txt /*term_sendkeys()*
term_setsize() eval.txt /*term_setsize()*
term_start() eval.txt /*term_start()*
term_wait() eval.txt /*term_wait()*
termcap term.txt /*termcap*
termcap-changed version4.txt /*termcap-changed*
Expand Down
53 changes: 40 additions & 13 deletions runtime/doc/terminal.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*terminal.txt* For Vim version 8.0. Last change: 2017 Jul 30
*terminal.txt* For Vim version 8.0. Last change: 2017 Aug 01


VIM REFERENCE MANUAL by Bram Moolenaar
Expand Down Expand Up @@ -48,6 +48,9 @@ See |CTRL-W| for more commands.
Special in the terminal window: *CTRL-W_.* *CTRL-W_N*
CTRL-W . send a CTRL-W to the job in the terminal
CTRL-W N go to Terminal Normal mode, see |Terminal-mode|
CTRL-W " {reg} paste register {reg} *CTRL-W_quote*
Also works with the = register to insert the result of
evaluating an expression.

See option 'termkey' for specifying another key instead of CTRL-W that
will work like CTRL-W. However, typing 'termkey' twice sends 'termkey' to
Expand Down Expand Up @@ -76,21 +79,28 @@ Syntax ~
If [command] is not given the 'shell' option is used.

A new buffer will be created, using [command] or
'shell' as the name. If a buffer by this name already
exists a number is added in parenthesis.
E.g. if "gdb" exists the second terminal buffer will
use "gdb (1)".

The window can be closed, in which case the buffer
becomes hidden. The command will not be stopped. The
`:buffer` command can be used to turn the current
window into a terminal window, using the existing
buffer. If there are unsaved changes this fails, use
! to force, as usual.
'shell' as the name, prefixed with a "!". If a buffer
by this name already exists a number is added in
parenthesis. E.g. if "gdb" exists the second terminal
buffer will use "!gdb (1)".

When the buffer associated with the terminal is wiped out the job is killed,
similar to calling `job_stop(job, "kill")`

So long as the job is running: If the window is closed the buffer becomes
hidden. The command will not be stopped. The `:buffer` command can be used
to turn the current window into a terminal window. If there are unsaved
changes this fails, use ! to force, as usual.

When the job has finished and no changes were made to the buffer: closing the
window will wipe out the buffer.

Before changes can be made to a terminal buffer, the 'modifiable' option must
be set. This is only possible when the job has finished. At the first change
the buffer will become a normal buffer and the highlighting is removed.
You may want to change the buffer name with |:file| to be able to write, since
the buffer name will still be set to the command.


Resizing ~

Expand Down Expand Up @@ -138,6 +148,23 @@ Unix ~
On Unix a pty is used to make it possible to run all kinds of commands. You
can even run Vim in the terminal! That's used for debugging, see below.

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.


MS-Windows ~

Expand Down Expand Up @@ -191,7 +218,7 @@ This opens three windows:

This uses two terminal windows. To open the gdb window: >
:term gdb [arguments]
To open the terminal to run the tested program |term_open()| is used.
To open the terminal to run the tested program |term_start()| is used.

TODO

Expand Down
Loading

0 comments on commit f55e4c8

Please sign in to comment.