Skip to content

Commit b5b7562

Browse files
committed
Update runtime files.
1 parent 4d8bac8 commit b5b7562

16 files changed

Lines changed: 157 additions & 99 deletions

File tree

runtime/doc/autocmd.txt

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*autocmd.txt* For Vim version 8.0. Last change: 2018 Feb 10
1+
*autocmd.txt* For Vim version 8.0. Last change: 2018 Mar 05
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -21,7 +21,6 @@ For a basic explanation, see section |40.3| in the user manual.
2121
11. Disabling autocommands |autocmd-disable|
2222

2323
{Vi does not have any of these commands}
24-
{only when the |+autocmd| feature has not been disabled at compile time}
2524

2625
==============================================================================
2726
1. Introduction *autocmd-intro*
@@ -324,6 +323,10 @@ Name triggered by ~
324323
|CmdwinEnter| after entering the command-line window
325324
|CmdwinLeave| before leaving the command-line window
326325

326+
|CmdlineChanged| after a change was made to the command-line text
327+
|CmdlineEnter| after the cursor moves to the command line
328+
|CmdlineLeave| before the cursor leaves the command line
329+
327330
|InsertEnter| starting Insert mode
328331
|InsertChange| when typing <Insert> while in Insert or Replace mode
329332
|InsertLeave| when leaving Insert mode
@@ -506,9 +509,9 @@ CmdUndefined When a user command is used but it isn't
506509
always define the user command and have it
507510
invoke an autoloaded function. See |autoload|.
508511
*CmdlineChanged*
509-
CmdlineChanged After a change was made to the text inside
510-
command line. Be careful not to mess up the
511-
command line, it may cause Vim to lock up.
512+
CmdlineChanged After a change was made to the text in the
513+
command line. Be careful not to mess up
514+
the command line, it may cause Vim to lock up.
512515
<afile> is set to a single character,
513516
indicating the type of command-line.
514517
|cmdwin-char|
@@ -785,7 +788,7 @@ InsertCharPre When a character is typed in Insert mode,
785788
inserted literally.
786789
It is not allowed to change the text |textlock|.
787790
The event is not triggered when 'paste' is
788-
set.
791+
set. {only with the +eval feature}
789792
*InsertEnter*
790793
InsertEnter Just before starting Insert mode. Also for
791794
Replace mode and Virtual Replace mode. The
@@ -931,6 +934,7 @@ SwapExists Detected an existing swap file when starting
931934
It is not allowed to change to another buffer,
932935
change a buffer name or change directory
933936
here.
937+
{only available with the +eval feature}
934938
*Syntax*
935939
Syntax When the 'syntax' option has been set. The
936940
pattern is matched against the syntax name.
@@ -1003,6 +1007,7 @@ TextYankPost After text has been yanked or deleted in the
10031007
called recursively.
10041008
It is not allowed to change the buffer text,
10051009
see |textlock|.
1010+
{only when compiled with the +eval feature}
10061011
*User*
10071012
User Never executed automatically. To be used for
10081013
autocommands that are only executed with

runtime/doc/eval.txt

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*eval.txt* For Vim version 8.0. Last change: 2018 Feb 27
1+
*eval.txt* For Vim version 8.0. Last change: 2018 Mar 09
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -2435,6 +2435,7 @@ term_gettty({buf}, [{input}]) String get the tty name of a terminal
24352435
term_list() List get the list of terminal buffers
24362436
term_scrape({buf}, {row}) List get row of a terminal screen
24372437
term_sendkeys({buf}, {keys}) none send keystrokes to a terminal
2438+
term_setrestore({buf}, {command}) none set command to restore terminal
24382439
term_start({cmd}, {options}) Job open a terminal window and run a job
24392440
term_wait({buf} [, {time}]) Number wait for screen to be updated
24402441
test_alloc_fail({id}, {countdown}, {repeat})
@@ -4885,7 +4886,19 @@ getwinpos([{timeout}]) *getwinpos()*
48854886
[x-pos, y-pos]
48864887
{timeout} can be used to specify how long to wait in msec for
48874888
a response from the terminal. When omitted 100 msec is used.
4888-
4889+
Use a longer time for a remote terminal.
4890+
When using a value less than 10 and no response is received
4891+
within that time, a previously reported position is returned,
4892+
if available. This can be used to poll for the position and
4893+
do some work in the mean time: >
4894+
while 1
4895+
let res = getwinpos(1)
4896+
if res[0] >= 0
4897+
break
4898+
endif
4899+
" Do some work here
4900+
endwhile
4901+
<
48894902
*getwinposx()*
48904903
getwinposx() The result is a Number, which is the X coordinate in pixels of
48914904
the left hand side of the GUI Vim window. Also works for an
@@ -8348,6 +8361,16 @@ term_sendkeys({buf}, {keys}) *term_sendkeys()*
83488361
means the character CTRL-X.
83498362
{only available when compiled with the |+terminal| feature}
83508363

8364+
term_setrestore({buf}, {command}) *term_setrestore()*
8365+
Set the command to write in a session file to restore the job
8366+
in this terminal. The line written in the session file is: >
8367+
terminal ++curwin ++cols=%d ++rows=%d {command}
8368+
< Make sure to escape the command properly.
8369+
8370+
Use an empty {command} to run 'shell'.
8371+
Use "NONE" to not restore this window.
8372+
{only available when compiled with the |+terminal| feature}
8373+
83518374
term_setsize({buf}, {expr}) *term_setsize()*
83528375
Not implemented yet.
83538376
{only available when compiled with the |+terminal| feature}
@@ -8391,6 +8414,8 @@ term_start({cmd}, {options}) *term_start()*
83918414
window; fails if the current buffer
83928415
cannot be |abandon|ed
83938416
"hidden" do not open a window
8417+
"norestore" do not add the terminal window to a
8418+
session file
83948419
"term_finish" What to do when the job is finished:
83958420
"close": close any windows
83968421
"open": open window if needed

runtime/doc/gui.txt

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*gui.txt* For Vim version 8.0. Last change: 2017 Nov 09
1+
*gui.txt* For Vim version 8.0. Last change: 2018 Mar 06
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -134,7 +134,7 @@ task bar with the 'guiheadroom' option.
134134
:winp[os]
135135
Display current position of the top left corner of the GUI vim
136136
window in pixels. Does not work in all versions.
137-
Also see |getwinposx()| and |getwinposy()|.
137+
Also see |getwinpos()|, |getwinposx()| and |getwinposy()|.
138138

139139
:winp[os] {X} {Y} *E466*
140140
Put the GUI vim window at the given {X} and {Y} coordinates.
@@ -992,10 +992,14 @@ it behaves in a strange way.
992992
:popu[p] {name} Popup the menu {name}. The menu named must
993993
have at least one subentry, but need not
994994
appear on the menu-bar (see |hidden-menus|).
995-
{only available for Win32 and GTK GUI}
995+
{only available for Win32 and GTK GUI or in
996+
the terminal when compiled with +insert_expand}
996997

997998
:popu[p]! {name} Like above, but use the position of the mouse
998999
pointer instead of the cursor.
1000+
In the terminal this is the last known
1001+
position, which is usually at the last click
1002+
or release (mouse movement is irrelevalt).
9991003

10001004
Example: >
10011005
:popup File
@@ -1006,6 +1010,10 @@ pointer if ! was used). >
10061010
:popup ]Toolbar
10071011
This creates a popup menu that doesn't exist on the main menu-bar.
10081012

1013+
Note that in the GUI the :popup command will return immediately, before a
1014+
selection has been made. In the terminal the commands waits for the user to
1015+
make a selection.
1016+
10091017
Note that a menu that starts with ']' will not be displayed.
10101018

10111019
==============================================================================

runtime/doc/options.txt

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*options.txt* For Vim version 8.0. Last change: 2018 Feb 25
1+
*options.txt* For Vim version 8.0. Last change: 2018 Mar 09
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -402,8 +402,8 @@ Setting the filetype
402402
used to set the option value in, unless this is a help
403403
window, in which case the window below help window is
404404
used (skipping the option-window).
405-
{not available when compiled without the |+eval| or
406-
|+autocmd| features}
405+
{not available when compiled without the |+eval|
406+
feature}
407407

408408
*$HOME*
409409
Using "~" is like using "$HOME", but it is only recognized at the start of an
@@ -1385,8 +1385,7 @@ A jump table for the options with a short description can be found at |Q_op|.
13851385
written
13861386
nowrite buffer which will not be written
13871387
acwrite buffer which will always be written with BufWriteCmd
1388-
autocommands. {not available when compiled without the
1389-
|+autocmd| feature}
1388+
autocommands.
13901389
quickfix quickfix buffer, contains list of errors |:cwindow|
13911390
or list of locations |:lwindow|
13921391
help help buffer (you are not supposed to set this
@@ -2466,8 +2465,6 @@ A jump table for the options with a short description can be found at |Q_op|.
24662465
'cursorbind' 'crb' boolean (default off)
24672466
local to window
24682467
{not in Vi}
2469-
{not available when compiled without the |+cursorbind|
2470-
feature}
24712468
When this option is set, as the cursor in the current
24722469
window moves other cursorbound windows (windows that also have
24732470
this option set) move their cursors to the corresponding line and
@@ -2918,8 +2915,6 @@ A jump table for the options with a short description can be found at |Q_op|.
29182915
'eventignore' 'ei' string (default "")
29192916
global
29202917
{not in Vi}
2921-
{not available when compiled without the |+autocmd|
2922-
feature}
29232918
A list of autocommand event names, which are to be ignored.
29242919
When set to "all" or when "all" is one of the items, all autocommand
29252920
events are ignored, autocommands will not be executed.
@@ -3168,8 +3163,6 @@ A jump table for the options with a short description can be found at |Q_op|.
31683163
'filetype' 'ft' string (default: "")
31693164
local to buffer
31703165
{not in Vi}
3171-
{not available when compiled without the |+autocmd|
3172-
feature}
31733166
When this option is set, the FileType autocommand event is triggered.
31743167
All autocommands that match with the value of this option will be
31753168
executed. Thus the value of 'filetype' is used in place of the file
@@ -5334,6 +5327,8 @@ A jump table for the options with a short description can be found at |Q_op|.
53345327
an explanation.
53355328
When 'buftype' is "nowrite" or "nofile" this option may be set, but
53365329
will be ignored.
5330+
Note that the text may actually be the same, e.g. 'modified' is set
5331+
when using "rA" on an "A".
53375332

53385333
*'more'* *'nomore'*
53395334
'more' boolean (Vim default: on, Vi default: off)
@@ -5422,6 +5417,8 @@ A jump table for the options with a short description can be found at |Q_op|.
54225417

54235418
In the "popup" model the right mouse button produces a pop-up menu.
54245419
You need to define this first, see |popup-menu|.
5420+
In a terminal the popup menu works if Vim is compiled with the
5421+
|+insert_expand| option.
54255422

54265423
Note that you can further refine the meaning of buttons with mappings.
54275424
See |gui-mouse-mapping|. But mappings are NOT used for modeless
@@ -6441,6 +6438,8 @@ A jump table for the options with a short description can be found at |Q_op|.
64416438
to find files which replace a distributed runtime files. You can put
64426439
a directory after $VIMRUNTIME to find files which add to distributed
64436440
runtime files.
6441+
When Vim is started with |--clean| the home directory entries are not
6442+
included.
64446443
This option cannot be set from a |modeline| or in the |sandbox|, for
64456444
security reasons.
64466445

@@ -6459,8 +6458,6 @@ A jump table for the options with a short description can be found at |Q_op|.
64596458
'scrollbind' 'scb' boolean (default off)
64606459
local to window
64616460
{not in Vi}
6462-
{not available when compiled without the |+scrollbind|
6463-
feature}
64646461
See also |scroll-binding|. When this option is set, the current
64656462
window scrolls as other scrollbind windows (windows that also have
64666463
this option set) scroll. This option is useful for viewing the
@@ -6498,8 +6495,6 @@ A jump table for the options with a short description can be found at |Q_op|.
64986495
*'scrollopt'* *'sbo'*
64996496
'scrollopt' 'sbo' string (default "ver,jump")
65006497
global
6501-
{not available when compiled without the |+scrollbind|
6502-
feature}
65036498
{not in Vi}
65046499
This is a comma-separated list of words that specifies how
65056500
'scrollbind' windows should behave. 'sbo' stands for ScrollBind
@@ -6589,7 +6584,7 @@ A jump table for the options with a short description can be found at |Q_op|.
65896584

65906585
*'sessionoptions'* *'ssop'*
65916586
'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
6592-
help,options,tabpages,winsize")
6587+
help,options,tabpages,winsize,terminal")
65936588
global
65946589
{not in Vi}
65956590
{not available when compiled without the |+mksession|
@@ -6621,6 +6616,7 @@ A jump table for the options with a short description can be found at |Q_op|.
66216616
tabpages all tab pages; without this only the current tab page
66226617
is restored, so that you can make a session for each
66236618
tab page separately
6619+
terminal include terminal windows where the command can be restored
66246620
unix with Unix end-of-line format (single <NL>), even when
66256621
on Windows or DOS
66266622
winpos position of the whole Vim window
@@ -7416,7 +7412,6 @@ A jump table for the options with a short description can be found at |Q_op|.
74167412
W F Preview window flag, text is ",PRV".
74177413
y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
74187414
Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
7419-
{not available when compiled without |+autocmd| feature}
74207415
q S "[Quickfix List]", "[Location List]" or empty.
74217416
k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
74227417
being used: "<keymap>"

runtime/doc/quickfix.txt

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*quickfix.txt* For Vim version 8.0. Last change: 2017 Dec 13
1+
*quickfix.txt* For Vim version 8.0. Last change: 2018 Mar 04
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -330,9 +330,9 @@ deleted for some reason, the message "line changed" is shown to warn you that
330330
the error location may not be correct. If you quit Vim and start again the
331331
marks are lost and the error locations may not be correct anymore.
332332

333-
If vim is built with |+autocmd| support, two autocommands are available for
334-
running commands before and after a quickfix command (':make', ':grep' and so
335-
on) is executed. See |QuickFixCmdPre| and |QuickFixCmdPost| for details.
333+
Two autocommands are available for running commands before and after a
334+
quickfix command (':make', ':grep' and so on) is executed. See
335+
|QuickFixCmdPre| and |QuickFixCmdPost| for details.
336336

337337
*QuickFixCmdPost-example*
338338
When 'encoding' differs from the locale, the error messages may have a
@@ -657,8 +657,8 @@ To get the number of the current list in the stack: >
657657
4. Using :make *:make_makeprg*
658658

659659
*:mak* *:make*
660-
:mak[e][!] [arguments] 1. If vim was built with |+autocmd|, all relevant
661-
|QuickFixCmdPre| autocommands are executed.
660+
:mak[e][!] [arguments] 1. All relevant |QuickFixCmdPre| autocommands are
661+
executed.
662662
2. If the 'autowrite' option is on, write any changed
663663
buffers
664664
3. An errorfile name is made from 'makeef'. If
@@ -670,9 +670,8 @@ To get the number of the current list in the stack: >
670670
errorfile (for Unix it is also echoed on the
671671
screen).
672672
5. The errorfile is read using 'errorformat'.
673-
6. If vim was built with |+autocmd|, all relevant
674-
|QuickFixCmdPost| autocommands are executed.
675-
See example below.
673+
6. All relevant |QuickFixCmdPost| autocommands are
674+
executed. See example below.
676675
7. If [!] is not given the first error is jumped to.
677676
8. The errorfile is deleted.
678677
9. You can now move through the errors with commands

runtime/doc/repeat.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*repeat.txt* For Vim version 8.0. Last change: 2018 Feb 11
1+
*repeat.txt* For Vim version 8.0. Last change: 2018 Mar 04
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -265,6 +265,7 @@ For writing a Vim script, see chapter 41 of the user manual |usr_41.txt|.
265265
loaded during initialization, see |load-plugins|.
266266

267267
Also see |pack-add|.
268+
{only available when compiled with +eval}
268269

269270
*:packl* *:packloadall*
270271
:packl[oadall][!] Load all packages in the "start" directory under each
@@ -288,6 +289,7 @@ For writing a Vim script, see chapter 41 of the user manual |usr_41.txt|.
288289
An error only causes sourcing the script where it
289290
happens to be aborted, further plugins will be loaded.
290291
See |packages|.
292+
{only available when compiled with +eval}
291293

292294
:scripte[ncoding] [encoding] *:scripte* *:scriptencoding* *E167*
293295
Specify the character encoding used in the script.

runtime/doc/starting.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*starting.txt* For Vim version 8.0. Last change: 2018 Feb 10
1+
*starting.txt* For Vim version 8.0. Last change: 2018 Mar 01
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar

runtime/doc/tags

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6606,6 +6606,7 @@ gettabinfo() eval.txt /*gettabinfo()*
66066606
gettabvar() eval.txt /*gettabvar()*
66076607
gettabwinvar() eval.txt /*gettabwinvar()*
66086608
getwininfo() eval.txt /*getwininfo()*
6609+
getwinpos() eval.txt /*getwinpos()*
66096610
getwinposx() eval.txt /*getwinposx()*
66106611
getwinposy() eval.txt /*getwinposy()*
66116612
getwinvar() eval.txt /*getwinvar()*
@@ -8927,6 +8928,7 @@ term_gettty() eval.txt /*term_gettty()*
89278928
term_list() eval.txt /*term_list()*
89288929
term_scrape() eval.txt /*term_scrape()*
89298930
term_sendkeys() eval.txt /*term_sendkeys()*
8931+
term_setrestore() eval.txt /*term_setrestore()*
89308932
term_setsize() eval.txt /*term_setsize()*
89318933
term_start() eval.txt /*term_start()*
89328934
term_wait() eval.txt /*term_wait()*
@@ -8944,6 +8946,8 @@ termdebug-example terminal.txt /*termdebug-example*
89448946
termdebug-starting terminal.txt /*termdebug-starting*
89458947
termdebug-stepping terminal.txt /*termdebug-stepping*
89468948
termdebug-variables terminal.txt /*termdebug-variables*
8949+
termdebug_popup terminal.txt /*termdebug_popup*
8950+
termdebug_wide terminal.txt /*termdebug_wide*
89478951
terminal terminal.txt /*terminal*
89488952
terminal-colors os_unix.txt /*terminal-colors*
89498953
terminal-cursor-style terminal.txt /*terminal-cursor-style*
@@ -8959,6 +8963,7 @@ terminal-options term.txt /*terminal-options*
89598963
terminal-output-codes term.txt /*terminal-output-codes*
89608964
terminal-resizing terminal.txt /*terminal-resizing*
89618965
terminal-screendump terminal.txt /*terminal-screendump*
8966+
terminal-session terminal.txt /*terminal-session*
89628967
terminal-size-color terminal.txt /*terminal-size-color*
89638968
terminal-special-keys terminal.txt /*terminal-special-keys*
89648969
terminal-testing terminal.txt /*terminal-testing*

0 commit comments

Comments
 (0)