blob: 4c267941d76eb7b804e5ea88fa06379e884eebe6 [file] [log] [blame]
Milly89872f52024-10-05 17:16:18 +02001*various.txt* For Vim version 9.1. Last change: 2024 Oct 05
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'
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +0100257 and 'shelltype' option.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000258 *E34*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000259 Any '!' in {cmd} is replaced with the previous
260 external command (see also 'cpoptions'). But not when
261 there is a backslash before the '!', then that
262 backslash is removed. Example: ":!ls" followed by
263 ":!echo ! \! \\!" executes "echo ls ! \!".
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200264
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000265 A '|' in {cmd} is passed to the shell, you cannot use
266 it to append a Vim command. See |:bar|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200267
268 If {cmd} contains "%" it is expanded to the current
Bram Moolenaaracc22402020-06-07 21:07:18 +0200269 file name, "#" is expanded to the alternate file name.
270 Special characters in the file name are not escaped,
271 use quotes to avoid their special meaning: >
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200272 :!ls "%"
Bram Moolenaaracc22402020-06-07 21:07:18 +0200273< If the file name contains a "$" then single quotes
274 might work better, but this only works if the file
275 name does not contain a single quote: >
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200276 :!ls '%'
277< This should always work, but it's more typing: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000278 :exe "!ls " .. shellescape(expand("%"))
Bram Moolenaaracc22402020-06-07 21:07:18 +0200279< To get a literal "%" or "#" prepend it with a
280 backslash. For example, to list all files starting
281 with "%": >
282 :!ls \%*
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200283<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000284 A newline character ends {cmd}, what follows is
285 interpreted as a following ":" command. However, if
286 there is a backslash before the newline it is removed
287 and {cmd} continues. It doesn't matter how many
288 backslashes are before the newline, only one is
289 removed.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200290
Bram Moolenaar071d4272004-06-13 20:20:40 +0000291 On Unix the command normally runs in a non-interactive
292 shell. If you want an interactive shell to be used
293 (to use aliases) set 'shellcmdflag' to "-ic".
294 For Win32 also see |:!start|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200295
Bram Moolenaare968e362014-05-13 20:23:24 +0200296 After the command has been executed, the timestamp and
297 size of the current file is checked |timestamp|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200298
Bram Moolenaar071d4272004-06-13 20:20:40 +0000299 Vim redraws the screen after the command is finished,
300 because it may have printed any text. This requires a
301 hit-enter prompt, so that you can read any messages.
302 To avoid this use: >
303 :silent !{cmd}
304< The screen is not redrawn then, thus you have to use
305 CTRL-L or ":redraw!" if the command did display
Bram Moolenaar76db9e02022-11-09 21:21:04 +0000306 something. However, this depends on what the |t_ti|
307 and |t_te| termcap entries are set to.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308 Also see |shell-window|.
309
310 *:!!*
311:!! Repeat last ":!{cmd}".
312
Bram Moolenaar61da1bf2019-06-06 12:14:49 +0200313 *:ve* *:ver* *:version*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000314:ve[rsion] Print the version number of the editor. If the
315 compiler used understands "__DATE__" the compilation
316 date is mentioned. Otherwise a fixed release-date is
317 shown.
318 The following lines contain information about which
319 features were enabled when Vim was compiled. When
320 there is a preceding '+', the feature is included,
321 when there is a '-' it is excluded. To change this,
322 you have to edit feature.h and recompile Vim.
323 To check for this in an expression, see |has()|.
324 Here is an overview of the features.
325 The first column shows the smallest version in which
326 they are included:
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100327 T tiny (always)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000328 N normal
Bram Moolenaar071d4272004-06-13 20:20:40 +0000329 H huge
330 m manually enabled or depends on other features
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100331 - never, feature was removed
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332 (none) system dependent
333 Thus if a feature is marked with "N", it is included
RestorerZac9c6d52023-10-05 22:25:12 +0200334 in the normal and huge versions of Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000335
336 *+feature-list*
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200337 *+acl* |ACL| support included
Bram Moolenaar071d4272004-06-13 20:20:40 +0000338 *+ARP* Amiga only: ARP support included
Martin Tournoij25f3a142022-10-08 19:26:41 +0100339H *+arabic* |Arabic| language support
340N *+autochdir* support 'autochdir' option
Bram Moolenaarfd999452022-08-24 18:30:14 +0100341T *+autocmd* |:autocmd|, automatic commands. Always enabled since
342 8.0.1564
Bram Moolenaare42a6d22017-11-12 19:21:51 +0100343H *+autoservername* Automatically enable |clientserver|
Bram Moolenaara2a80162017-11-21 23:09:50 +0100344m *+balloon_eval* |balloon-eval| support in the GUI. Included when
345 compiling with supported GUI (Motif, GTK, GUI) and
346 either Netbeans/Sun Workshop integration or |+eval|
347 feature.
348H *+balloon_eval_term* |balloon-eval| support in the terminal,
349 'balloonevalterm'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350N *+browse* |:browse| command
Bram Moolenaar2ee347f2022-08-26 17:53:44 +0100351T *++builtin_terms* maximal terminals builtin |builtin-terms| Always
352 enabled since 9.0.0280
Bram Moolenaar071d4272004-06-13 20:20:40 +0000353N *+byte_offset* support for 'o' flag in 'statusline' option, "go"
354 and ":goto" commands.
Bram Moolenaar298b4402016-01-28 22:38:53 +0100355m *+channel* inter process communication |channel|
Martin Tournoij7904fa42022-10-04 16:28:45 +0100356T *+cindent* |'cindent'|, C indenting; Always enabled
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357N *+clientserver* Unix and Win32: Remote invocation |clientserver|
Bram Moolenaar56c860c2019-08-17 20:09:31 +0200358 *+clipboard* |clipboard| support compiled-in
359 *+clipboard_working* |clipboard| support compiled-in and working
Bram Moolenaar06fe74a2019-08-31 16:20:32 +0200360T *+cmdline_compl* command line completion |cmdline-completion|
Bram Moolenaar85388672021-01-31 17:03:52 +0100361T *+cmdline_hist* command line history |cmdline-history|
Martin Tournoijba43e762022-10-13 22:12:15 +0100362T *+cmdline_info* |'showcmd'| and |'ruler'|; Always enabled since
363 9.0.0747
Martin Tournoij7904fa42022-10-04 16:28:45 +0100364T *+cmdwin* |cmdline-window| support; Always enabled since 9.0.0657
Bram Moolenaar8c96af92019-09-28 19:05:57 +0200365T *+comments* |'comments'| support
Martin Tournoij25f3a142022-10-08 19:26:41 +0100366N *+conceal* "conceal" support, see |conceal| |:syn-conceal| etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367N *+cryptv* encryption support |encryption|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100368H *+cscope* |cscope| support
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100369T *+cursorbind* |'cursorbind'| support
Bram Moolenaarac6e65f2005-08-29 22:25:38 +0000370m *+cursorshape* |termcap-cursor-shape| support
371m *+debug* Compiled for debugging.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000372N *+dialog_gui* Support for |:confirm| with GUI dialog.
373N *+dialog_con* Support for |:confirm| with console dialog.
374N *+dialog_con_gui* Support for |:confirm| with GUI and console dialog.
375N *+diff* |vimdiff| and 'diff'
376N *+digraphs* |digraphs| *E196*
Bram Moolenaar43cb6262018-03-14 21:39:02 +0100377 *+directx* Win32 GUI only: DirectX and |'renderoptions'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000378 *+dnd* Support for DnD into the "~ register |quote_~|.
Martin Tournoij25f3a142022-10-08 19:26:41 +0100379H *+emacs_tags* |emacs-tags| files
Bram Moolenaar071d4272004-06-13 20:20:40 +0000380N *+eval* expression evaluation |eval.txt|
Bram Moolenaar47003982021-12-05 21:54:04 +0000381T *+ex_extra* always on now, used to be for Vim's extra Ex commands
Bram Moolenaar071d4272004-06-13 20:20:40 +0000382N *+extra_search* |'hlsearch'| and |'incsearch'| options.
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100383- *+farsi* Removed: |farsi| language
Bram Moolenaar7dd54322022-08-26 18:01:12 +0100384T *+file_in_path* |gf|, |CTRL-W_f| and |<cfile>| Always enabled since
385 9.0.265
Bram Moolenaar071d4272004-06-13 20:20:40 +0000386N *+find_in_path* include file searches: |[I|, |:isearch|,
387 |CTRL-W_CTRL-I|, |:checkpath|, etc.
388N *+folding* |folding|
389 *+footer* |gui-footer|
390 *+fork* Unix only: |fork| shell commands
Bram Moolenaar73e28dc2022-09-17 21:08:33 +0100391T *+float* Floating point support Always enabled since 9.0.0491
Bram Moolenaar071d4272004-06-13 20:20:40 +0000392N *+gettext* message translations |multi-lang|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100393- *+GUI_Athena* Unix only: Athena |GUI|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000394 *+GUI_neXtaw* Unix only: neXtaw |GUI|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000395 *+GUI_GTK* Unix only: GTK+ |GUI|
396 *+GUI_Motif* Unix only: Motif |GUI|
397 *+GUI_Photon* QNX only: Photon |GUI|
398m *+hangul_input* Hangul input support |hangul|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000399 *+iconv* Compiled with the |iconv()| function
400 *+iconv/dyn* Likewise |iconv-dynamic| |/dyn|
Bram Moolenaar06fe74a2019-08-31 16:20:32 +0200401T *+insert_expand* |insert_expand| Insert mode completion
Bram Moolenaarbfe13cc2020-04-12 17:53:12 +0200402m *+ipv6* Support for IPv6 networking |channel|
Bram Moolenaar38a55632016-02-15 22:07:32 +0100403m *+job* starting and stopping jobs |job|
Bram Moolenaar739f13a2021-12-13 13:12:53 +0000404T *+jumplist* |jumplist|; Always enabled since 8.2.3795
Martin Tournoij25f3a142022-10-08 19:26:41 +0100405H *+keymap* |'keymap'|
Bram Moolenaarbc8801c2016-08-02 21:04:33 +0200406N *+lambda* |lambda| and |closure|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100407H *+langmap* |'langmap'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000408N *+libcall* |libcall()|
409N *+linebreak* |'linebreak'|, |'breakat'| and |'showbreak'|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100410T *+lispindent* |'lisp'|
Bram Moolenaar0c72fe42018-03-29 16:04:08 +0200411T *+listcmds* Vim commands for the list of buffers |buffer-hidden|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000412 and argument list |:argdelete|
Bram Moolenaar088e8e32019-08-08 22:15:18 +0200413T *+localmap* Support for mappings local to a buffer |:map-local|
Bram Moolenaar0ba04292010-07-14 23:23:17 +0200414m *+lua* |Lua| interface
415m *+lua/dyn* |Lua| interface |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416N *+menu* |:menu|
417N *+mksession* |:mksession|
Bram Moolenaar30e9b3c2019-09-07 16:24:12 +0200418T *+modify_fname* |filename-modifiers|
Bram Moolenaar96f45c02019-10-26 19:53:45 +0200419T *+mouse* Mouse handling |mouse-using|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000420N *+mouseshape* |'mouseshape'|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100421N *+mouse_dec* Unix only: Dec terminal mouse handling |dec-mouse|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000422N *+mouse_gpm* Unix only: Linux console mouse handling |gpm-mouse|
Bram Moolenaar8a3b8052022-06-26 12:21:15 +0100423m *+mouse_gpm/dyn* Same as |+mouse_gpm| with optional library dependency
424 |/dyn|
Bram Moolenaar13600302014-05-22 18:26:40 +0200425N *+mouse_jsbterm* JSB mouse handling |jsbterm-mouse|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100426N *+mouse_netterm* Unix only: netterm mouse handling |netterm-mouse|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100427N *+mouse_pterm* QNX only: pterm mouse handling |qnx-terminal|
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000428N *+mouse_sysmouse* Unix only: *BSD console mouse handling |sysmouse|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100429N *+mouse_sgr* Unix only: sgr mouse handling |sgr-mouse|
430N *+mouse_urxvt* Unix only: urxvt mouse handling |urxvt-mouse|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100431N *+mouse_xterm* Unix only: xterm mouse handling |xterm-mouse|
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100432T *+multi_byte* Unicode support, 16 and 32 bit characters |multibyte|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000433 *+multi_byte_ime* Win32 input method for multibyte chars |multibyte-ime|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100434N *+multi_lang* non-English language support |multi-lang|
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000435m *+mzscheme* Mzscheme interface |mzscheme|
Bram Moolenaar4770d092006-01-12 23:22:24 +0000436m *+mzscheme/dyn* Mzscheme interface |mzscheme-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437m *+netbeans_intg* |netbeans|
Bram Moolenaar47003982021-12-05 21:54:04 +0000438T *+num64* 64-bit Number support |Number|
Bram Moolenaara2baa732022-02-04 16:09:54 +0000439 Always enabled since 8.2.0271, use v:numbersize to
Bram Moolenaarf9706e92020-02-22 14:27:04 +0100440 check the actual size of a Number.
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100441m *+ole* Win32 GUI only: |ole-interface|
Bram Moolenaar91c49372016-05-08 09:50:29 +0200442N *+packages* Loading |packages|
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +0100443T *+path_extra* Up/downwards search in 'path' and 'tags' Always
444 enabled since 9.0.0270
Bram Moolenaara5792f52005-11-23 21:25:05 +0000445m *+perl* Perl interface |perl|
446m *+perl/dyn* Perl interface |perl-dynamic| |/dyn|
Bram Moolenaar7fc0c062010-08-10 21:43:35 +0200447N *+persistent_undo* Persistent undo |undo-persistence|
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100448N *+popupwin* Popup windows |popup-window|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100449 *+postscript* |:hardcopy| writes a PostScript file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000450N *+printer* |:hardcopy| command
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000451H *+profile* |:profile| command
Bram Moolenaar60aad972010-07-21 20:36:22 +0200452m *+python* Python 2 interface |python|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100453m *+python/dyn* Python 2 interface |python-dynamic| |/dyn|
Bram Moolenaar60aad972010-07-21 20:36:22 +0200454m *+python3* Python 3 interface |python|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100455m *+python3/dyn* Python 3 interface |python-dynamic| |/dyn|
Yee Cheng Chinc13b3d12023-08-20 21:18:38 +0200456m *+python3/dyn-stable*
h_east59858792023-10-25 22:47:05 +0900457 Python 3 interface |python-dynamic| |python-stable|
458 |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000459N *+quickfix* |:make| and |quickfix| commands
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000460N *+reltime* |reltime()| function, 'hlsearch'/'incsearch' timeout,
461 'redrawtime' option
Martin Tournoij25f3a142022-10-08 19:26:41 +0100462H *+rightleft* Right to left typing |'rightleft'|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000463m *+ruby* Ruby interface |ruby|
464m *+ruby/dyn* Ruby interface |ruby-dynamic| |/dyn|
Bram Moolenaar98ef2332018-03-18 14:44:37 +0100465T *+scrollbind* |'scrollbind'|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100466N *+signs* |:sign|
467T *+smartindent* |'smartindent'|
468H *+sodium* compiled with libsodium for better encryption support
469H *+sound* |sound_playevent()|, |sound_playfile()| functions, etc.
Bram Moolenaar12ee7ff2019-06-10 22:47:40 +0200470N *+spell* spell checking support, see |spell|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100471N *+startuptime* |--startuptime| argument
472N *+statusline* Options 'statusline', 'rulerformat' and special
Bram Moolenaar071d4272004-06-13 20:20:40 +0000473 formats of 'titlestring' and 'iconstring'
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100474- *+sun_workshop* Removed: |workshop|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475N *+syntax* Syntax highlighting |syntax|
476 *+system()* Unix only: opposite of |+fork|
Bram Moolenaar64d8e252016-09-06 22:12:34 +0200477T *+tag_binary* binary searching in tags file |tag-binary-search|
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100478- *+tag_old_static* Removed; method for static tags |tag-old-static|
479- *+tag_any_white* Removed; was to allow any white space in tags files
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100480m *+tcl* Tcl interface |tcl|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000481m *+tcl/dyn* Tcl interface |tcl-dynamic| |/dyn|
Bram Moolenaar1ccd8ff2017-08-11 19:50:37 +0200482m *+terminal* Support for terminal window |terminal|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000483 *+terminfo* uses |terminfo| instead of termcap
484N *+termresponse* support for |t_RV| and |v:termresponse|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100485N *+termguicolors* 24-bit color in xterm-compatible terminals support
Bram Moolenaar88774872022-08-16 20:24:29 +0100486T *+textobjects* |text-objects| selection. Always enabled since 9.0.0222.
Bram Moolenaar9d87a372018-12-18 21:41:50 +0100487N *+textprop* |text-properties|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000488 *+tgetent* non-Unix only: able to use external termcap
Bram Moolenaare18c0b32016-03-20 21:08:34 +0100489N *+timers* the |timer_start()| function
Bram Moolenaar47003982021-12-05 21:54:04 +0000490T *+title* Setting the window 'title' and 'icon'; Always enabled
Bram Moolenaar071d4272004-06-13 20:20:40 +0000491N *+toolbar* |gui-toolbar|
Bram Moolenaarac9fb182019-04-27 13:04:13 +0200492T *+user_commands* User-defined commands. |user-commands|
493 Always enabled since 8.1.1210.
Martin Tournoij25f3a142022-10-08 19:26:41 +0100494H *+vartabs* Variable-width tabstops. |'vartabstop'|
Bram Moolenaar47003982021-12-05 21:54:04 +0000495T *+vertsplit* Vertically split windows |:vsplit|; Always enabled
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200496 since 8.0.1118.
Bram Moolenaara6feb162022-01-02 12:06:33 +0000497T *+vim9script* |Vim9| script
498N *+viminfo* |'viminfo'|
Bram Moolenaar47003982021-12-05 21:54:04 +0000499T *+virtualedit* |'virtualedit'| Always enabled since 8.1.826.
Bram Moolenaar870ba5f2019-01-11 14:37:20 +0100500T *+visual* Visual mode |Visual-mode| Always enabled since 7.4.200.
501T *+visualextra* extra Visual mode commands |blockwise-operators|
Bram Moolenaar1f0bfe52018-07-29 16:09:22 +0200502T *+vreplace* |gR| and |gr|
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +0100503 *+vtp* on MS-Windows console: support for 'termguicolors'
Bram Moolenaar074fbd42022-08-26 16:41:14 +0100504T *+wildignore* |'wildignore'| Always enabled since 9.0.0278
Bram Moolenaarf1dcd142022-12-31 15:30:45 +0000505T *+wildmenu* |'wildmenu'| Always enabled since 9.0.0279
Bram Moolenaar870ba5f2019-01-11 14:37:20 +0100506T *+windows* more than one window; Always enabled since 8.0.1118.
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100507m *+writebackup* |'writebackup'| is default on
508m *+xim* X input method |xim|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000509 *+xfontset* X fontset support |xfontset|
Christian Brabandte085dfd2023-09-30 12:49:18 +0200510N *+xattr* compiled with extended attribute support (Linux only)
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200511 *+xpm* pixmap support
Bram Moolenaar9b451252012-08-15 17:43:31 +0200512m *+xpm_w32* Win32 GUI only: pixmap support |w32-xpm-support|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000513 *+xsmp* XSMP (X session management) support
514 *+xsmp_interact* interactive XSMP (X session management) support
515N *+xterm_clipboard* Unix only: xterm clipboard handling
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100516m *+xterm_save* save and restore xterm screen |xterm-screens|
517N *+X11* Unix only: can restore window title |X11|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000518
519 */dyn* *E370* *E448*
520 To some of the features "/dyn" is added when the
521 feature is only available when the related library can
522 be dynamically loaded.
523
524:ve[rsion] {nr} Is now ignored. This was previously used to check the
525 version number of a .vimrc file. It was removed,
526 because you can now use the ":if" command for
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200527 version-dependent behavior.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000528
529 *:redi* *:redir*
530:redi[r][!] > {file} Redirect messages to file {file}. The messages which
531 are the output of commands are written to that file,
532 until redirection ends. The messages are also still
533 shown on the screen. When [!] is included, an
534 existing file is overwritten. When [!] is omitted,
535 and {file} exists, this command fails.
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200536
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537 Only one ":redir" can be active at a time. Calls to
538 ":redir" will close any active redirection before
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200539 starting redirection to the new target. For recursive
540 use check out |execute()|.
541
Bram Moolenaar071d4272004-06-13 20:20:40 +0000542 To stop the messages and commands from being echoed to
543 the screen, put the commands in a function and call it
544 with ":silent call Function()".
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000545 An alternative is to use the 'verbosefile' option,
546 this can be used in combination with ":redir".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547
548:redi[r] >> {file} Redirect messages to file {file}. Append if {file}
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200549 already exists.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000551:redi[r] @{a-zA-Z}
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +0000552:redi[r] @{a-zA-Z}> Redirect messages to register {a-z}. Append to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553 contents of the register if its name is given
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000554 uppercase {A-Z}. The ">" after the register name is
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200555 optional.
556:redi[r] @{a-z}>> Append messages to register {a-z}.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000557
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100558:redi[r] @*>
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000559:redi[r] @+> Redirect messages to the selection or clipboard. For
560 backward compatibility, the ">" after the register
561 name can be omitted. See |quotestar| and |quoteplus|.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100562:redi[r] @*>>
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000563:redi[r] @+>> Append messages to the selection or clipboard.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +0000565:redi[r] @"> Redirect messages to the unnamed register. For
566 backward compatibility, the ">" after the register
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200567 name can be omitted.
568:redi[r] @">> Append messages to the unnamed register.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000569 *E1092*
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000570:redi[r] => {var} Redirect messages to a variable.
571 In legacy script: If the variable doesn't exist, then
572 it is created. If the variable exists, then it is
573 initialized to an empty string. After the redirection
574 starts, if the variable is removed or locked or the
575 variable type is changed, then further command output
Bram Moolenaare1dc76f2022-06-25 18:01:32 +0100576 messages will cause errors. When using a local
577 variable (l:var in a function or s:var in a script)
578 and another `:redir` causes the current one to end,
579 the scope might be different and the assignment fails.
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000580 In Vim9 script: the variable must have been declared
581 as a string.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000582 The variable will remain empty until redirection ends.
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000583 Only string variables can be used.
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200584 To get the output of one command the |execute()|
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +0200585 function can be used instead of redirection.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000586
587:redi[r] =>> {var} Append messages to an existing variable. Only string
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200588 variables can be used.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000589 *E1185*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200590:redi[r] END End redirecting messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000591
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200592 *:filt* *:filter*
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000593:filt[er][!] {pattern} {command}
594:filt[er][!] /{pattern}/ {command}
Bram Moolenaar214641f2017-03-05 17:04:09 +0100595 Restrict the output of {command} to lines matching
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000596 with {pattern}. For example, to list only xml files: >
Bram Moolenaar818078d2016-08-27 21:58:42 +0200597 :filter /\.xml$/ oldfiles
Bram Moolenaar214641f2017-03-05 17:04:09 +0100598< If the [!] is given, restrict the output of {command}
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000599 to lines that do NOT match {pattern}.
Bram Moolenaar214641f2017-03-05 17:04:09 +0100600
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000601 {pattern} is a Vim search pattern. Instead of enclosing
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200602 it in / any non-ID character (see |'isident'|) can be
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000603 used, so long as it does not appear in {pattern}.
604 Without the enclosing character the pattern cannot
605 include the bar character. 'ignorecase' is not used.
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200606
607 The pattern is matched against the relevant part of
608 the output, not necessarily the whole line. Only some
609 commands support filtering, try it out to check if it
Bram Moolenaarf86db782018-10-25 13:31:37 +0200610 works. Some of the commands that support filtering:
Bram Moolenaarad6dc492019-04-27 22:40:08 +0200611 |:#| - filter whole line
612 |:clist| - filter by file name or module name
613 |:command| - filter by command name
614 |:files| - filter by file name
615 |:highlight| - filter by highlight group
Christian Brabandt42a5b5a2024-05-24 07:39:34 +0200616 |:history| - filter by history commands
Bram Moolenaarad6dc492019-04-27 22:40:08 +0200617 |:jumps| - filter by file name
618 |:let| - filter by variable name
619 |:list| - filter whole line
620 |:llist| - filter by file name or module name
621 |:marks| - filter by text in the current file,
622 or file name for other files
623 |:oldfiles| - filter by file name
Bram Moolenaar8fc42962019-10-26 17:33:13 +0200624 |:registers| - filter by register contents
625 (does not work multi-line)
Bram Moolenaar0e6adf82021-12-16 14:41:10 +0000626 |:set| - filter by option name
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200627
628 Only normal messages are filtered, error messages are
629 not.
630
Bram Moolenaare0fa3742016-02-20 15:47:01 +0100631 *:sil* *:silent* *:silent!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000632:sil[ent][!] {command} Execute {command} silently. Normal messages will not
633 be given or added to the message history.
634 When [!] is added, error messages will also be
635 skipped, and commands and mappings will not be aborted
636 when an error is detected. |v:errmsg| is still set.
637 When [!] is not used, an error message will cause
638 further messages to be displayed normally.
639 Redirection, started with |:redir|, will continue as
640 usual, although there might be small differences.
641 This will allow redirecting the output of a command
642 without seeing it on the screen. Example: >
643 :redir >/tmp/foobar
644 :silent g/Aap/p
645 :redir END
646< To execute a Normal mode command silently, use the
647 |:normal| command. For example, to search for a
648 string without messages: >
649 :silent exe "normal /path\<CR>"
650< ":silent!" is useful to execute a command that may
651 fail, but the failure is to be ignored. Example: >
652 :let v:errmsg = ""
653 :silent! /^begin
654 :if v:errmsg != ""
655 : ... pattern was not found
656< ":silent" will also avoid the hit-enter prompt. When
657 using this for an external command, this may cause the
658 screen to be messed up. Use |CTRL-L| to clean it up
659 then.
660 ":silent menu ..." defines a menu that will not echo a
661 Command-line command. The command will still produce
662 messages though. Use ":silent" in the command itself
663 to avoid that: ":silent menu .... :silent command".
664
Bram Moolenaar8e258a42009-07-09 13:55:43 +0000665 *:uns* *:unsilent*
666:uns[ilent] {command} Execute {command} not silently. Only makes a
667 difference when |:silent| was used to get to this
668 command.
669 Use this for giving a message even when |:silent| was
670 used. In this example |:silent| is used to avoid the
671 message about reading the file and |:unsilent| to be
672 able to list the first line of each file. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000673 :silent argdo unsilent echo expand('%') .. ": " .. getline(1)
Bram Moolenaar8e258a42009-07-09 13:55:43 +0000674<
675
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676 *:verb* *:verbose*
677:[count]verb[ose] {command}
678 Execute {command} with 'verbose' set to [count]. If
Bram Moolenaared203462004-06-16 11:19:22 +0000679 [count] is omitted one is used. ":0verbose" can be
680 used to set 'verbose' to zero.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681 The additional use of ":silent" makes messages
682 generated but not displayed.
683 The combination of ":silent" and ":verbose" can be
684 used to generate messages and check them with
685 |v:statusmsg| and friends. For example: >
686 :let v:statusmsg = ""
687 :silent verbose runtime foobar.vim
688 :if v:statusmsg != ""
689 : " foobar.vim could not be found
690 :endif
691< When concatenating another command, the ":verbose"
692 only applies to the first one: >
693 :4verbose set verbose | set verbose
694< verbose=4 ~
695 verbose=0 ~
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000696 For logging verbose messages in a file use the
697 'verbosefile' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698
Bram Moolenaar8aff23a2005-08-19 20:40:30 +0000699 *:verbose-cmd*
700When 'verbose' is non-zero, listing the value of a Vim option or a key map or
Bram Moolenaare344bea2005-09-01 20:46:49 +0000701an abbreviation or a user-defined function or a command or a highlight group
702or an autocommand will also display where it was last defined. If it was
703defined manually then there will be no "Last set" message. When it was
704defined while executing a function, user command or autocommand, the script in
705which it was defined is reported.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200706{not available when compiled without the |+eval| feature}
Bram Moolenaar8aff23a2005-08-19 20:40:30 +0000707
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708 *K*
709K Run a program to lookup the keyword under the
710 cursor. The name of the program is given with the
711 'keywordprg' (kp) option (default is "man"). The
712 keyword is formed of letters, numbers and the
713 characters in 'iskeyword'. The keyword under or
714 right of the cursor is used. The same can be done
715 with the command >
716 :!{program} {keyword}
717< There is an example of a program to use in the tools
Bram Moolenaar214641f2017-03-05 17:04:09 +0100718 directory of Vim. It is called "ref" and does a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000719 simple spelling check.
720 Special cases:
Bram Moolenaar26852122016-05-24 20:02:38 +0200721 - If 'keywordprg' begins with ":" it is invoked as
722 a Vim Ex command with [count].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 - If 'keywordprg' is empty, the ":help" command is
724 used. It's a good idea to include more characters
725 in 'iskeyword' then, to be able to find more help.
Bram Moolenaar26852122016-05-24 20:02:38 +0200726 - When 'keywordprg' is equal to "man" or starts with
727 ":", a [count] before "K" is inserted after
728 keywordprg and before the keyword. For example,
729 using "2K" while the cursor is on "mkdir", results
730 in: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731 !man 2 mkdir
732< - When 'keywordprg' is equal to "man -s", a count
733 before "K" is inserted after the "-s". If there is
734 no count, the "-s" is removed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000735
736 *v_K*
737{Visual}K Like "K", but use the visually highlighted text for
738 the keyword. Only works when the highlighted text is
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200739 not more than one line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000740
741[N]gs *gs* *:sl* *:sleep*
Bram Moolenaare2edc2e2021-01-16 20:21:23 +0100742:[N]sl[eep] [N][m] Do nothing for [N] seconds. When [m] is included,
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000743 sleep for [N] milliseconds. The count for "gs" always
Bram Moolenaar071d4272004-06-13 20:20:40 +0000744 uses seconds. The default is one second. >
745 :sleep "sleep for one second
746 :5sleep "sleep for five seconds
Bram Moolenaare2edc2e2021-01-16 20:21:23 +0100747 :sleep 100m "sleep for 100 milliseconds
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748 10gs "sleep for ten seconds
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100749< Can be interrupted with CTRL-C (CTRL-Break on
750 MS-Windows). "gs" stands for "goto sleep".
Bram Moolenaar677ee682005-01-27 14:41:15 +0000751 While sleeping the cursor is positioned in the text,
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200752 if at a visible position.
Bram Moolenaar15146672011-10-20 22:22:38 +0200753 Also process the received netbeans messages. {only
754 available when compiled with the |+netbeans_intg|
755 feature}
756
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100757 *:sl!* *:sleep!*
Bram Moolenaar2346a632021-06-13 19:02:49 +0200758:[N]sl[eep]! [N][m] Same as above, but hide the cursor.
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100759
Bram Moolenaard4aa83a2019-05-09 18:59:31 +0200760 *:xrestore* *:xr*
761:xr[estore] [display] Reinitializes the connection to the X11 server. Useful
762 after the X server restarts, e.g. when running Vim for
763 long time inside screen/tmux and connecting from
Bram Moolenaar68e65602019-05-26 21:33:31 +0200764 different machines.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100765 [display] should be in the format of the $DISPLAY
Bram Moolenaard4aa83a2019-05-09 18:59:31 +0200766 environment variable (e.g. "localhost:10.0")
767 If [display] is omitted, then it reinitializes the
768 connection to the X11 server using the same value as
769 was used for the previous execution of this command.
770 If the value was never specified, then it uses the
771 value of $DISPLAY environment variable as it was when
772 Vim was started.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100773 {only available when compiled with the |+clipboard|
Bram Moolenaard4aa83a2019-05-09 18:59:31 +0200774 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775
776 *g_CTRL-A*
777g CTRL-A Only when Vim was compiled with MEM_PROFILING defined
778 (which is very rare): print memory usage statistics.
779 Only useful for debugging Vim.
Bram Moolenaar345efa02016-01-15 20:57:49 +0100780 For incrementing in Visual mode see |v_g_CTRL-A|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781
782==============================================================================
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +02007832. Using Vim like less or more *less*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784
785If you use the less or more program to view a file, you don't get syntax
786highlighting. Thus you would like to use Vim instead. You can do this by
787using the shell script "$VIMRUNTIME/macros/less.sh".
788
789This shell script uses the Vim script "$VIMRUNTIME/macros/less.vim". It sets
790up mappings to simulate the commands that less supports. Otherwise, you can
791still use the Vim commands.
792
793This isn't perfect. For example, when viewing a short file Vim will still use
Bram Moolenaar7ff78462020-07-10 22:00:53 +0200794the whole screen. But it works well enough for most uses, and you get syntax
Bram Moolenaar071d4272004-06-13 20:20:40 +0000795highlighting.
796
797The "h" key will give you a short overview of the available commands.
798
Bram Moolenaare392eb42015-11-19 20:38:09 +0100799If you want to set options differently when using less, define the
800LessInitFunc in your vimrc, for example: >
801
802 func LessInitFunc()
803 set nocursorcolumn nocursorline
804 endfunc
805<
806
Bram Moolenaard2855f52018-07-31 22:23:58 +0200807 vim:tw=78:ts=8:noet:ft=help:norl: