blob: b68c336f3fd9669bc12a62534eb84d56d3111b5e [file] [log] [blame]
D. Ben Knoble187df692025-04-21 10:19:51 +02001*various.txt* For Vim version 9.1. Last change: 2025 Apr 21
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]
D. Ben Knoble187df692025-04-21 10:19:51 +0200101 Print [range] lines (default current line). Can also
102 be spelled `:[range]|` due to Vi compatibility (see
103 |:bar|). Gives an error in an empty buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000104 Note: If you are looking for a way to print your text
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000105 on paper see |:hardcopy|. In the GUI you can use the
106 File.Print menu entry.
107 See |ex-flags| for [flags].
Bram Moolenaar818078d2016-08-27 21:58:42 +0200108 The |:filter| command can be used to only show lines
109 matching a pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000110
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000111:[range]p[rint] {count} [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000112 Print {count} lines, starting with [range] (default
113 current line |cmdline-ranges|).
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000114 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000115
116 *:P* *:Print*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000117:[range]P[rint] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000118 Just as ":print". Was apparently added to Vi for
119 people that keep the shift key pressed too long...
Bram Moolenaar1588bc82022-03-08 21:35:07 +0000120 This command is not supported in |Vim9| script.
Bram Moolenaar166af9b2010-11-16 20:34:40 +0100121 Note: A user command can overrule this command.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000122 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000123
124 *:l* *:list*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000125:[range]l[ist] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000126 Same as :print, but display unprintable characters
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +0200127 with '^' and put $ after the line. This can be
Bram Moolenaard58e9292011-02-09 17:07:58 +0100128 further changed with the 'listchars' option.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000129 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130
131 *:nu* *:number*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000132:[range]nu[mber] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000133 Same as :print, but precede each line with its line
Bram Moolenaarfaa959a2006-02-20 21:37:40 +0000134 number. (See also 'highlight' and 'numberwidth'
135 option).
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000136 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000137
138 *:#*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000139:[range]# [count] [flags]
140 synonym for :number.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000141
Christian Brabandtf4bc59c2024-06-15 15:52:53 +0200142 *:#!* *vim-shebang*
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000143:#!{anything} Ignored, so that you can start a Vim script with: >
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000144 #!vim -S
Christian Brabandtca471142024-06-17 13:06:34 +0200145 let mylogbook='$HOME/logbook.md'
146 exe $':e {mylogbook}'
147 $
148 put ='## ' .. strftime('%d. %b %Y')
149 norm! o
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000150<
Christian Brabandtca471142024-06-17 13:06:34 +0200151 Make that script executable and run it to create a
152 new diary entry.
153
Bram Moolenaar071d4272004-06-13 20:20:40 +0000154 *:z* *E144*
Bram Moolenaar4466ad62020-11-21 13:16:30 +0100155:[range]z[+-^.=][count] Display several lines of text surrounding the line
156 specified with [range], or around the current line
157 if there is no [range].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000158
Bram Moolenaar4466ad62020-11-21 13:16:30 +0100159 If there is a [count], that's how many lines you'll
160 see; if there is no [count] and only one window then
161 twice the value of the 'scroll' option is used,
162 otherwise the current window height minus 3 is used.
163 This is the value of "scr" in the table below.
164
165 If there is a [count] the 'window' option is set to
Bram Moolenaarb6b046b2011-12-30 13:11:27 +0100166 its value.
167
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168 :z can be used either alone or followed by any of
Bram Moolenaar207f0092020-08-30 17:20:20 +0200169 several marks. These have the following effect:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000170
Bram Moolenaar662db672011-03-22 14:05:35 +0100171 mark first line last line new cursor line ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000172 ---- ---------- --------- ------------
173 + current line 1 scr forward 1 scr forward
174 - 1 scr back current line current line
175 ^ 2 scr back 1 scr back 1 scr back
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +0000176 . 1/2 scr back 1/2 scr fwd 1/2 scr fwd
177 = 1/2 scr back 1/2 scr fwd current line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178
179 Specifying no mark at all is the same as "+".
180 If the mark is "=", a line of dashes is printed
181 around the current line.
182
Bram Moolenaar6c391a72021-09-09 21:55:11 +0200183 *:z!*
Dominique Pelle7f2dd1e2021-09-04 13:44:01 +0200184:[range]z![+-^.=][count]
Bram Moolenaar22863042021-10-16 15:23:36 +0100185 Like ":z", but when [count] is not specified, it
Dominique Pelle7f2dd1e2021-09-04 13:44:01 +0200186 defaults to the Vim window height minus one.
187
188:[range]z[!]#[+-^.=][count] *:z#*
189 Like ":z" or ":z!", but number the lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000190
191 *:=*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000192:= [flags] Print the last line number.
193 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000194
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000195:{range}= [flags] Prints the last line number in {range}. For example,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196 this prints the current line number: >
197 :.=
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000198< See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000199
200:norm[al][!] {commands} *:norm* *:normal*
201 Execute Normal mode commands {commands}. This makes
202 it possible to execute Normal mode commands typed on
Bram Moolenaar4a748032010-09-30 21:47:56 +0200203 the command-line. {commands} are executed like they
204 are typed. For undo all commands are undone together.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000205 Execution stops when an error is encountered.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100206
Bram Moolenaar071d4272004-06-13 20:20:40 +0000207 If the [!] is given, mappings will not be used.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100208 Without it, when this command is called from a
209 non-remappable mapping (|:noremap|), the argument can
210 be mapped anyway.
211
Bram Moolenaar071d4272004-06-13 20:20:40 +0000212 {commands} should be a complete command. If
213 {commands} does not finish a command, the last one
214 will be aborted as if <Esc> or <C-C> was typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215 This implies that an insert command must be completed
216 (to start Insert mode, see |:startinsert|). A ":"
Bram Moolenaar7c626922005-02-07 22:01:03 +0000217 command must be completed as well. And you can't use
218 "Q" or "gQ" to start Ex mode.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100219
220 The display is not updated while ":normal" is busy.
221
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100222 {commands} cannot start with a space. Put a count of
223 1 (one) before it, "1 " is one space.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100224
Bram Moolenaar071d4272004-06-13 20:20:40 +0000225 The 'insertmode' option is ignored for {commands}.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100226
Bram Moolenaar071d4272004-06-13 20:20:40 +0000227 This command cannot be followed by another command,
228 since any '|' is considered part of the command.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100229
Bram Moolenaar071d4272004-06-13 20:20:40 +0000230 This command can be used recursively, but the depth is
231 limited by 'maxmapdepth'.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100232
Bram Moolenaar071d4272004-06-13 20:20:40 +0000233 An alternative is to use |:execute|, which uses an
234 expression as argument. This allows the use of
Bram Moolenaar46f9d492010-06-12 20:18:19 +0200235 printable characters to represent special characters.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100236
Bram Moolenaar46f9d492010-06-12 20:18:19 +0200237 Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000238 :exe "normal \<c-w>\<c-w>"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000239
240:{range}norm[al][!] {commands} *:normal-range*
241 Execute Normal mode commands {commands} for each line
242 in the {range}. Before executing the {commands}, the
243 cursor is positioned in the first column of the range,
244 for each line. Otherwise it's the same as the
245 ":normal" command without a range.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246
247 *:sh* *:shell* *E371*
248:sh[ell] This command starts a shell. When the shell exits
249 (after the "exit" command) you return to Vim. The
250 name for the shell command comes from 'shell' option.
251 *E360*
252 Note: This doesn't work when Vim on the Amiga was
253 started in QuickFix mode from a compiler, because the
254 compiler will have set stdin to a non-interactive
255 mode.
256
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000257 *:!cmd* *:!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000258:!{cmd} Execute {cmd} with the shell. See also the 'shell'
Christian Brabandtf18987c2024-11-12 21:38:22 +0100259 and 'shelltype' option. For the filter command, see
260 |:range!|.
matveyta01148d2024-11-23 14:19:58 +0100261
262 Vim builds command line using options 'shell', 'shcf',
263 'sxq' and 'shq' in the following order:
264 `&sh &shcf &sxq &shq {cmd} &shq &sxq`
265 So setting both 'sxq' and 'shq' is possible but rarely
266 useful. Additional escaping inside `{cmd}` may also
267 be due to 'sxe' option.
268
269 Also, all |cmdline-special| characters in {cmd} are
270 replaced by Vim before passing them to shell.
271
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000272 *E34*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000273 Any '!' in {cmd} is replaced with the previous
274 external command (see also 'cpoptions'). But not when
275 there is a backslash before the '!', then that
276 backslash is removed. Example: ":!ls" followed by
277 ":!echo ! \! \\!" executes "echo ls ! \!".
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200278
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000279 A '|' in {cmd} is passed to the shell, you cannot use
280 it to append a Vim command. See |:bar|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200281
282 If {cmd} contains "%" it is expanded to the current
Bram Moolenaaracc22402020-06-07 21:07:18 +0200283 file name, "#" is expanded to the alternate file name.
284 Special characters in the file name are not escaped,
285 use quotes to avoid their special meaning: >
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200286 :!ls "%"
Bram Moolenaaracc22402020-06-07 21:07:18 +0200287< If the file name contains a "$" then single quotes
288 might work better, but this only works if the file
289 name does not contain a single quote: >
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200290 :!ls '%'
291< This should always work, but it's more typing: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000292 :exe "!ls " .. shellescape(expand("%"))
Bram Moolenaaracc22402020-06-07 21:07:18 +0200293< To get a literal "%" or "#" prepend it with a
294 backslash. For example, to list all files starting
295 with "%": >
296 :!ls \%*
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200297<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000298 A newline character ends {cmd}, what follows is
299 interpreted as a following ":" command. However, if
300 there is a backslash before the newline it is removed
301 and {cmd} continues. It doesn't matter how many
302 backslashes are before the newline, only one is
303 removed.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200304
Bram Moolenaar071d4272004-06-13 20:20:40 +0000305 On Unix the command normally runs in a non-interactive
306 shell. If you want an interactive shell to be used
307 (to use aliases) set 'shellcmdflag' to "-ic".
308 For Win32 also see |:!start|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200309
Bram Moolenaare968e362014-05-13 20:23:24 +0200310 After the command has been executed, the timestamp and
311 size of the current file is checked |timestamp|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200312
Bram Moolenaar071d4272004-06-13 20:20:40 +0000313 Vim redraws the screen after the command is finished,
314 because it may have printed any text. This requires a
315 hit-enter prompt, so that you can read any messages.
316 To avoid this use: >
317 :silent !{cmd}
318< The screen is not redrawn then, thus you have to use
319 CTRL-L or ":redraw!" if the command did display
Bram Moolenaar76db9e02022-11-09 21:21:04 +0000320 something. However, this depends on what the |t_ti|
321 and |t_te| termcap entries are set to.
matveyta01148d2024-11-23 14:19:58 +0100322
323 Hint: use |:terminal| command if you want to run {cmd}
324 in Vim window. `:term ++shell ++close {cmd}` could
325 serve as close approximation to what `:!{cmd}` does.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326
327 *:!!*
328:!! Repeat last ":!{cmd}".
329
Bram Moolenaar61da1bf2019-06-06 12:14:49 +0200330 *:ve* *:ver* *:version*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000331:ve[rsion] Print the version number of the editor. If the
332 compiler used understands "__DATE__" the compilation
333 date is mentioned. Otherwise a fixed release-date is
334 shown.
335 The following lines contain information about which
336 features were enabled when Vim was compiled. When
337 there is a preceding '+', the feature is included,
338 when there is a '-' it is excluded. To change this,
339 you have to edit feature.h and recompile Vim.
340 To check for this in an expression, see |has()|.
341 Here is an overview of the features.
342 The first column shows the smallest version in which
343 they are included:
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100344 T tiny (always)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345 N normal
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346 H huge
347 m manually enabled or depends on other features
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100348 - never, feature was removed
Bram Moolenaar071d4272004-06-13 20:20:40 +0000349 (none) system dependent
350 Thus if a feature is marked with "N", it is included
RestorerZac9c6d52023-10-05 22:25:12 +0200351 in the normal and huge versions of Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000352
353 *+feature-list*
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200354 *+acl* |ACL| support included
Bram Moolenaar071d4272004-06-13 20:20:40 +0000355 *+ARP* Amiga only: ARP support included
Martin Tournoij25f3a142022-10-08 19:26:41 +0100356H *+arabic* |Arabic| language support
357N *+autochdir* support 'autochdir' option
Bram Moolenaarfd999452022-08-24 18:30:14 +0100358T *+autocmd* |:autocmd|, automatic commands. Always enabled since
359 8.0.1564
Bram Moolenaare42a6d22017-11-12 19:21:51 +0100360H *+autoservername* Automatically enable |clientserver|
Bram Moolenaara2a80162017-11-21 23:09:50 +0100361m *+balloon_eval* |balloon-eval| support in the GUI. Included when
362 compiling with supported GUI (Motif, GTK, GUI) and
363 either Netbeans/Sun Workshop integration or |+eval|
364 feature.
365H *+balloon_eval_term* |balloon-eval| support in the terminal,
366 'balloonevalterm'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367N *+browse* |:browse| command
Bram Moolenaar2ee347f2022-08-26 17:53:44 +0100368T *++builtin_terms* maximal terminals builtin |builtin-terms| Always
369 enabled since 9.0.0280
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370N *+byte_offset* support for 'o' flag in 'statusline' option, "go"
371 and ":goto" commands.
Bram Moolenaar298b4402016-01-28 22:38:53 +0100372m *+channel* inter process communication |channel|
Martin Tournoij7904fa42022-10-04 16:28:45 +0100373T *+cindent* |'cindent'|, C indenting; Always enabled
Bram Moolenaar071d4272004-06-13 20:20:40 +0000374N *+clientserver* Unix and Win32: Remote invocation |clientserver|
Bram Moolenaar56c860c2019-08-17 20:09:31 +0200375 *+clipboard* |clipboard| support compiled-in
376 *+clipboard_working* |clipboard| support compiled-in and working
Bram Moolenaar06fe74a2019-08-31 16:20:32 +0200377T *+cmdline_compl* command line completion |cmdline-completion|
Bram Moolenaar85388672021-01-31 17:03:52 +0100378T *+cmdline_hist* command line history |cmdline-history|
Martin Tournoijba43e762022-10-13 22:12:15 +0100379T *+cmdline_info* |'showcmd'| and |'ruler'|; Always enabled since
380 9.0.0747
Martin Tournoij7904fa42022-10-04 16:28:45 +0100381T *+cmdwin* |cmdline-window| support; Always enabled since 9.0.0657
Bram Moolenaar8c96af92019-09-28 19:05:57 +0200382T *+comments* |'comments'| support
Martin Tournoij25f3a142022-10-08 19:26:41 +0100383N *+conceal* "conceal" support, see |conceal| |:syn-conceal| etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000384N *+cryptv* encryption support |encryption|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100385H *+cscope* |cscope| support
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100386T *+cursorbind* |'cursorbind'| support
Bram Moolenaarac6e65f2005-08-29 22:25:38 +0000387m *+cursorshape* |termcap-cursor-shape| support
388m *+debug* Compiled for debugging.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000389N *+dialog_gui* Support for |:confirm| with GUI dialog.
390N *+dialog_con* Support for |:confirm| with console dialog.
391N *+dialog_con_gui* Support for |:confirm| with GUI and console dialog.
392N *+diff* |vimdiff| and 'diff'
393N *+digraphs* |digraphs| *E196*
Bram Moolenaar43cb6262018-03-14 21:39:02 +0100394 *+directx* Win32 GUI only: DirectX and |'renderoptions'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000395 *+dnd* Support for DnD into the "~ register |quote_~|.
Martin Tournoij25f3a142022-10-08 19:26:41 +0100396H *+emacs_tags* |emacs-tags| files
Bram Moolenaar071d4272004-06-13 20:20:40 +0000397N *+eval* expression evaluation |eval.txt|
Bram Moolenaar47003982021-12-05 21:54:04 +0000398T *+ex_extra* always on now, used to be for Vim's extra Ex commands
Bram Moolenaar071d4272004-06-13 20:20:40 +0000399N *+extra_search* |'hlsearch'| and |'incsearch'| options.
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100400- *+farsi* Removed: |farsi| language
Bram Moolenaar7dd54322022-08-26 18:01:12 +0100401T *+file_in_path* |gf|, |CTRL-W_f| and |<cfile>| Always enabled since
402 9.0.265
Bram Moolenaar071d4272004-06-13 20:20:40 +0000403N *+find_in_path* include file searches: |[I|, |:isearch|,
404 |CTRL-W_CTRL-I|, |:checkpath|, etc.
405N *+folding* |folding|
406 *+footer* |gui-footer|
407 *+fork* Unix only: |fork| shell commands
Bram Moolenaar73e28dc2022-09-17 21:08:33 +0100408T *+float* Floating point support Always enabled since 9.0.0491
Bram Moolenaar071d4272004-06-13 20:20:40 +0000409N *+gettext* message translations |multi-lang|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100410- *+GUI_Athena* Unix only: Athena |GUI|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000411 *+GUI_neXtaw* Unix only: neXtaw |GUI|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000412 *+GUI_GTK* Unix only: GTK+ |GUI|
413 *+GUI_Motif* Unix only: Motif |GUI|
414 *+GUI_Photon* QNX only: Photon |GUI|
415m *+hangul_input* Hangul input support |hangul|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000416 *+iconv* Compiled with the |iconv()| function
417 *+iconv/dyn* Likewise |iconv-dynamic| |/dyn|
Bram Moolenaar06fe74a2019-08-31 16:20:32 +0200418T *+insert_expand* |insert_expand| Insert mode completion
Bram Moolenaarbfe13cc2020-04-12 17:53:12 +0200419m *+ipv6* Support for IPv6 networking |channel|
Bram Moolenaar38a55632016-02-15 22:07:32 +0100420m *+job* starting and stopping jobs |job|
Bram Moolenaar739f13a2021-12-13 13:12:53 +0000421T *+jumplist* |jumplist|; Always enabled since 8.2.3795
Martin Tournoij25f3a142022-10-08 19:26:41 +0100422H *+keymap* |'keymap'|
Bram Moolenaarbc8801c2016-08-02 21:04:33 +0200423N *+lambda* |lambda| and |closure|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100424H *+langmap* |'langmap'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000425N *+libcall* |libcall()|
426N *+linebreak* |'linebreak'|, |'breakat'| and |'showbreak'|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100427T *+lispindent* |'lisp'|
Bram Moolenaar0c72fe42018-03-29 16:04:08 +0200428T *+listcmds* Vim commands for the list of buffers |buffer-hidden|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000429 and argument list |:argdelete|
Bram Moolenaar088e8e32019-08-08 22:15:18 +0200430T *+localmap* Support for mappings local to a buffer |:map-local|
Bram Moolenaar0ba04292010-07-14 23:23:17 +0200431m *+lua* |Lua| interface
432m *+lua/dyn* |Lua| interface |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000433N *+menu* |:menu|
434N *+mksession* |:mksession|
Bram Moolenaar30e9b3c2019-09-07 16:24:12 +0200435T *+modify_fname* |filename-modifiers|
Bram Moolenaar96f45c02019-10-26 19:53:45 +0200436T *+mouse* Mouse handling |mouse-using|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437N *+mouseshape* |'mouseshape'|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100438N *+mouse_dec* Unix only: Dec terminal mouse handling |dec-mouse|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000439N *+mouse_gpm* Unix only: Linux console mouse handling |gpm-mouse|
Bram Moolenaar8a3b8052022-06-26 12:21:15 +0100440m *+mouse_gpm/dyn* Same as |+mouse_gpm| with optional library dependency
441 |/dyn|
Bram Moolenaar13600302014-05-22 18:26:40 +0200442N *+mouse_jsbterm* JSB mouse handling |jsbterm-mouse|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100443N *+mouse_netterm* Unix only: netterm mouse handling |netterm-mouse|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100444N *+mouse_pterm* QNX only: pterm mouse handling |qnx-terminal|
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000445N *+mouse_sysmouse* Unix only: *BSD console mouse handling |sysmouse|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100446N *+mouse_sgr* Unix only: sgr mouse handling |sgr-mouse|
447N *+mouse_urxvt* Unix only: urxvt mouse handling |urxvt-mouse|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100448N *+mouse_xterm* Unix only: xterm mouse handling |xterm-mouse|
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100449T *+multi_byte* Unicode support, 16 and 32 bit characters |multibyte|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000450 *+multi_byte_ime* Win32 input method for multibyte chars |multibyte-ime|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100451N *+multi_lang* non-English language support |multi-lang|
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000452m *+mzscheme* Mzscheme interface |mzscheme|
Bram Moolenaar4770d092006-01-12 23:22:24 +0000453m *+mzscheme/dyn* Mzscheme interface |mzscheme-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000454m *+netbeans_intg* |netbeans|
Bram Moolenaar47003982021-12-05 21:54:04 +0000455T *+num64* 64-bit Number support |Number|
Bram Moolenaara2baa732022-02-04 16:09:54 +0000456 Always enabled since 8.2.0271, use v:numbersize to
Bram Moolenaarf9706e92020-02-22 14:27:04 +0100457 check the actual size of a Number.
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100458m *+ole* Win32 GUI only: |ole-interface|
Bram Moolenaar91c49372016-05-08 09:50:29 +0200459N *+packages* Loading |packages|
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +0100460T *+path_extra* Up/downwards search in 'path' and 'tags' Always
461 enabled since 9.0.0270
Bram Moolenaara5792f52005-11-23 21:25:05 +0000462m *+perl* Perl interface |perl|
463m *+perl/dyn* Perl interface |perl-dynamic| |/dyn|
Bram Moolenaar7fc0c062010-08-10 21:43:35 +0200464N *+persistent_undo* Persistent undo |undo-persistence|
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100465N *+popupwin* Popup windows |popup-window|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100466 *+postscript* |:hardcopy| writes a PostScript file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000467N *+printer* |:hardcopy| command
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000468H *+profile* |:profile| command
Bram Moolenaar60aad972010-07-21 20:36:22 +0200469m *+python* Python 2 interface |python|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100470m *+python/dyn* Python 2 interface |python-dynamic| |/dyn|
Bram Moolenaar60aad972010-07-21 20:36:22 +0200471m *+python3* Python 3 interface |python|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100472m *+python3/dyn* Python 3 interface |python-dynamic| |/dyn|
Yee Cheng Chinc13b3d12023-08-20 21:18:38 +0200473m *+python3/dyn-stable*
h_east59858792023-10-25 22:47:05 +0900474 Python 3 interface |python-dynamic| |python-stable|
475 |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476N *+quickfix* |:make| and |quickfix| commands
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000477N *+reltime* |reltime()| function, 'hlsearch'/'incsearch' timeout,
478 'redrawtime' option
Martin Tournoij25f3a142022-10-08 19:26:41 +0100479H *+rightleft* Right to left typing |'rightleft'|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000480m *+ruby* Ruby interface |ruby|
481m *+ruby/dyn* Ruby interface |ruby-dynamic| |/dyn|
Bram Moolenaar98ef2332018-03-18 14:44:37 +0100482T *+scrollbind* |'scrollbind'|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100483N *+signs* |:sign|
484T *+smartindent* |'smartindent'|
485H *+sodium* compiled with libsodium for better encryption support
486H *+sound* |sound_playevent()|, |sound_playfile()| functions, etc.
Bram Moolenaar12ee7ff2019-06-10 22:47:40 +0200487N *+spell* spell checking support, see |spell|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100488N *+startuptime* |--startuptime| argument
489N *+statusline* Options 'statusline', 'rulerformat' and special
Bram Moolenaar071d4272004-06-13 20:20:40 +0000490 formats of 'titlestring' and 'iconstring'
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100491- *+sun_workshop* Removed: |workshop|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000492N *+syntax* Syntax highlighting |syntax|
493 *+system()* Unix only: opposite of |+fork|
Bram Moolenaar64d8e252016-09-06 22:12:34 +0200494T *+tag_binary* binary searching in tags file |tag-binary-search|
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100495- *+tag_old_static* Removed; method for static tags |tag-old-static|
496- *+tag_any_white* Removed; was to allow any white space in tags files
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100497m *+tcl* Tcl interface |tcl|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000498m *+tcl/dyn* Tcl interface |tcl-dynamic| |/dyn|
Bram Moolenaar1ccd8ff2017-08-11 19:50:37 +0200499m *+terminal* Support for terminal window |terminal|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500 *+terminfo* uses |terminfo| instead of termcap
501N *+termresponse* support for |t_RV| and |v:termresponse|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100502N *+termguicolors* 24-bit color in xterm-compatible terminals support
Bram Moolenaar88774872022-08-16 20:24:29 +0100503T *+textobjects* |text-objects| selection. Always enabled since 9.0.0222.
Bram Moolenaar9d87a372018-12-18 21:41:50 +0100504N *+textprop* |text-properties|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000505 *+tgetent* non-Unix only: able to use external termcap
Bram Moolenaare18c0b32016-03-20 21:08:34 +0100506N *+timers* the |timer_start()| function
Bram Moolenaar47003982021-12-05 21:54:04 +0000507T *+title* Setting the window 'title' and 'icon'; Always enabled
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508N *+toolbar* |gui-toolbar|
Bram Moolenaarac9fb182019-04-27 13:04:13 +0200509T *+user_commands* User-defined commands. |user-commands|
510 Always enabled since 8.1.1210.
Martin Tournoij25f3a142022-10-08 19:26:41 +0100511H *+vartabs* Variable-width tabstops. |'vartabstop'|
Bram Moolenaar47003982021-12-05 21:54:04 +0000512T *+vertsplit* Vertically split windows |:vsplit|; Always enabled
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200513 since 8.0.1118.
Bram Moolenaara6feb162022-01-02 12:06:33 +0000514T *+vim9script* |Vim9| script
515N *+viminfo* |'viminfo'|
Bram Moolenaar47003982021-12-05 21:54:04 +0000516T *+virtualedit* |'virtualedit'| Always enabled since 8.1.826.
Bram Moolenaar870ba5f2019-01-11 14:37:20 +0100517T *+visual* Visual mode |Visual-mode| Always enabled since 7.4.200.
518T *+visualextra* extra Visual mode commands |blockwise-operators|
Bram Moolenaar1f0bfe52018-07-29 16:09:22 +0200519T *+vreplace* |gR| and |gr|
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +0100520 *+vtp* on MS-Windows console: support for 'termguicolors'
Bram Moolenaar074fbd42022-08-26 16:41:14 +0100521T *+wildignore* |'wildignore'| Always enabled since 9.0.0278
Bram Moolenaarf1dcd142022-12-31 15:30:45 +0000522T *+wildmenu* |'wildmenu'| Always enabled since 9.0.0279
Bram Moolenaar870ba5f2019-01-11 14:37:20 +0100523T *+windows* more than one window; Always enabled since 8.0.1118.
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100524m *+writebackup* |'writebackup'| is default on
525m *+xim* X input method |xim|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526 *+xfontset* X fontset support |xfontset|
Christian Brabandte085dfd2023-09-30 12:49:18 +0200527N *+xattr* compiled with extended attribute support (Linux only)
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200528 *+xpm* pixmap support
Bram Moolenaar9b451252012-08-15 17:43:31 +0200529m *+xpm_w32* Win32 GUI only: pixmap support |w32-xpm-support|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000530 *+xsmp* XSMP (X session management) support
531 *+xsmp_interact* interactive XSMP (X session management) support
532N *+xterm_clipboard* Unix only: xterm clipboard handling
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100533m *+xterm_save* save and restore xterm screen |xterm-screens|
534N *+X11* Unix only: can restore window title |X11|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000535
536 */dyn* *E370* *E448*
537 To some of the features "/dyn" is added when the
538 feature is only available when the related library can
539 be dynamically loaded.
540
541:ve[rsion] {nr} Is now ignored. This was previously used to check the
542 version number of a .vimrc file. It was removed,
543 because you can now use the ":if" command for
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200544 version-dependent behavior.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000545
546 *:redi* *:redir*
547:redi[r][!] > {file} Redirect messages to file {file}. The messages which
548 are the output of commands are written to that file,
549 until redirection ends. The messages are also still
550 shown on the screen. When [!] is included, an
551 existing file is overwritten. When [!] is omitted,
552 and {file} exists, this command fails.
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200553
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554 Only one ":redir" can be active at a time. Calls to
555 ":redir" will close any active redirection before
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200556 starting redirection to the new target. For recursive
557 use check out |execute()|.
558
Bram Moolenaar071d4272004-06-13 20:20:40 +0000559 To stop the messages and commands from being echoed to
560 the screen, put the commands in a function and call it
561 with ":silent call Function()".
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000562 An alternative is to use the 'verbosefile' option,
563 this can be used in combination with ":redir".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564
565:redi[r] >> {file} Redirect messages to file {file}. Append if {file}
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200566 already exists.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000568:redi[r] @{a-zA-Z}
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +0000569:redi[r] @{a-zA-Z}> Redirect messages to register {a-z}. Append to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000570 contents of the register if its name is given
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000571 uppercase {A-Z}. The ">" after the register name is
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200572 optional.
573:redi[r] @{a-z}>> Append messages to register {a-z}.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000574
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100575:redi[r] @*>
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000576:redi[r] @+> Redirect messages to the selection or clipboard. For
577 backward compatibility, the ">" after the register
578 name can be omitted. See |quotestar| and |quoteplus|.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100579:redi[r] @*>>
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000580:redi[r] @+>> Append messages to the selection or clipboard.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000581
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +0000582:redi[r] @"> Redirect messages to the unnamed register. For
583 backward compatibility, the ">" after the register
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200584 name can be omitted.
585:redi[r] @">> Append messages to the unnamed register.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000586 *E1092*
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000587:redi[r] => {var} Redirect messages to a variable.
588 In legacy script: If the variable doesn't exist, then
589 it is created. If the variable exists, then it is
590 initialized to an empty string. After the redirection
591 starts, if the variable is removed or locked or the
592 variable type is changed, then further command output
Bram Moolenaare1dc76f2022-06-25 18:01:32 +0100593 messages will cause errors. When using a local
594 variable (l:var in a function or s:var in a script)
595 and another `:redir` causes the current one to end,
596 the scope might be different and the assignment fails.
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000597 In Vim9 script: the variable must have been declared
598 as a string.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000599 The variable will remain empty until redirection ends.
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000600 Only string variables can be used.
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200601 To get the output of one command the |execute()|
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +0200602 function can be used instead of redirection.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000603
604:redi[r] =>> {var} Append messages to an existing variable. Only string
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200605 variables can be used.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000606 *E1185*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200607:redi[r] END End redirecting messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000608
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200609 *:filt* *:filter*
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000610:filt[er][!] {pattern} {command}
611:filt[er][!] /{pattern}/ {command}
Bram Moolenaar214641f2017-03-05 17:04:09 +0100612 Restrict the output of {command} to lines matching
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000613 with {pattern}. For example, to list only xml files: >
Bram Moolenaar818078d2016-08-27 21:58:42 +0200614 :filter /\.xml$/ oldfiles
Bram Moolenaar214641f2017-03-05 17:04:09 +0100615< If the [!] is given, restrict the output of {command}
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000616 to lines that do NOT match {pattern}.
Bram Moolenaar214641f2017-03-05 17:04:09 +0100617
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000618 {pattern} is a Vim search pattern. Instead of enclosing
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200619 it in / any non-ID character (see |'isident'|) can be
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000620 used, so long as it does not appear in {pattern}.
621 Without the enclosing character the pattern cannot
622 include the bar character. 'ignorecase' is not used.
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200623
624 The pattern is matched against the relevant part of
625 the output, not necessarily the whole line. Only some
626 commands support filtering, try it out to check if it
Bram Moolenaarf86db782018-10-25 13:31:37 +0200627 works. Some of the commands that support filtering:
Bram Moolenaarad6dc492019-04-27 22:40:08 +0200628 |:#| - filter whole line
629 |:clist| - filter by file name or module name
630 |:command| - filter by command name
631 |:files| - filter by file name
632 |:highlight| - filter by highlight group
Christian Brabandt42a5b5a2024-05-24 07:39:34 +0200633 |:history| - filter by history commands
Bram Moolenaarad6dc492019-04-27 22:40:08 +0200634 |:jumps| - filter by file name
635 |:let| - filter by variable name
636 |:list| - filter whole line
637 |:llist| - filter by file name or module name
638 |:marks| - filter by text in the current file,
639 or file name for other files
640 |:oldfiles| - filter by file name
Bram Moolenaar8fc42962019-10-26 17:33:13 +0200641 |:registers| - filter by register contents
642 (does not work multi-line)
Bram Moolenaar0e6adf82021-12-16 14:41:10 +0000643 |:set| - filter by option name
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200644
645 Only normal messages are filtered, error messages are
646 not.
647
Bram Moolenaare0fa3742016-02-20 15:47:01 +0100648 *:sil* *:silent* *:silent!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649:sil[ent][!] {command} Execute {command} silently. Normal messages will not
650 be given or added to the message history.
651 When [!] is added, error messages will also be
652 skipped, and commands and mappings will not be aborted
653 when an error is detected. |v:errmsg| is still set.
654 When [!] is not used, an error message will cause
655 further messages to be displayed normally.
656 Redirection, started with |:redir|, will continue as
657 usual, although there might be small differences.
658 This will allow redirecting the output of a command
659 without seeing it on the screen. Example: >
660 :redir >/tmp/foobar
661 :silent g/Aap/p
662 :redir END
663< To execute a Normal mode command silently, use the
664 |:normal| command. For example, to search for a
665 string without messages: >
666 :silent exe "normal /path\<CR>"
667< ":silent!" is useful to execute a command that may
668 fail, but the failure is to be ignored. Example: >
669 :let v:errmsg = ""
670 :silent! /^begin
671 :if v:errmsg != ""
672 : ... pattern was not found
673< ":silent" will also avoid the hit-enter prompt. When
674 using this for an external command, this may cause the
675 screen to be messed up. Use |CTRL-L| to clean it up
676 then.
677 ":silent menu ..." defines a menu that will not echo a
678 Command-line command. The command will still produce
679 messages though. Use ":silent" in the command itself
680 to avoid that: ":silent menu .... :silent command".
681
Bram Moolenaar8e258a42009-07-09 13:55:43 +0000682 *:uns* *:unsilent*
683:uns[ilent] {command} Execute {command} not silently. Only makes a
684 difference when |:silent| was used to get to this
685 command.
686 Use this for giving a message even when |:silent| was
687 used. In this example |:silent| is used to avoid the
688 message about reading the file and |:unsilent| to be
689 able to list the first line of each file. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000690 :silent argdo unsilent echo expand('%') .. ": " .. getline(1)
Bram Moolenaar8e258a42009-07-09 13:55:43 +0000691<
692
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693 *:verb* *:verbose*
694:[count]verb[ose] {command}
695 Execute {command} with 'verbose' set to [count]. If
Bram Moolenaared203462004-06-16 11:19:22 +0000696 [count] is omitted one is used. ":0verbose" can be
697 used to set 'verbose' to zero.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698 The additional use of ":silent" makes messages
699 generated but not displayed.
700 The combination of ":silent" and ":verbose" can be
701 used to generate messages and check them with
702 |v:statusmsg| and friends. For example: >
703 :let v:statusmsg = ""
704 :silent verbose runtime foobar.vim
705 :if v:statusmsg != ""
706 : " foobar.vim could not be found
707 :endif
708< When concatenating another command, the ":verbose"
709 only applies to the first one: >
710 :4verbose set verbose | set verbose
711< verbose=4 ~
712 verbose=0 ~
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000713 For logging verbose messages in a file use the
714 'verbosefile' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000715
Bram Moolenaar8aff23a2005-08-19 20:40:30 +0000716 *:verbose-cmd*
717When 'verbose' is non-zero, listing the value of a Vim option or a key map or
Bram Moolenaare344bea2005-09-01 20:46:49 +0000718an abbreviation or a user-defined function or a command or a highlight group
719or an autocommand will also display where it was last defined. If it was
720defined manually then there will be no "Last set" message. When it was
721defined while executing a function, user command or autocommand, the script in
722which it was defined is reported.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200723{not available when compiled without the |+eval| feature}
Bram Moolenaar8aff23a2005-08-19 20:40:30 +0000724
Bram Moolenaar071d4272004-06-13 20:20:40 +0000725 *K*
726K Run a program to lookup the keyword under the
727 cursor. The name of the program is given with the
728 'keywordprg' (kp) option (default is "man"). The
729 keyword is formed of letters, numbers and the
730 characters in 'iskeyword'. The keyword under or
731 right of the cursor is used. The same can be done
732 with the command >
733 :!{program} {keyword}
734< There is an example of a program to use in the tools
Bram Moolenaar214641f2017-03-05 17:04:09 +0100735 directory of Vim. It is called "ref" and does a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000736 simple spelling check.
737 Special cases:
Bram Moolenaar26852122016-05-24 20:02:38 +0200738 - If 'keywordprg' begins with ":" it is invoked as
739 a Vim Ex command with [count].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000740 - If 'keywordprg' is empty, the ":help" command is
741 used. It's a good idea to include more characters
742 in 'iskeyword' then, to be able to find more help.
Bram Moolenaar26852122016-05-24 20:02:38 +0200743 - When 'keywordprg' is equal to "man" or starts with
744 ":", a [count] before "K" is inserted after
745 keywordprg and before the keyword. For example,
746 using "2K" while the cursor is on "mkdir", results
747 in: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748 !man 2 mkdir
749< - When 'keywordprg' is equal to "man -s", a count
750 before "K" is inserted after the "-s". If there is
751 no count, the "-s" is removed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752
753 *v_K*
754{Visual}K Like "K", but use the visually highlighted text for
755 the keyword. Only works when the highlighted text is
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200756 not more than one line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757
758[N]gs *gs* *:sl* *:sleep*
Bram Moolenaare2edc2e2021-01-16 20:21:23 +0100759:[N]sl[eep] [N][m] Do nothing for [N] seconds. When [m] is included,
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000760 sleep for [N] milliseconds. The count for "gs" always
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761 uses seconds. The default is one second. >
762 :sleep "sleep for one second
763 :5sleep "sleep for five seconds
Bram Moolenaare2edc2e2021-01-16 20:21:23 +0100764 :sleep 100m "sleep for 100 milliseconds
Bram Moolenaar071d4272004-06-13 20:20:40 +0000765 10gs "sleep for ten seconds
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100766< Can be interrupted with CTRL-C (CTRL-Break on
767 MS-Windows). "gs" stands for "goto sleep".
Bram Moolenaar677ee682005-01-27 14:41:15 +0000768 While sleeping the cursor is positioned in the text,
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200769 if at a visible position.
Yee Cheng Chine70587d2025-02-13 20:55:45 +0100770 Queued messages and timers (|+timers|) are processed
771 during the sleep as well.
Bram Moolenaar15146672011-10-20 22:22:38 +0200772
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100773 *:sl!* *:sleep!*
Bram Moolenaar2346a632021-06-13 19:02:49 +0200774:[N]sl[eep]! [N][m] Same as above, but hide the cursor.
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100775
Bram Moolenaard4aa83a2019-05-09 18:59:31 +0200776 *:xrestore* *:xr*
777:xr[estore] [display] Reinitializes the connection to the X11 server. Useful
778 after the X server restarts, e.g. when running Vim for
779 long time inside screen/tmux and connecting from
Bram Moolenaar68e65602019-05-26 21:33:31 +0200780 different machines.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100781 [display] should be in the format of the $DISPLAY
Bram Moolenaard4aa83a2019-05-09 18:59:31 +0200782 environment variable (e.g. "localhost:10.0")
783 If [display] is omitted, then it reinitializes the
784 connection to the X11 server using the same value as
785 was used for the previous execution of this command.
786 If the value was never specified, then it uses the
787 value of $DISPLAY environment variable as it was when
788 Vim was started.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100789 {only available when compiled with the |+clipboard|
Bram Moolenaard4aa83a2019-05-09 18:59:31 +0200790 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791
792 *g_CTRL-A*
793g CTRL-A Only when Vim was compiled with MEM_PROFILING defined
794 (which is very rare): print memory usage statistics.
795 Only useful for debugging Vim.
Bram Moolenaar345efa02016-01-15 20:57:49 +0100796 For incrementing in Visual mode see |v_g_CTRL-A|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797
798==============================================================================
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +02007992. Using Vim like less or more *less*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000800
801If you use the less or more program to view a file, you don't get syntax
802highlighting. Thus you would like to use Vim instead. You can do this by
803using the shell script "$VIMRUNTIME/macros/less.sh".
804
805This shell script uses the Vim script "$VIMRUNTIME/macros/less.vim". It sets
806up mappings to simulate the commands that less supports. Otherwise, you can
807still use the Vim commands.
808
809This isn't perfect. For example, when viewing a short file Vim will still use
Bram Moolenaar7ff78462020-07-10 22:00:53 +0200810the whole screen. But it works well enough for most uses, and you get syntax
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811highlighting.
812
813The "h" key will give you a short overview of the available commands.
814
Bram Moolenaare392eb42015-11-19 20:38:09 +0100815If you want to set options differently when using less, define the
816LessInitFunc in your vimrc, for example: >
817
818 func LessInitFunc()
819 set nocursorcolumn nocursorline
820 endfunc
821<
822
Bram Moolenaard2855f52018-07-31 22:23:58 +0200823 vim:tw=78:ts=8:noet:ft=help:norl: