blob: 8b4f988ee9ec1583c1a6dd1e312846fe7afdcb54 [file] [log] [blame]
Bram Moolenaar63b74a82019-03-24 15:09:13 +01001*various.txt* For Vim version 8.1. Last change: 2019 Mar 23
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
Bram Moolenaare12bab32019-01-08 22:02:56 +010033 *:redrawt* *:redrawtabline*
34:redrawt[abline] Redraw the tabline. Useful to update the tabline when
35 'tabline' includes an item that doesn't trigger
36 automatic updating.
37
Bram Moolenaar071d4272004-06-13 20:20:40 +000038 *N<Del>*
39<Del> When entering a number: Remove the last digit.
40 Note: if you like to use <BS> for this, add this
41 mapping to your .vimrc: >
42 :map CTRL-V <BS> CTRL-V <Del>
43< See |:fixdel| if your <Del> key does not do what you
44 want.
45
46:as[cii] or *ga* *:as* *:ascii*
47ga Print the ascii value of the character under the
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010048 cursor in decimal, hexadecimal and octal.
49 Mnemonic: Get Ascii value.
50
51 For example, when the cursor is on a 'R':
Bram Moolenaar071d4272004-06-13 20:20:40 +000052 <R> 82, Hex 52, Octal 122 ~
53 When the character is a non-standard ASCII character,
54 but printable according to the 'isprint' option, the
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010055 non-printable version is also given.
56
57 When the character is larger than 127, the <M-x> form
58 is also printed. For example:
Bram Moolenaar071d4272004-06-13 20:20:40 +000059 <~A> <M-^A> 129, Hex 81, Octal 201 ~
60 <p> <|~> <M-~> 254, Hex fe, Octal 376 ~
61 (where <p> is a special character)
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010062
Bram Moolenaar071d4272004-06-13 20:20:40 +000063 The <Nul> character in a file is stored internally as
64 <NL>, but it will be shown as:
65 <^@> 0, Hex 00, Octal 000 ~
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010066
Bram Moolenaar362e1a32006-03-06 23:29:24 +000067 If the character has composing characters these are
68 also shown. The value of 'maxcombine' doesn't matter.
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010069
70 If the character can be inserted as a digraph, also
71 output the two characters that can be used to create
72 the character:
73 <ö> 246, Hex 00f6, Oct 366, Digr o: ~
74 This shows you can type CTRL-K o : to insert ö.
75
76 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +000077
78 *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 Moolenaar4c92e752019-02-17 21:18:32 +010085 {not in Vi}
Bram Moolenaarca003e12006-03-17 23:19:38 +000086
87 *8g8*
888g8 Find an illegal UTF-8 byte sequence at or after the
89 cursor. This works in two situations:
90 1. when 'encoding' is any 8-bit encoding
91 2. when 'encoding' is "utf-8" and 'fileencoding' is
92 any 8-bit encoding
93 Thus it can be used when editing a file that was
94 supposed to be UTF-8 but was read as if it is an 8-bit
95 encoding because it contains illegal bytes.
96 Does not wrap around the end of the file.
97 Note that when the cursor is on an illegal byte or the
98 cursor is halfway a multi-byte character the command
99 won't move the cursor.
Bram Moolenaar4c92e752019-02-17 21:18:32 +0100100 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000102 *:p* *:pr* *:print* *E749*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000103:[range]p[rint] [flags]
104 Print [range] lines (default current line).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000105 Note: If you are looking for a way to print your text
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000106 on paper see |:hardcopy|. In the GUI you can use the
107 File.Print menu entry.
108 See |ex-flags| for [flags].
Bram Moolenaar818078d2016-08-27 21:58:42 +0200109 The |:filter| command can be used to only show lines
110 matching a pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000111
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000112:[range]p[rint] {count} [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000113 Print {count} lines, starting with [range] (default
114 current line |cmdline-ranges|).
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000115 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000116
117 *:P* *:Print*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000118:[range]P[rint] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000119 Just as ":print". Was apparently added to Vi for
120 people that keep the shift key pressed too long...
Bram Moolenaar166af9b2010-11-16 20:34:40 +0100121 Note: A user command can overrule this command.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000122 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000123
124 *:l* *:list*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000125:[range]l[ist] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000126 Same as :print, but display unprintable characters
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +0200127 with '^' and put $ after the line. This can be
Bram Moolenaard58e9292011-02-09 17:07:58 +0100128 further changed with the 'listchars' option.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000129 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130
131 *:nu* *:number*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000132:[range]nu[mber] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000133 Same as :print, but precede each line with its line
Bram Moolenaarfaa959a2006-02-20 21:37:40 +0000134 number. (See also 'highlight' and 'numberwidth'
135 option).
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000136 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000137
138 *:#*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000139:[range]# [count] [flags]
140 synonym for :number.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000141
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000142 *:#!*
143:#!{anything} Ignored, so that you can start a Vim script with: >
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000144 #!vim -S
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000145 echo "this is a Vim script"
146 quit
147<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148 *:z* *E144*
149:{range}z[+-^.=]{count} Display several lines of text surrounding the line
150 specified with {range}, or around the current line
151 if there is no {range}. If there is a {count}, that's
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000152 how many lines you'll see; if there is only one window
Bram Moolenaar662db672011-03-22 14:05:35 +0100153 then twice the value of the 'scroll' option is used,
154 otherwise the current window height minus 3 is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000155
Bram Moolenaarb6b046b2011-12-30 13:11:27 +0100156 If there is a {count} the 'window' option is set to
157 its value.
158
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159 :z can be used either alone or followed by any of
160 several punctuation marks. These have the following
161 effect:
162
Bram Moolenaar662db672011-03-22 14:05:35 +0100163 mark first line last line new cursor line ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000164 ---- ---------- --------- ------------
165 + current line 1 scr forward 1 scr forward
166 - 1 scr back current line current line
167 ^ 2 scr back 1 scr back 1 scr back
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +0000168 . 1/2 scr back 1/2 scr fwd 1/2 scr fwd
169 = 1/2 scr back 1/2 scr fwd current line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000170
171 Specifying no mark at all is the same as "+".
172 If the mark is "=", a line of dashes is printed
173 around the current line.
174
175:{range}z#[+-^.=]{count} *:z#*
176 Like ":z", but number the lines.
177 {not in all versions of Vi, not with these arguments}
178
179 *:=*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000180:= [flags] Print the last line number.
181 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000182
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000183:{range}= [flags] Prints the last line number in {range}. For example,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000184 this prints the current line number: >
185 :.=
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000186< See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000187
188:norm[al][!] {commands} *:norm* *:normal*
189 Execute Normal mode commands {commands}. This makes
190 it possible to execute Normal mode commands typed on
Bram Moolenaar4a748032010-09-30 21:47:56 +0200191 the command-line. {commands} are executed like they
192 are typed. For undo all commands are undone together.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000193 Execution stops when an error is encountered.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100194
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195 If the [!] is given, mappings will not be used.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100196 Without it, when this command is called from a
197 non-remappable mapping (|:noremap|), the argument can
198 be mapped anyway.
199
Bram Moolenaar071d4272004-06-13 20:20:40 +0000200 {commands} should be a complete command. If
201 {commands} does not finish a command, the last one
202 will be aborted as if <Esc> or <C-C> was typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000203 This implies that an insert command must be completed
204 (to start Insert mode, see |:startinsert|). A ":"
Bram Moolenaar7c626922005-02-07 22:01:03 +0000205 command must be completed as well. And you can't use
206 "Q" or "gQ" to start Ex mode.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100207
208 The display is not updated while ":normal" is busy.
209
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100210 {commands} cannot start with a space. Put a count of
211 1 (one) before it, "1 " is one space.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100212
Bram Moolenaar071d4272004-06-13 20:20:40 +0000213 The 'insertmode' option is ignored for {commands}.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100214
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215 This command cannot be followed by another command,
216 since any '|' is considered part of the command.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100217
Bram Moolenaar071d4272004-06-13 20:20:40 +0000218 This command can be used recursively, but the depth is
219 limited by 'maxmapdepth'.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100220
Bram Moolenaar071d4272004-06-13 20:20:40 +0000221 An alternative is to use |:execute|, which uses an
222 expression as argument. This allows the use of
Bram Moolenaar46f9d492010-06-12 20:18:19 +0200223 printable characters to represent special characters.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100224
Bram Moolenaar46f9d492010-06-12 20:18:19 +0200225 Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226 :exe "normal \<c-w>\<c-w>"
227< {not in Vi, of course}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000228
229:{range}norm[al][!] {commands} *:normal-range*
230 Execute Normal mode commands {commands} for each line
231 in the {range}. Before executing the {commands}, the
232 cursor is positioned in the first column of the range,
233 for each line. Otherwise it's the same as the
234 ":normal" command without a range.
235 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000236
237 *:sh* *:shell* *E371*
238:sh[ell] This command starts a shell. When the shell exits
239 (after the "exit" command) you return to Vim. The
240 name for the shell command comes from 'shell' option.
241 *E360*
242 Note: This doesn't work when Vim on the Amiga was
243 started in QuickFix mode from a compiler, because the
244 compiler will have set stdin to a non-interactive
245 mode.
246
247 *:!cmd* *:!* *E34*
248:!{cmd} Execute {cmd} with the shell. See also the 'shell'
249 and 'shelltype' option.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200250
Bram Moolenaar071d4272004-06-13 20:20:40 +0000251 Any '!' in {cmd} is replaced with the previous
252 external command (see also 'cpoptions'). But not when
253 there is a backslash before the '!', then that
254 backslash is removed. Example: ":!ls" followed by
255 ":!echo ! \! \\!" executes "echo ls ! \!".
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200256
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000257 A '|' in {cmd} is passed to the shell, you cannot use
258 it to append a Vim command. See |:bar|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200259
260 If {cmd} contains "%" it is expanded to the current
261 file name. Special characters are not escaped, use
262 quotes to avoid their special meaning: >
263 :!ls "%"
264< If the file name contains a "$" single quotes might
265 work better (but a single quote causes trouble): >
266 :!ls '%'
267< This should always work, but it's more typing: >
268 :exe "!ls " . shellescape(expand("%"))
269<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270 A newline character ends {cmd}, what follows is
271 interpreted as a following ":" command. However, if
272 there is a backslash before the newline it is removed
273 and {cmd} continues. It doesn't matter how many
274 backslashes are before the newline, only one is
275 removed.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200276
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277 On Unix the command normally runs in a non-interactive
278 shell. If you want an interactive shell to be used
279 (to use aliases) set 'shellcmdflag' to "-ic".
280 For Win32 also see |:!start|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200281
Bram Moolenaare968e362014-05-13 20:23:24 +0200282 After the command has been executed, the timestamp and
283 size of the current file is checked |timestamp|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200284
Bram Moolenaar071d4272004-06-13 20:20:40 +0000285 Vim redraws the screen after the command is finished,
286 because it may have printed any text. This requires a
287 hit-enter prompt, so that you can read any messages.
288 To avoid this use: >
289 :silent !{cmd}
290< The screen is not redrawn then, thus you have to use
291 CTRL-L or ":redraw!" if the command did display
292 something.
293 Also see |shell-window|.
294
295 *:!!*
296:!! Repeat last ":!{cmd}".
297
298 *:ve* *:version*
299:ve[rsion] Print the version number of the editor. If the
300 compiler used understands "__DATE__" the compilation
301 date is mentioned. Otherwise a fixed release-date is
302 shown.
303 The following lines contain information about which
304 features were enabled when Vim was compiled. When
305 there is a preceding '+', the feature is included,
306 when there is a '-' it is excluded. To change this,
307 you have to edit feature.h and recompile Vim.
308 To check for this in an expression, see |has()|.
309 Here is an overview of the features.
310 The first column shows the smallest version in which
311 they are included:
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100312 T tiny (always)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000313 S small
314 N normal
315 B big
316 H huge
317 m manually enabled or depends on other features
318 (none) system dependent
319 Thus if a feature is marked with "N", it is included
320 in the normal, big and huge versions of Vim.
321
322 *+feature-list*
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200323 *+acl* |ACL| support included
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324 *+ARP* Amiga only: ARP support included
325B *+arabic* |Arabic| language support
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100326T *+autocmd* |:autocmd|, automatic commands
Bram Moolenaare42a6d22017-11-12 19:21:51 +0100327H *+autoservername* Automatically enable |clientserver|
Bram Moolenaara2a80162017-11-21 23:09:50 +0100328m *+balloon_eval* |balloon-eval| support in the GUI. Included when
329 compiling with supported GUI (Motif, GTK, GUI) and
330 either Netbeans/Sun Workshop integration or |+eval|
331 feature.
332H *+balloon_eval_term* |balloon-eval| support in the terminal,
333 'balloonevalterm'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000334N *+browse* |:browse| command
335N *+builtin_terms* some terminals builtin |builtin-terms|
336B *++builtin_terms* maximal terminals builtin |builtin-terms|
337N *+byte_offset* support for 'o' flag in 'statusline' option, "go"
338 and ":goto" commands.
Bram Moolenaar298b4402016-01-28 22:38:53 +0100339m *+channel* inter process communication |channel|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000340N *+cindent* |'cindent'|, C indenting
341N *+clientserver* Unix and Win32: Remote invocation |clientserver|
342 *+clipboard* |clipboard| support
343N *+cmdline_compl* command line completion |cmdline-completion|
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200344S *+cmdline_hist* command line history |cmdline-history|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345N *+cmdline_info* |'showcmd'| and |'ruler'|
346N *+comments* |'comments'| support
Bram Moolenaarca8c9862010-07-24 15:00:38 +0200347B *+conceal* "conceal" support, see |conceal| |:syn-conceal| etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000348N *+cryptv* encryption support |encryption|
349B *+cscope* |cscope| support
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100350T *+cursorbind* |'cursorbind'| support
Bram Moolenaarac6e65f2005-08-29 22:25:38 +0000351m *+cursorshape* |termcap-cursor-shape| support
352m *+debug* Compiled for debugging.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000353N *+dialog_gui* Support for |:confirm| with GUI dialog.
354N *+dialog_con* Support for |:confirm| with console dialog.
355N *+dialog_con_gui* Support for |:confirm| with GUI and console dialog.
356N *+diff* |vimdiff| and 'diff'
357N *+digraphs* |digraphs| *E196*
Bram Moolenaar43cb6262018-03-14 21:39:02 +0100358 *+directx* Win32 GUI only: DirectX and |'renderoptions'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359 *+dnd* Support for DnD into the "~ register |quote_~|.
360B *+emacs_tags* |emacs-tags| files
361N *+eval* expression evaluation |eval.txt|
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +0100362N *+ex_extra* always on now, used to be for Vim's extra Ex commands
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363N *+extra_search* |'hlsearch'| and |'incsearch'| options.
364B *+farsi* |farsi| language
365N *+file_in_path* |gf|, |CTRL-W_f| and |<cfile>|
366N *+find_in_path* include file searches: |[I|, |:isearch|,
367 |CTRL-W_CTRL-I|, |:checkpath|, etc.
368N *+folding* |folding|
369 *+footer* |gui-footer|
370 *+fork* Unix only: |fork| shell commands
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000371 *+float* Floating point support
Bram Moolenaar071d4272004-06-13 20:20:40 +0000372N *+gettext* message translations |multi-lang|
373 *+GUI_Athena* Unix only: Athena |GUI|
374 *+GUI_neXtaw* Unix only: neXtaw |GUI|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000375 *+GUI_GTK* Unix only: GTK+ |GUI|
376 *+GUI_Motif* Unix only: Motif |GUI|
377 *+GUI_Photon* QNX only: Photon |GUI|
378m *+hangul_input* Hangul input support |hangul|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000379 *+iconv* Compiled with the |iconv()| function
380 *+iconv/dyn* Likewise |iconv-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000381N *+insert_expand* |insert_expand| Insert mode completion
Bram Moolenaar38a55632016-02-15 22:07:32 +0100382m *+job* starting and stopping jobs |job|
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200383S *+jumplist* |jumplist|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000384B *+keymap* |'keymap'|
Bram Moolenaarbc8801c2016-08-02 21:04:33 +0200385N *+lambda* |lambda| and |closure|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000386B *+langmap* |'langmap'|
387N *+libcall* |libcall()|
388N *+linebreak* |'linebreak'|, |'breakat'| and |'showbreak'|
389N *+lispindent* |'lisp'|
Bram Moolenaar0c72fe42018-03-29 16:04:08 +0200390T *+listcmds* Vim commands for the list of buffers |buffer-hidden|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000391 and argument list |:argdelete|
392N *+localmap* Support for mappings local to a buffer |:map-local|
Bram Moolenaar0ba04292010-07-14 23:23:17 +0200393m *+lua* |Lua| interface
394m *+lua/dyn* |Lua| interface |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000395N *+menu* |:menu|
396N *+mksession* |:mksession|
397N *+modify_fname* |filename-modifiers|
398N *+mouse* Mouse handling |mouse-using|
399N *+mouseshape* |'mouseshape'|
400B *+mouse_dec* Unix only: Dec terminal mouse handling |dec-mouse|
401N *+mouse_gpm* Unix only: Linux console mouse handling |gpm-mouse|
Bram Moolenaar13600302014-05-22 18:26:40 +0200402N *+mouse_jsbterm* JSB mouse handling |jsbterm-mouse|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000403B *+mouse_netterm* Unix only: netterm mouse handling |netterm-mouse|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100404N *+mouse_pterm* QNX only: pterm mouse handling |qnx-terminal|
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000405N *+mouse_sysmouse* Unix only: *BSD console mouse handling |sysmouse|
Bram Moolenaar9b451252012-08-15 17:43:31 +0200406B *+mouse_sgr* Unix only: sgr mouse handling |sgr-mouse|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100407B *+mouse_urxvt* Unix only: urxvt mouse handling |urxvt-mouse|
408N *+mouse_xterm* Unix only: xterm mouse handling |xterm-mouse|
Bram Moolenaare6ae6222013-05-21 21:01:10 +0200409N *+multi_byte* 16 and 32 bit characters |multibyte|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000410 *+multi_byte_ime* Win32 input method for multibyte chars |multibyte-ime|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100411N *+multi_lang* non-English language support |multi-lang|
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000412m *+mzscheme* Mzscheme interface |mzscheme|
Bram Moolenaar4770d092006-01-12 23:22:24 +0000413m *+mzscheme/dyn* Mzscheme interface |mzscheme-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000414m *+netbeans_intg* |netbeans|
Bram Moolenaar22fcfad2016-07-01 18:17:26 +0200415 *+num64* 64-bit Number support |Number|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100416m *+ole* Win32 GUI only: |ole-interface|
Bram Moolenaar91c49372016-05-08 09:50:29 +0200417N *+packages* Loading |packages|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100418N *+path_extra* Up/downwards search in 'path' and 'tags'
Bram Moolenaara5792f52005-11-23 21:25:05 +0000419m *+perl* Perl interface |perl|
420m *+perl/dyn* Perl interface |perl-dynamic| |/dyn|
Bram Moolenaar7fc0c062010-08-10 21:43:35 +0200421N *+persistent_undo* Persistent undo |undo-persistence|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100422 *+postscript* |:hardcopy| writes a PostScript file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000423N *+printer* |:hardcopy| command
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000424H *+profile* |:profile| command
Bram Moolenaar60aad972010-07-21 20:36:22 +0200425m *+python* Python 2 interface |python|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100426m *+python/dyn* Python 2 interface |python-dynamic| |/dyn|
Bram Moolenaar60aad972010-07-21 20:36:22 +0200427m *+python3* Python 3 interface |python|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100428m *+python3/dyn* Python 3 interface |python-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000429N *+quickfix* |:make| and |quickfix| commands
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000430N *+reltime* |reltime()| function, 'hlsearch'/'incsearch' timeout,
431 'redrawtime' option
Bram Moolenaar071d4272004-06-13 20:20:40 +0000432B *+rightleft* Right to left typing |'rightleft'|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000433m *+ruby* Ruby interface |ruby|
434m *+ruby/dyn* Ruby interface |ruby-dynamic| |/dyn|
Bram Moolenaar98ef2332018-03-18 14:44:37 +0100435T *+scrollbind* |'scrollbind'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000436B *+signs* |:sign|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100437N *+smartindent* |'smartindent'|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100438N *+startuptime* |--startuptime| argument
439N *+statusline* Options 'statusline', 'rulerformat' and special
Bram Moolenaar071d4272004-06-13 20:20:40 +0000440 formats of 'titlestring' and 'iconstring'
Bram Moolenaard09091d2019-01-17 16:07:22 +0100441m *+sun_workshop* |workshop|; no longer supported
Bram Moolenaar071d4272004-06-13 20:20:40 +0000442N *+syntax* Syntax highlighting |syntax|
443 *+system()* Unix only: opposite of |+fork|
Bram Moolenaar64d8e252016-09-06 22:12:34 +0200444T *+tag_binary* binary searching in tags file |tag-binary-search|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000445N *+tag_old_static* old method for static tags |tag-old-static|
Bram Moolenaar63b74a82019-03-24 15:09:13 +0100446m *+tag_any_white* Removed; was to allow any white space in tags files
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100447m *+tcl* Tcl interface |tcl|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000448m *+tcl/dyn* Tcl interface |tcl-dynamic| |/dyn|
Bram Moolenaar1ccd8ff2017-08-11 19:50:37 +0200449m *+terminal* Support for terminal window |terminal|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000450 *+terminfo* uses |terminfo| instead of termcap
451N *+termresponse* support for |t_RV| and |v:termresponse|
Bram Moolenaar61be73b2016-04-29 22:59:22 +0200452B *+termguicolors* 24-bit color in xterm-compatible terminals support
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100453N *+textobjects* |text-objects| selection
Bram Moolenaar9d87a372018-12-18 21:41:50 +0100454N *+textprop* |text-properties|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000455 *+tgetent* non-Unix only: able to use external termcap
Bram Moolenaare18c0b32016-03-20 21:08:34 +0100456N *+timers* the |timer_start()| function
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000457N *+title* Setting the window 'title' and 'icon'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000458N *+toolbar* |gui-toolbar|
Bram Moolenaarac9fb182019-04-27 13:04:13 +0200459T *+user_commands* User-defined commands. |user-commands|
460 Always enabled since 8.1.1210.
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200461B *+vartabs* Variable-width tabstops. |'vartabstop'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000462N *+viminfo* |'viminfo'|
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200463 *+vertsplit* Vertically split windows |:vsplit|; Always enabled
464 since 8.0.1118.
465 in sync with the |+windows| feature
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100466N *+virtualedit* |'virtualedit'|
Bram Moolenaar870ba5f2019-01-11 14:37:20 +0100467T *+visual* Visual mode |Visual-mode| Always enabled since 7.4.200.
468T *+visualextra* extra Visual mode commands |blockwise-operators|
Bram Moolenaar1f0bfe52018-07-29 16:09:22 +0200469T *+vreplace* |gR| and |gr|
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +0100470 *+vtp* on MS-Windows console: support for 'termguicolors'
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100471N *+wildignore* |'wildignore'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000472N *+wildmenu* |'wildmenu'|
Bram Moolenaar870ba5f2019-01-11 14:37:20 +0100473T *+windows* more than one window; Always enabled since 8.0.1118.
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100474m *+writebackup* |'writebackup'| is default on
475m *+xim* X input method |xim|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476 *+xfontset* X fontset support |xfontset|
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200477 *+xpm* pixmap support
Bram Moolenaar9b451252012-08-15 17:43:31 +0200478m *+xpm_w32* Win32 GUI only: pixmap support |w32-xpm-support|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479 *+xsmp* XSMP (X session management) support
480 *+xsmp_interact* interactive XSMP (X session management) support
481N *+xterm_clipboard* Unix only: xterm clipboard handling
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100482m *+xterm_save* save and restore xterm screen |xterm-screens|
483N *+X11* Unix only: can restore window title |X11|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000484
485 */dyn* *E370* *E448*
486 To some of the features "/dyn" is added when the
487 feature is only available when the related library can
488 be dynamically loaded.
489
490:ve[rsion] {nr} Is now ignored. This was previously used to check the
491 version number of a .vimrc file. It was removed,
492 because you can now use the ":if" command for
493 version-dependent behavior. {not in Vi}
494
495 *:redi* *:redir*
496:redi[r][!] > {file} Redirect messages to file {file}. The messages which
497 are the output of commands are written to that file,
498 until redirection ends. The messages are also still
499 shown on the screen. When [!] is included, an
500 existing file is overwritten. When [!] is omitted,
501 and {file} exists, this command fails.
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200502
Bram Moolenaar071d4272004-06-13 20:20:40 +0000503 Only one ":redir" can be active at a time. Calls to
504 ":redir" will close any active redirection before
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200505 starting redirection to the new target. For recursive
506 use check out |execute()|.
507
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508 To stop the messages and commands from being echoed to
509 the screen, put the commands in a function and call it
510 with ":silent call Function()".
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000511 An alternative is to use the 'verbosefile' option,
512 this can be used in combination with ":redir".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000513 {not in Vi}
514
515:redi[r] >> {file} Redirect messages to file {file}. Append if {file}
516 already exists. {not in Vi}
517
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000518:redi[r] @{a-zA-Z}
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +0000519:redi[r] @{a-zA-Z}> Redirect messages to register {a-z}. Append to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000520 contents of the register if its name is given
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000521 uppercase {A-Z}. The ">" after the register name is
522 optional. {not in Vi}
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +0000523:redi[r] @{a-z}>> Append messages to register {a-z}. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000524
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000525:redi[r] @*>
526:redi[r] @+> Redirect messages to the selection or clipboard. For
527 backward compatibility, the ">" after the register
528 name can be omitted. See |quotestar| and |quoteplus|.
529 {not in Vi}
530:redi[r] @*>>
531:redi[r] @+>> Append messages to the selection or clipboard.
532 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000533
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +0000534:redi[r] @"> Redirect messages to the unnamed register. For
535 backward compatibility, the ">" after the register
536 name can be omitted. {not in Vi}
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +0000537:redi[r] @">> Append messages to the unnamed register. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000538
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000539:redi[r] => {var} Redirect messages to a variable. If the variable
540 doesn't exist, then it is created. If the variable
541 exists, then it is initialized to an empty string.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000542 The variable will remain empty until redirection ends.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000543 Only string variables can be used. After the
544 redirection starts, if the variable is removed or
545 locked or the variable type is changed, then further
546 command output messages will cause errors. {not in Vi}
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200547 To get the output of one command the |execute()|
548 function can be used.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000549
550:redi[r] =>> {var} Append messages to an existing variable. Only string
551 variables can be used. {not in Vi}
552
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553:redi[r] END End redirecting messages. {not in Vi}
554
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200555 *:filt* *:filter*
Bram Moolenaar214641f2017-03-05 17:04:09 +0100556:filt[er][!] {pat} {command}
557:filt[er][!] /{pat}/ {command}
558 Restrict the output of {command} to lines matching
559 with {pat}. For example, to list only xml files: >
Bram Moolenaar818078d2016-08-27 21:58:42 +0200560 :filter /\.xml$/ oldfiles
Bram Moolenaar214641f2017-03-05 17:04:09 +0100561< If the [!] is given, restrict the output of {command}
562 to lines that do NOT match {pat}.
563
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200564 {pat} is a Vim search pattern. Instead of enclosing
565 it in / any non-ID character (see |'isident'|) can be
566 used, so long as it does not appear in {pat}. Without
567 the enclosing character the pattern cannot include the
568 bar character.
569
570 The pattern is matched against the relevant part of
571 the output, not necessarily the whole line. Only some
572 commands support filtering, try it out to check if it
Bram Moolenaarf86db782018-10-25 13:31:37 +0200573 works. Some of the commands that support filtering:
Bram Moolenaarad6dc492019-04-27 22:40:08 +0200574 |:#| - filter whole line
575 |:clist| - filter by file name or module name
576 |:command| - filter by command name
577 |:files| - filter by file name
578 |:highlight| - filter by highlight group
579 |:jumps| - filter by file name
580 |:let| - filter by variable name
581 |:list| - filter whole line
582 |:llist| - filter by file name or module name
583 |:marks| - filter by text in the current file,
584 or file name for other files
585 |:oldfiles| - filter by file name
586 |:set| - filter by variable name
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200587
588 Only normal messages are filtered, error messages are
589 not.
590
Bram Moolenaare0fa3742016-02-20 15:47:01 +0100591 *:sil* *:silent* *:silent!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592:sil[ent][!] {command} Execute {command} silently. Normal messages will not
593 be given or added to the message history.
594 When [!] is added, error messages will also be
595 skipped, and commands and mappings will not be aborted
596 when an error is detected. |v:errmsg| is still set.
597 When [!] is not used, an error message will cause
598 further messages to be displayed normally.
599 Redirection, started with |:redir|, will continue as
600 usual, although there might be small differences.
601 This will allow redirecting the output of a command
602 without seeing it on the screen. Example: >
603 :redir >/tmp/foobar
604 :silent g/Aap/p
605 :redir END
606< To execute a Normal mode command silently, use the
607 |:normal| command. For example, to search for a
608 string without messages: >
609 :silent exe "normal /path\<CR>"
610< ":silent!" is useful to execute a command that may
611 fail, but the failure is to be ignored. Example: >
612 :let v:errmsg = ""
613 :silent! /^begin
614 :if v:errmsg != ""
615 : ... pattern was not found
616< ":silent" will also avoid the hit-enter prompt. When
617 using this for an external command, this may cause the
618 screen to be messed up. Use |CTRL-L| to clean it up
619 then.
620 ":silent menu ..." defines a menu that will not echo a
621 Command-line command. The command will still produce
622 messages though. Use ":silent" in the command itself
623 to avoid that: ":silent menu .... :silent command".
624
Bram Moolenaar8e258a42009-07-09 13:55:43 +0000625 *:uns* *:unsilent*
626:uns[ilent] {command} Execute {command} not silently. Only makes a
627 difference when |:silent| was used to get to this
628 command.
629 Use this for giving a message even when |:silent| was
630 used. In this example |:silent| is used to avoid the
631 message about reading the file and |:unsilent| to be
632 able to list the first line of each file. >
633 :silent argdo unsilent echo expand('%') . ": " . getline(1)
634<
635
Bram Moolenaar071d4272004-06-13 20:20:40 +0000636 *:verb* *:verbose*
637:[count]verb[ose] {command}
638 Execute {command} with 'verbose' set to [count]. If
Bram Moolenaared203462004-06-16 11:19:22 +0000639 [count] is omitted one is used. ":0verbose" can be
640 used to set 'verbose' to zero.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000641 The additional use of ":silent" makes messages
642 generated but not displayed.
643 The combination of ":silent" and ":verbose" can be
644 used to generate messages and check them with
645 |v:statusmsg| and friends. For example: >
646 :let v:statusmsg = ""
647 :silent verbose runtime foobar.vim
648 :if v:statusmsg != ""
649 : " foobar.vim could not be found
650 :endif
651< When concatenating another command, the ":verbose"
652 only applies to the first one: >
653 :4verbose set verbose | set verbose
654< verbose=4 ~
655 verbose=0 ~
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000656 For logging verbose messages in a file use the
657 'verbosefile' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000658
Bram Moolenaar8aff23a2005-08-19 20:40:30 +0000659 *:verbose-cmd*
660When 'verbose' is non-zero, listing the value of a Vim option or a key map or
Bram Moolenaare344bea2005-09-01 20:46:49 +0000661an abbreviation or a user-defined function or a command or a highlight group
662or an autocommand will also display where it was last defined. If it was
663defined manually then there will be no "Last set" message. When it was
664defined while executing a function, user command or autocommand, the script in
665which it was defined is reported.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200666{not available when compiled without the |+eval| feature}
Bram Moolenaar8aff23a2005-08-19 20:40:30 +0000667
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668 *K*
669K Run a program to lookup the keyword under the
670 cursor. The name of the program is given with the
671 'keywordprg' (kp) option (default is "man"). The
672 keyword is formed of letters, numbers and the
673 characters in 'iskeyword'. The keyword under or
674 right of the cursor is used. The same can be done
675 with the command >
676 :!{program} {keyword}
677< There is an example of a program to use in the tools
Bram Moolenaar214641f2017-03-05 17:04:09 +0100678 directory of Vim. It is called "ref" and does a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679 simple spelling check.
680 Special cases:
Bram Moolenaar26852122016-05-24 20:02:38 +0200681 - If 'keywordprg' begins with ":" it is invoked as
682 a Vim Ex command with [count].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000683 - If 'keywordprg' is empty, the ":help" command is
684 used. It's a good idea to include more characters
685 in 'iskeyword' then, to be able to find more help.
Bram Moolenaar26852122016-05-24 20:02:38 +0200686 - When 'keywordprg' is equal to "man" or starts with
687 ":", a [count] before "K" is inserted after
688 keywordprg and before the keyword. For example,
689 using "2K" while the cursor is on "mkdir", results
690 in: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000691 !man 2 mkdir
692< - When 'keywordprg' is equal to "man -s", a count
693 before "K" is inserted after the "-s". If there is
694 no count, the "-s" is removed.
695 {not in Vi}
696
697 *v_K*
698{Visual}K Like "K", but use the visually highlighted text for
699 the keyword. Only works when the highlighted text is
700 not more than one line. {not in Vi}
701
702[N]gs *gs* *:sl* *:sleep*
703:[N]sl[eep] [N] [m] Do nothing for [N] seconds. When [m] is included,
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000704 sleep for [N] milliseconds. The count for "gs" always
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705 uses seconds. The default is one second. >
706 :sleep "sleep for one second
707 :5sleep "sleep for five seconds
708 :sleep 100m "sleep for a hundred milliseconds
709 10gs "sleep for ten seconds
710< Can be interrupted with CTRL-C (CTRL-Break on MS-DOS).
Bram Moolenaar677ee682005-01-27 14:41:15 +0000711 "gs" stands for "goto sleep".
712 While sleeping the cursor is positioned in the text,
713 if at a visible position. {not in Vi}
Bram Moolenaar15146672011-10-20 22:22:38 +0200714 Also process the received netbeans messages. {only
715 available when compiled with the |+netbeans_intg|
716 feature}
717
Bram Moolenaar071d4272004-06-13 20:20:40 +0000718
719 *g_CTRL-A*
720g CTRL-A Only when Vim was compiled with MEM_PROFILING defined
721 (which is very rare): print memory usage statistics.
722 Only useful for debugging Vim.
Bram Moolenaar345efa02016-01-15 20:57:49 +0100723 For incrementing in Visual mode see |v_g_CTRL-A|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000724
725==============================================================================
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +02007262. Using Vim like less or more *less*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727
728If you use the less or more program to view a file, you don't get syntax
729highlighting. Thus you would like to use Vim instead. You can do this by
730using the shell script "$VIMRUNTIME/macros/less.sh".
731
732This shell script uses the Vim script "$VIMRUNTIME/macros/less.vim". It sets
733up mappings to simulate the commands that less supports. Otherwise, you can
734still use the Vim commands.
735
736This isn't perfect. For example, when viewing a short file Vim will still use
737the whole screen. But it works good enough for most uses, and you get syntax
738highlighting.
739
740The "h" key will give you a short overview of the available commands.
741
Bram Moolenaare392eb42015-11-19 20:38:09 +0100742If you want to set options differently when using less, define the
743LessInitFunc in your vimrc, for example: >
744
745 func LessInitFunc()
746 set nocursorcolumn nocursorline
747 endfunc
748<
749
Bram Moolenaard2855f52018-07-31 22:23:58 +0200750 vim:tw=78:ts=8:noet:ft=help:norl: