blob: 1ce892733ac926675e68fdca706e6d866e4b7a27 [file] [log] [blame]
Christian Brabandtca471142024-06-17 13:06:34 +02001*various.txt* For Vim version 9.1. Last change: 2024 Jun 17
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.
22 Useful to update the screen halfway executing a script
23 or function. Also when halfway a mapping and
24 'lazyredraw' is set.
25
26 *:redraws* *:redrawstatus*
27:redraws[tatus][!] Redraw the status line of the current window. When !
28 is included all status lines are redrawn.
29 Useful to update the status line(s) when 'statusline'
30 includes an item that doesn't cause automatic
31 updating.
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +010032 If the command line is being edited the redraw is
33 postponed until later.
Bram Moolenaar071d4272004-06-13 20:20:40 +000034
Bram Moolenaare12bab32019-01-08 22:02:56 +010035 *:redrawt* *:redrawtabline*
36:redrawt[abline] Redraw the tabline. Useful to update the tabline when
37 'tabline' includes an item that doesn't trigger
38 automatic updating.
39
Bram Moolenaar071d4272004-06-13 20:20:40 +000040 *N<Del>*
41<Del> When entering a number: Remove the last digit.
42 Note: if you like to use <BS> for this, add this
43 mapping to your .vimrc: >
44 :map CTRL-V <BS> CTRL-V <Del>
45< See |:fixdel| if your <Del> key does not do what you
46 want.
47
48:as[cii] or *ga* *:as* *:ascii*
49ga Print the ascii value of the character under the
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010050 cursor in decimal, hexadecimal and octal.
51 Mnemonic: Get Ascii value.
52
53 For example, when the cursor is on a 'R':
Bram Moolenaar071d4272004-06-13 20:20:40 +000054 <R> 82, Hex 52, Octal 122 ~
55 When the character is a non-standard ASCII character,
56 but printable according to the 'isprint' option, the
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010057 non-printable version is also given.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +010058
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010059 When the character is larger than 127, the <M-x> form
60 is also printed. For example:
Bram Moolenaar071d4272004-06-13 20:20:40 +000061 <~A> <M-^A> 129, Hex 81, Octal 201 ~
62 <p> <|~> <M-~> 254, Hex fe, Octal 376 ~
63 (where <p> is a special character)
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010064
Bram Moolenaar071d4272004-06-13 20:20:40 +000065 The <Nul> character in a file is stored internally as
66 <NL>, but it will be shown as:
67 <^@> 0, Hex 00, Octal 000 ~
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010068
Bram Moolenaar362e1a32006-03-06 23:29:24 +000069 If the character has composing characters these are
70 also shown. The value of 'maxcombine' doesn't matter.
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010071
72 If the character can be inserted as a digraph, also
73 output the two characters that can be used to create
74 the character:
75 <ö> 246, Hex 00f6, Oct 366, Digr o: ~
76 This shows you can type CTRL-K o : to insert ö.
77
Bram Moolenaar071d4272004-06-13 20:20:40 +000078 *g8*
79g8 Print the hex values of the bytes used in the
80 character under the cursor, assuming it is in |UTF-8|
Bram Moolenaar362e1a32006-03-06 23:29:24 +000081 encoding. This also shows composing characters. The
82 value of 'maxcombine' doesn't matter.
83 Example of a character with two composing characters:
Bram Moolenaar071d4272004-06-13 20:20:40 +000084 e0 b8 81 + e0 b8 b9 + e0 b9 89 ~
Bram Moolenaarca003e12006-03-17 23:19:38 +000085
86 *8g8*
878g8 Find an illegal UTF-8 byte sequence at or after the
88 cursor. This works in two situations:
89 1. when 'encoding' is any 8-bit encoding
90 2. when 'encoding' is "utf-8" and 'fileencoding' is
91 any 8-bit encoding
92 Thus it can be used when editing a file that was
93 supposed to be UTF-8 but was read as if it is an 8-bit
94 encoding because it contains illegal bytes.
95 Does not wrap around the end of the file.
96 Note that when the cursor is on an illegal byte or the
Bram Moolenaar207f0092020-08-30 17:20:20 +020097 cursor is halfway a multibyte character the command
Bram Moolenaarca003e12006-03-17 23:19:38 +000098 won't move the cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +000099
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000100 *:p* *:pr* *:print* *E749*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000101:[range]p[rint] [flags]
102 Print [range] lines (default current line).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103 Note: If you are looking for a way to print your text
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000104 on paper see |:hardcopy|. In the GUI you can use the
105 File.Print menu entry.
106 See |ex-flags| for [flags].
Bram Moolenaar818078d2016-08-27 21:58:42 +0200107 The |:filter| command can be used to only show lines
108 matching a pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000110:[range]p[rint] {count} [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000111 Print {count} lines, starting with [range] (default
112 current line |cmdline-ranges|).
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000113 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000114
115 *:P* *:Print*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000116:[range]P[rint] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000117 Just as ":print". Was apparently added to Vi for
118 people that keep the shift key pressed too long...
Bram Moolenaar1588bc82022-03-08 21:35:07 +0000119 This command is not supported in |Vim9| script.
Bram Moolenaar166af9b2010-11-16 20:34:40 +0100120 Note: A user command can overrule this command.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000121 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122
123 *:l* *:list*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000124:[range]l[ist] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000125 Same as :print, but display unprintable characters
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +0200126 with '^' and put $ after the line. This can be
Bram Moolenaard58e9292011-02-09 17:07:58 +0100127 further changed with the 'listchars' option.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000128 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000129
130 *:nu* *:number*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000131:[range]nu[mber] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000132 Same as :print, but precede each line with its line
Bram Moolenaarfaa959a2006-02-20 21:37:40 +0000133 number. (See also 'highlight' and 'numberwidth'
134 option).
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000135 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000136
137 *:#*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000138:[range]# [count] [flags]
139 synonym for :number.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000140
Christian Brabandtf4bc59c2024-06-15 15:52:53 +0200141 *:#!* *vim-shebang*
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000142:#!{anything} Ignored, so that you can start a Vim script with: >
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000143 #!vim -S
Christian Brabandtca471142024-06-17 13:06:34 +0200144 let mylogbook='$HOME/logbook.md'
145 exe $':e {mylogbook}'
146 $
147 put ='## ' .. strftime('%d. %b %Y')
148 norm! o
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000149<
Christian Brabandtca471142024-06-17 13:06:34 +0200150 Make that script executable and run it to create a
151 new diary entry.
152
Bram Moolenaar071d4272004-06-13 20:20:40 +0000153 *:z* *E144*
Bram Moolenaar4466ad62020-11-21 13:16:30 +0100154:[range]z[+-^.=][count] Display several lines of text surrounding the line
155 specified with [range], or around the current line
156 if there is no [range].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000157
Bram Moolenaar4466ad62020-11-21 13:16:30 +0100158 If there is a [count], that's how many lines you'll
159 see; if there is no [count] and only one window then
160 twice the value of the 'scroll' option is used,
161 otherwise the current window height minus 3 is used.
162 This is the value of "scr" in the table below.
163
164 If there is a [count] the 'window' option is set to
Bram Moolenaarb6b046b2011-12-30 13:11:27 +0100165 its value.
166
Bram Moolenaar071d4272004-06-13 20:20:40 +0000167 :z can be used either alone or followed by any of
Bram Moolenaar207f0092020-08-30 17:20:20 +0200168 several marks. These have the following effect:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000169
Bram Moolenaar662db672011-03-22 14:05:35 +0100170 mark first line last line new cursor line ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000171 ---- ---------- --------- ------------
172 + current line 1 scr forward 1 scr forward
173 - 1 scr back current line current line
174 ^ 2 scr back 1 scr back 1 scr back
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +0000175 . 1/2 scr back 1/2 scr fwd 1/2 scr fwd
176 = 1/2 scr back 1/2 scr fwd current line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000177
178 Specifying no mark at all is the same as "+".
179 If the mark is "=", a line of dashes is printed
180 around the current line.
181
Bram Moolenaar6c391a72021-09-09 21:55:11 +0200182 *:z!*
Dominique Pelle7f2dd1e2021-09-04 13:44:01 +0200183:[range]z![+-^.=][count]
Bram Moolenaar22863042021-10-16 15:23:36 +0100184 Like ":z", but when [count] is not specified, it
Dominique Pelle7f2dd1e2021-09-04 13:44:01 +0200185 defaults to the Vim window height minus one.
186
187:[range]z[!]#[+-^.=][count] *:z#*
188 Like ":z" or ":z!", but number the lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000189
190 *:=*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000191:= [flags] Print the last line number.
192 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000194:{range}= [flags] Prints the last line number in {range}. For example,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195 this prints the current line number: >
196 :.=
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000197< See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198
199:norm[al][!] {commands} *:norm* *:normal*
200 Execute Normal mode commands {commands}. This makes
201 it possible to execute Normal mode commands typed on
Bram Moolenaar4a748032010-09-30 21:47:56 +0200202 the command-line. {commands} are executed like they
203 are typed. For undo all commands are undone together.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000204 Execution stops when an error is encountered.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100205
Bram Moolenaar071d4272004-06-13 20:20:40 +0000206 If the [!] is given, mappings will not be used.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100207 Without it, when this command is called from a
208 non-remappable mapping (|:noremap|), the argument can
209 be mapped anyway.
210
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211 {commands} should be a complete command. If
212 {commands} does not finish a command, the last one
213 will be aborted as if <Esc> or <C-C> was typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000214 This implies that an insert command must be completed
215 (to start Insert mode, see |:startinsert|). A ":"
Bram Moolenaar7c626922005-02-07 22:01:03 +0000216 command must be completed as well. And you can't use
217 "Q" or "gQ" to start Ex mode.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100218
219 The display is not updated while ":normal" is busy.
220
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100221 {commands} cannot start with a space. Put a count of
222 1 (one) before it, "1 " is one space.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100223
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224 The 'insertmode' option is ignored for {commands}.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100225
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226 This command cannot be followed by another command,
227 since any '|' is considered part of the command.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100228
Bram Moolenaar071d4272004-06-13 20:20:40 +0000229 This command can be used recursively, but the depth is
230 limited by 'maxmapdepth'.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100231
Bram Moolenaar071d4272004-06-13 20:20:40 +0000232 An alternative is to use |:execute|, which uses an
233 expression as argument. This allows the use of
Bram Moolenaar46f9d492010-06-12 20:18:19 +0200234 printable characters to represent special characters.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100235
Bram Moolenaar46f9d492010-06-12 20:18:19 +0200236 Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000237 :exe "normal \<c-w>\<c-w>"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000238
239:{range}norm[al][!] {commands} *:normal-range*
240 Execute Normal mode commands {commands} for each line
241 in the {range}. Before executing the {commands}, the
242 cursor is positioned in the first column of the range,
243 for each line. Otherwise it's the same as the
244 ":normal" command without a range.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000245
246 *:sh* *:shell* *E371*
247:sh[ell] This command starts a shell. When the shell exits
248 (after the "exit" command) you return to Vim. The
249 name for the shell command comes from 'shell' option.
250 *E360*
251 Note: This doesn't work when Vim on the Amiga was
252 started in QuickFix mode from a compiler, because the
253 compiler will have set stdin to a non-interactive
254 mode.
255
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000256 *:!cmd* *:!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000257:!{cmd} Execute {cmd} with the shell. See also the 'shell'
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +0100258 and 'shelltype' option.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000259 *E34*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000260 Any '!' in {cmd} is replaced with the previous
261 external command (see also 'cpoptions'). But not when
262 there is a backslash before the '!', then that
263 backslash is removed. Example: ":!ls" followed by
264 ":!echo ! \! \\!" executes "echo ls ! \!".
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200265
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000266 A '|' in {cmd} is passed to the shell, you cannot use
267 it to append a Vim command. See |:bar|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200268
269 If {cmd} contains "%" it is expanded to the current
Bram Moolenaaracc22402020-06-07 21:07:18 +0200270 file name, "#" is expanded to the alternate file name.
271 Special characters in the file name are not escaped,
272 use quotes to avoid their special meaning: >
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200273 :!ls "%"
Bram Moolenaaracc22402020-06-07 21:07:18 +0200274< If the file name contains a "$" then single quotes
275 might work better, but this only works if the file
276 name does not contain a single quote: >
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200277 :!ls '%'
278< This should always work, but it's more typing: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000279 :exe "!ls " .. shellescape(expand("%"))
Bram Moolenaaracc22402020-06-07 21:07:18 +0200280< To get a literal "%" or "#" prepend it with a
281 backslash. For example, to list all files starting
282 with "%": >
283 :!ls \%*
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200284<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000285 A newline character ends {cmd}, what follows is
286 interpreted as a following ":" command. However, if
287 there is a backslash before the newline it is removed
288 and {cmd} continues. It doesn't matter how many
289 backslashes are before the newline, only one is
290 removed.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200291
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292 On Unix the command normally runs in a non-interactive
293 shell. If you want an interactive shell to be used
294 (to use aliases) set 'shellcmdflag' to "-ic".
295 For Win32 also see |:!start|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200296
Bram Moolenaare968e362014-05-13 20:23:24 +0200297 After the command has been executed, the timestamp and
298 size of the current file is checked |timestamp|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200299
Bram Moolenaar071d4272004-06-13 20:20:40 +0000300 Vim redraws the screen after the command is finished,
301 because it may have printed any text. This requires a
302 hit-enter prompt, so that you can read any messages.
303 To avoid this use: >
304 :silent !{cmd}
305< The screen is not redrawn then, thus you have to use
306 CTRL-L or ":redraw!" if the command did display
Bram Moolenaar76db9e02022-11-09 21:21:04 +0000307 something. However, this depends on what the |t_ti|
308 and |t_te| termcap entries are set to.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000309 Also see |shell-window|.
310
311 *:!!*
312:!! Repeat last ":!{cmd}".
313
Bram Moolenaar61da1bf2019-06-06 12:14:49 +0200314 *:ve* *:ver* *:version*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000315:ve[rsion] Print the version number of the editor. If the
316 compiler used understands "__DATE__" the compilation
317 date is mentioned. Otherwise a fixed release-date is
318 shown.
319 The following lines contain information about which
320 features were enabled when Vim was compiled. When
321 there is a preceding '+', the feature is included,
322 when there is a '-' it is excluded. To change this,
323 you have to edit feature.h and recompile Vim.
324 To check for this in an expression, see |has()|.
325 Here is an overview of the features.
326 The first column shows the smallest version in which
327 they are included:
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100328 T tiny (always)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000329 N normal
Bram Moolenaar071d4272004-06-13 20:20:40 +0000330 H huge
331 m manually enabled or depends on other features
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100332 - never, feature was removed
Bram Moolenaar071d4272004-06-13 20:20:40 +0000333 (none) system dependent
334 Thus if a feature is marked with "N", it is included
RestorerZac9c6d52023-10-05 22:25:12 +0200335 in the normal and huge versions of Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000336
337 *+feature-list*
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200338 *+acl* |ACL| support included
Bram Moolenaar071d4272004-06-13 20:20:40 +0000339 *+ARP* Amiga only: ARP support included
Martin Tournoij25f3a142022-10-08 19:26:41 +0100340H *+arabic* |Arabic| language support
341N *+autochdir* support 'autochdir' option
Bram Moolenaarfd999452022-08-24 18:30:14 +0100342T *+autocmd* |:autocmd|, automatic commands. Always enabled since
343 8.0.1564
Bram Moolenaare42a6d22017-11-12 19:21:51 +0100344H *+autoservername* Automatically enable |clientserver|
Bram Moolenaara2a80162017-11-21 23:09:50 +0100345m *+balloon_eval* |balloon-eval| support in the GUI. Included when
346 compiling with supported GUI (Motif, GTK, GUI) and
347 either Netbeans/Sun Workshop integration or |+eval|
348 feature.
349H *+balloon_eval_term* |balloon-eval| support in the terminal,
350 'balloonevalterm'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000351N *+browse* |:browse| command
Bram Moolenaar2ee347f2022-08-26 17:53:44 +0100352T *++builtin_terms* maximal terminals builtin |builtin-terms| Always
353 enabled since 9.0.0280
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354N *+byte_offset* support for 'o' flag in 'statusline' option, "go"
355 and ":goto" commands.
Bram Moolenaar298b4402016-01-28 22:38:53 +0100356m *+channel* inter process communication |channel|
Martin Tournoij7904fa42022-10-04 16:28:45 +0100357T *+cindent* |'cindent'|, C indenting; Always enabled
Bram Moolenaar071d4272004-06-13 20:20:40 +0000358N *+clientserver* Unix and Win32: Remote invocation |clientserver|
Bram Moolenaar56c860c2019-08-17 20:09:31 +0200359 *+clipboard* |clipboard| support compiled-in
360 *+clipboard_working* |clipboard| support compiled-in and working
Bram Moolenaar06fe74a2019-08-31 16:20:32 +0200361T *+cmdline_compl* command line completion |cmdline-completion|
Bram Moolenaar85388672021-01-31 17:03:52 +0100362T *+cmdline_hist* command line history |cmdline-history|
Martin Tournoijba43e762022-10-13 22:12:15 +0100363T *+cmdline_info* |'showcmd'| and |'ruler'|; Always enabled since
364 9.0.0747
Martin Tournoij7904fa42022-10-04 16:28:45 +0100365T *+cmdwin* |cmdline-window| support; Always enabled since 9.0.0657
Bram Moolenaar8c96af92019-09-28 19:05:57 +0200366T *+comments* |'comments'| support
Martin Tournoij25f3a142022-10-08 19:26:41 +0100367N *+conceal* "conceal" support, see |conceal| |:syn-conceal| etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000368N *+cryptv* encryption support |encryption|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100369H *+cscope* |cscope| support
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100370T *+cursorbind* |'cursorbind'| support
Bram Moolenaarac6e65f2005-08-29 22:25:38 +0000371m *+cursorshape* |termcap-cursor-shape| support
372m *+debug* Compiled for debugging.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373N *+dialog_gui* Support for |:confirm| with GUI dialog.
374N *+dialog_con* Support for |:confirm| with console dialog.
375N *+dialog_con_gui* Support for |:confirm| with GUI and console dialog.
376N *+diff* |vimdiff| and 'diff'
377N *+digraphs* |digraphs| *E196*
Bram Moolenaar43cb6262018-03-14 21:39:02 +0100378 *+directx* Win32 GUI only: DirectX and |'renderoptions'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000379 *+dnd* Support for DnD into the "~ register |quote_~|.
Martin Tournoij25f3a142022-10-08 19:26:41 +0100380H *+emacs_tags* |emacs-tags| files
Bram Moolenaar071d4272004-06-13 20:20:40 +0000381N *+eval* expression evaluation |eval.txt|
Bram Moolenaar47003982021-12-05 21:54:04 +0000382T *+ex_extra* always on now, used to be for Vim's extra Ex commands
Bram Moolenaar071d4272004-06-13 20:20:40 +0000383N *+extra_search* |'hlsearch'| and |'incsearch'| options.
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100384- *+farsi* Removed: |farsi| language
Bram Moolenaar7dd54322022-08-26 18:01:12 +0100385T *+file_in_path* |gf|, |CTRL-W_f| and |<cfile>| Always enabled since
386 9.0.265
Bram Moolenaar071d4272004-06-13 20:20:40 +0000387N *+find_in_path* include file searches: |[I|, |:isearch|,
388 |CTRL-W_CTRL-I|, |:checkpath|, etc.
389N *+folding* |folding|
390 *+footer* |gui-footer|
391 *+fork* Unix only: |fork| shell commands
Bram Moolenaar73e28dc2022-09-17 21:08:33 +0100392T *+float* Floating point support Always enabled since 9.0.0491
Bram Moolenaar071d4272004-06-13 20:20:40 +0000393N *+gettext* message translations |multi-lang|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100394- *+GUI_Athena* Unix only: Athena |GUI|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000395 *+GUI_neXtaw* Unix only: neXtaw |GUI|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000396 *+GUI_GTK* Unix only: GTK+ |GUI|
397 *+GUI_Motif* Unix only: Motif |GUI|
398 *+GUI_Photon* QNX only: Photon |GUI|
399m *+hangul_input* Hangul input support |hangul|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000400 *+iconv* Compiled with the |iconv()| function
401 *+iconv/dyn* Likewise |iconv-dynamic| |/dyn|
Bram Moolenaar06fe74a2019-08-31 16:20:32 +0200402T *+insert_expand* |insert_expand| Insert mode completion
Bram Moolenaarbfe13cc2020-04-12 17:53:12 +0200403m *+ipv6* Support for IPv6 networking |channel|
Bram Moolenaar38a55632016-02-15 22:07:32 +0100404m *+job* starting and stopping jobs |job|
Bram Moolenaar739f13a2021-12-13 13:12:53 +0000405T *+jumplist* |jumplist|; Always enabled since 8.2.3795
Martin Tournoij25f3a142022-10-08 19:26:41 +0100406H *+keymap* |'keymap'|
Bram Moolenaarbc8801c2016-08-02 21:04:33 +0200407N *+lambda* |lambda| and |closure|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100408H *+langmap* |'langmap'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000409N *+libcall* |libcall()|
410N *+linebreak* |'linebreak'|, |'breakat'| and |'showbreak'|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100411T *+lispindent* |'lisp'|
Bram Moolenaar0c72fe42018-03-29 16:04:08 +0200412T *+listcmds* Vim commands for the list of buffers |buffer-hidden|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000413 and argument list |:argdelete|
Bram Moolenaar088e8e32019-08-08 22:15:18 +0200414T *+localmap* Support for mappings local to a buffer |:map-local|
Bram Moolenaar0ba04292010-07-14 23:23:17 +0200415m *+lua* |Lua| interface
416m *+lua/dyn* |Lua| interface |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000417N *+menu* |:menu|
418N *+mksession* |:mksession|
Bram Moolenaar30e9b3c2019-09-07 16:24:12 +0200419T *+modify_fname* |filename-modifiers|
Bram Moolenaar96f45c02019-10-26 19:53:45 +0200420T *+mouse* Mouse handling |mouse-using|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000421N *+mouseshape* |'mouseshape'|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100422N *+mouse_dec* Unix only: Dec terminal mouse handling |dec-mouse|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000423N *+mouse_gpm* Unix only: Linux console mouse handling |gpm-mouse|
Bram Moolenaar8a3b8052022-06-26 12:21:15 +0100424m *+mouse_gpm/dyn* Same as |+mouse_gpm| with optional library dependency
425 |/dyn|
Bram Moolenaar13600302014-05-22 18:26:40 +0200426N *+mouse_jsbterm* JSB mouse handling |jsbterm-mouse|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100427N *+mouse_netterm* Unix only: netterm mouse handling |netterm-mouse|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100428N *+mouse_pterm* QNX only: pterm mouse handling |qnx-terminal|
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000429N *+mouse_sysmouse* Unix only: *BSD console mouse handling |sysmouse|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100430N *+mouse_sgr* Unix only: sgr mouse handling |sgr-mouse|
431N *+mouse_urxvt* Unix only: urxvt mouse handling |urxvt-mouse|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100432N *+mouse_xterm* Unix only: xterm mouse handling |xterm-mouse|
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100433T *+multi_byte* Unicode support, 16 and 32 bit characters |multibyte|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000434 *+multi_byte_ime* Win32 input method for multibyte chars |multibyte-ime|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100435N *+multi_lang* non-English language support |multi-lang|
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000436m *+mzscheme* Mzscheme interface |mzscheme|
Bram Moolenaar4770d092006-01-12 23:22:24 +0000437m *+mzscheme/dyn* Mzscheme interface |mzscheme-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438m *+netbeans_intg* |netbeans|
Bram Moolenaar47003982021-12-05 21:54:04 +0000439T *+num64* 64-bit Number support |Number|
Bram Moolenaara2baa732022-02-04 16:09:54 +0000440 Always enabled since 8.2.0271, use v:numbersize to
Bram Moolenaarf9706e92020-02-22 14:27:04 +0100441 check the actual size of a Number.
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100442m *+ole* Win32 GUI only: |ole-interface|
Bram Moolenaar91c49372016-05-08 09:50:29 +0200443N *+packages* Loading |packages|
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +0100444T *+path_extra* Up/downwards search in 'path' and 'tags' Always
445 enabled since 9.0.0270
Bram Moolenaara5792f52005-11-23 21:25:05 +0000446m *+perl* Perl interface |perl|
447m *+perl/dyn* Perl interface |perl-dynamic| |/dyn|
Bram Moolenaar7fc0c062010-08-10 21:43:35 +0200448N *+persistent_undo* Persistent undo |undo-persistence|
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100449N *+popupwin* Popup windows |popup-window|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100450 *+postscript* |:hardcopy| writes a PostScript file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000451N *+printer* |:hardcopy| command
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000452H *+profile* |:profile| command
Bram Moolenaar60aad972010-07-21 20:36:22 +0200453m *+python* Python 2 interface |python|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100454m *+python/dyn* Python 2 interface |python-dynamic| |/dyn|
Bram Moolenaar60aad972010-07-21 20:36:22 +0200455m *+python3* Python 3 interface |python|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100456m *+python3/dyn* Python 3 interface |python-dynamic| |/dyn|
Yee Cheng Chinc13b3d12023-08-20 21:18:38 +0200457m *+python3/dyn-stable*
h_east59858792023-10-25 22:47:05 +0900458 Python 3 interface |python-dynamic| |python-stable|
459 |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000460N *+quickfix* |:make| and |quickfix| commands
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000461N *+reltime* |reltime()| function, 'hlsearch'/'incsearch' timeout,
462 'redrawtime' option
Martin Tournoij25f3a142022-10-08 19:26:41 +0100463H *+rightleft* Right to left typing |'rightleft'|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000464m *+ruby* Ruby interface |ruby|
465m *+ruby/dyn* Ruby interface |ruby-dynamic| |/dyn|
Bram Moolenaar98ef2332018-03-18 14:44:37 +0100466T *+scrollbind* |'scrollbind'|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100467N *+signs* |:sign|
468T *+smartindent* |'smartindent'|
469H *+sodium* compiled with libsodium for better encryption support
470H *+sound* |sound_playevent()|, |sound_playfile()| functions, etc.
Bram Moolenaar12ee7ff2019-06-10 22:47:40 +0200471N *+spell* spell checking support, see |spell|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100472N *+startuptime* |--startuptime| argument
473N *+statusline* Options 'statusline', 'rulerformat' and special
Bram Moolenaar071d4272004-06-13 20:20:40 +0000474 formats of 'titlestring' and 'iconstring'
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100475- *+sun_workshop* Removed: |workshop|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476N *+syntax* Syntax highlighting |syntax|
477 *+system()* Unix only: opposite of |+fork|
Bram Moolenaar64d8e252016-09-06 22:12:34 +0200478T *+tag_binary* binary searching in tags file |tag-binary-search|
Bram Moolenaar4ceaa3a2019-12-03 22:49:09 +0100479- *+tag_old_static* Removed; method for static tags |tag-old-static|
480- *+tag_any_white* Removed; was to allow any white space in tags files
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100481m *+tcl* Tcl interface |tcl|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000482m *+tcl/dyn* Tcl interface |tcl-dynamic| |/dyn|
Bram Moolenaar1ccd8ff2017-08-11 19:50:37 +0200483m *+terminal* Support for terminal window |terminal|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000484 *+terminfo* uses |terminfo| instead of termcap
485N *+termresponse* support for |t_RV| and |v:termresponse|
Martin Tournoij25f3a142022-10-08 19:26:41 +0100486N *+termguicolors* 24-bit color in xterm-compatible terminals support
Bram Moolenaar88774872022-08-16 20:24:29 +0100487T *+textobjects* |text-objects| selection. Always enabled since 9.0.0222.
Bram Moolenaar9d87a372018-12-18 21:41:50 +0100488N *+textprop* |text-properties|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000489 *+tgetent* non-Unix only: able to use external termcap
Bram Moolenaare18c0b32016-03-20 21:08:34 +0100490N *+timers* the |timer_start()| function
Bram Moolenaar47003982021-12-05 21:54:04 +0000491T *+title* Setting the window 'title' and 'icon'; Always enabled
Bram Moolenaar071d4272004-06-13 20:20:40 +0000492N *+toolbar* |gui-toolbar|
Bram Moolenaarac9fb182019-04-27 13:04:13 +0200493T *+user_commands* User-defined commands. |user-commands|
494 Always enabled since 8.1.1210.
Martin Tournoij25f3a142022-10-08 19:26:41 +0100495H *+vartabs* Variable-width tabstops. |'vartabstop'|
Bram Moolenaar47003982021-12-05 21:54:04 +0000496T *+vertsplit* Vertically split windows |:vsplit|; Always enabled
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200497 since 8.0.1118.
Bram Moolenaara6feb162022-01-02 12:06:33 +0000498T *+vim9script* |Vim9| script
499N *+viminfo* |'viminfo'|
Bram Moolenaar47003982021-12-05 21:54:04 +0000500T *+virtualedit* |'virtualedit'| Always enabled since 8.1.826.
Bram Moolenaar870ba5f2019-01-11 14:37:20 +0100501T *+visual* Visual mode |Visual-mode| Always enabled since 7.4.200.
502T *+visualextra* extra Visual mode commands |blockwise-operators|
Bram Moolenaar1f0bfe52018-07-29 16:09:22 +0200503T *+vreplace* |gR| and |gr|
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +0100504 *+vtp* on MS-Windows console: support for 'termguicolors'
Bram Moolenaar074fbd42022-08-26 16:41:14 +0100505T *+wildignore* |'wildignore'| Always enabled since 9.0.0278
Bram Moolenaarf1dcd142022-12-31 15:30:45 +0000506T *+wildmenu* |'wildmenu'| Always enabled since 9.0.0279
Bram Moolenaar870ba5f2019-01-11 14:37:20 +0100507T *+windows* more than one window; Always enabled since 8.0.1118.
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100508m *+writebackup* |'writebackup'| is default on
509m *+xim* X input method |xim|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510 *+xfontset* X fontset support |xfontset|
Christian Brabandte085dfd2023-09-30 12:49:18 +0200511N *+xattr* compiled with extended attribute support (Linux only)
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200512 *+xpm* pixmap support
Bram Moolenaar9b451252012-08-15 17:43:31 +0200513m *+xpm_w32* Win32 GUI only: pixmap support |w32-xpm-support|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000514 *+xsmp* XSMP (X session management) support
515 *+xsmp_interact* interactive XSMP (X session management) support
516N *+xterm_clipboard* Unix only: xterm clipboard handling
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100517m *+xterm_save* save and restore xterm screen |xterm-screens|
518N *+X11* Unix only: can restore window title |X11|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000519
520 */dyn* *E370* *E448*
521 To some of the features "/dyn" is added when the
522 feature is only available when the related library can
523 be dynamically loaded.
524
525:ve[rsion] {nr} Is now ignored. This was previously used to check the
526 version number of a .vimrc file. It was removed,
527 because you can now use the ":if" command for
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200528 version-dependent behavior.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000529
530 *:redi* *:redir*
531:redi[r][!] > {file} Redirect messages to file {file}. The messages which
532 are the output of commands are written to that file,
533 until redirection ends. The messages are also still
534 shown on the screen. When [!] is included, an
535 existing file is overwritten. When [!] is omitted,
536 and {file} exists, this command fails.
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200537
Bram Moolenaar071d4272004-06-13 20:20:40 +0000538 Only one ":redir" can be active at a time. Calls to
539 ":redir" will close any active redirection before
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200540 starting redirection to the new target. For recursive
541 use check out |execute()|.
542
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543 To stop the messages and commands from being echoed to
544 the screen, put the commands in a function and call it
545 with ":silent call Function()".
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000546 An alternative is to use the 'verbosefile' option,
547 this can be used in combination with ":redir".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000548
549:redi[r] >> {file} Redirect messages to file {file}. Append if {file}
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200550 already exists.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000551
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000552:redi[r] @{a-zA-Z}
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +0000553:redi[r] @{a-zA-Z}> Redirect messages to register {a-z}. Append to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554 contents of the register if its name is given
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000555 uppercase {A-Z}. The ">" after the register name is
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200556 optional.
557:redi[r] @{a-z}>> Append messages to register {a-z}.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000558
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100559:redi[r] @*>
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000560:redi[r] @+> Redirect messages to the selection or clipboard. For
561 backward compatibility, the ">" after the register
562 name can be omitted. See |quotestar| and |quoteplus|.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100563:redi[r] @*>>
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000564:redi[r] @+>> Append messages to the selection or clipboard.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +0000566:redi[r] @"> Redirect messages to the unnamed register. For
567 backward compatibility, the ">" after the register
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200568 name can be omitted.
569:redi[r] @">> Append messages to the unnamed register.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000570 *E1092*
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000571:redi[r] => {var} Redirect messages to a variable.
572 In legacy script: If the variable doesn't exist, then
573 it is created. If the variable exists, then it is
574 initialized to an empty string. After the redirection
575 starts, if the variable is removed or locked or the
576 variable type is changed, then further command output
Bram Moolenaare1dc76f2022-06-25 18:01:32 +0100577 messages will cause errors. When using a local
578 variable (l:var in a function or s:var in a script)
579 and another `:redir` causes the current one to end,
580 the scope might be different and the assignment fails.
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000581 In Vim9 script: the variable must have been declared
582 as a string.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000583 The variable will remain empty until redirection ends.
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000584 Only string variables can be used.
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200585 To get the output of one command the |execute()|
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +0200586 function can be used instead of redirection.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000587
588:redi[r] =>> {var} Append messages to an existing variable. Only string
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200589 variables can be used.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000590 *E1185*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200591:redi[r] END End redirecting messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200593 *:filt* *:filter*
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000594:filt[er][!] {pattern} {command}
595:filt[er][!] /{pattern}/ {command}
Bram Moolenaar214641f2017-03-05 17:04:09 +0100596 Restrict the output of {command} to lines matching
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000597 with {pattern}. For example, to list only xml files: >
Bram Moolenaar818078d2016-08-27 21:58:42 +0200598 :filter /\.xml$/ oldfiles
Bram Moolenaar214641f2017-03-05 17:04:09 +0100599< If the [!] is given, restrict the output of {command}
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000600 to lines that do NOT match {pattern}.
Bram Moolenaar214641f2017-03-05 17:04:09 +0100601
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000602 {pattern} is a Vim search pattern. Instead of enclosing
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200603 it in / any non-ID character (see |'isident'|) can be
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000604 used, so long as it does not appear in {pattern}.
605 Without the enclosing character the pattern cannot
606 include the bar character. 'ignorecase' is not used.
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200607
608 The pattern is matched against the relevant part of
609 the output, not necessarily the whole line. Only some
610 commands support filtering, try it out to check if it
Bram Moolenaarf86db782018-10-25 13:31:37 +0200611 works. Some of the commands that support filtering:
Bram Moolenaarad6dc492019-04-27 22:40:08 +0200612 |:#| - filter whole line
613 |:clist| - filter by file name or module name
614 |:command| - filter by command name
615 |:files| - filter by file name
616 |:highlight| - filter by highlight group
Christian Brabandt42a5b5a2024-05-24 07:39:34 +0200617 |:history| - filter by history commands
Bram Moolenaarad6dc492019-04-27 22:40:08 +0200618 |:jumps| - filter by file name
619 |:let| - filter by variable name
620 |:list| - filter whole line
621 |:llist| - filter by file name or module name
622 |:marks| - filter by text in the current file,
623 or file name for other files
624 |:oldfiles| - filter by file name
Bram Moolenaar8fc42962019-10-26 17:33:13 +0200625 |:registers| - filter by register contents
626 (does not work multi-line)
Bram Moolenaar0e6adf82021-12-16 14:41:10 +0000627 |:set| - filter by option name
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200628
629 Only normal messages are filtered, error messages are
630 not.
631
Bram Moolenaare0fa3742016-02-20 15:47:01 +0100632 *:sil* *:silent* *:silent!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633:sil[ent][!] {command} Execute {command} silently. Normal messages will not
634 be given or added to the message history.
635 When [!] is added, error messages will also be
636 skipped, and commands and mappings will not be aborted
637 when an error is detected. |v:errmsg| is still set.
638 When [!] is not used, an error message will cause
639 further messages to be displayed normally.
640 Redirection, started with |:redir|, will continue as
641 usual, although there might be small differences.
642 This will allow redirecting the output of a command
643 without seeing it on the screen. Example: >
644 :redir >/tmp/foobar
645 :silent g/Aap/p
646 :redir END
647< To execute a Normal mode command silently, use the
648 |:normal| command. For example, to search for a
649 string without messages: >
650 :silent exe "normal /path\<CR>"
651< ":silent!" is useful to execute a command that may
652 fail, but the failure is to be ignored. Example: >
653 :let v:errmsg = ""
654 :silent! /^begin
655 :if v:errmsg != ""
656 : ... pattern was not found
657< ":silent" will also avoid the hit-enter prompt. When
658 using this for an external command, this may cause the
659 screen to be messed up. Use |CTRL-L| to clean it up
660 then.
661 ":silent menu ..." defines a menu that will not echo a
662 Command-line command. The command will still produce
663 messages though. Use ":silent" in the command itself
664 to avoid that: ":silent menu .... :silent command".
665
Bram Moolenaar8e258a42009-07-09 13:55:43 +0000666 *:uns* *:unsilent*
667:uns[ilent] {command} Execute {command} not silently. Only makes a
668 difference when |:silent| was used to get to this
669 command.
670 Use this for giving a message even when |:silent| was
671 used. In this example |:silent| is used to avoid the
672 message about reading the file and |:unsilent| to be
673 able to list the first line of each file. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000674 :silent argdo unsilent echo expand('%') .. ": " .. getline(1)
Bram Moolenaar8e258a42009-07-09 13:55:43 +0000675<
676
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 *:verb* *:verbose*
678:[count]verb[ose] {command}
679 Execute {command} with 'verbose' set to [count]. If
Bram Moolenaared203462004-06-16 11:19:22 +0000680 [count] is omitted one is used. ":0verbose" can be
681 used to set 'verbose' to zero.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000682 The additional use of ":silent" makes messages
683 generated but not displayed.
684 The combination of ":silent" and ":verbose" can be
685 used to generate messages and check them with
686 |v:statusmsg| and friends. For example: >
687 :let v:statusmsg = ""
688 :silent verbose runtime foobar.vim
689 :if v:statusmsg != ""
690 : " foobar.vim could not be found
691 :endif
692< When concatenating another command, the ":verbose"
693 only applies to the first one: >
694 :4verbose set verbose | set verbose
695< verbose=4 ~
696 verbose=0 ~
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000697 For logging verbose messages in a file use the
698 'verbosefile' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699
Bram Moolenaar8aff23a2005-08-19 20:40:30 +0000700 *:verbose-cmd*
701When 'verbose' is non-zero, listing the value of a Vim option or a key map or
Bram Moolenaare344bea2005-09-01 20:46:49 +0000702an abbreviation or a user-defined function or a command or a highlight group
703or an autocommand will also display where it was last defined. If it was
704defined manually then there will be no "Last set" message. When it was
705defined while executing a function, user command or autocommand, the script in
706which it was defined is reported.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200707{not available when compiled without the |+eval| feature}
Bram Moolenaar8aff23a2005-08-19 20:40:30 +0000708
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709 *K*
710K Run a program to lookup the keyword under the
711 cursor. The name of the program is given with the
712 'keywordprg' (kp) option (default is "man"). The
713 keyword is formed of letters, numbers and the
714 characters in 'iskeyword'. The keyword under or
715 right of the cursor is used. The same can be done
716 with the command >
717 :!{program} {keyword}
718< There is an example of a program to use in the tools
Bram Moolenaar214641f2017-03-05 17:04:09 +0100719 directory of Vim. It is called "ref" and does a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 simple spelling check.
721 Special cases:
Bram Moolenaar26852122016-05-24 20:02:38 +0200722 - If 'keywordprg' begins with ":" it is invoked as
723 a Vim Ex command with [count].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000724 - If 'keywordprg' is empty, the ":help" command is
725 used. It's a good idea to include more characters
726 in 'iskeyword' then, to be able to find more help.
Bram Moolenaar26852122016-05-24 20:02:38 +0200727 - When 'keywordprg' is equal to "man" or starts with
728 ":", a [count] before "K" is inserted after
729 keywordprg and before the keyword. For example,
730 using "2K" while the cursor is on "mkdir", results
731 in: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732 !man 2 mkdir
733< - When 'keywordprg' is equal to "man -s", a count
734 before "K" is inserted after the "-s". If there is
735 no count, the "-s" is removed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000736
737 *v_K*
738{Visual}K Like "K", but use the visually highlighted text for
739 the keyword. Only works when the highlighted text is
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200740 not more than one line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000741
742[N]gs *gs* *:sl* *:sleep*
Bram Moolenaare2edc2e2021-01-16 20:21:23 +0100743:[N]sl[eep] [N][m] Do nothing for [N] seconds. When [m] is included,
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000744 sleep for [N] milliseconds. The count for "gs" always
Bram Moolenaar071d4272004-06-13 20:20:40 +0000745 uses seconds. The default is one second. >
746 :sleep "sleep for one second
747 :5sleep "sleep for five seconds
Bram Moolenaare2edc2e2021-01-16 20:21:23 +0100748 :sleep 100m "sleep for 100 milliseconds
Bram Moolenaar071d4272004-06-13 20:20:40 +0000749 10gs "sleep for ten seconds
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100750< Can be interrupted with CTRL-C (CTRL-Break on
751 MS-Windows). "gs" stands for "goto sleep".
Bram Moolenaar677ee682005-01-27 14:41:15 +0000752 While sleeping the cursor is positioned in the text,
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200753 if at a visible position.
Bram Moolenaar15146672011-10-20 22:22:38 +0200754 Also process the received netbeans messages. {only
755 available when compiled with the |+netbeans_intg|
756 feature}
757
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100758 *:sl!* *:sleep!*
Bram Moolenaar2346a632021-06-13 19:02:49 +0200759:[N]sl[eep]! [N][m] Same as above, but hide the cursor.
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100760
Bram Moolenaard4aa83a2019-05-09 18:59:31 +0200761 *:xrestore* *:xr*
762:xr[estore] [display] Reinitializes the connection to the X11 server. Useful
763 after the X server restarts, e.g. when running Vim for
764 long time inside screen/tmux and connecting from
Bram Moolenaar68e65602019-05-26 21:33:31 +0200765 different machines.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100766 [display] should be in the format of the $DISPLAY
Bram Moolenaard4aa83a2019-05-09 18:59:31 +0200767 environment variable (e.g. "localhost:10.0")
768 If [display] is omitted, then it reinitializes the
769 connection to the X11 server using the same value as
770 was used for the previous execution of this command.
771 If the value was never specified, then it uses the
772 value of $DISPLAY environment variable as it was when
773 Vim was started.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100774 {only available when compiled with the |+clipboard|
Bram Moolenaard4aa83a2019-05-09 18:59:31 +0200775 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776
777 *g_CTRL-A*
778g CTRL-A Only when Vim was compiled with MEM_PROFILING defined
779 (which is very rare): print memory usage statistics.
780 Only useful for debugging Vim.
Bram Moolenaar345efa02016-01-15 20:57:49 +0100781 For incrementing in Visual mode see |v_g_CTRL-A|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782
783==============================================================================
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +02007842. Using Vim like less or more *less*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000785
786If you use the less or more program to view a file, you don't get syntax
787highlighting. Thus you would like to use Vim instead. You can do this by
788using the shell script "$VIMRUNTIME/macros/less.sh".
789
790This shell script uses the Vim script "$VIMRUNTIME/macros/less.vim". It sets
791up mappings to simulate the commands that less supports. Otherwise, you can
792still use the Vim commands.
793
794This isn't perfect. For example, when viewing a short file Vim will still use
Bram Moolenaar7ff78462020-07-10 22:00:53 +0200795the whole screen. But it works well enough for most uses, and you get syntax
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796highlighting.
797
798The "h" key will give you a short overview of the available commands.
799
Bram Moolenaare392eb42015-11-19 20:38:09 +0100800If you want to set options differently when using less, define the
801LessInitFunc in your vimrc, for example: >
802
803 func LessInitFunc()
804 set nocursorcolumn nocursorline
805 endfunc
806<
807
Bram Moolenaard2855f52018-07-31 22:23:58 +0200808 vim:tw=78:ts=8:noet:ft=help:norl: