blob: 7c8f3111c1e9effa6695d4380e054b04cec9c156 [file] [log] [blame]
Bram Moolenaarb1c91982018-05-17 17:04:55 +02001*various.txt* For Vim version 8.1. Last change: 2018 Mar 29
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.
32
33 *N<Del>*
34<Del> When entering a number: Remove the last digit.
35 Note: if you like to use <BS> for this, add this
36 mapping to your .vimrc: >
37 :map CTRL-V <BS> CTRL-V <Del>
38< See |:fixdel| if your <Del> key does not do what you
39 want.
40
41:as[cii] or *ga* *:as* *:ascii*
42ga Print the ascii value of the character under the
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010043 cursor in decimal, hexadecimal and octal.
44 Mnemonic: Get Ascii value.
45
46 For example, when the cursor is on a 'R':
Bram Moolenaar071d4272004-06-13 20:20:40 +000047 <R> 82, Hex 52, Octal 122 ~
48 When the character is a non-standard ASCII character,
49 but printable according to the 'isprint' option, the
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010050 non-printable version is also given.
51
52 When the character is larger than 127, the <M-x> form
53 is also printed. For example:
Bram Moolenaar071d4272004-06-13 20:20:40 +000054 <~A> <M-^A> 129, Hex 81, Octal 201 ~
55 <p> <|~> <M-~> 254, Hex fe, Octal 376 ~
56 (where <p> is a special character)
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010057
Bram Moolenaar071d4272004-06-13 20:20:40 +000058 The <Nul> character in a file is stored internally as
59 <NL>, but it will be shown as:
60 <^@> 0, Hex 00, Octal 000 ~
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010061
Bram Moolenaar362e1a32006-03-06 23:29:24 +000062 If the character has composing characters these are
63 also shown. The value of 'maxcombine' doesn't matter.
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010064
65 If the character can be inserted as a digraph, also
66 output the two characters that can be used to create
67 the character:
68 <ö> 246, Hex 00f6, Oct 366, Digr o: ~
69 This shows you can type CTRL-K o : to insert ö.
70
71 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +000072
73 *g8*
74g8 Print the hex values of the bytes used in the
75 character under the cursor, assuming it is in |UTF-8|
Bram Moolenaar362e1a32006-03-06 23:29:24 +000076 encoding. This also shows composing characters. The
77 value of 'maxcombine' doesn't matter.
78 Example of a character with two composing characters:
Bram Moolenaar071d4272004-06-13 20:20:40 +000079 e0 b8 81 + e0 b8 b9 + e0 b9 89 ~
Bram Moolenaarca003e12006-03-17 23:19:38 +000080 {not in Vi} {only when compiled with the |+multi_byte|
81 feature}
82
83 *8g8*
848g8 Find an illegal UTF-8 byte sequence at or after the
85 cursor. This works in two situations:
86 1. when 'encoding' is any 8-bit encoding
87 2. when 'encoding' is "utf-8" and 'fileencoding' is
88 any 8-bit encoding
89 Thus it can be used when editing a file that was
90 supposed to be UTF-8 but was read as if it is an 8-bit
91 encoding because it contains illegal bytes.
92 Does not wrap around the end of the file.
93 Note that when the cursor is on an illegal byte or the
94 cursor is halfway a multi-byte character the command
95 won't move the cursor.
96 {not in Vi} {only when compiled with the |+multi_byte|
97 feature}
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 Moolenaar166af9b2010-11-16 20:34:40 +0100118 Note: A user command can overrule this command.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000119 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000120
121 *:l* *:list*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000122:[range]l[ist] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000123 Same as :print, but display unprintable characters
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +0200124 with '^' and put $ after the line. This can be
Bram Moolenaard58e9292011-02-09 17:07:58 +0100125 further changed with the 'listchars' option.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000126 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000127
128 *:nu* *:number*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000129:[range]nu[mber] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130 Same as :print, but precede each line with its line
Bram Moolenaarfaa959a2006-02-20 21:37:40 +0000131 number. (See also 'highlight' and 'numberwidth'
132 option).
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000133 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000134
135 *:#*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000136:[range]# [count] [flags]
137 synonym for :number.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000138
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000139 *:#!*
140:#!{anything} Ignored, so that you can start a Vim script with: >
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000141 #!vim -S
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000142 echo "this is a Vim script"
143 quit
144<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145 *:z* *E144*
146:{range}z[+-^.=]{count} Display several lines of text surrounding the line
147 specified with {range}, or around the current line
148 if there is no {range}. If there is a {count}, that's
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000149 how many lines you'll see; if there is only one window
Bram Moolenaar662db672011-03-22 14:05:35 +0100150 then twice the value of the 'scroll' option is used,
151 otherwise the current window height minus 3 is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152
Bram Moolenaarb6b046b2011-12-30 13:11:27 +0100153 If there is a {count} the 'window' option is set to
154 its value.
155
Bram Moolenaar071d4272004-06-13 20:20:40 +0000156 :z can be used either alone or followed by any of
157 several punctuation marks. These have the following
158 effect:
159
Bram Moolenaar662db672011-03-22 14:05:35 +0100160 mark first line last line new cursor line ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000161 ---- ---------- --------- ------------
162 + current line 1 scr forward 1 scr forward
163 - 1 scr back current line current line
164 ^ 2 scr back 1 scr back 1 scr back
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +0000165 . 1/2 scr back 1/2 scr fwd 1/2 scr fwd
166 = 1/2 scr back 1/2 scr fwd current line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000167
168 Specifying no mark at all is the same as "+".
169 If the mark is "=", a line of dashes is printed
170 around the current line.
171
172:{range}z#[+-^.=]{count} *:z#*
173 Like ":z", but number the lines.
174 {not in all versions of Vi, not with these arguments}
175
176 *:=*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000177:= [flags] Print the last line number.
178 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000179
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000180:{range}= [flags] Prints the last line number in {range}. For example,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000181 this prints the current line number: >
182 :.=
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000183< See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000184
185:norm[al][!] {commands} *:norm* *:normal*
186 Execute Normal mode commands {commands}. This makes
187 it possible to execute Normal mode commands typed on
Bram Moolenaar4a748032010-09-30 21:47:56 +0200188 the command-line. {commands} are executed like they
189 are typed. For undo all commands are undone together.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000190 Execution stops when an error is encountered.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100191
Bram Moolenaar071d4272004-06-13 20:20:40 +0000192 If the [!] is given, mappings will not be used.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100193 Without it, when this command is called from a
194 non-remappable mapping (|:noremap|), the argument can
195 be mapped anyway.
196
Bram Moolenaar071d4272004-06-13 20:20:40 +0000197 {commands} should be a complete command. If
198 {commands} does not finish a command, the last one
199 will be aborted as if <Esc> or <C-C> was typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000200 This implies that an insert command must be completed
201 (to start Insert mode, see |:startinsert|). A ":"
Bram Moolenaar7c626922005-02-07 22:01:03 +0000202 command must be completed as well. And you can't use
203 "Q" or "gQ" to start Ex mode.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100204
205 The display is not updated while ":normal" is busy.
206
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100207 {commands} cannot start with a space. Put a count of
208 1 (one) before it, "1 " is one space.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100209
Bram Moolenaar071d4272004-06-13 20:20:40 +0000210 The 'insertmode' option is ignored for {commands}.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100211
Bram Moolenaar071d4272004-06-13 20:20:40 +0000212 This command cannot be followed by another command,
213 since any '|' is considered part of the command.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100214
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215 This command can be used recursively, but the depth is
216 limited by 'maxmapdepth'.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100217
Bram Moolenaar071d4272004-06-13 20:20:40 +0000218 An alternative is to use |:execute|, which uses an
219 expression as argument. This allows the use of
Bram Moolenaar46f9d492010-06-12 20:18:19 +0200220 printable characters to represent special characters.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100221
Bram Moolenaar46f9d492010-06-12 20:18:19 +0200222 Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000223 :exe "normal \<c-w>\<c-w>"
224< {not in Vi, of course}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000225
226:{range}norm[al][!] {commands} *:normal-range*
227 Execute Normal mode commands {commands} for each line
228 in the {range}. Before executing the {commands}, the
229 cursor is positioned in the first column of the range,
230 for each line. Otherwise it's the same as the
231 ":normal" command without a range.
232 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000233
234 *:sh* *:shell* *E371*
235:sh[ell] This command starts a shell. When the shell exits
236 (after the "exit" command) you return to Vim. The
237 name for the shell command comes from 'shell' option.
238 *E360*
239 Note: This doesn't work when Vim on the Amiga was
240 started in QuickFix mode from a compiler, because the
241 compiler will have set stdin to a non-interactive
242 mode.
243
244 *:!cmd* *:!* *E34*
245:!{cmd} Execute {cmd} with the shell. See also the 'shell'
246 and 'shelltype' option.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200247
Bram Moolenaar071d4272004-06-13 20:20:40 +0000248 Any '!' in {cmd} is replaced with the previous
249 external command (see also 'cpoptions'). But not when
250 there is a backslash before the '!', then that
251 backslash is removed. Example: ":!ls" followed by
252 ":!echo ! \! \\!" executes "echo ls ! \!".
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200253
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000254 A '|' in {cmd} is passed to the shell, you cannot use
255 it to append a Vim command. See |:bar|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200256
257 If {cmd} contains "%" it is expanded to the current
258 file name. Special characters are not escaped, use
259 quotes to avoid their special meaning: >
260 :!ls "%"
261< If the file name contains a "$" single quotes might
262 work better (but a single quote causes trouble): >
263 :!ls '%'
264< This should always work, but it's more typing: >
265 :exe "!ls " . shellescape(expand("%"))
266<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000267 A newline character ends {cmd}, what follows is
268 interpreted as a following ":" command. However, if
269 there is a backslash before the newline it is removed
270 and {cmd} continues. It doesn't matter how many
271 backslashes are before the newline, only one is
272 removed.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200273
Bram Moolenaar071d4272004-06-13 20:20:40 +0000274 On Unix the command normally runs in a non-interactive
275 shell. If you want an interactive shell to be used
276 (to use aliases) set 'shellcmdflag' to "-ic".
277 For Win32 also see |:!start|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200278
Bram Moolenaare968e362014-05-13 20:23:24 +0200279 After the command has been executed, the timestamp and
280 size of the current file is checked |timestamp|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200281
Bram Moolenaar071d4272004-06-13 20:20:40 +0000282 Vim redraws the screen after the command is finished,
283 because it may have printed any text. This requires a
284 hit-enter prompt, so that you can read any messages.
285 To avoid this use: >
286 :silent !{cmd}
287< The screen is not redrawn then, thus you have to use
288 CTRL-L or ":redraw!" if the command did display
289 something.
290 Also see |shell-window|.
291
292 *:!!*
293:!! Repeat last ":!{cmd}".
294
295 *:ve* *:version*
296:ve[rsion] Print the version number of the editor. If the
297 compiler used understands "__DATE__" the compilation
298 date is mentioned. Otherwise a fixed release-date is
299 shown.
300 The following lines contain information about which
301 features were enabled when Vim was compiled. When
302 there is a preceding '+', the feature is included,
303 when there is a '-' it is excluded. To change this,
304 you have to edit feature.h and recompile Vim.
305 To check for this in an expression, see |has()|.
306 Here is an overview of the features.
307 The first column shows the smallest version in which
308 they are included:
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100309 T tiny (always)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000310 S small
311 N normal
312 B big
313 H huge
314 m manually enabled or depends on other features
315 (none) system dependent
316 Thus if a feature is marked with "N", it is included
317 in the normal, big and huge versions of Vim.
318
319 *+feature-list*
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200320 *+acl* |ACL| support included
Bram Moolenaar071d4272004-06-13 20:20:40 +0000321 *+ARP* Amiga only: ARP support included
322B *+arabic* |Arabic| language support
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100323T *+autocmd* |:autocmd|, automatic commands
Bram Moolenaare42a6d22017-11-12 19:21:51 +0100324H *+autoservername* Automatically enable |clientserver|
Bram Moolenaara2a80162017-11-21 23:09:50 +0100325m *+balloon_eval* |balloon-eval| support in the GUI. Included when
326 compiling with supported GUI (Motif, GTK, GUI) and
327 either Netbeans/Sun Workshop integration or |+eval|
328 feature.
329H *+balloon_eval_term* |balloon-eval| support in the terminal,
330 'balloonevalterm'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000331N *+browse* |:browse| command
332N *+builtin_terms* some terminals builtin |builtin-terms|
333B *++builtin_terms* maximal terminals builtin |builtin-terms|
334N *+byte_offset* support for 'o' flag in 'statusline' option, "go"
335 and ":goto" commands.
Bram Moolenaar298b4402016-01-28 22:38:53 +0100336m *+channel* inter process communication |channel|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000337N *+cindent* |'cindent'|, C indenting
338N *+clientserver* Unix and Win32: Remote invocation |clientserver|
339 *+clipboard* |clipboard| support
340N *+cmdline_compl* command line completion |cmdline-completion|
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200341S *+cmdline_hist* command line history |cmdline-history|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000342N *+cmdline_info* |'showcmd'| and |'ruler'|
343N *+comments* |'comments'| support
Bram Moolenaarca8c9862010-07-24 15:00:38 +0200344B *+conceal* "conceal" support, see |conceal| |:syn-conceal| etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345N *+cryptv* encryption support |encryption|
346B *+cscope* |cscope| support
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100347T *+cursorbind* |'cursorbind'| support
Bram Moolenaarac6e65f2005-08-29 22:25:38 +0000348m *+cursorshape* |termcap-cursor-shape| support
349m *+debug* Compiled for debugging.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350N *+dialog_gui* Support for |:confirm| with GUI dialog.
351N *+dialog_con* Support for |:confirm| with console dialog.
352N *+dialog_con_gui* Support for |:confirm| with GUI and console dialog.
353N *+diff* |vimdiff| and 'diff'
354N *+digraphs* |digraphs| *E196*
Bram Moolenaar43cb6262018-03-14 21:39:02 +0100355 *+directx* Win32 GUI only: DirectX and |'renderoptions'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000356 *+dnd* Support for DnD into the "~ register |quote_~|.
357B *+emacs_tags* |emacs-tags| files
358N *+eval* expression evaluation |eval.txt|
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +0100359N *+ex_extra* always on now, used to be for Vim's extra Ex commands
Bram Moolenaar071d4272004-06-13 20:20:40 +0000360N *+extra_search* |'hlsearch'| and |'incsearch'| options.
361B *+farsi* |farsi| language
362N *+file_in_path* |gf|, |CTRL-W_f| and |<cfile>|
363N *+find_in_path* include file searches: |[I|, |:isearch|,
364 |CTRL-W_CTRL-I|, |:checkpath|, etc.
365N *+folding* |folding|
366 *+footer* |gui-footer|
367 *+fork* Unix only: |fork| shell commands
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000368 *+float* Floating point support
Bram Moolenaar071d4272004-06-13 20:20:40 +0000369N *+gettext* message translations |multi-lang|
370 *+GUI_Athena* Unix only: Athena |GUI|
371 *+GUI_neXtaw* Unix only: neXtaw |GUI|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000372 *+GUI_GTK* Unix only: GTK+ |GUI|
373 *+GUI_Motif* Unix only: Motif |GUI|
374 *+GUI_Photon* QNX only: Photon |GUI|
375m *+hangul_input* Hangul input support |hangul|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000376 *+iconv* Compiled with the |iconv()| function
377 *+iconv/dyn* Likewise |iconv-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000378N *+insert_expand* |insert_expand| Insert mode completion
Bram Moolenaar38a55632016-02-15 22:07:32 +0100379m *+job* starting and stopping jobs |job|
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200380S *+jumplist* |jumplist|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000381B *+keymap* |'keymap'|
Bram Moolenaarbc8801c2016-08-02 21:04:33 +0200382N *+lambda* |lambda| and |closure|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000383B *+langmap* |'langmap'|
384N *+libcall* |libcall()|
385N *+linebreak* |'linebreak'|, |'breakat'| and |'showbreak'|
386N *+lispindent* |'lisp'|
Bram Moolenaar0c72fe42018-03-29 16:04:08 +0200387T *+listcmds* Vim commands for the list of buffers |buffer-hidden|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000388 and argument list |:argdelete|
389N *+localmap* Support for mappings local to a buffer |:map-local|
Bram Moolenaar0ba04292010-07-14 23:23:17 +0200390m *+lua* |Lua| interface
391m *+lua/dyn* |Lua| interface |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000392N *+menu* |:menu|
393N *+mksession* |:mksession|
394N *+modify_fname* |filename-modifiers|
395N *+mouse* Mouse handling |mouse-using|
396N *+mouseshape* |'mouseshape'|
397B *+mouse_dec* Unix only: Dec terminal mouse handling |dec-mouse|
398N *+mouse_gpm* Unix only: Linux console mouse handling |gpm-mouse|
Bram Moolenaar13600302014-05-22 18:26:40 +0200399N *+mouse_jsbterm* JSB mouse handling |jsbterm-mouse|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000400B *+mouse_netterm* Unix only: netterm mouse handling |netterm-mouse|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100401N *+mouse_pterm* QNX only: pterm mouse handling |qnx-terminal|
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000402N *+mouse_sysmouse* Unix only: *BSD console mouse handling |sysmouse|
Bram Moolenaar9b451252012-08-15 17:43:31 +0200403B *+mouse_sgr* Unix only: sgr mouse handling |sgr-mouse|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100404B *+mouse_urxvt* Unix only: urxvt mouse handling |urxvt-mouse|
405N *+mouse_xterm* Unix only: xterm mouse handling |xterm-mouse|
Bram Moolenaare6ae6222013-05-21 21:01:10 +0200406N *+multi_byte* 16 and 32 bit characters |multibyte|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000407 *+multi_byte_ime* Win32 input method for multibyte chars |multibyte-ime|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100408N *+multi_lang* non-English language support |multi-lang|
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000409m *+mzscheme* Mzscheme interface |mzscheme|
Bram Moolenaar4770d092006-01-12 23:22:24 +0000410m *+mzscheme/dyn* Mzscheme interface |mzscheme-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000411m *+netbeans_intg* |netbeans|
Bram Moolenaar22fcfad2016-07-01 18:17:26 +0200412 *+num64* 64-bit Number support |Number|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100413m *+ole* Win32 GUI only: |ole-interface|
Bram Moolenaar91c49372016-05-08 09:50:29 +0200414N *+packages* Loading |packages|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100415N *+path_extra* Up/downwards search in 'path' and 'tags'
Bram Moolenaara5792f52005-11-23 21:25:05 +0000416m *+perl* Perl interface |perl|
417m *+perl/dyn* Perl interface |perl-dynamic| |/dyn|
Bram Moolenaar7fc0c062010-08-10 21:43:35 +0200418N *+persistent_undo* Persistent undo |undo-persistence|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100419 *+postscript* |:hardcopy| writes a PostScript file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000420N *+printer* |:hardcopy| command
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000421H *+profile* |:profile| command
Bram Moolenaar60aad972010-07-21 20:36:22 +0200422m *+python* Python 2 interface |python|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100423m *+python/dyn* Python 2 interface |python-dynamic| |/dyn|
Bram Moolenaar60aad972010-07-21 20:36:22 +0200424m *+python3* Python 3 interface |python|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100425m *+python3/dyn* Python 3 interface |python-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000426N *+quickfix* |:make| and |quickfix| commands
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000427N *+reltime* |reltime()| function, 'hlsearch'/'incsearch' timeout,
428 'redrawtime' option
Bram Moolenaar071d4272004-06-13 20:20:40 +0000429B *+rightleft* Right to left typing |'rightleft'|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000430m *+ruby* Ruby interface |ruby|
431m *+ruby/dyn* Ruby interface |ruby-dynamic| |/dyn|
Bram Moolenaar98ef2332018-03-18 14:44:37 +0100432T *+scrollbind* |'scrollbind'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000433B *+signs* |:sign|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100434N *+smartindent* |'smartindent'|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100435N *+startuptime* |--startuptime| argument
436N *+statusline* Options 'statusline', 'rulerformat' and special
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437 formats of 'titlestring' and 'iconstring'
438m *+sun_workshop* |workshop|
439N *+syntax* Syntax highlighting |syntax|
440 *+system()* Unix only: opposite of |+fork|
Bram Moolenaar64d8e252016-09-06 22:12:34 +0200441T *+tag_binary* binary searching in tags file |tag-binary-search|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000442N *+tag_old_static* old method for static tags |tag-old-static|
443m *+tag_any_white* any white space allowed in tags file |tag-any-white|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100444m *+tcl* Tcl interface |tcl|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000445m *+tcl/dyn* Tcl interface |tcl-dynamic| |/dyn|
Bram Moolenaar1ccd8ff2017-08-11 19:50:37 +0200446m *+terminal* Support for terminal window |terminal|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000447 *+terminfo* uses |terminfo| instead of termcap
448N *+termresponse* support for |t_RV| and |v:termresponse|
Bram Moolenaar61be73b2016-04-29 22:59:22 +0200449B *+termguicolors* 24-bit color in xterm-compatible terminals support
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100450N *+textobjects* |text-objects| selection
Bram Moolenaar071d4272004-06-13 20:20:40 +0000451 *+tgetent* non-Unix only: able to use external termcap
Bram Moolenaare18c0b32016-03-20 21:08:34 +0100452N *+timers* the |timer_start()| function
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000453N *+title* Setting the window 'title' and 'icon'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000454N *+toolbar* |gui-toolbar|
455N *+user_commands* User-defined commands. |user-commands|
456N *+viminfo* |'viminfo'|
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200457 *+vertsplit* Vertically split windows |:vsplit|; Always enabled
458 since 8.0.1118.
459 in sync with the |+windows| feature
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100460N *+virtualedit* |'virtualedit'|
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +0100461S *+visual* Visual mode |Visual-mode| Always enabled since 7.4.200.
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100462N *+visualextra* extra Visual mode commands |blockwise-operators|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000463N *+vreplace* |gR| and |gr|
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +0100464 *+vtp* on MS-Windows console: support for 'termguicolors'
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100465N *+wildignore* |'wildignore'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000466N *+wildmenu* |'wildmenu'|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +0100467 *+windows* more than one window; Always enabled since 8.0.1118.
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100468m *+writebackup* |'writebackup'| is default on
469m *+xim* X input method |xim|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000470 *+xfontset* X fontset support |xfontset|
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200471 *+xpm* pixmap support
Bram Moolenaar9b451252012-08-15 17:43:31 +0200472m *+xpm_w32* Win32 GUI only: pixmap support |w32-xpm-support|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000473 *+xsmp* XSMP (X session management) support
474 *+xsmp_interact* interactive XSMP (X session management) support
475N *+xterm_clipboard* Unix only: xterm clipboard handling
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100476m *+xterm_save* save and restore xterm screen |xterm-screens|
477N *+X11* Unix only: can restore window title |X11|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000478
479 */dyn* *E370* *E448*
480 To some of the features "/dyn" is added when the
481 feature is only available when the related library can
482 be dynamically loaded.
483
484:ve[rsion] {nr} Is now ignored. This was previously used to check the
485 version number of a .vimrc file. It was removed,
486 because you can now use the ":if" command for
487 version-dependent behavior. {not in Vi}
488
489 *:redi* *:redir*
490:redi[r][!] > {file} Redirect messages to file {file}. The messages which
491 are the output of commands are written to that file,
492 until redirection ends. The messages are also still
493 shown on the screen. When [!] is included, an
494 existing file is overwritten. When [!] is omitted,
495 and {file} exists, this command fails.
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200496
Bram Moolenaar071d4272004-06-13 20:20:40 +0000497 Only one ":redir" can be active at a time. Calls to
498 ":redir" will close any active redirection before
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200499 starting redirection to the new target. For recursive
500 use check out |execute()|.
501
Bram Moolenaar071d4272004-06-13 20:20:40 +0000502 To stop the messages and commands from being echoed to
503 the screen, put the commands in a function and call it
504 with ":silent call Function()".
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000505 An alternative is to use the 'verbosefile' option,
506 this can be used in combination with ":redir".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000507 {not in Vi}
508
509:redi[r] >> {file} Redirect messages to file {file}. Append if {file}
510 already exists. {not in Vi}
511
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000512:redi[r] @{a-zA-Z}
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +0000513:redi[r] @{a-zA-Z}> Redirect messages to register {a-z}. Append to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000514 contents of the register if its name is given
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000515 uppercase {A-Z}. The ">" after the register name is
516 optional. {not in Vi}
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +0000517:redi[r] @{a-z}>> Append messages to register {a-z}. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000518
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000519:redi[r] @*>
520:redi[r] @+> Redirect messages to the selection or clipboard. For
521 backward compatibility, the ">" after the register
522 name can be omitted. See |quotestar| and |quoteplus|.
523 {not in Vi}
524:redi[r] @*>>
525:redi[r] @+>> Append messages to the selection or clipboard.
526 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +0000528:redi[r] @"> Redirect messages to the unnamed register. For
529 backward compatibility, the ">" after the register
530 name can be omitted. {not in Vi}
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +0000531:redi[r] @">> Append messages to the unnamed register. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000532
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000533:redi[r] => {var} Redirect messages to a variable. If the variable
534 doesn't exist, then it is created. If the variable
535 exists, then it is initialized to an empty string.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000536 The variable will remain empty until redirection ends.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000537 Only string variables can be used. After the
538 redirection starts, if the variable is removed or
539 locked or the variable type is changed, then further
540 command output messages will cause errors. {not in Vi}
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200541 To get the output of one command the |execute()|
542 function can be used.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000543
544:redi[r] =>> {var} Append messages to an existing variable. Only string
545 variables can be used. {not in Vi}
546
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547:redi[r] END End redirecting messages. {not in Vi}
548
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200549 *:filt* *:filter*
Bram Moolenaar214641f2017-03-05 17:04:09 +0100550:filt[er][!] {pat} {command}
551:filt[er][!] /{pat}/ {command}
552 Restrict the output of {command} to lines matching
553 with {pat}. For example, to list only xml files: >
Bram Moolenaar818078d2016-08-27 21:58:42 +0200554 :filter /\.xml$/ oldfiles
Bram Moolenaar214641f2017-03-05 17:04:09 +0100555< If the [!] is given, restrict the output of {command}
556 to lines that do NOT match {pat}.
557
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200558 {pat} is a Vim search pattern. Instead of enclosing
559 it in / any non-ID character (see |'isident'|) can be
560 used, so long as it does not appear in {pat}. Without
561 the enclosing character the pattern cannot include the
562 bar character.
563
564 The pattern is matched against the relevant part of
565 the output, not necessarily the whole line. Only some
566 commands support filtering, try it out to check if it
567 works.
568
569 Only normal messages are filtered, error messages are
570 not.
571
Bram Moolenaare0fa3742016-02-20 15:47:01 +0100572 *:sil* *:silent* *:silent!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573:sil[ent][!] {command} Execute {command} silently. Normal messages will not
574 be given or added to the message history.
575 When [!] is added, error messages will also be
576 skipped, and commands and mappings will not be aborted
577 when an error is detected. |v:errmsg| is still set.
578 When [!] is not used, an error message will cause
579 further messages to be displayed normally.
580 Redirection, started with |:redir|, will continue as
581 usual, although there might be small differences.
582 This will allow redirecting the output of a command
583 without seeing it on the screen. Example: >
584 :redir >/tmp/foobar
585 :silent g/Aap/p
586 :redir END
587< To execute a Normal mode command silently, use the
588 |:normal| command. For example, to search for a
589 string without messages: >
590 :silent exe "normal /path\<CR>"
591< ":silent!" is useful to execute a command that may
592 fail, but the failure is to be ignored. Example: >
593 :let v:errmsg = ""
594 :silent! /^begin
595 :if v:errmsg != ""
596 : ... pattern was not found
597< ":silent" will also avoid the hit-enter prompt. When
598 using this for an external command, this may cause the
599 screen to be messed up. Use |CTRL-L| to clean it up
600 then.
601 ":silent menu ..." defines a menu that will not echo a
602 Command-line command. The command will still produce
603 messages though. Use ":silent" in the command itself
604 to avoid that: ":silent menu .... :silent command".
605
Bram Moolenaar8e258a42009-07-09 13:55:43 +0000606 *:uns* *:unsilent*
607:uns[ilent] {command} Execute {command} not silently. Only makes a
608 difference when |:silent| was used to get to this
609 command.
610 Use this for giving a message even when |:silent| was
611 used. In this example |:silent| is used to avoid the
612 message about reading the file and |:unsilent| to be
613 able to list the first line of each file. >
614 :silent argdo unsilent echo expand('%') . ": " . getline(1)
615<
616
Bram Moolenaar071d4272004-06-13 20:20:40 +0000617 *:verb* *:verbose*
618:[count]verb[ose] {command}
619 Execute {command} with 'verbose' set to [count]. If
Bram Moolenaared203462004-06-16 11:19:22 +0000620 [count] is omitted one is used. ":0verbose" can be
621 used to set 'verbose' to zero.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622 The additional use of ":silent" makes messages
623 generated but not displayed.
624 The combination of ":silent" and ":verbose" can be
625 used to generate messages and check them with
626 |v:statusmsg| and friends. For example: >
627 :let v:statusmsg = ""
628 :silent verbose runtime foobar.vim
629 :if v:statusmsg != ""
630 : " foobar.vim could not be found
631 :endif
632< When concatenating another command, the ":verbose"
633 only applies to the first one: >
634 :4verbose set verbose | set verbose
635< verbose=4 ~
636 verbose=0 ~
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000637 For logging verbose messages in a file use the
638 'verbosefile' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000639
Bram Moolenaar8aff23a2005-08-19 20:40:30 +0000640 *:verbose-cmd*
641When 'verbose' is non-zero, listing the value of a Vim option or a key map or
Bram Moolenaare344bea2005-09-01 20:46:49 +0000642an abbreviation or a user-defined function or a command or a highlight group
643or an autocommand will also display where it was last defined. If it was
644defined manually then there will be no "Last set" message. When it was
645defined while executing a function, user command or autocommand, the script in
646which it was defined is reported.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200647{not available when compiled without the |+eval| feature}
Bram Moolenaar8aff23a2005-08-19 20:40:30 +0000648
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649 *K*
650K Run a program to lookup the keyword under the
651 cursor. The name of the program is given with the
652 'keywordprg' (kp) option (default is "man"). The
653 keyword is formed of letters, numbers and the
654 characters in 'iskeyword'. The keyword under or
655 right of the cursor is used. The same can be done
656 with the command >
657 :!{program} {keyword}
658< There is an example of a program to use in the tools
Bram Moolenaar214641f2017-03-05 17:04:09 +0100659 directory of Vim. It is called "ref" and does a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000660 simple spelling check.
661 Special cases:
Bram Moolenaar26852122016-05-24 20:02:38 +0200662 - If 'keywordprg' begins with ":" it is invoked as
663 a Vim Ex command with [count].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000664 - If 'keywordprg' is empty, the ":help" command is
665 used. It's a good idea to include more characters
666 in 'iskeyword' then, to be able to find more help.
Bram Moolenaar26852122016-05-24 20:02:38 +0200667 - When 'keywordprg' is equal to "man" or starts with
668 ":", a [count] before "K" is inserted after
669 keywordprg and before the keyword. For example,
670 using "2K" while the cursor is on "mkdir", results
671 in: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000672 !man 2 mkdir
673< - When 'keywordprg' is equal to "man -s", a count
674 before "K" is inserted after the "-s". If there is
675 no count, the "-s" is removed.
676 {not in Vi}
677
678 *v_K*
679{Visual}K Like "K", but use the visually highlighted text for
680 the keyword. Only works when the highlighted text is
681 not more than one line. {not in Vi}
682
683[N]gs *gs* *:sl* *:sleep*
684:[N]sl[eep] [N] [m] Do nothing for [N] seconds. When [m] is included,
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000685 sleep for [N] milliseconds. The count for "gs" always
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686 uses seconds. The default is one second. >
687 :sleep "sleep for one second
688 :5sleep "sleep for five seconds
689 :sleep 100m "sleep for a hundred milliseconds
690 10gs "sleep for ten seconds
691< Can be interrupted with CTRL-C (CTRL-Break on MS-DOS).
Bram Moolenaar677ee682005-01-27 14:41:15 +0000692 "gs" stands for "goto sleep".
693 While sleeping the cursor is positioned in the text,
694 if at a visible position. {not in Vi}
Bram Moolenaar15146672011-10-20 22:22:38 +0200695 Also process the received netbeans messages. {only
696 available when compiled with the |+netbeans_intg|
697 feature}
698
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699
700 *g_CTRL-A*
701g CTRL-A Only when Vim was compiled with MEM_PROFILING defined
702 (which is very rare): print memory usage statistics.
703 Only useful for debugging Vim.
Bram Moolenaar345efa02016-01-15 20:57:49 +0100704 For incrementing in Visual mode see |v_g_CTRL-A|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705
706==============================================================================
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +02007072. Using Vim like less or more *less*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708
709If you use the less or more program to view a file, you don't get syntax
710highlighting. Thus you would like to use Vim instead. You can do this by
711using the shell script "$VIMRUNTIME/macros/less.sh".
712
713This shell script uses the Vim script "$VIMRUNTIME/macros/less.vim". It sets
714up mappings to simulate the commands that less supports. Otherwise, you can
715still use the Vim commands.
716
717This isn't perfect. For example, when viewing a short file Vim will still use
718the whole screen. But it works good enough for most uses, and you get syntax
719highlighting.
720
721The "h" key will give you a short overview of the available commands.
722
Bram Moolenaare392eb42015-11-19 20:38:09 +0100723If you want to set options differently when using less, define the
724LessInitFunc in your vimrc, for example: >
725
726 func LessInitFunc()
727 set nocursorcolumn nocursorline
728 endfunc
729<
730
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731 vim:tw=78:ts=8:ft=help:norl: