Skip to content

Commit b6e0ec6

Browse files
committed
Documentation updates.
1 parent 9cc5f75 commit b6e0ec6

12 files changed

Lines changed: 104 additions & 54 deletions

File tree

runtime/doc/channel.txt

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*channel.txt* For Vim version 8.0. Last change: 2017 Jun 11
1+
*channel.txt* For Vim version 8.0. Last change: 2017 Jul 22
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -611,7 +611,7 @@ See |job_setoptions()| and |ch_setoptions()|.
611611
"close_cb": handler Callback for when the channel is closed. Same as
612612
"close_cb" on |ch_open()|, see |close_cb|.
613613
*job-drop*
614-
"drop" Specifies when to drop messages. Same as "drop" on
614+
"drop": when Specifies when to drop messages. Same as "drop" on
615615
|ch_open()|, see |channel-drop|. For "auto" the
616616
exit_cb is not considered.
617617
*job-exit_cb*
@@ -624,12 +624,12 @@ See |job_setoptions()| and |ch_setoptions()|.
624624
Note that data can be buffered, callbacks may still be
625625
called after the process ends.
626626
*job-timeout*
627-
"timeout" The time to wait for a request when blocking, E.g.
627+
"timeout": time The time to wait for a request when blocking, E.g.
628628
when using ch_evalexpr(). In milliseconds. The
629629
default is 2000 (2 seconds).
630630
*out_timeout* *err_timeout*
631-
"out_timeout" Timeout for stdout. Only when using pipes.
632-
"err_timeout" Timeout for stderr. Only when using pipes.
631+
"out_timeout": time Timeout for stdout. Only when using pipes.
632+
"err_timeout": time Timeout for stderr. Only when using pipes.
633633
Note: when setting "timeout" the part specific mode is
634634
overwritten. Therefore set "timeout" first and the
635635
part specific mode later.
@@ -641,8 +641,9 @@ See |job_setoptions()| and |ch_setoptions()|.
641641
The default is "term".
642642

643643
*job-term*
644-
"term": "open" Start a terminal and connect the job
645-
stdin/stdout/stderr to it.
644+
"term": "open" Start a terminal in a new window and connect the job
645+
stdin/stdout/stderr to it. Similar to using
646+
`:terminal`.
646647
NOTE: Not implemented yet!
647648

648649
"channel": {channel} Use an existing channel instead of creating a new one.
@@ -652,6 +653,11 @@ See |job_setoptions()| and |ch_setoptions()|.
652653
cause I/O errors.
653654
Existing callbacks and other settings remain.
654655

656+
"pty": 1 Use a pty (pseudo-tty) instead of a pipe when
657+
possible. This is most useful in combination with a
658+
terminal window, see |terminal|.
659+
{only on Unix and Unix-like systems}
660+
655661
*job-in_io* *in_top* *in_bot* *in_name* *in_buf*
656662
"in_io": "null" disconnect stdin (read from /dev/null)
657663
"in_io": "pipe" stdin is connected to the channel (default)

runtime/doc/eval.txt

Lines changed: 2 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: 2017 Jul 15
1+
*eval.txt* For Vim version 8.0. Last change: 2017 Jul 22
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -2179,7 +2179,7 @@ index({list}, {expr} [, {start} [, {ic}]])
21792179
Number index in {list} where {expr} appears
21802180
input({prompt} [, {text} [, {completion}]])
21812181
String get input from the user
2182-
inputdialog({prompt} [, {text} [, {completion}]]])
2182+
inputdialog({prompt} [, {text} [, {completion}]])
21832183
String like input() but in a GUI dialog
21842184
inputlist({textlist}) Number let the user pick from a choice list
21852185
inputrestore() Number restore typeahead

runtime/doc/gui.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*gui.txt* For Vim version 8.0. Last change: 2014 Mar 08
1+
*gui.txt* For Vim version 8.0. Last change: 2017 Jul 15
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -79,7 +79,8 @@ When the GUI starts up initializations are carried out, in this order:
7979
and DOS/Win32 "_gvimrc" is tried first.
8080

8181
NOTE: All but the first one are not carried out if Vim was started with
82-
"-u NONE" and no "-U" argument was given, or when started with "-U NONE".
82+
"-u NONE" or "-u DEFAULTS" and no "-U" argument was given, or when started
83+
with "-U NONE".
8384

8485
All this happens AFTER the normal Vim initializations, like reading your
8586
.vimrc file. See |initialization|.

runtime/doc/index.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*index.txt* For Vim version 8.0. Last change: 2017 Jul 15
1+
*index.txt* For Vim version 8.0. Last change: 2017 Jul 16
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -530,6 +530,7 @@ tag command action in Normal mode ~
530530
|CTRL-W_CTRL-_| CTRL-W CTRL-_ same as "CTRL-W _"
531531
|CTRL-W_+| CTRL-W + increase current window height N lines
532532
|CTRL-W_-| CTRL-W - decrease current window height N lines
533+
|CTRL-W_:| CTRL-W : same as |:|, edit a command line
533534
|CTRL-W_<| CTRL-W < decrease current window width N columns
534535
|CTRL-W_=| CTRL-W = make all windows the same height & width
535536
|CTRL-W_>| CTRL-W > increase current window width N columns

runtime/doc/intro.txt

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*intro.txt* For Vim version 8.0. Last change: 2016 Sep 24
1+
*intro.txt* For Vim version 8.0. Last change: 2017 Jul 17
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -143,9 +143,14 @@ There are two ways to report bugs, both work:
143143

144144
Please be brief; all the time that is spent on answering mail is subtracted
145145
from the time that is spent on improving Vim! Always give a reproducible
146-
example and try to find out which settings or other things influence the
147-
appearance of the bug. Try different machines, if possible. Send me patches
148-
if you can!
146+
example and try to find out which settings or other things trigger the bug.
147+
148+
Preferably start Vim with: >
149+
vim --clean -u reproduce.vim
150+
Where reproduce.vim is a script that reproduces the problem. Try different
151+
machines, if relevant (is this an MS-Windows specific bug perhaps?).
152+
153+
Send me patches if you can!
149154

150155
It will help to include information about the version of Vim you are using and
151156
your setup. You can get the information with this command: >

runtime/doc/tags

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1064,6 +1064,8 @@ $VIM_POSIX vi_diff.txt /*$VIM_POSIX*
10641064
'termbidi' options.txt /*'termbidi'*
10651065
'termencoding' options.txt /*'termencoding'*
10661066
'termguicolors' options.txt /*'termguicolors'*
1067+
'termkey' options.txt /*'termkey'*
1068+
'termsize' options.txt /*'termsize'*
10671069
'terse' options.txt /*'terse'*
10681070
'textauto' options.txt /*'textauto'*
10691071
'textmode' options.txt /*'textmode'*
@@ -1079,8 +1081,10 @@ $VIM_POSIX vi_diff.txt /*$VIM_POSIX*
10791081
'titlelen' options.txt /*'titlelen'*
10801082
'titleold' options.txt /*'titleold'*
10811083
'titlestring' options.txt /*'titlestring'*
1084+
'tk' options.txt /*'tk'*
10821085
'tl' options.txt /*'tl'*
10831086
'tm' options.txt /*'tm'*
1087+
'tms' options.txt /*'tms'*
10841088
'to' options.txt /*'to'*
10851089
'toolbar' options.txt /*'toolbar'*
10861090
'toolbariconsize' options.txt /*'toolbariconsize'*
@@ -1124,7 +1128,9 @@ $VIM_POSIX vi_diff.txt /*$VIM_POSIX*
11241128
'vi' options.txt /*'vi'*
11251129
'viewdir' options.txt /*'viewdir'*
11261130
'viewoptions' options.txt /*'viewoptions'*
1131+
'vif' options.txt /*'vif'*
11271132
'viminfo' options.txt /*'viminfo'*
1133+
'viminfofile' options.txt /*'viminfofile'*
11281134
'virtualedit' options.txt /*'virtualedit'*
11291135
'visualbell' options.txt /*'visualbell'*
11301136
'vop' options.txt /*'vop'*
@@ -1344,6 +1350,7 @@ $VIM_POSIX vi_diff.txt /*$VIM_POSIX*
13441350
-+rv gui_x11.txt /*-+rv*
13451351
-- starting.txt /*--*
13461352
--- starting.txt /*---*
1353+
--clean starting.txt /*--clean*
13471354
--cmd starting.txt /*--cmd*
13481355
--echo-wid starting.txt /*--echo-wid*
13491356
--help starting.txt /*--help*
@@ -3528,6 +3535,7 @@ CTRL-V-alternative gui_w32.txt /*CTRL-V-alternative*
35283535
CTRL-W index.txt /*CTRL-W*
35293536
CTRL-W_+ windows.txt /*CTRL-W_+*
35303537
CTRL-W_- windows.txt /*CTRL-W_-*
3538+
CTRL-W_: windows.txt /*CTRL-W_:*
35313539
CTRL-W_< windows.txt /*CTRL-W_<*
35323540
CTRL-W_<BS> windows.txt /*CTRL-W_<BS>*
35333541
CTRL-W_<CR> quickfix.txt /*CTRL-W_<CR>*

runtime/doc/term.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*term.txt* For Vim version 8.0. Last change: 2017 Apr 11
1+
*term.txt* For Vim version 8.0. Last change: 2017 Jul 21
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -315,7 +315,7 @@ Added by Vim (there are no standard codes for these):
315315
t_IE set icon text end *t_IE* *'t_IE'*
316316
t_WP set window position (Y, X) in pixels *t_WP* *'t_WP'*
317317
t_GP get window position (Y, X) in pixels *t_GP* *'t_GP'*
318-
t_WS set window size (height, width) in characters *t_WS* *'t_WS'*
318+
t_WS set window size (height, width in cells) *t_WS* *'t_WS'*
319319
t_SI start insert mode (bar cursor shape) *t_SI* *'t_SI'*
320320
t_SR start replace mode (underline cursor shape) *t_SR* *'t_SR'*
321321
t_EI end insert or replace mode (block cursor shape) *t_EI* *'t_EI'*

runtime/doc/terminal.txt

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*terminal.txt* For Vim version 8.0. Last change: 2017 Jul 15
1+
*terminal.txt* For Vim version 8.0. Last change: 2017 Jul 19
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -9,6 +9,10 @@ Terminal window support *terminal*
99

1010
WARNING: THIS IS ONLY PARTLY IMPLEMENTED, ANYTHING CAN STILL CHANGE
1111

12+
The terminal feature is optional, use this to check if your Vim has it: >
13+
echo has('terminal')
14+
If the result is "1" you have it.
15+
1216

1317
1. Basic use |terminal-use|
1418
2. Remote testing |terminal-testing|
@@ -34,6 +38,7 @@ the job. This uses a pty when possible.
3438

3539
Navigate between windows with CTRL-W commands (and mouse).
3640
E.g. CTRL-W CTRL-W moves focus to the next window.
41+
Use "CTRL-W :" to edit an Ex command.
3742

3843
See option 'termkey' for specifying the key that precedes a Vim command.
3944
Default is CTRL-W.
@@ -62,6 +67,10 @@ Syntax ~
6267
buffer. If there are unsaved changes this fails, use
6368
! to force, as usual.
6469

70+
When the buffer associated with the terminal is wiped out the job is killed,
71+
similar to calling `job_stop(job, "kill")`
72+
73+
6574
Resizing ~
6675

6776
The size of the terminal can be in one of three modes:
@@ -83,6 +92,19 @@ The |term_getsize()| function can be used to get the current size of the
8392
terminal. |term_setsize()| can be used only when in the first or second mode,
8493
not when 'termsize' is "rowsXcols".
8594

95+
96+
Unix ~
97+
98+
On Unix a pty is used to make it possible to run all kinds of commands. You
99+
can even run Vim in the terminal! That's used for debugging, see below.
100+
101+
102+
MS-Windows ~
103+
104+
On MS-Windows a hidden console is used to run the command in. This should
105+
work well for all kind of commands. Obviously, they must be commands that run
106+
in a terminal, not open their own window.
107+
86108
==============================================================================
87109
2. Remote testing *terminal-testing*
88110

runtime/doc/todo.txt

Lines changed: 29 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*todo.txt* For Vim version 8.0. Last change: 2017 Jul 15
1+
*todo.txt* For Vim version 8.0. Last change: 2017 Jul 22
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -35,31 +35,20 @@ entered there will not be repeated below, unless there is extra information.
3535
*known-bugs*
3636
-------------------- Known bugs and current work -----------------------
3737

38-
When redrawing for the channel buffer, command line completion is cleared.
39-
(Ramel Eshed, 2017 May 4)
40-
When a timer triggers the command completion disappears. (Dominique Pelle,
41-
2017 Jun 13, #1768)
42-
Caused by 8.0.0592.
43-
Check if anything was output? Don't redraw when scrolled. (#1820)
44-
When redrawing the command line a pending CTRL-R shows ", which is removed.
45-
46-
No maintainer for German translations.
4738
No maintainer for Vietnamese translations.
4839
No maintainer for Simplified Chinese translations.
4940

5041

5142
Terminal emulator window:
5243
- Lots of stuff to implement, see src/terminal.c
53-
- Windows implementation (WiP): https://github.com/mattn/vim/tree/terminal
54-
Using winpty ?
55-
- Running a shell command from the GUI still has limitations. Look into how
56-
the terminal emulator of the Vim shell project can help:
44+
- Running a shell command from the GUI still has limitations. Look into how
45+
the terminal emulator of the Vim shell project can help:
5746
http://vimshell.wana.at
58-
- Add debugger interface. Implementation for gdb by Xavier de Gaye.
59-
Should work like an IDE. Try to keep it generic. Now found here:
47+
- Add debugger interface. Implementation for gdb by Xavier de Gaye. Should
48+
work like an IDE. Try to keep it generic. Now found here:
6049
http://clewn.sf.net.
61-
- Look into the idevim plugin/script.
62-
- Related wishes for NetBeans commands:
50+
- Look into the idevim plugin/script.
51+
- Related wishes for NetBeans commands:
6352
- make it possible to have 'defineAnnoType' also handle terminal colors.
6453
- send 'balloonText' events for the cursor position (using CursorHold ?)
6554
in terminal mode.
@@ -136,8 +125,8 @@ Regexp problems:
136125
Another one: echom matchstr(" sdfsfsf\n sfdsdfsdf",'[^\n]*')
137126
(2017 May 15, #1252)
138127

139-
Patch to update b:changedtick in the quickfix window. (Yegappan Lakshmanan,
140-
2017 Jul 13)
128+
Patch for quickfix: parse lines for any quickfix list. (Yegappan Lakshmanan,
129+
2017 Jul 20)
141130

142131
With foldmethod=syntax and nofoldenable comment highlighting isn't removed.
143132
(Marcin Szewczyk, 2017 Apr 26)
@@ -151,29 +140,38 @@ Error in emsg with buggy script. (Dominique, 2017 Apr 30)
151140

152141
Better detection of strace file. (Steven Fernandez, 2017 Jul 12, #1837)
153142

154-
To reproduce problems "vim -u NONE -N" is often used, but this still uses
155-
'viminfo'. Add "-I" to not use 'viminfo'?
156-
Or use "vim -B" for "bug reproduction"?
157-
158143
Bug with conceal mode: 3rd element returned by synconcealed() differs for
159144
every call. (Dominique Pelle, 2017 Jun 18)
160145

161146
Add options_default() / options_restore() to set several options to Vim
162147
defaults for a plugin. Comments from Zyx, 2017 May 10.
163148
Perhaps use a vimcontext / endvimcontext command block.
164149

165-
Patch to trigger OptionSet when entering diff mode. (Christian Brabandt, 2017
166-
Jul 7)
167-
168150
Illegal memory access, requires ASAN to see. (Dominique Pelle, 2015 Jul 28)
169151
Still happens (2017 Jul 9)
170152

171153
Memory leak in test_arabic.
172154

155+
Include Haiku port? (Adrien Destugues, Siarzhuk Zharski, 2013 Oct 24)
156+
It can replace the BeOS code, which is likely not used anymore.
157+
Now on github: #1856. Is not up-to-date.
158+
173159
Refactored HTML indent file. (Michael Lee, #1821)
174160

175161
Using uninitialzed value in test_crypt.
176162

163+
All functions are global, which makes functions like get() and len() awkward.
164+
For the future use the ~get() and ~len() syntax, e.g.:
165+
mylist~get(idx)
166+
mydict~get(idx)
167+
mystring~len()
168+
Alternatives for ~:
169+
^ list^get() could also be used
170+
. list.get() already means concatenate
171+
$ list$get() harder to read
172+
@ list@get() harder to read
173+
-> list->get() two characters, used for lambda
174+
177175
X11: Putting more than about 262040 characters of text on the clipboard and
178176
pasting it in another Vim doesn't work. (Dominique Pelle, 2008 Aug 21-23)
179177
clip_x11_request_selection_cb() is called with zero value and length.
@@ -187,6 +185,10 @@ Problem with three-piece comment. (Michael Lee, 2017 May 11, #1696)
187185
When checking if a bufref is valid, also check the buffer number, to catch the
188186
case of :bwipe followed by :new.
189187

188+
Patch to skip writing a temp file for diffing if the buffer is equal to the
189+
existing file. (Akria Sheng, 2017 Jul 22)
190+
Could also skip writing lines that are the same.
191+
190192
Files for Latvian language. (Vitolins, 2017 May 3, #1675)
191193

192194
MS-Windows: Opening same file in a second gvim hangs. (Sven Bruggemann, 2017
@@ -1057,9 +1059,6 @@ For the path use a hash instead of dir%dir%dir%name hash%name.
10571059
Patch to add ":undorecover", get as much text out of the undo file as
10581060
possible. (Christian Brabandt, 2014 Mar 12, update Aug 22)
10591061

1060-
Include Haiku port? (Adrien Destugues, Siarzhuk Zharski, 2013 Oct 24)
1061-
It can replace the BeOS code, which is likely not used anymore.
1062-
10631062
Updated spec ftplugin. (Matěj Cepl, 2013 Oct 16)
10641063

10651064
Patch to right-align signs. (James Kolb (email james), 2013 Sep 23)

runtime/doc/usr_03.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*usr_03.txt* For Vim version 8.0. Last change: 2016 Jan 05
1+
*usr_03.txt* For Vim version 8.0. Last change: 2017 Jul 21
22

33
VIM USER MANUAL - by Bram Moolenaar
44

@@ -352,7 +352,7 @@ The "?" command works like "/" but searches backwards: >
352352
?word
353353
354354
The "N" command repeats the last search the opposite direction. Thus using
355-
"N" after a "/" command search backwards, using "N" after "?" searches
355+
"N" after a "/" command searches backwards, using "N" after "?" searches
356356
forward.
357357

358358

@@ -512,7 +512,7 @@ only if it is at the beginning of a line.
512512
The $ character matches the end of a line. Therefore, "was$" matches the
513513
word was only if it is at the end of a line.
514514

515-
Let's mark the places where "the" matches in this example line with "x"s:
515+
Let's mark the places where "/the" matches in this example line with "x"s:
516516

517517
the solder holding one of the chips melted and the ~
518518
xxx xxx xxx

0 commit comments

Comments
 (0)