blob: abca72813a3612f54e642e40bf3b7b3f358e8962 [file] [log] [blame]
Hirohito Higashi73b96502025-06-28 18:18:21 +02001*various.txt* For Vim version 9.1. Last change: 2025 Jun 28
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Various commands *various*
8
91. Various commands |various-cmds|
Bram Moolenaar91604412010-06-03 20:25:18 +0200102. Using Vim like less or more |less|
Bram Moolenaar071d4272004-06-13 20:20:40 +000011
12==============================================================================
131. Various commands *various-cmds*
14
15 *CTRL-L*
Bram Moolenaar30abd282005-06-22 22:35:10 +000016CTRL-L Clear and redraw the screen. The redraw may happen
17 later, after processing typeahead.
Bram Moolenaar071d4272004-06-13 20:20:40 +000018
19 *:redr* *:redraw*
20:redr[aw][!] Redraw the screen right now. When ! is included it is
21 cleared first.
Shane Harperc1b39842024-07-17 19:40:40 +020022 It can be used to redraw the screen in a script
23 or function (or a mapping if |'lazyredraw'| is set).
Bram Moolenaar071d4272004-06-13 20:20:40 +000024
25 *:redraws* *:redrawstatus*
26:redraws[tatus][!] Redraw the status line of the current window. When !
27 is included all status lines are redrawn.
28 Useful to update the status line(s) when 'statusline'
29 includes an item that doesn't cause automatic
30 updating.
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +010031 If the command line is being edited the redraw is
32 postponed until later.
Bram Moolenaar071d4272004-06-13 20:20:40 +000033
Bram Moolenaare12bab32019-01-08 22:02:56 +010034 *:redrawt* *:redrawtabline*
35:redrawt[abline] Redraw the tabline. Useful to update the tabline when
36 'tabline' includes an item that doesn't trigger
37 automatic updating.
38
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +020039 *E1547* *:redrawtabp* *:redrawtabpanel*
Christian Brabandtba19b652025-05-15 20:16:04 +020040:redrawtabp[anel] Redraw the tabpanel Useful to update the tabpanel
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +020041 when 'tabpanel' includes an item that doesn't trigger
42 automatic updating.
43
Bram Moolenaar071d4272004-06-13 20:20:40 +000044 *N<Del>*
45<Del> When entering a number: Remove the last digit.
46 Note: if you like to use <BS> for this, add this
47 mapping to your .vimrc: >
48 :map CTRL-V <BS> CTRL-V <Del>
49< See |:fixdel| if your <Del> key does not do what you
50 want.
51
52:as[cii] or *ga* *:as* *:ascii*
53ga Print the ascii value of the character under the
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010054 cursor in decimal, hexadecimal and octal.
55 Mnemonic: Get Ascii value.
56
57 For example, when the cursor is on a 'R':
Bram Moolenaar071d4272004-06-13 20:20:40 +000058 <R> 82, Hex 52, Octal 122 ~
59 When the character is a non-standard ASCII character,
60 but printable according to the 'isprint' option, the
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010061 non-printable version is also given.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +010062
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010063 When the character is larger than 127, the <M-x> form
64 is also printed. For example:
Bram Moolenaar071d4272004-06-13 20:20:40 +000065 <~A> <M-^A> 129, Hex 81, Octal 201 ~
66 <p> <|~> <M-~> 254, Hex fe, Octal 376 ~
67 (where <p> is a special character)
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010068
Bram Moolenaar071d4272004-06-13 20:20:40 +000069 The <Nul> character in a file is stored internally as
70 <NL>, but it will be shown as:
71 <^@> 0, Hex 00, Octal 000 ~
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010072
Bram Moolenaar362e1a32006-03-06 23:29:24 +000073 If the character has composing characters these are
74 also shown. The value of 'maxcombine' doesn't matter.
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010075
76 If the character can be inserted as a digraph, also
77 output the two characters that can be used to create
78 the character:
Milly89872f52024-10-05 17:16:18 +020079 <ö> 246, Hex 00f6, Oct 366, Digr o: ~
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010080 This shows you can type CTRL-K o : to insert ö.
81
Bram Moolenaar071d4272004-06-13 20:20:40 +000082 *g8*
83g8 Print the hex values of the bytes used in the
84 character under the cursor, assuming it is in |UTF-8|
Bram Moolenaar362e1a32006-03-06 23:29:24 +000085 encoding. This also shows composing characters. The
86 value of 'maxcombine' doesn't matter.
87 Example of a character with two composing characters:
Bram Moolenaar071d4272004-06-13 20:20:40 +000088 e0 b8 81 + e0 b8 b9 + e0 b9 89 ~
Bram Moolenaarca003e12006-03-17 23:19:38 +000089
90 *8g8*
918g8 Find an illegal UTF-8 byte sequence at or after the
92 cursor. This works in two situations:
93 1. when 'encoding' is any 8-bit encoding
94 2. when 'encoding' is "utf-8" and 'fileencoding' is
95 any 8-bit encoding
96 Thus it can be used when editing a file that was
97 supposed to be UTF-8 but was read as if it is an 8-bit
98 encoding because it contains illegal bytes.
99 Does not wrap around the end of the file.
100 Note that when the cursor is on an illegal byte or the
Bram Moolenaar207f0092020-08-30 17:20:20 +0200101 cursor is halfway a multibyte character the command
Bram Moolenaarca003e12006-03-17 23:19:38 +0000102 won't move the cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000104 *:p* *:pr* *:print* *E749*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000105:[range]p[rint] [flags]
D. Ben Knoble187df692025-04-21 10:19:51 +0200106 Print [range] lines (default current line). Can also
107 be spelled `:[range]|` due to Vi compatibility (see
108 |:bar|). Gives an error in an empty buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109 Note: If you are looking for a way to print your text
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000110 on paper see |:hardcopy|. In the GUI you can use the
111 File.Print menu entry.
112 See |ex-flags| for [flags].
Bram Moolenaar818078d2016-08-27 21:58:42 +0200113 The |:filter| command can be used to only show lines
114 matching a pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000115
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000116:[range]p[rint] {count} [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000117 Print {count} lines, starting with [range] (default
118 current line |cmdline-ranges|).
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000119 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000120
121 *:P* *:Print*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000122:[range]P[rint] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000123 Just as ":print". Was apparently added to Vi for
124 people that keep the shift key pressed too long...
Bram Moolenaar1588bc82022-03-08 21:35:07 +0000125 This command is not supported in |Vim9| script.
Bram Moolenaar166af9b2010-11-16 20:34:40 +0100126 Note: A user command can overrule this command.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000127 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000128
129 *:l* *:list*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000130:[range]l[ist] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000131 Same as :print, but display unprintable characters
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +0200132 with '^' and put $ after the line. This can be
Bram Moolenaard58e9292011-02-09 17:07:58 +0100133 further changed with the 'listchars' option.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000134 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000135
136 *:nu* *:number*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000137:[range]nu[mber] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000138 Same as :print, but precede each line with its line
Bram Moolenaarfaa959a2006-02-20 21:37:40 +0000139 number. (See also 'highlight' and 'numberwidth'
140 option).
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000141 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000142
143 *:#*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000144:[range]# [count] [flags]
145 synonym for :number.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000146
Christian Brabandtf4bc59c2024-06-15 15:52:53 +0200147 *:#!* *vim-shebang*
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000148:#!{anything} Ignored, so that you can start a Vim script with: >
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000149 #!vim -S
Christian Brabandtca471142024-06-17 13:06:34 +0200150 let mylogbook='$HOME/logbook.md'
151 exe $':e {mylogbook}'
152 $
153 put ='## ' .. strftime('%d. %b %Y')
154 norm! o
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000155<
Christian Brabandtca471142024-06-17 13:06:34 +0200156 Make that script executable and run it to create a
157 new diary entry.
158
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159 *:z* *E144*
Bram Moolenaar4466ad62020-11-21 13:16:30 +0100160:[range]z[+-^.=][count] Display several lines of text surrounding the line
161 specified with [range], or around the current line
162 if there is no [range].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000163
Bram Moolenaar4466ad62020-11-21 13:16:30 +0100164 If there is a [count], that's how many lines you'll
165 see; if there is no [count] and only one window then
166 twice the value of the 'scroll' option is used,
167 otherwise the current window height minus 3 is used.
168 This is the value of "scr" in the table below.
169
170 If there is a [count] the 'window' option is set to
Bram Moolenaarb6b046b2011-12-30 13:11:27 +0100171 its value.
172
Bram Moolenaar071d4272004-06-13 20:20:40 +0000173 :z can be used either alone or followed by any of
Bram Moolenaar207f0092020-08-30 17:20:20 +0200174 several marks. These have the following effect:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000175
Bram Moolenaar662db672011-03-22 14:05:35 +0100176 mark first line last line new cursor line ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000177 ---- ---------- --------- ------------
178 + current line 1 scr forward 1 scr forward
179 - 1 scr back current line current line
180 ^ 2 scr back 1 scr back 1 scr back
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +0000181 . 1/2 scr back 1/2 scr fwd 1/2 scr fwd
182 = 1/2 scr back 1/2 scr fwd current line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000183
184 Specifying no mark at all is the same as "+".
185 If the mark is "=", a line of dashes is printed
186 around the current line.
187
Bram Moolenaar6c391a72021-09-09 21:55:11 +0200188 *:z!*
Dominique Pelle7f2dd1e2021-09-04 13:44:01 +0200189:[range]z![+-^.=][count]
Bram Moolenaar22863042021-10-16 15:23:36 +0100190 Like ":z", but when [count] is not specified, it
Dominique Pelle7f2dd1e2021-09-04 13:44:01 +0200191 defaults to the Vim window height minus one.
192
193:[range]z[!]#[+-^.=][count] *:z#*
194 Like ":z" or ":z!", but number the lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195
196 *:=*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000197:= [flags] Print the last line number.
198 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000199
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000200:{range}= [flags] Prints the last line number in {range}. For example,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000201 this prints the current line number: >
202 :.=
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000203< See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000204
205:norm[al][!] {commands} *:norm* *:normal*
206 Execute Normal mode commands {commands}. This makes
207 it possible to execute Normal mode commands typed on
Bram Moolenaar4a748032010-09-30 21:47:56 +0200208 the command-line. {commands} are executed like they
209 are typed. For undo all commands are undone together.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000210 Execution stops when an error is encountered.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100211
Bram Moolenaar071d4272004-06-13 20:20:40 +0000212 If the [!] is given, mappings will not be used.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100213 Without it, when this command is called from a
214 non-remappable mapping (|:noremap|), the argument can
215 be mapped anyway.
216
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217 {commands} should be a complete command. If
218 {commands} does not finish a command, the last one
219 will be aborted as if <Esc> or <C-C> was typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000220 This implies that an insert command must be completed
221 (to start Insert mode, see |:startinsert|). A ":"
Bram Moolenaar7c626922005-02-07 22:01:03 +0000222 command must be completed as well. And you can't use
223 "Q" or "gQ" to start Ex mode.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100224
225 The display is not updated while ":normal" is busy.
226
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100227 {commands} cannot start with a space. Put a count of
228 1 (one) before it, "1 " is one space.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100229
Bram Moolenaar071d4272004-06-13 20:20:40 +0000230 The 'insertmode' option is ignored for {commands}.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100231
Bram Moolenaar071d4272004-06-13 20:20:40 +0000232 This command cannot be followed by another command,
233 since any '|' is considered part of the command.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100234
Bram Moolenaar071d4272004-06-13 20:20:40 +0000235 This command can be used recursively, but the depth is
236 limited by 'maxmapdepth'.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100237
Bram Moolenaar071d4272004-06-13 20:20:40 +0000238 An alternative is to use |:execute|, which uses an
239 expression as argument. This allows the use of
Bram Moolenaar46f9d492010-06-12 20:18:19 +0200240 printable characters to represent special characters.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100241
Bram Moolenaar46f9d492010-06-12 20:18:19 +0200242 Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000243 :exe "normal \<c-w>\<c-w>"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000244
245:{range}norm[al][!] {commands} *:normal-range*
246 Execute Normal mode commands {commands} for each line
247 in the {range}. Before executing the {commands}, the
248 cursor is positioned in the first column of the range,
249 for each line. Otherwise it's the same as the
250 ":normal" command without a range.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000251
252 *:sh* *:shell* *E371*
253:sh[ell] This command starts a shell. When the shell exits
254 (after the "exit" command) you return to Vim. The
255 name for the shell command comes from 'shell' option.
256 *E360*
257 Note: This doesn't work when Vim on the Amiga was
258 started in QuickFix mode from a compiler, because the
259 compiler will have set stdin to a non-interactive
260 mode.
261
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000262 *:!cmd* *:!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000263:!{cmd} Execute {cmd} with the shell. See also the 'shell'
Christian Brabandtf18987c2024-11-12 21:38:22 +0100264 and 'shelltype' option. For the filter command, see
265 |:range!|.
matveyta01148d2024-11-23 14:19:58 +0100266
267 Vim builds command line using options 'shell', 'shcf',
268 'sxq' and 'shq' in the following order:
269 `&sh &shcf &sxq &shq {cmd} &shq &sxq`
270 So setting both 'sxq' and 'shq' is possible but rarely
271 useful. Additional escaping inside `{cmd}` may also
272 be due to 'sxe' option.
273
274 Also, all |cmdline-special| characters in {cmd} are
275 replaced by Vim before passing them to shell.
276
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000277 *E34*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000278 Any '!' in {cmd} is replaced with the previous
279 external command (see also 'cpoptions'). But not when
280 there is a backslash before the '!', then that
281 backslash is removed. Example: ":!ls" followed by
282 ":!echo ! \! \\!" executes "echo ls ! \!".
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200283
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000284 A '|' in {cmd} is passed to the shell, you cannot use
285 it to append a Vim command. See |:bar|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200286
287 If {cmd} contains "%" it is expanded to the current
Bram Moolenaaracc22402020-06-07 21:07:18 +0200288 file name, "#" is expanded to the alternate file name.
289 Special characters in the file name are not escaped,
290 use quotes to avoid their special meaning: >
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200291 :!ls "%"
Bram Moolenaaracc22402020-06-07 21:07:18 +0200292< If the file name contains a "$" then single quotes
293 might work better, but this only works if the file
294 name does not contain a single quote: >
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200295 :!ls '%'
296< This should always work, but it's more typing: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000297 :exe "!ls " .. shellescape(expand("%"))
Bram Moolenaaracc22402020-06-07 21:07:18 +0200298< To get a literal "%" or "#" prepend it with a
299 backslash. For example, to list all files starting
300 with "%": >
301 :!ls \%*
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200302<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303 A newline character ends {cmd}, what follows is
304 interpreted as a following ":" command. However, if
305 there is a backslash before the newline it is removed
306 and {cmd} continues. It doesn't matter how many
307 backslashes are before the newline, only one is
308 removed.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200309
Bram Moolenaar071d4272004-06-13 20:20:40 +0000310 On Unix the command normally runs in a non-interactive
311 shell. If you want an interactive shell to be used
312 (to use aliases) set 'shellcmdflag' to "-ic".
313 For Win32 also see |:!start|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200314
Bram Moolenaare968e362014-05-13 20:23:24 +0200315 After the command has been executed, the timestamp and
316 size of the current file is checked |timestamp|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200317
Bram Moolenaar071d4272004-06-13 20:20:40 +0000318 Vim redraws the screen after the command is finished,
319 because it may have printed any text. This requires a
320 hit-enter prompt, so that you can read any messages.
321 To avoid this use: >
322 :silent !{cmd}
323< The screen is not redrawn then, thus you have to use
324 CTRL-L or ":redraw!" if the command did display
Bram Moolenaar76db9e02022-11-09 21:21:04 +0000325 something. However, this depends on what the |t_ti|
326 and |t_te| termcap entries are set to.
matveyta01148d2024-11-23 14:19:58 +0100327
328 Hint: use |:terminal| command if you want to run {cmd}
329 in Vim window. `:term ++shell ++close {cmd}` could
330 serve as close approximation to what `:!{cmd}` does.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000331
332 *:!!*
333:!! Repeat last ":!{cmd}".
334
Bram Moolenaar61da1bf2019-06-06 12:14:49 +0200335 *:ve* *:ver* *:version*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000336:ve[rsion] Print the version number of the editor. If the
337 compiler used understands "__DATE__" the compilation
338 date is mentioned. Otherwise a fixed release-date is
339 shown.
340 The following lines contain information about which
341 features were enabled when Vim was compiled. When
342 there is a preceding '+', the feature is included,
343 when there is a '-' it is excluded. To change this,
344 you have to edit feature.h and recompile Vim.
345 To check for this in an expression, see |has()|.
346 Here is an overview of the features.
347 The first column shows the smallest version in which
348 they are included:
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100349 T tiny (always)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350 N normal
Bram Moolenaar071d4272004-06-13 20:20:40 +0000351 H huge
352 m manually enabled or depends on other features
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100353 - never, feature was removed
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 (none) system dependent
355 Thus if a feature is marked with "N", it is included
RestorerZac9c6d52023-10-05 22:25:12 +0200356 in the normal and huge versions of Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357
358 *+feature-list*
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200359 *+acl* |ACL| support included
Bram Moolenaar071d4272004-06-13 20:20:40 +0000360 *+ARP* Amiga only: ARP support included
Martin Tournoij25f3a142022-10-08 19:26:41 +0100361H *+arabic* |Arabic| language support
362N *+autochdir* support 'autochdir' option
Bram Moolenaarfd999452022-08-24 18:30:14 +0100363T *+autocmd* |:autocmd|, automatic commands. Always enabled since
364 8.0.1564
Bram Moolenaare42a6d22017-11-12 19:21:51 +0100365H *+autoservername* Automatically enable |clientserver|
Bram Moolenaara2a80162017-11-21 23:09:50 +0100366m *+balloon_eval* |balloon-eval| support in the GUI. Included when
367 compiling with supported GUI (Motif, GTK, GUI) and
368 either Netbeans/Sun Workshop integration or |+eval|
369 feature.
370H *+balloon_eval_term* |balloon-eval| support in the terminal,
371 'balloonevalterm'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000372N *+browse* |:browse| command
Bram Moolenaar2ee347f2022-08-26 17:53:44 +0100373T *++builtin_terms* maximal terminals builtin |builtin-terms| Always
374 enabled since 9.0.0280
Bram Moolenaar071d4272004-06-13 20:20:40 +0000375N *+byte_offset* support for 'o' flag in 'statusline' option, "go"
376 and ":goto" commands.
Bram Moolenaar298b4402016-01-28 22:38:53 +0100377m *+channel* inter process communication |channel|
Martin Tournoij7904fa42022-10-04 16:28:45 +0100378T *+cindent* |'cindent'|, C indenting; Always enabled
Bram Moolenaar071d4272004-06-13 20:20:40 +0000379N *+clientserver* Unix and Win32: Remote invocation |clientserver|
Bram Moolenaar56c860c2019-08-17 20:09:31 +0200380 *+clipboard* |clipboard| support compiled-in
381 *+clipboard_working* |clipboard| support compiled-in and working
Bram Moolenaar06fe74a2019-08-31 16:20:32 +0200382T *+cmdline_compl* command line completion |cmdline-completion|
Bram Moolenaar85388672021-01-31 17:03:52 +0100383T *+cmdline_hist* command line history |cmdline-history|
Martin Tournoijba43e762022-10-13 22:12:15 +0100384T *+cmdline_info* |'showcmd'| and |'ruler'|; Always enabled since
385 9.0.0747
Martin Tournoij7904fa42022-10-04 16:28:45 +0100386T *+cmdwin* |cmdline-window| support; Always enabled since 9.0.0657
Bram Moolenaar8c96af92019-09-28 19:05:57 +0200387T *+comments* |'comments'| support
Martin Tournoij25f3a142022-10-08 19:26:41 +0100388N *+conceal* "conceal" support, see |conceal| |:syn-conceal| etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000389N *+cryptv* encryption support |encryption|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100390H *+cscope* |cscope| support
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100391T *+cursorbind* |'cursorbind'| support
Bram Moolenaarac6e65f2005-08-29 22:25:38 +0000392m *+cursorshape* |termcap-cursor-shape| support
393m *+debug* Compiled for debugging.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000394N *+dialog_gui* Support for |:confirm| with GUI dialog.
395N *+dialog_con* Support for |:confirm| with console dialog.
396N *+dialog_con_gui* Support for |:confirm| with GUI and console dialog.
397N *+diff* |vimdiff| and 'diff'
398N *+digraphs* |digraphs| *E196*
Bram Moolenaar43cb6262018-03-14 21:39:02 +0100399 *+directx* Win32 GUI only: DirectX and |'renderoptions'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000400 *+dnd* Support for DnD into the "~ register |quote_~|.
Martin Tournoij25f3a142022-10-08 19:26:41 +0100401H *+emacs_tags* |emacs-tags| files
Bram Moolenaar071d4272004-06-13 20:20:40 +0000402N *+eval* expression evaluation |eval.txt|
Bram Moolenaar47003982021-12-05 21:54:04 +0000403T *+ex_extra* always on now, used to be for Vim's extra Ex commands
Bram Moolenaar071d4272004-06-13 20:20:40 +0000404N *+extra_search* |'hlsearch'| and |'incsearch'| options.
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100405- *+farsi* Removed: |farsi| language
Bram Moolenaar7dd54322022-08-26 18:01:12 +0100406T *+file_in_path* |gf|, |CTRL-W_f| and |<cfile>| Always enabled since
407 9.0.265
Bram Moolenaar071d4272004-06-13 20:20:40 +0000408N *+find_in_path* include file searches: |[I|, |:isearch|,
409 |CTRL-W_CTRL-I|, |:checkpath|, etc.
410N *+folding* |folding|
411 *+footer* |gui-footer|
412 *+fork* Unix only: |fork| shell commands
Bram Moolenaar73e28dc2022-09-17 21:08:33 +0100413T *+float* Floating point support Always enabled since 9.0.0491
Bram Moolenaar071d4272004-06-13 20:20:40 +0000414N *+gettext* message translations |multi-lang|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100415- *+GUI_Athena* Unix only: Athena |GUI|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416 *+GUI_neXtaw* Unix only: neXtaw |GUI|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000417 *+GUI_GTK* Unix only: GTK+ |GUI|
418 *+GUI_Motif* Unix only: Motif |GUI|
419 *+GUI_Photon* QNX only: Photon |GUI|
420m *+hangul_input* Hangul input support |hangul|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000421 *+iconv* Compiled with the |iconv()| function
422 *+iconv/dyn* Likewise |iconv-dynamic| |/dyn|
Bram Moolenaar06fe74a2019-08-31 16:20:32 +0200423T *+insert_expand* |insert_expand| Insert mode completion
Bram Moolenaarbfe13cc2020-04-12 17:53:12 +0200424m *+ipv6* Support for IPv6 networking |channel|
Bram Moolenaar38a55632016-02-15 22:07:32 +0100425m *+job* starting and stopping jobs |job|
Bram Moolenaar739f13a2021-12-13 13:12:53 +0000426T *+jumplist* |jumplist|; Always enabled since 8.2.3795
Martin Tournoij25f3a142022-10-08 19:26:41 +0100427H *+keymap* |'keymap'|
Bram Moolenaarbc8801c2016-08-02 21:04:33 +0200428N *+lambda* |lambda| and |closure|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100429H *+langmap* |'langmap'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000430N *+libcall* |libcall()|
431N *+linebreak* |'linebreak'|, |'breakat'| and |'showbreak'|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100432T *+lispindent* |'lisp'|
Bram Moolenaar0c72fe42018-03-29 16:04:08 +0200433T *+listcmds* Vim commands for the list of buffers |buffer-hidden|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000434 and argument list |:argdelete|
Bram Moolenaar088e8e32019-08-08 22:15:18 +0200435T *+localmap* Support for mappings local to a buffer |:map-local|
Bram Moolenaar0ba04292010-07-14 23:23:17 +0200436m *+lua* |Lua| interface
437m *+lua/dyn* |Lua| interface |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438N *+menu* |:menu|
439N *+mksession* |:mksession|
Bram Moolenaar30e9b3c2019-09-07 16:24:12 +0200440T *+modify_fname* |filename-modifiers|
Bram Moolenaar96f45c02019-10-26 19:53:45 +0200441T *+mouse* Mouse handling |mouse-using|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000442N *+mouseshape* |'mouseshape'|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100443N *+mouse_dec* Unix only: Dec terminal mouse handling |dec-mouse|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000444N *+mouse_gpm* Unix only: Linux console mouse handling |gpm-mouse|
Bram Moolenaar8a3b8052022-06-26 12:21:15 +0100445m *+mouse_gpm/dyn* Same as |+mouse_gpm| with optional library dependency
446 |/dyn|
Bram Moolenaar13600302014-05-22 18:26:40 +0200447N *+mouse_jsbterm* JSB mouse handling |jsbterm-mouse|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100448N *+mouse_netterm* Unix only: netterm mouse handling |netterm-mouse|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100449N *+mouse_pterm* QNX only: pterm mouse handling |qnx-terminal|
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000450N *+mouse_sysmouse* Unix only: *BSD console mouse handling |sysmouse|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100451N *+mouse_sgr* Unix only: sgr mouse handling |sgr-mouse|
452N *+mouse_urxvt* Unix only: urxvt mouse handling |urxvt-mouse|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100453N *+mouse_xterm* Unix only: xterm mouse handling |xterm-mouse|
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100454T *+multi_byte* Unicode support, 16 and 32 bit characters |multibyte|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000455 *+multi_byte_ime* Win32 input method for multibyte chars |multibyte-ime|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100456N *+multi_lang* non-English language support |multi-lang|
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000457m *+mzscheme* Mzscheme interface |mzscheme|
Bram Moolenaar4770d092006-01-12 23:22:24 +0000458m *+mzscheme/dyn* Mzscheme interface |mzscheme-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000459m *+netbeans_intg* |netbeans|
Bram Moolenaar47003982021-12-05 21:54:04 +0000460T *+num64* 64-bit Number support |Number|
Bram Moolenaara2baa732022-02-04 16:09:54 +0000461 Always enabled since 8.2.0271, use v:numbersize to
Bram Moolenaarf9706e92020-02-22 14:27:04 +0100462 check the actual size of a Number.
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100463m *+ole* Win32 GUI only: |ole-interface|
Bram Moolenaar91c49372016-05-08 09:50:29 +0200464N *+packages* Loading |packages|
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +0100465T *+path_extra* Up/downwards search in 'path' and 'tags' Always
466 enabled since 9.0.0270
Bram Moolenaara5792f52005-11-23 21:25:05 +0000467m *+perl* Perl interface |perl|
468m *+perl/dyn* Perl interface |perl-dynamic| |/dyn|
Bram Moolenaar7fc0c062010-08-10 21:43:35 +0200469N *+persistent_undo* Persistent undo |undo-persistence|
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100470N *+popupwin* Popup windows |popup-window|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100471 *+postscript* |:hardcopy| writes a PostScript file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000472N *+printer* |:hardcopy| command
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000473H *+profile* |:profile| command
Bram Moolenaar60aad972010-07-21 20:36:22 +0200474m *+python* Python 2 interface |python|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100475m *+python/dyn* Python 2 interface |python-dynamic| |/dyn|
Bram Moolenaar60aad972010-07-21 20:36:22 +0200476m *+python3* Python 3 interface |python|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100477m *+python3/dyn* Python 3 interface |python-dynamic| |/dyn|
Yee Cheng Chinc13b3d12023-08-20 21:18:38 +0200478m *+python3/dyn-stable*
h_east59858792023-10-25 22:47:05 +0900479 Python 3 interface |python-dynamic| |python-stable|
480 |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000481N *+quickfix* |:make| and |quickfix| commands
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000482N *+reltime* |reltime()| function, 'hlsearch'/'incsearch' timeout,
483 'redrawtime' option
Martin Tournoij25f3a142022-10-08 19:26:41 +0100484H *+rightleft* Right to left typing |'rightleft'|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000485m *+ruby* Ruby interface |ruby|
486m *+ruby/dyn* Ruby interface |ruby-dynamic| |/dyn|
Bram Moolenaar98ef2332018-03-18 14:44:37 +0100487T *+scrollbind* |'scrollbind'|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100488N *+signs* |:sign|
489T *+smartindent* |'smartindent'|
490H *+sodium* compiled with libsodium for better encryption support
491H *+sound* |sound_playevent()|, |sound_playfile()| functions, etc.
Bram Moolenaar12ee7ff2019-06-10 22:47:40 +0200492N *+spell* spell checking support, see |spell|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100493N *+startuptime* |--startuptime| argument
494N *+statusline* Options 'statusline', 'rulerformat' and special
Bram Moolenaar071d4272004-06-13 20:20:40 +0000495 formats of 'titlestring' and 'iconstring'
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100496- *+sun_workshop* Removed: |workshop|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000497N *+syntax* Syntax highlighting |syntax|
498 *+system()* Unix only: opposite of |+fork|
Naruhiko Nishinobe5bd4d2025-05-14 21:20:28 +0200499H *+tabpanel* Support for |tabpanel|
Bram Moolenaar64d8e252016-09-06 22:12:34 +0200500T *+tag_binary* binary searching in tags file |tag-binary-search|
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100501- *+tag_old_static* Removed; method for static tags |tag-old-static|
502- *+tag_any_white* Removed; was to allow any white space in tags files
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100503m *+tcl* Tcl interface |tcl|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000504m *+tcl/dyn* Tcl interface |tcl-dynamic| |/dyn|
Bram Moolenaar1ccd8ff2017-08-11 19:50:37 +0200505m *+terminal* Support for terminal window |terminal|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000506 *+terminfo* uses |terminfo| instead of termcap
507N *+termresponse* support for |t_RV| and |v:termresponse|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100508N *+termguicolors* 24-bit color in xterm-compatible terminals support
Bram Moolenaar88774872022-08-16 20:24:29 +0100509T *+textobjects* |text-objects| selection. Always enabled since 9.0.0222.
Bram Moolenaar9d87a372018-12-18 21:41:50 +0100510N *+textprop* |text-properties|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000511 *+tgetent* non-Unix only: able to use external termcap
Bram Moolenaare18c0b32016-03-20 21:08:34 +0100512N *+timers* the |timer_start()| function
Bram Moolenaar47003982021-12-05 21:54:04 +0000513T *+title* Setting the window 'title' and 'icon'; Always enabled
Bram Moolenaar071d4272004-06-13 20:20:40 +0000514N *+toolbar* |gui-toolbar|
Bram Moolenaarac9fb182019-04-27 13:04:13 +0200515T *+user_commands* User-defined commands. |user-commands|
516 Always enabled since 8.1.1210.
Damien Lejaybfa16362025-06-10 21:12:31 +0200517H *+vartabs* Variable-width tab stops. |'vartabstop'|
Bram Moolenaar47003982021-12-05 21:54:04 +0000518T *+vertsplit* Vertically split windows |:vsplit|; Always enabled
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200519 since 8.0.1118.
Bram Moolenaara6feb162022-01-02 12:06:33 +0000520T *+vim9script* |Vim9| script
521N *+viminfo* |'viminfo'|
Bram Moolenaar47003982021-12-05 21:54:04 +0000522T *+virtualedit* |'virtualedit'| Always enabled since 8.1.826.
Bram Moolenaar870ba5f2019-01-11 14:37:20 +0100523T *+visual* Visual mode |Visual-mode| Always enabled since 7.4.200.
524T *+visualextra* extra Visual mode commands |blockwise-operators|
Bram Moolenaar1f0bfe52018-07-29 16:09:22 +0200525T *+vreplace* |gR| and |gr|
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +0100526 *+vtp* on MS-Windows console: support for 'termguicolors'
Foxe Chenb90c2392025-06-27 21:10:35 +0200527N *+wayland* Unix only: support for the Wayland protocol.
528N *+wayland_clipboard* Unix only: support for Wayland selections/clipboard.
Bram Moolenaar074fbd42022-08-26 16:41:14 +0100529T *+wildignore* |'wildignore'| Always enabled since 9.0.0278
Bram Moolenaarf1dcd142022-12-31 15:30:45 +0000530T *+wildmenu* |'wildmenu'| Always enabled since 9.0.0279
Bram Moolenaar870ba5f2019-01-11 14:37:20 +0100531T *+windows* more than one window; Always enabled since 8.0.1118.
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100532m *+writebackup* |'writebackup'| is default on
533m *+xim* X input method |xim|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000534 *+xfontset* X fontset support |xfontset|
Christian Brabandte085dfd2023-09-30 12:49:18 +0200535N *+xattr* compiled with extended attribute support (Linux only)
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200536 *+xpm* pixmap support
Bram Moolenaar9b451252012-08-15 17:43:31 +0200537m *+xpm_w32* Win32 GUI only: pixmap support |w32-xpm-support|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000538 *+xsmp* XSMP (X session management) support
539 *+xsmp_interact* interactive XSMP (X session management) support
540N *+xterm_clipboard* Unix only: xterm clipboard handling
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100541m *+xterm_save* save and restore xterm screen |xterm-screens|
542N *+X11* Unix only: can restore window title |X11|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543
544 */dyn* *E370* *E448*
545 To some of the features "/dyn" is added when the
546 feature is only available when the related library can
547 be dynamically loaded.
548
549:ve[rsion] {nr} Is now ignored. This was previously used to check the
550 version number of a .vimrc file. It was removed,
551 because you can now use the ":if" command for
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200552 version-dependent behavior.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553
554 *:redi* *:redir*
555:redi[r][!] > {file} Redirect messages to file {file}. The messages which
556 are the output of commands are written to that file,
557 until redirection ends. The messages are also still
558 shown on the screen. When [!] is included, an
559 existing file is overwritten. When [!] is omitted,
560 and {file} exists, this command fails.
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200561
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562 Only one ":redir" can be active at a time. Calls to
563 ":redir" will close any active redirection before
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200564 starting redirection to the new target. For recursive
565 use check out |execute()|.
566
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567 To stop the messages and commands from being echoed to
568 the screen, put the commands in a function and call it
569 with ":silent call Function()".
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000570 An alternative is to use the 'verbosefile' option,
571 this can be used in combination with ":redir".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572
573:redi[r] >> {file} Redirect messages to file {file}. Append if {file}
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200574 already exists.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000575
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000576:redi[r] @{a-zA-Z}
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +0000577:redi[r] @{a-zA-Z}> Redirect messages to register {a-z}. Append to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000578 contents of the register if its name is given
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000579 uppercase {A-Z}. The ">" after the register name is
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200580 optional.
581:redi[r] @{a-z}>> Append messages to register {a-z}.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100583:redi[r] @*>
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000584:redi[r] @+> Redirect messages to the selection or clipboard. For
585 backward compatibility, the ">" after the register
586 name can be omitted. See |quotestar| and |quoteplus|.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100587:redi[r] @*>>
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000588:redi[r] @+>> Append messages to the selection or clipboard.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000589
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +0000590:redi[r] @"> Redirect messages to the unnamed register. For
591 backward compatibility, the ">" after the register
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200592 name can be omitted.
593:redi[r] @">> Append messages to the unnamed register.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000594 *E1092*
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000595:redi[r] => {var} Redirect messages to a variable.
596 In legacy script: If the variable doesn't exist, then
597 it is created. If the variable exists, then it is
598 initialized to an empty string. After the redirection
599 starts, if the variable is removed or locked or the
600 variable type is changed, then further command output
Bram Moolenaare1dc76f2022-06-25 18:01:32 +0100601 messages will cause errors. When using a local
602 variable (l:var in a function or s:var in a script)
603 and another `:redir` causes the current one to end,
604 the scope might be different and the assignment fails.
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000605 In Vim9 script: the variable must have been declared
606 as a string.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000607 The variable will remain empty until redirection ends.
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000608 Only string variables can be used.
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200609 To get the output of one command the |execute()|
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +0200610 function can be used instead of redirection.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000611
612:redi[r] =>> {var} Append messages to an existing variable. Only string
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200613 variables can be used.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000614 *E1185*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200615:redi[r] END End redirecting messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000616
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200617 *:filt* *:filter*
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000618:filt[er][!] {pattern} {command}
619:filt[er][!] /{pattern}/ {command}
Bram Moolenaar214641f2017-03-05 17:04:09 +0100620 Restrict the output of {command} to lines matching
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000621 with {pattern}. For example, to list only xml files: >
Bram Moolenaar818078d2016-08-27 21:58:42 +0200622 :filter /\.xml$/ oldfiles
Bram Moolenaar214641f2017-03-05 17:04:09 +0100623< If the [!] is given, restrict the output of {command}
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000624 to lines that do NOT match {pattern}.
Bram Moolenaar214641f2017-03-05 17:04:09 +0100625
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000626 {pattern} is a Vim search pattern. Instead of enclosing
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200627 it in / any non-ID character (see |'isident'|) can be
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000628 used, so long as it does not appear in {pattern}.
629 Without the enclosing character the pattern cannot
630 include the bar character. 'ignorecase' is not used.
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200631
632 The pattern is matched against the relevant part of
633 the output, not necessarily the whole line. Only some
634 commands support filtering, try it out to check if it
Bram Moolenaarf86db782018-10-25 13:31:37 +0200635 works. Some of the commands that support filtering:
Bram Moolenaarad6dc492019-04-27 22:40:08 +0200636 |:#| - filter whole line
637 |:clist| - filter by file name or module name
638 |:command| - filter by command name
639 |:files| - filter by file name
640 |:highlight| - filter by highlight group
Christian Brabandt42a5b5a2024-05-24 07:39:34 +0200641 |:history| - filter by history commands
Bram Moolenaarad6dc492019-04-27 22:40:08 +0200642 |:jumps| - filter by file name
643 |:let| - filter by variable name
644 |:list| - filter whole line
645 |:llist| - filter by file name or module name
646 |:marks| - filter by text in the current file,
647 or file name for other files
648 |:oldfiles| - filter by file name
Bram Moolenaar8fc42962019-10-26 17:33:13 +0200649 |:registers| - filter by register contents
650 (does not work multi-line)
Bram Moolenaar0e6adf82021-12-16 14:41:10 +0000651 |:set| - filter by option name
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200652
653 Only normal messages are filtered, error messages are
654 not.
655
Bram Moolenaare0fa3742016-02-20 15:47:01 +0100656 *:sil* *:silent* *:silent!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000657:sil[ent][!] {command} Execute {command} silently. Normal messages will not
658 be given or added to the message history.
659 When [!] is added, error messages will also be
660 skipped, and commands and mappings will not be aborted
661 when an error is detected. |v:errmsg| is still set.
662 When [!] is not used, an error message will cause
663 further messages to be displayed normally.
664 Redirection, started with |:redir|, will continue as
665 usual, although there might be small differences.
666 This will allow redirecting the output of a command
667 without seeing it on the screen. Example: >
668 :redir >/tmp/foobar
669 :silent g/Aap/p
670 :redir END
671< To execute a Normal mode command silently, use the
672 |:normal| command. For example, to search for a
673 string without messages: >
674 :silent exe "normal /path\<CR>"
675< ":silent!" is useful to execute a command that may
676 fail, but the failure is to be ignored. Example: >
677 :let v:errmsg = ""
678 :silent! /^begin
679 :if v:errmsg != ""
680 : ... pattern was not found
681< ":silent" will also avoid the hit-enter prompt. When
682 using this for an external command, this may cause the
683 screen to be messed up. Use |CTRL-L| to clean it up
684 then.
685 ":silent menu ..." defines a menu that will not echo a
686 Command-line command. The command will still produce
687 messages though. Use ":silent" in the command itself
688 to avoid that: ":silent menu .... :silent command".
689
Bram Moolenaar8e258a42009-07-09 13:55:43 +0000690 *:uns* *:unsilent*
691:uns[ilent] {command} Execute {command} not silently. Only makes a
692 difference when |:silent| was used to get to this
693 command.
694 Use this for giving a message even when |:silent| was
695 used. In this example |:silent| is used to avoid the
696 message about reading the file and |:unsilent| to be
697 able to list the first line of each file. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000698 :silent argdo unsilent echo expand('%') .. ": " .. getline(1)
Bram Moolenaar8e258a42009-07-09 13:55:43 +0000699<
700
Bram Moolenaar071d4272004-06-13 20:20:40 +0000701 *:verb* *:verbose*
702:[count]verb[ose] {command}
703 Execute {command} with 'verbose' set to [count]. If
Bram Moolenaared203462004-06-16 11:19:22 +0000704 [count] is omitted one is used. ":0verbose" can be
705 used to set 'verbose' to zero.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706 The additional use of ":silent" makes messages
707 generated but not displayed.
708 The combination of ":silent" and ":verbose" can be
709 used to generate messages and check them with
710 |v:statusmsg| and friends. For example: >
711 :let v:statusmsg = ""
712 :silent verbose runtime foobar.vim
713 :if v:statusmsg != ""
714 : " foobar.vim could not be found
715 :endif
716< When concatenating another command, the ":verbose"
717 only applies to the first one: >
718 :4verbose set verbose | set verbose
719< verbose=4 ~
720 verbose=0 ~
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000721 For logging verbose messages in a file use the
722 'verbosefile' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723
Bram Moolenaar8aff23a2005-08-19 20:40:30 +0000724 *:verbose-cmd*
725When 'verbose' is non-zero, listing the value of a Vim option or a key map or
Bram Moolenaare344bea2005-09-01 20:46:49 +0000726an abbreviation or a user-defined function or a command or a highlight group
727or an autocommand will also display where it was last defined. If it was
728defined manually then there will be no "Last set" message. When it was
729defined while executing a function, user command or autocommand, the script in
730which it was defined is reported.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200731{not available when compiled without the |+eval| feature}
Bram Moolenaar8aff23a2005-08-19 20:40:30 +0000732
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733 *K*
734K Run a program to lookup the keyword under the
735 cursor. The name of the program is given with the
736 'keywordprg' (kp) option (default is "man"). The
737 keyword is formed of letters, numbers and the
738 characters in 'iskeyword'. The keyword under or
739 right of the cursor is used. The same can be done
740 with the command >
741 :!{program} {keyword}
742< There is an example of a program to use in the tools
Bram Moolenaar214641f2017-03-05 17:04:09 +0100743 directory of Vim. It is called "ref" and does a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000744 simple spelling check.
745 Special cases:
Bram Moolenaar26852122016-05-24 20:02:38 +0200746 - If 'keywordprg' begins with ":" it is invoked as
747 a Vim Ex command with [count].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748 - If 'keywordprg' is empty, the ":help" command is
749 used. It's a good idea to include more characters
750 in 'iskeyword' then, to be able to find more help.
Bram Moolenaar26852122016-05-24 20:02:38 +0200751 - When 'keywordprg' is equal to "man" or starts with
752 ":", a [count] before "K" is inserted after
753 keywordprg and before the keyword. For example,
754 using "2K" while the cursor is on "mkdir", results
755 in: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000756 !man 2 mkdir
757< - When 'keywordprg' is equal to "man -s", a count
758 before "K" is inserted after the "-s". If there is
759 no count, the "-s" is removed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000760
761 *v_K*
762{Visual}K Like "K", but use the visually highlighted text for
763 the keyword. Only works when the highlighted text is
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200764 not more than one line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000765
766[N]gs *gs* *:sl* *:sleep*
Bram Moolenaare2edc2e2021-01-16 20:21:23 +0100767:[N]sl[eep] [N][m] Do nothing for [N] seconds. When [m] is included,
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000768 sleep for [N] milliseconds. The count for "gs" always
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 uses seconds. The default is one second. >
770 :sleep "sleep for one second
771 :5sleep "sleep for five seconds
Bram Moolenaare2edc2e2021-01-16 20:21:23 +0100772 :sleep 100m "sleep for 100 milliseconds
Bram Moolenaar071d4272004-06-13 20:20:40 +0000773 10gs "sleep for ten seconds
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100774< Can be interrupted with CTRL-C (CTRL-Break on
775 MS-Windows). "gs" stands for "goto sleep".
Bram Moolenaar677ee682005-01-27 14:41:15 +0000776 While sleeping the cursor is positioned in the text,
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200777 if at a visible position.
Yee Cheng Chine70587d2025-02-13 20:55:45 +0100778 Queued messages and timers (|+timers|) are processed
779 during the sleep as well.
Bram Moolenaar15146672011-10-20 22:22:38 +0200780
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100781 *:sl!* *:sleep!*
Bram Moolenaar2346a632021-06-13 19:02:49 +0200782:[N]sl[eep]! [N][m] Same as above, but hide the cursor.
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100783
Bram Moolenaard4aa83a2019-05-09 18:59:31 +0200784 *:xrestore* *:xr*
785:xr[estore] [display] Reinitializes the connection to the X11 server. Useful
786 after the X server restarts, e.g. when running Vim for
787 long time inside screen/tmux and connecting from
Bram Moolenaar68e65602019-05-26 21:33:31 +0200788 different machines.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100789 [display] should be in the format of the $DISPLAY
Bram Moolenaard4aa83a2019-05-09 18:59:31 +0200790 environment variable (e.g. "localhost:10.0")
791 If [display] is omitted, then it reinitializes the
792 connection to the X11 server using the same value as
793 was used for the previous execution of this command.
794 If the value was never specified, then it uses the
795 value of $DISPLAY environment variable as it was when
Foxe Chenb90c2392025-06-27 21:10:35 +0200796 Vim was started. This will also update |v:clipmethod|.
Hirohito Higashi73b96502025-06-28 18:18:21 +0200797 {only available when compiled with the
798 |+xterm_clipboard| feature}
Foxe Chenb90c2392025-06-27 21:10:35 +0200799
800 *:clipreset* *:clip*
801:clip[reset] Attempts to choose a new method for accessing the
Hirohito Higashi73b96502025-06-28 18:18:21 +0200802 clipboard, using the 'clipmethod' option. This is
Foxe Chenb90c2392025-06-27 21:10:35 +0200803 useful when the current method has become unavailable,
804 and you want to try using another method.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100805 {only available when compiled with the |+clipboard|
Bram Moolenaard4aa83a2019-05-09 18:59:31 +0200806 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807
808 *g_CTRL-A*
809g CTRL-A Only when Vim was compiled with MEM_PROFILING defined
810 (which is very rare): print memory usage statistics.
811 Only useful for debugging Vim.
Bram Moolenaar345efa02016-01-15 20:57:49 +0100812 For incrementing in Visual mode see |v_g_CTRL-A|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000813
814==============================================================================
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +02008152. Using Vim like less or more *less*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000816
817If you use the less or more program to view a file, you don't get syntax
818highlighting. Thus you would like to use Vim instead. You can do this by
819using the shell script "$VIMRUNTIME/macros/less.sh".
820
821This shell script uses the Vim script "$VIMRUNTIME/macros/less.vim". It sets
822up mappings to simulate the commands that less supports. Otherwise, you can
823still use the Vim commands.
824
825This isn't perfect. For example, when viewing a short file Vim will still use
Bram Moolenaar7ff78462020-07-10 22:00:53 +0200826the whole screen. But it works well enough for most uses, and you get syntax
Bram Moolenaar071d4272004-06-13 20:20:40 +0000827highlighting.
828
829The "h" key will give you a short overview of the available commands.
830
Bram Moolenaare392eb42015-11-19 20:38:09 +0100831If you want to set options differently when using less, define the
832LessInitFunc in your vimrc, for example: >
833
834 func LessInitFunc()
835 set nocursorcolumn nocursorline
836 endfunc
837<
838
Bram Moolenaard2855f52018-07-31 22:23:58 +0200839 vim:tw=78:ts=8:noet:ft=help:norl: