blob: 440a665629049a36a60727cecceb4c703d6ed5ca [file] [log] [blame]
Christian Brabandt0a4e57f2024-12-16 10:20:51 +01001*various.txt* For Vim version 9.1. Last change: 2024 Dec 16
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
Bram Moolenaar071d4272004-06-13 20:20:40 +000039 *N<Del>*
40<Del> When entering a number: Remove the last digit.
41 Note: if you like to use <BS> for this, add this
42 mapping to your .vimrc: >
43 :map CTRL-V <BS> CTRL-V <Del>
44< See |:fixdel| if your <Del> key does not do what you
45 want.
46
47:as[cii] or *ga* *:as* *:ascii*
48ga Print the ascii value of the character under the
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010049 cursor in decimal, hexadecimal and octal.
50 Mnemonic: Get Ascii value.
51
52 For example, when the cursor is on a 'R':
Bram Moolenaar071d4272004-06-13 20:20:40 +000053 <R> 82, Hex 52, Octal 122 ~
54 When the character is a non-standard ASCII character,
55 but printable according to the 'isprint' option, the
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010056 non-printable version is also given.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +010057
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010058 When the character is larger than 127, the <M-x> form
59 is also printed. For example:
Bram Moolenaar071d4272004-06-13 20:20:40 +000060 <~A> <M-^A> 129, Hex 81, Octal 201 ~
61 <p> <|~> <M-~> 254, Hex fe, Octal 376 ~
62 (where <p> is a special character)
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010063
Bram Moolenaar071d4272004-06-13 20:20:40 +000064 The <Nul> character in a file is stored internally as
65 <NL>, but it will be shown as:
66 <^@> 0, Hex 00, Octal 000 ~
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010067
Bram Moolenaar362e1a32006-03-06 23:29:24 +000068 If the character has composing characters these are
69 also shown. The value of 'maxcombine' doesn't matter.
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010070
71 If the character can be inserted as a digraph, also
72 output the two characters that can be used to create
73 the character:
Milly89872f52024-10-05 17:16:18 +020074 <ö> 246, Hex 00f6, Oct 366, Digr o: ~
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010075 This shows you can type CTRL-K o : to insert ö.
76
Bram Moolenaar071d4272004-06-13 20:20:40 +000077 *g8*
78g8 Print the hex values of the bytes used in the
79 character under the cursor, assuming it is in |UTF-8|
Bram Moolenaar362e1a32006-03-06 23:29:24 +000080 encoding. This also shows composing characters. The
81 value of 'maxcombine' doesn't matter.
82 Example of a character with two composing characters:
Bram Moolenaar071d4272004-06-13 20:20:40 +000083 e0 b8 81 + e0 b8 b9 + e0 b9 89 ~
Bram Moolenaarca003e12006-03-17 23:19:38 +000084
85 *8g8*
868g8 Find an illegal UTF-8 byte sequence at or after the
87 cursor. This works in two situations:
88 1. when 'encoding' is any 8-bit encoding
89 2. when 'encoding' is "utf-8" and 'fileencoding' is
90 any 8-bit encoding
91 Thus it can be used when editing a file that was
92 supposed to be UTF-8 but was read as if it is an 8-bit
93 encoding because it contains illegal bytes.
94 Does not wrap around the end of the file.
95 Note that when the cursor is on an illegal byte or the
Bram Moolenaar207f0092020-08-30 17:20:20 +020096 cursor is halfway a multibyte character the command
Bram Moolenaarca003e12006-03-17 23:19:38 +000097 won't move the cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +000098
Bram Moolenaar551dbcc2006-04-25 22:13:59 +000099 *:p* *:pr* *:print* *E749*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000100:[range]p[rint] [flags]
101 Print [range] lines (default current line).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000102 Note: If you are looking for a way to print your text
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000103 on paper see |:hardcopy|. In the GUI you can use the
104 File.Print menu entry.
105 See |ex-flags| for [flags].
Bram Moolenaar818078d2016-08-27 21:58:42 +0200106 The |:filter| command can be used to only show lines
107 matching a pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000108
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000109:[range]p[rint] {count} [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000110 Print {count} lines, starting with [range] (default
111 current line |cmdline-ranges|).
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000112 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000113
114 *:P* *:Print*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000115:[range]P[rint] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000116 Just as ":print". Was apparently added to Vi for
117 people that keep the shift key pressed too long...
Bram Moolenaar1588bc82022-03-08 21:35:07 +0000118 This command is not supported in |Vim9| script.
Bram Moolenaar166af9b2010-11-16 20:34:40 +0100119 Note: A user command can overrule this command.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000120 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121
122 *:l* *:list*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000123:[range]l[ist] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000124 Same as :print, but display unprintable characters
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +0200125 with '^' and put $ after the line. This can be
Bram Moolenaard58e9292011-02-09 17:07:58 +0100126 further changed with the 'listchars' option.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000127 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000128
129 *:nu* *:number*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000130:[range]nu[mber] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000131 Same as :print, but precede each line with its line
Bram Moolenaarfaa959a2006-02-20 21:37:40 +0000132 number. (See also 'highlight' and 'numberwidth'
133 option).
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000134 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000135
136 *:#*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000137:[range]# [count] [flags]
138 synonym for :number.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139
Christian Brabandtf4bc59c2024-06-15 15:52:53 +0200140 *:#!* *vim-shebang*
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000141:#!{anything} Ignored, so that you can start a Vim script with: >
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000142 #!vim -S
Christian Brabandtca471142024-06-17 13:06:34 +0200143 let mylogbook='$HOME/logbook.md'
144 exe $':e {mylogbook}'
145 $
146 put ='## ' .. strftime('%d. %b %Y')
147 norm! o
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000148<
Christian Brabandtca471142024-06-17 13:06:34 +0200149 Make that script executable and run it to create a
150 new diary entry.
151
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152 *:z* *E144*
Bram Moolenaar4466ad62020-11-21 13:16:30 +0100153:[range]z[+-^.=][count] Display several lines of text surrounding the line
154 specified with [range], or around the current line
155 if there is no [range].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000156
Bram Moolenaar4466ad62020-11-21 13:16:30 +0100157 If there is a [count], that's how many lines you'll
158 see; if there is no [count] and only one window then
159 twice the value of the 'scroll' option is used,
160 otherwise the current window height minus 3 is used.
161 This is the value of "scr" in the table below.
162
163 If there is a [count] the 'window' option is set to
Bram Moolenaarb6b046b2011-12-30 13:11:27 +0100164 its value.
165
Bram Moolenaar071d4272004-06-13 20:20:40 +0000166 :z can be used either alone or followed by any of
Bram Moolenaar207f0092020-08-30 17:20:20 +0200167 several marks. These have the following effect:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168
Bram Moolenaar662db672011-03-22 14:05:35 +0100169 mark first line last line new cursor line ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000170 ---- ---------- --------- ------------
171 + current line 1 scr forward 1 scr forward
172 - 1 scr back current line current line
173 ^ 2 scr back 1 scr back 1 scr back
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +0000174 . 1/2 scr back 1/2 scr fwd 1/2 scr fwd
175 = 1/2 scr back 1/2 scr fwd current line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176
177 Specifying no mark at all is the same as "+".
178 If the mark is "=", a line of dashes is printed
179 around the current line.
180
Bram Moolenaar6c391a72021-09-09 21:55:11 +0200181 *:z!*
Dominique Pelle7f2dd1e2021-09-04 13:44:01 +0200182:[range]z![+-^.=][count]
Bram Moolenaar22863042021-10-16 15:23:36 +0100183 Like ":z", but when [count] is not specified, it
Dominique Pelle7f2dd1e2021-09-04 13:44:01 +0200184 defaults to the Vim window height minus one.
185
186:[range]z[!]#[+-^.=][count] *:z#*
187 Like ":z" or ":z!", but number the lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000188
189 *:=*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000190:= [flags] Print the last line number.
191 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000192
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000193:{range}= [flags] Prints the last line number in {range}. For example,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000194 this prints the current line number: >
195 :.=
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000196< See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000197
198:norm[al][!] {commands} *:norm* *:normal*
199 Execute Normal mode commands {commands}. This makes
200 it possible to execute Normal mode commands typed on
Bram Moolenaar4a748032010-09-30 21:47:56 +0200201 the command-line. {commands} are executed like they
202 are typed. For undo all commands are undone together.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000203 Execution stops when an error is encountered.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100204
Bram Moolenaar071d4272004-06-13 20:20:40 +0000205 If the [!] is given, mappings will not be used.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100206 Without it, when this command is called from a
207 non-remappable mapping (|:noremap|), the argument can
208 be mapped anyway.
209
Bram Moolenaar071d4272004-06-13 20:20:40 +0000210 {commands} should be a complete command. If
211 {commands} does not finish a command, the last one
212 will be aborted as if <Esc> or <C-C> was typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000213 This implies that an insert command must be completed
214 (to start Insert mode, see |:startinsert|). A ":"
Bram Moolenaar7c626922005-02-07 22:01:03 +0000215 command must be completed as well. And you can't use
216 "Q" or "gQ" to start Ex mode.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100217
218 The display is not updated while ":normal" is busy.
219
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100220 {commands} cannot start with a space. Put a count of
221 1 (one) before it, "1 " is one space.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100222
Bram Moolenaar071d4272004-06-13 20:20:40 +0000223 The 'insertmode' option is ignored for {commands}.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100224
Bram Moolenaar071d4272004-06-13 20:20:40 +0000225 This command cannot be followed by another command,
226 since any '|' is considered part of the command.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100227
Bram Moolenaar071d4272004-06-13 20:20:40 +0000228 This command can be used recursively, but the depth is
229 limited by 'maxmapdepth'.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100230
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231 An alternative is to use |:execute|, which uses an
232 expression as argument. This allows the use of
Bram Moolenaar46f9d492010-06-12 20:18:19 +0200233 printable characters to represent special characters.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100234
Bram Moolenaar46f9d492010-06-12 20:18:19 +0200235 Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000236 :exe "normal \<c-w>\<c-w>"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000237
238:{range}norm[al][!] {commands} *:normal-range*
239 Execute Normal mode commands {commands} for each line
240 in the {range}. Before executing the {commands}, the
241 cursor is positioned in the first column of the range,
242 for each line. Otherwise it's the same as the
243 ":normal" command without a range.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000244
245 *:sh* *:shell* *E371*
246:sh[ell] This command starts a shell. When the shell exits
247 (after the "exit" command) you return to Vim. The
248 name for the shell command comes from 'shell' option.
249 *E360*
250 Note: This doesn't work when Vim on the Amiga was
251 started in QuickFix mode from a compiler, because the
252 compiler will have set stdin to a non-interactive
253 mode.
254
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000255 *:!cmd* *:!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000256:!{cmd} Execute {cmd} with the shell. See also the 'shell'
Christian Brabandtf18987c2024-11-12 21:38:22 +0100257 and 'shelltype' option. For the filter command, see
258 |:range!|.
matveyta01148d2024-11-23 14:19:58 +0100259
260 Vim builds command line using options 'shell', 'shcf',
261 'sxq' and 'shq' in the following order:
262 `&sh &shcf &sxq &shq {cmd} &shq &sxq`
263 So setting both 'sxq' and 'shq' is possible but rarely
264 useful. Additional escaping inside `{cmd}` may also
265 be due to 'sxe' option.
266
267 Also, all |cmdline-special| characters in {cmd} are
268 replaced by Vim before passing them to shell.
269
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000270 *E34*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000271 Any '!' in {cmd} is replaced with the previous
272 external command (see also 'cpoptions'). But not when
273 there is a backslash before the '!', then that
274 backslash is removed. Example: ":!ls" followed by
275 ":!echo ! \! \\!" executes "echo ls ! \!".
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200276
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000277 A '|' in {cmd} is passed to the shell, you cannot use
278 it to append a Vim command. See |:bar|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200279
280 If {cmd} contains "%" it is expanded to the current
Bram Moolenaaracc22402020-06-07 21:07:18 +0200281 file name, "#" is expanded to the alternate file name.
282 Special characters in the file name are not escaped,
283 use quotes to avoid their special meaning: >
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200284 :!ls "%"
Bram Moolenaaracc22402020-06-07 21:07:18 +0200285< If the file name contains a "$" then single quotes
286 might work better, but this only works if the file
287 name does not contain a single quote: >
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200288 :!ls '%'
289< This should always work, but it's more typing: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000290 :exe "!ls " .. shellescape(expand("%"))
Bram Moolenaaracc22402020-06-07 21:07:18 +0200291< To get a literal "%" or "#" prepend it with a
292 backslash. For example, to list all files starting
293 with "%": >
294 :!ls \%*
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200295<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000296 A newline character ends {cmd}, what follows is
297 interpreted as a following ":" command. However, if
298 there is a backslash before the newline it is removed
299 and {cmd} continues. It doesn't matter how many
300 backslashes are before the newline, only one is
301 removed.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200302
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303 On Unix the command normally runs in a non-interactive
304 shell. If you want an interactive shell to be used
305 (to use aliases) set 'shellcmdflag' to "-ic".
306 For Win32 also see |:!start|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200307
Bram Moolenaare968e362014-05-13 20:23:24 +0200308 After the command has been executed, the timestamp and
309 size of the current file is checked |timestamp|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200310
Bram Moolenaar071d4272004-06-13 20:20:40 +0000311 Vim redraws the screen after the command is finished,
312 because it may have printed any text. This requires a
313 hit-enter prompt, so that you can read any messages.
314 To avoid this use: >
315 :silent !{cmd}
316< The screen is not redrawn then, thus you have to use
317 CTRL-L or ":redraw!" if the command did display
Bram Moolenaar76db9e02022-11-09 21:21:04 +0000318 something. However, this depends on what the |t_ti|
319 and |t_te| termcap entries are set to.
matveyta01148d2024-11-23 14:19:58 +0100320
321 Hint: use |:terminal| command if you want to run {cmd}
322 in Vim window. `:term ++shell ++close {cmd}` could
323 serve as close approximation to what `:!{cmd}` does.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324
325 *:!!*
326:!! Repeat last ":!{cmd}".
327
Bram Moolenaar61da1bf2019-06-06 12:14:49 +0200328 *:ve* *:ver* *:version*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000329:ve[rsion] Print the version number of the editor. If the
330 compiler used understands "__DATE__" the compilation
331 date is mentioned. Otherwise a fixed release-date is
332 shown.
333 The following lines contain information about which
334 features were enabled when Vim was compiled. When
335 there is a preceding '+', the feature is included,
336 when there is a '-' it is excluded. To change this,
337 you have to edit feature.h and recompile Vim.
338 To check for this in an expression, see |has()|.
339 Here is an overview of the features.
340 The first column shows the smallest version in which
341 they are included:
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100342 T tiny (always)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000343 N normal
Bram Moolenaar071d4272004-06-13 20:20:40 +0000344 H huge
345 m manually enabled or depends on other features
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100346 - never, feature was removed
Bram Moolenaar071d4272004-06-13 20:20:40 +0000347 (none) system dependent
348 Thus if a feature is marked with "N", it is included
RestorerZac9c6d52023-10-05 22:25:12 +0200349 in the normal and huge versions of Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350
351 *+feature-list*
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200352 *+acl* |ACL| support included
Bram Moolenaar071d4272004-06-13 20:20:40 +0000353 *+ARP* Amiga only: ARP support included
Martin Tournoij25f3a142022-10-08 19:26:41 +0100354H *+arabic* |Arabic| language support
355N *+autochdir* support 'autochdir' option
Bram Moolenaarfd999452022-08-24 18:30:14 +0100356T *+autocmd* |:autocmd|, automatic commands. Always enabled since
357 8.0.1564
Bram Moolenaare42a6d22017-11-12 19:21:51 +0100358H *+autoservername* Automatically enable |clientserver|
Bram Moolenaara2a80162017-11-21 23:09:50 +0100359m *+balloon_eval* |balloon-eval| support in the GUI. Included when
360 compiling with supported GUI (Motif, GTK, GUI) and
361 either Netbeans/Sun Workshop integration or |+eval|
362 feature.
363H *+balloon_eval_term* |balloon-eval| support in the terminal,
364 'balloonevalterm'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000365N *+browse* |:browse| command
Bram Moolenaar2ee347f2022-08-26 17:53:44 +0100366T *++builtin_terms* maximal terminals builtin |builtin-terms| Always
367 enabled since 9.0.0280
Bram Moolenaar071d4272004-06-13 20:20:40 +0000368N *+byte_offset* support for 'o' flag in 'statusline' option, "go"
369 and ":goto" commands.
Bram Moolenaar298b4402016-01-28 22:38:53 +0100370m *+channel* inter process communication |channel|
Martin Tournoij7904fa42022-10-04 16:28:45 +0100371T *+cindent* |'cindent'|, C indenting; Always enabled
Bram Moolenaar071d4272004-06-13 20:20:40 +0000372N *+clientserver* Unix and Win32: Remote invocation |clientserver|
Bram Moolenaar56c860c2019-08-17 20:09:31 +0200373 *+clipboard* |clipboard| support compiled-in
374 *+clipboard_working* |clipboard| support compiled-in and working
Bram Moolenaar06fe74a2019-08-31 16:20:32 +0200375T *+cmdline_compl* command line completion |cmdline-completion|
Bram Moolenaar85388672021-01-31 17:03:52 +0100376T *+cmdline_hist* command line history |cmdline-history|
Martin Tournoijba43e762022-10-13 22:12:15 +0100377T *+cmdline_info* |'showcmd'| and |'ruler'|; Always enabled since
378 9.0.0747
Martin Tournoij7904fa42022-10-04 16:28:45 +0100379T *+cmdwin* |cmdline-window| support; Always enabled since 9.0.0657
Bram Moolenaar8c96af92019-09-28 19:05:57 +0200380T *+comments* |'comments'| support
Martin Tournoij25f3a142022-10-08 19:26:41 +0100381N *+conceal* "conceal" support, see |conceal| |:syn-conceal| etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000382N *+cryptv* encryption support |encryption|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100383H *+cscope* |cscope| support
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100384T *+cursorbind* |'cursorbind'| support
Bram Moolenaarac6e65f2005-08-29 22:25:38 +0000385m *+cursorshape* |termcap-cursor-shape| support
386m *+debug* Compiled for debugging.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000387N *+dialog_gui* Support for |:confirm| with GUI dialog.
388N *+dialog_con* Support for |:confirm| with console dialog.
389N *+dialog_con_gui* Support for |:confirm| with GUI and console dialog.
390N *+diff* |vimdiff| and 'diff'
391N *+digraphs* |digraphs| *E196*
Bram Moolenaar43cb6262018-03-14 21:39:02 +0100392 *+directx* Win32 GUI only: DirectX and |'renderoptions'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000393 *+dnd* Support for DnD into the "~ register |quote_~|.
Martin Tournoij25f3a142022-10-08 19:26:41 +0100394H *+emacs_tags* |emacs-tags| files
Bram Moolenaar071d4272004-06-13 20:20:40 +0000395N *+eval* expression evaluation |eval.txt|
Bram Moolenaar47003982021-12-05 21:54:04 +0000396T *+ex_extra* always on now, used to be for Vim's extra Ex commands
Bram Moolenaar071d4272004-06-13 20:20:40 +0000397N *+extra_search* |'hlsearch'| and |'incsearch'| options.
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100398- *+farsi* Removed: |farsi| language
Bram Moolenaar7dd54322022-08-26 18:01:12 +0100399T *+file_in_path* |gf|, |CTRL-W_f| and |<cfile>| Always enabled since
400 9.0.265
Bram Moolenaar071d4272004-06-13 20:20:40 +0000401N *+find_in_path* include file searches: |[I|, |:isearch|,
402 |CTRL-W_CTRL-I|, |:checkpath|, etc.
403N *+folding* |folding|
404 *+footer* |gui-footer|
405 *+fork* Unix only: |fork| shell commands
Bram Moolenaar73e28dc2022-09-17 21:08:33 +0100406T *+float* Floating point support Always enabled since 9.0.0491
Bram Moolenaar071d4272004-06-13 20:20:40 +0000407N *+gettext* message translations |multi-lang|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100408- *+GUI_Athena* Unix only: Athena |GUI|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000409 *+GUI_neXtaw* Unix only: neXtaw |GUI|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000410 *+GUI_GTK* Unix only: GTK+ |GUI|
411 *+GUI_Motif* Unix only: Motif |GUI|
412 *+GUI_Photon* QNX only: Photon |GUI|
413m *+hangul_input* Hangul input support |hangul|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000414 *+iconv* Compiled with the |iconv()| function
415 *+iconv/dyn* Likewise |iconv-dynamic| |/dyn|
Bram Moolenaar06fe74a2019-08-31 16:20:32 +0200416T *+insert_expand* |insert_expand| Insert mode completion
Bram Moolenaarbfe13cc2020-04-12 17:53:12 +0200417m *+ipv6* Support for IPv6 networking |channel|
Bram Moolenaar38a55632016-02-15 22:07:32 +0100418m *+job* starting and stopping jobs |job|
Bram Moolenaar739f13a2021-12-13 13:12:53 +0000419T *+jumplist* |jumplist|; Always enabled since 8.2.3795
Martin Tournoij25f3a142022-10-08 19:26:41 +0100420H *+keymap* |'keymap'|
Bram Moolenaarbc8801c2016-08-02 21:04:33 +0200421N *+lambda* |lambda| and |closure|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100422H *+langmap* |'langmap'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000423N *+libcall* |libcall()|
424N *+linebreak* |'linebreak'|, |'breakat'| and |'showbreak'|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100425T *+lispindent* |'lisp'|
Bram Moolenaar0c72fe42018-03-29 16:04:08 +0200426T *+listcmds* Vim commands for the list of buffers |buffer-hidden|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000427 and argument list |:argdelete|
Bram Moolenaar088e8e32019-08-08 22:15:18 +0200428T *+localmap* Support for mappings local to a buffer |:map-local|
Bram Moolenaar0ba04292010-07-14 23:23:17 +0200429m *+lua* |Lua| interface
430m *+lua/dyn* |Lua| interface |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000431N *+menu* |:menu|
432N *+mksession* |:mksession|
Bram Moolenaar30e9b3c2019-09-07 16:24:12 +0200433T *+modify_fname* |filename-modifiers|
Bram Moolenaar96f45c02019-10-26 19:53:45 +0200434T *+mouse* Mouse handling |mouse-using|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000435N *+mouseshape* |'mouseshape'|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100436N *+mouse_dec* Unix only: Dec terminal mouse handling |dec-mouse|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437N *+mouse_gpm* Unix only: Linux console mouse handling |gpm-mouse|
Bram Moolenaar8a3b8052022-06-26 12:21:15 +0100438m *+mouse_gpm/dyn* Same as |+mouse_gpm| with optional library dependency
439 |/dyn|
Bram Moolenaar13600302014-05-22 18:26:40 +0200440N *+mouse_jsbterm* JSB mouse handling |jsbterm-mouse|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100441N *+mouse_netterm* Unix only: netterm mouse handling |netterm-mouse|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100442N *+mouse_pterm* QNX only: pterm mouse handling |qnx-terminal|
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000443N *+mouse_sysmouse* Unix only: *BSD console mouse handling |sysmouse|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100444N *+mouse_sgr* Unix only: sgr mouse handling |sgr-mouse|
445N *+mouse_urxvt* Unix only: urxvt mouse handling |urxvt-mouse|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100446N *+mouse_xterm* Unix only: xterm mouse handling |xterm-mouse|
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100447T *+multi_byte* Unicode support, 16 and 32 bit characters |multibyte|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000448 *+multi_byte_ime* Win32 input method for multibyte chars |multibyte-ime|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100449N *+multi_lang* non-English language support |multi-lang|
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000450m *+mzscheme* Mzscheme interface |mzscheme|
Bram Moolenaar4770d092006-01-12 23:22:24 +0000451m *+mzscheme/dyn* Mzscheme interface |mzscheme-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000452m *+netbeans_intg* |netbeans|
Bram Moolenaar47003982021-12-05 21:54:04 +0000453T *+num64* 64-bit Number support |Number|
Bram Moolenaara2baa732022-02-04 16:09:54 +0000454 Always enabled since 8.2.0271, use v:numbersize to
Bram Moolenaarf9706e92020-02-22 14:27:04 +0100455 check the actual size of a Number.
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100456m *+ole* Win32 GUI only: |ole-interface|
Bram Moolenaar91c49372016-05-08 09:50:29 +0200457N *+packages* Loading |packages|
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +0100458T *+path_extra* Up/downwards search in 'path' and 'tags' Always
459 enabled since 9.0.0270
Bram Moolenaara5792f52005-11-23 21:25:05 +0000460m *+perl* Perl interface |perl|
461m *+perl/dyn* Perl interface |perl-dynamic| |/dyn|
Bram Moolenaar7fc0c062010-08-10 21:43:35 +0200462N *+persistent_undo* Persistent undo |undo-persistence|
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100463N *+popupwin* Popup windows |popup-window|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100464 *+postscript* |:hardcopy| writes a PostScript file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000465N *+printer* |:hardcopy| command
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000466H *+profile* |:profile| command
Bram Moolenaar60aad972010-07-21 20:36:22 +0200467m *+python* Python 2 interface |python|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100468m *+python/dyn* Python 2 interface |python-dynamic| |/dyn|
Bram Moolenaar60aad972010-07-21 20:36:22 +0200469m *+python3* Python 3 interface |python|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100470m *+python3/dyn* Python 3 interface |python-dynamic| |/dyn|
Yee Cheng Chinc13b3d12023-08-20 21:18:38 +0200471m *+python3/dyn-stable*
h_east59858792023-10-25 22:47:05 +0900472 Python 3 interface |python-dynamic| |python-stable|
473 |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000474N *+quickfix* |:make| and |quickfix| commands
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000475N *+reltime* |reltime()| function, 'hlsearch'/'incsearch' timeout,
476 'redrawtime' option
Martin Tournoij25f3a142022-10-08 19:26:41 +0100477H *+rightleft* Right to left typing |'rightleft'|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000478m *+ruby* Ruby interface |ruby|
479m *+ruby/dyn* Ruby interface |ruby-dynamic| |/dyn|
Bram Moolenaar98ef2332018-03-18 14:44:37 +0100480T *+scrollbind* |'scrollbind'|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100481N *+signs* |:sign|
482T *+smartindent* |'smartindent'|
483H *+sodium* compiled with libsodium for better encryption support
484H *+sound* |sound_playevent()|, |sound_playfile()| functions, etc.
Bram Moolenaar12ee7ff2019-06-10 22:47:40 +0200485N *+spell* spell checking support, see |spell|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100486N *+startuptime* |--startuptime| argument
487N *+statusline* Options 'statusline', 'rulerformat' and special
Bram Moolenaar071d4272004-06-13 20:20:40 +0000488 formats of 'titlestring' and 'iconstring'
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100489- *+sun_workshop* Removed: |workshop|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000490N *+syntax* Syntax highlighting |syntax|
491 *+system()* Unix only: opposite of |+fork|
Bram Moolenaar64d8e252016-09-06 22:12:34 +0200492T *+tag_binary* binary searching in tags file |tag-binary-search|
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100493- *+tag_old_static* Removed; method for static tags |tag-old-static|
494- *+tag_any_white* Removed; was to allow any white space in tags files
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100495m *+tcl* Tcl interface |tcl|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000496m *+tcl/dyn* Tcl interface |tcl-dynamic| |/dyn|
Bram Moolenaar1ccd8ff2017-08-11 19:50:37 +0200497m *+terminal* Support for terminal window |terminal|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000498 *+terminfo* uses |terminfo| instead of termcap
499N *+termresponse* support for |t_RV| and |v:termresponse|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100500N *+termguicolors* 24-bit color in xterm-compatible terminals support
Bram Moolenaar88774872022-08-16 20:24:29 +0100501T *+textobjects* |text-objects| selection. Always enabled since 9.0.0222.
Bram Moolenaar9d87a372018-12-18 21:41:50 +0100502N *+textprop* |text-properties|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000503 *+tgetent* non-Unix only: able to use external termcap
Bram Moolenaare18c0b32016-03-20 21:08:34 +0100504N *+timers* the |timer_start()| function
Bram Moolenaar47003982021-12-05 21:54:04 +0000505T *+title* Setting the window 'title' and 'icon'; Always enabled
Bram Moolenaar071d4272004-06-13 20:20:40 +0000506N *+toolbar* |gui-toolbar|
Bram Moolenaarac9fb182019-04-27 13:04:13 +0200507T *+user_commands* User-defined commands. |user-commands|
508 Always enabled since 8.1.1210.
Martin Tournoij25f3a142022-10-08 19:26:41 +0100509H *+vartabs* Variable-width tabstops. |'vartabstop'|
Bram Moolenaar47003982021-12-05 21:54:04 +0000510T *+vertsplit* Vertically split windows |:vsplit|; Always enabled
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200511 since 8.0.1118.
Bram Moolenaara6feb162022-01-02 12:06:33 +0000512T *+vim9script* |Vim9| script
513N *+viminfo* |'viminfo'|
Bram Moolenaar47003982021-12-05 21:54:04 +0000514T *+virtualedit* |'virtualedit'| Always enabled since 8.1.826.
Bram Moolenaar870ba5f2019-01-11 14:37:20 +0100515T *+visual* Visual mode |Visual-mode| Always enabled since 7.4.200.
516T *+visualextra* extra Visual mode commands |blockwise-operators|
Bram Moolenaar1f0bfe52018-07-29 16:09:22 +0200517T *+vreplace* |gR| and |gr|
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +0100518 *+vtp* on MS-Windows console: support for 'termguicolors'
Bram Moolenaar074fbd42022-08-26 16:41:14 +0100519T *+wildignore* |'wildignore'| Always enabled since 9.0.0278
Bram Moolenaarf1dcd142022-12-31 15:30:45 +0000520T *+wildmenu* |'wildmenu'| Always enabled since 9.0.0279
Bram Moolenaar870ba5f2019-01-11 14:37:20 +0100521T *+windows* more than one window; Always enabled since 8.0.1118.
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100522m *+writebackup* |'writebackup'| is default on
523m *+xim* X input method |xim|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000524 *+xfontset* X fontset support |xfontset|
Christian Brabandte085dfd2023-09-30 12:49:18 +0200525N *+xattr* compiled with extended attribute support (Linux only)
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200526 *+xpm* pixmap support
Bram Moolenaar9b451252012-08-15 17:43:31 +0200527m *+xpm_w32* Win32 GUI only: pixmap support |w32-xpm-support|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000528 *+xsmp* XSMP (X session management) support
529 *+xsmp_interact* interactive XSMP (X session management) support
530N *+xterm_clipboard* Unix only: xterm clipboard handling
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100531m *+xterm_save* save and restore xterm screen |xterm-screens|
532N *+X11* Unix only: can restore window title |X11|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000533
534 */dyn* *E370* *E448*
535 To some of the features "/dyn" is added when the
536 feature is only available when the related library can
537 be dynamically loaded.
538
539:ve[rsion] {nr} Is now ignored. This was previously used to check the
540 version number of a .vimrc file. It was removed,
541 because you can now use the ":if" command for
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200542 version-dependent behavior.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543
544 *:redi* *:redir*
545:redi[r][!] > {file} Redirect messages to file {file}. The messages which
546 are the output of commands are written to that file,
547 until redirection ends. The messages are also still
548 shown on the screen. When [!] is included, an
549 existing file is overwritten. When [!] is omitted,
550 and {file} exists, this command fails.
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200551
Bram Moolenaar071d4272004-06-13 20:20:40 +0000552 Only one ":redir" can be active at a time. Calls to
553 ":redir" will close any active redirection before
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200554 starting redirection to the new target. For recursive
555 use check out |execute()|.
556
Bram Moolenaar071d4272004-06-13 20:20:40 +0000557 To stop the messages and commands from being echoed to
558 the screen, put the commands in a function and call it
559 with ":silent call Function()".
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000560 An alternative is to use the 'verbosefile' option,
561 this can be used in combination with ":redir".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562
563:redi[r] >> {file} Redirect messages to file {file}. Append if {file}
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200564 already exists.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000566:redi[r] @{a-zA-Z}
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +0000567:redi[r] @{a-zA-Z}> Redirect messages to register {a-z}. Append to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000568 contents of the register if its name is given
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000569 uppercase {A-Z}. The ">" after the register name is
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200570 optional.
571:redi[r] @{a-z}>> Append messages to register {a-z}.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100573:redi[r] @*>
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000574:redi[r] @+> Redirect messages to the selection or clipboard. For
575 backward compatibility, the ">" after the register
576 name can be omitted. See |quotestar| and |quoteplus|.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100577:redi[r] @*>>
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000578:redi[r] @+>> Append messages to the selection or clipboard.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000579
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +0000580:redi[r] @"> Redirect messages to the unnamed register. For
581 backward compatibility, the ">" after the register
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200582 name can be omitted.
583:redi[r] @">> Append messages to the unnamed register.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000584 *E1092*
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000585:redi[r] => {var} Redirect messages to a variable.
586 In legacy script: If the variable doesn't exist, then
587 it is created. If the variable exists, then it is
588 initialized to an empty string. After the redirection
589 starts, if the variable is removed or locked or the
590 variable type is changed, then further command output
Bram Moolenaare1dc76f2022-06-25 18:01:32 +0100591 messages will cause errors. When using a local
592 variable (l:var in a function or s:var in a script)
593 and another `:redir` causes the current one to end,
594 the scope might be different and the assignment fails.
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000595 In Vim9 script: the variable must have been declared
596 as a string.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000597 The variable will remain empty until redirection ends.
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000598 Only string variables can be used.
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200599 To get the output of one command the |execute()|
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +0200600 function can be used instead of redirection.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000601
602:redi[r] =>> {var} Append messages to an existing variable. Only string
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200603 variables can be used.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000604 *E1185*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200605:redi[r] END End redirecting messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000606
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200607 *:filt* *:filter*
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000608:filt[er][!] {pattern} {command}
609:filt[er][!] /{pattern}/ {command}
Bram Moolenaar214641f2017-03-05 17:04:09 +0100610 Restrict the output of {command} to lines matching
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000611 with {pattern}. For example, to list only xml files: >
Bram Moolenaar818078d2016-08-27 21:58:42 +0200612 :filter /\.xml$/ oldfiles
Bram Moolenaar214641f2017-03-05 17:04:09 +0100613< If the [!] is given, restrict the output of {command}
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000614 to lines that do NOT match {pattern}.
Bram Moolenaar214641f2017-03-05 17:04:09 +0100615
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000616 {pattern} is a Vim search pattern. Instead of enclosing
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200617 it in / any non-ID character (see |'isident'|) can be
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000618 used, so long as it does not appear in {pattern}.
619 Without the enclosing character the pattern cannot
620 include the bar character. 'ignorecase' is not used.
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200621
622 The pattern is matched against the relevant part of
623 the output, not necessarily the whole line. Only some
624 commands support filtering, try it out to check if it
Bram Moolenaarf86db782018-10-25 13:31:37 +0200625 works. Some of the commands that support filtering:
Bram Moolenaarad6dc492019-04-27 22:40:08 +0200626 |:#| - filter whole line
627 |:clist| - filter by file name or module name
628 |:command| - filter by command name
629 |:files| - filter by file name
630 |:highlight| - filter by highlight group
Christian Brabandt42a5b5a2024-05-24 07:39:34 +0200631 |:history| - filter by history commands
Bram Moolenaarad6dc492019-04-27 22:40:08 +0200632 |:jumps| - filter by file name
633 |:let| - filter by variable name
634 |:list| - filter whole line
635 |:llist| - filter by file name or module name
636 |:marks| - filter by text in the current file,
637 or file name for other files
638 |:oldfiles| - filter by file name
Bram Moolenaar8fc42962019-10-26 17:33:13 +0200639 |:registers| - filter by register contents
640 (does not work multi-line)
Bram Moolenaar0e6adf82021-12-16 14:41:10 +0000641 |:set| - filter by option name
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200642
643 Only normal messages are filtered, error messages are
644 not.
645
Bram Moolenaare0fa3742016-02-20 15:47:01 +0100646 *:sil* *:silent* *:silent!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000647:sil[ent][!] {command} Execute {command} silently. Normal messages will not
648 be given or added to the message history.
649 When [!] is added, error messages will also be
650 skipped, and commands and mappings will not be aborted
651 when an error is detected. |v:errmsg| is still set.
652 When [!] is not used, an error message will cause
653 further messages to be displayed normally.
654 Redirection, started with |:redir|, will continue as
655 usual, although there might be small differences.
656 This will allow redirecting the output of a command
657 without seeing it on the screen. Example: >
658 :redir >/tmp/foobar
659 :silent g/Aap/p
660 :redir END
661< To execute a Normal mode command silently, use the
662 |:normal| command. For example, to search for a
663 string without messages: >
664 :silent exe "normal /path\<CR>"
665< ":silent!" is useful to execute a command that may
666 fail, but the failure is to be ignored. Example: >
667 :let v:errmsg = ""
668 :silent! /^begin
669 :if v:errmsg != ""
670 : ... pattern was not found
671< ":silent" will also avoid the hit-enter prompt. When
672 using this for an external command, this may cause the
673 screen to be messed up. Use |CTRL-L| to clean it up
674 then.
675 ":silent menu ..." defines a menu that will not echo a
676 Command-line command. The command will still produce
677 messages though. Use ":silent" in the command itself
678 to avoid that: ":silent menu .... :silent command".
679
Bram Moolenaar8e258a42009-07-09 13:55:43 +0000680 *:uns* *:unsilent*
681:uns[ilent] {command} Execute {command} not silently. Only makes a
682 difference when |:silent| was used to get to this
683 command.
684 Use this for giving a message even when |:silent| was
685 used. In this example |:silent| is used to avoid the
686 message about reading the file and |:unsilent| to be
687 able to list the first line of each file. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000688 :silent argdo unsilent echo expand('%') .. ": " .. getline(1)
Bram Moolenaar8e258a42009-07-09 13:55:43 +0000689<
690
Bram Moolenaar071d4272004-06-13 20:20:40 +0000691 *:verb* *:verbose*
692:[count]verb[ose] {command}
693 Execute {command} with 'verbose' set to [count]. If
Bram Moolenaared203462004-06-16 11:19:22 +0000694 [count] is omitted one is used. ":0verbose" can be
695 used to set 'verbose' to zero.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000696 The additional use of ":silent" makes messages
697 generated but not displayed.
698 The combination of ":silent" and ":verbose" can be
699 used to generate messages and check them with
700 |v:statusmsg| and friends. For example: >
701 :let v:statusmsg = ""
702 :silent verbose runtime foobar.vim
703 :if v:statusmsg != ""
704 : " foobar.vim could not be found
705 :endif
706< When concatenating another command, the ":verbose"
707 only applies to the first one: >
708 :4verbose set verbose | set verbose
709< verbose=4 ~
710 verbose=0 ~
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000711 For logging verbose messages in a file use the
712 'verbosefile' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713
Bram Moolenaar8aff23a2005-08-19 20:40:30 +0000714 *:verbose-cmd*
715When 'verbose' is non-zero, listing the value of a Vim option or a key map or
Bram Moolenaare344bea2005-09-01 20:46:49 +0000716an abbreviation or a user-defined function or a command or a highlight group
717or an autocommand will also display where it was last defined. If it was
718defined manually then there will be no "Last set" message. When it was
719defined while executing a function, user command or autocommand, the script in
720which it was defined is reported.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200721{not available when compiled without the |+eval| feature}
Bram Moolenaar8aff23a2005-08-19 20:40:30 +0000722
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 *K*
724K Run a program to lookup the keyword under the
725 cursor. The name of the program is given with the
726 'keywordprg' (kp) option (default is "man"). The
727 keyword is formed of letters, numbers and the
728 characters in 'iskeyword'. The keyword under or
729 right of the cursor is used. The same can be done
730 with the command >
731 :!{program} {keyword}
732< There is an example of a program to use in the tools
Bram Moolenaar214641f2017-03-05 17:04:09 +0100733 directory of Vim. It is called "ref" and does a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000734 simple spelling check.
735 Special cases:
Bram Moolenaar26852122016-05-24 20:02:38 +0200736 - If 'keywordprg' begins with ":" it is invoked as
737 a Vim Ex command with [count].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738 - If 'keywordprg' is empty, the ":help" command is
739 used. It's a good idea to include more characters
740 in 'iskeyword' then, to be able to find more help.
Bram Moolenaar26852122016-05-24 20:02:38 +0200741 - When 'keywordprg' is equal to "man" or starts with
742 ":", a [count] before "K" is inserted after
743 keywordprg and before the keyword. For example,
744 using "2K" while the cursor is on "mkdir", results
745 in: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746 !man 2 mkdir
747< - When 'keywordprg' is equal to "man -s", a count
748 before "K" is inserted after the "-s". If there is
749 no count, the "-s" is removed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750
751 *v_K*
752{Visual}K Like "K", but use the visually highlighted text for
753 the keyword. Only works when the highlighted text is
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200754 not more than one line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000755
756[N]gs *gs* *:sl* *:sleep*
Bram Moolenaare2edc2e2021-01-16 20:21:23 +0100757:[N]sl[eep] [N][m] Do nothing for [N] seconds. When [m] is included,
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000758 sleep for [N] milliseconds. The count for "gs" always
Bram Moolenaar071d4272004-06-13 20:20:40 +0000759 uses seconds. The default is one second. >
760 :sleep "sleep for one second
761 :5sleep "sleep for five seconds
Bram Moolenaare2edc2e2021-01-16 20:21:23 +0100762 :sleep 100m "sleep for 100 milliseconds
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763 10gs "sleep for ten seconds
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100764< Can be interrupted with CTRL-C (CTRL-Break on
765 MS-Windows). "gs" stands for "goto sleep".
Bram Moolenaar677ee682005-01-27 14:41:15 +0000766 While sleeping the cursor is positioned in the text,
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200767 if at a visible position.
Bram Moolenaar15146672011-10-20 22:22:38 +0200768 Also process the received netbeans messages. {only
769 available when compiled with the |+netbeans_intg|
770 feature}
771
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100772 *:sl!* *:sleep!*
Bram Moolenaar2346a632021-06-13 19:02:49 +0200773:[N]sl[eep]! [N][m] Same as above, but hide the cursor.
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100774
Bram Moolenaard4aa83a2019-05-09 18:59:31 +0200775 *:xrestore* *:xr*
776:xr[estore] [display] Reinitializes the connection to the X11 server. Useful
777 after the X server restarts, e.g. when running Vim for
778 long time inside screen/tmux and connecting from
Bram Moolenaar68e65602019-05-26 21:33:31 +0200779 different machines.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100780 [display] should be in the format of the $DISPLAY
Bram Moolenaard4aa83a2019-05-09 18:59:31 +0200781 environment variable (e.g. "localhost:10.0")
782 If [display] is omitted, then it reinitializes the
783 connection to the X11 server using the same value as
784 was used for the previous execution of this command.
785 If the value was never specified, then it uses the
786 value of $DISPLAY environment variable as it was when
787 Vim was started.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100788 {only available when compiled with the |+clipboard|
Bram Moolenaard4aa83a2019-05-09 18:59:31 +0200789 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790
791 *g_CTRL-A*
792g CTRL-A Only when Vim was compiled with MEM_PROFILING defined
793 (which is very rare): print memory usage statistics.
794 Only useful for debugging Vim.
Bram Moolenaar345efa02016-01-15 20:57:49 +0100795 For incrementing in Visual mode see |v_g_CTRL-A|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796
797==============================================================================
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +02007982. Using Vim like less or more *less*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000799
800If you use the less or more program to view a file, you don't get syntax
801highlighting. Thus you would like to use Vim instead. You can do this by
802using the shell script "$VIMRUNTIME/macros/less.sh".
803
804This shell script uses the Vim script "$VIMRUNTIME/macros/less.vim". It sets
805up mappings to simulate the commands that less supports. Otherwise, you can
806still use the Vim commands.
807
808This isn't perfect. For example, when viewing a short file Vim will still use
Bram Moolenaar7ff78462020-07-10 22:00:53 +0200809the whole screen. But it works well enough for most uses, and you get syntax
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810highlighting.
811
812The "h" key will give you a short overview of the available commands.
813
Bram Moolenaare392eb42015-11-19 20:38:09 +0100814If you want to set options differently when using less, define the
815LessInitFunc in your vimrc, for example: >
816
817 func LessInitFunc()
818 set nocursorcolumn nocursorline
819 endfunc
820<
821
Bram Moolenaard2855f52018-07-31 22:23:58 +0200822 vim:tw=78:ts=8:noet:ft=help:norl: