1
- *builtin.txt* For Vim version 9.1. Last change: 2024 Apr 04
1
+ *builtin.txt* For Vim version 9.1. Last change: 2024 Apr 07
2
2
3
3
4
4
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -220,12 +220,12 @@ getbufvar({buf}, {varname} [, {def}])
220
220
any variable {varname} in buffer {buf}
221
221
getcellwidths() List get character cell width overrides
222
222
getchangelist([{buf} ]) List list of change list items
223
- getchar([expr]) Number or String
223
+ getchar([{ expr} ]) Number or String
224
224
get one character from the user
225
225
getcharmod() Number modifiers for the last typed character
226
226
getcharpos({expr} ) List position of cursor, mark, etc.
227
227
getcharsearch() Dict last character search
228
- getcharstr([expr]) String get one character from the user
228
+ getcharstr([{ expr} ]) String get one character from the user
229
229
getcmdcompltype() String return the type of the current
230
230
command-line completion
231
231
getcmdline() String return the current command-line
@@ -398,7 +398,7 @@ menu_info({name} [, {mode}]) Dict get menu item information
398
398
min({expr} ) Number minimum value of items in {expr}
399
399
mkdir({name} [, {flags} [, {prot} ]])
400
400
Number create directory {name}
401
- mode([expr]) String current editing mode
401
+ mode([{ expr} ]) String current editing mode
402
402
mzeval({expr} ) any evaluate | MzScheme | expression
403
403
nextnonblank({lnum} ) Number line nr of non-blank line >= {lnum}
404
404
nr2char({expr} [, {utf8} ]) String single char with ASCII/UTF-8 value {expr}
@@ -699,7 +699,7 @@ test_override({expr}, {val}) none test with Vim internal overrides
699
699
test_refcount({expr} ) Number get the reference count of {expr}
700
700
test_setmouse({row} , {col} ) none set the mouse position for testing
701
701
test_settime({expr} ) none set current time for testing
702
- test_srand_seed([seed]) none set seed for testing srand()
702
+ test_srand_seed([{ seed} ]) none set seed for testing srand()
703
703
test_unknown() any unknown value for testing
704
704
test_void() any void value for testing
705
705
timer_info([{id} ]) List information about timers
@@ -729,7 +729,7 @@ virtcol({expr} [, {list} [, {winid}])
729
729
screen column of cursor or mark
730
730
virtcol2col({winid} , {lnum} , {col} )
731
731
Number byte index of a character on screen
732
- visualmode([expr]) String last visual mode used
732
+ visualmode([{ expr} ]) String last visual mode used
733
733
wildmenumode() Number whether 'wildmenu' mode is active
734
734
win_execute({id} , {command} [, {silent} ])
735
735
String execute {command} in window {id}
@@ -3455,16 +3455,16 @@ getchangelist([{buf}]) *getchangelist()*
3455
3455
Can also be used as a | method | : >
3456
3456
GetBufnr()->getchangelist()
3457
3457
3458
- getchar([expr]) *getchar()*
3458
+ getchar([{ expr} ]) *getchar()*
3459
3459
Get a single character from the user or input stream.
3460
- If [ expr] is omitted, wait until a character is available.
3461
- If [ expr] is 0, only get a character when one is available.
3460
+ If { expr} is omitted, wait until a character is available.
3461
+ If { expr} is 0, only get a character when one is available.
3462
3462
Return zero otherwise.
3463
- If [ expr] is 1, only check if a character is available, it is
3463
+ If { expr} is 1, only check if a character is available, it is
3464
3464
not consumed. Return zero if no character available.
3465
3465
If you prefer always getting a string use | getcharstr() | .
3466
3466
3467
- Without [ expr] and when [ expr] is 0 a whole character or
3467
+ Without { expr} and when { expr} is 0 a whole character or
3468
3468
special key is returned. If it is a single character, the
3469
3469
result is a Number. Use | nr2char() | to convert it to a String.
3470
3470
Otherwise a String is returned with the encoded character.
@@ -3474,11 +3474,11 @@ getchar([expr]) *getchar()*
3474
3474
also a String when a modifier (shift, control, alt) was used
3475
3475
that is not included in the character.
3476
3476
3477
- When [ expr] is 0 and Esc is typed, there will be a short delay
3477
+ When { expr} is 0 and Esc is typed, there will be a short delay
3478
3478
while Vim waits to see if this is the start of an escape
3479
3479
sequence.
3480
3480
3481
- When [ expr] is 1 only the first byte is returned. For a
3481
+ When { expr} is 1 only the first byte is returned. For a
3482
3482
one-byte character it is the character itself as a number.
3483
3483
Use nr2char() to convert it to a String.
3484
3484
@@ -3589,13 +3589,13 @@ getcharsearch() *getcharsearch()*
3589
3589
< Also see | setcharsearch() | .
3590
3590
3591
3591
3592
- getcharstr([expr]) *getcharstr()*
3592
+ getcharstr([{ expr} ]) *getcharstr()*
3593
3593
Get a single character from the user or input stream as a
3594
3594
string.
3595
- If [ expr] is omitted, wait until a character is available.
3596
- If [ expr] is 0 or false, only get a character when one is
3595
+ If { expr} is omitted, wait until a character is available.
3596
+ If { expr} is 0 or false, only get a character when one is
3597
3597
available. Return an empty string otherwise.
3598
- If [ expr] is 1 or true, only check if a character is
3598
+ If { expr} is 1 or true, only check if a character is
3599
3599
available, it is not consumed. Return an empty string
3600
3600
if no character is available.
3601
3601
Otherwise this works like | getchar() | , except that a number
@@ -6648,8 +6648,8 @@ mkdir({name} [, {flags} [, {prot}]])
6648
6648
GetName()->mkdir()
6649
6649
<
6650
6650
*mode()*
6651
- mode([expr]) Return a string that indicates the current mode.
6652
- If [ expr] is supplied and it evaluates to a non-zero Number or
6651
+ mode([{ expr} ]) Return a string that indicates the current mode.
6652
+ If { expr} is supplied and it evaluates to a non-zero Number or
6653
6653
a non-empty String (| non-zero-arg | ), then the full mode is
6654
6654
returned, otherwise only the first letter is returned.
6655
6655
Also see | state() | .
0 commit comments