blob: 232ccda37df000eda29ef055b7530ceb84b337de [file] [log] [blame]
Bram Moolenaara2a80162017-11-21 23:09:50 +01001*various.txt* For Vim version 8.0. Last change: 2017 Nov 18
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
43 cursor in decimal, hexadecimal and octal. For
44 example, when the cursor is on a 'R':
45 <R> 82, Hex 52, Octal 122 ~
46 When the character is a non-standard ASCII character,
47 but printable according to the 'isprint' option, the
48 non-printable version is also given. When the
49 character is larger than 127, the <M-x> form is also
50 printed. For example:
51 <~A> <M-^A> 129, Hex 81, Octal 201 ~
52 <p> <|~> <M-~> 254, Hex fe, Octal 376 ~
53 (where <p> is a special character)
54 The <Nul> character in a file is stored internally as
55 <NL>, but it will be shown as:
56 <^@> 0, Hex 00, Octal 000 ~
Bram Moolenaar362e1a32006-03-06 23:29:24 +000057 If the character has composing characters these are
58 also shown. The value of 'maxcombine' doesn't matter.
Bram Moolenaar071d4272004-06-13 20:20:40 +000059 Mnemonic: Get Ascii value. {not in Vi}
60
61 *g8*
62g8 Print the hex values of the bytes used in the
63 character under the cursor, assuming it is in |UTF-8|
Bram Moolenaar362e1a32006-03-06 23:29:24 +000064 encoding. This also shows composing characters. The
65 value of 'maxcombine' doesn't matter.
66 Example of a character with two composing characters:
Bram Moolenaar071d4272004-06-13 20:20:40 +000067 e0 b8 81 + e0 b8 b9 + e0 b9 89 ~
Bram Moolenaarca003e12006-03-17 23:19:38 +000068 {not in Vi} {only when compiled with the |+multi_byte|
69 feature}
70
71 *8g8*
728g8 Find an illegal UTF-8 byte sequence at or after the
73 cursor. This works in two situations:
74 1. when 'encoding' is any 8-bit encoding
75 2. when 'encoding' is "utf-8" and 'fileencoding' is
76 any 8-bit encoding
77 Thus it can be used when editing a file that was
78 supposed to be UTF-8 but was read as if it is an 8-bit
79 encoding because it contains illegal bytes.
80 Does not wrap around the end of the file.
81 Note that when the cursor is on an illegal byte or the
82 cursor is halfway a multi-byte character the command
83 won't move the cursor.
84 {not in Vi} {only when compiled with the |+multi_byte|
85 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +000086
Bram Moolenaar551dbcc2006-04-25 22:13:59 +000087 *:p* *:pr* *:print* *E749*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +000088:[range]p[rint] [flags]
89 Print [range] lines (default current line).
Bram Moolenaar071d4272004-06-13 20:20:40 +000090 Note: If you are looking for a way to print your text
Bram Moolenaar5313dcb2005-02-22 08:56:13 +000091 on paper see |:hardcopy|. In the GUI you can use the
92 File.Print menu entry.
93 See |ex-flags| for [flags].
Bram Moolenaar818078d2016-08-27 21:58:42 +020094 The |:filter| command can be used to only show lines
95 matching a pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +000096
Bram Moolenaar5313dcb2005-02-22 08:56:13 +000097:[range]p[rint] {count} [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +000098 Print {count} lines, starting with [range] (default
99 current line |cmdline-ranges|).
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000100 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101
102 *:P* *:Print*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000103:[range]P[rint] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000104 Just as ":print". Was apparently added to Vi for
105 people that keep the shift key pressed too long...
Bram Moolenaar166af9b2010-11-16 20:34:40 +0100106 Note: A user command can overrule this command.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000107 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000108
109 *:l* *:list*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000110:[range]l[ist] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000111 Same as :print, but display unprintable characters
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +0200112 with '^' and put $ after the line. This can be
Bram Moolenaard58e9292011-02-09 17:07:58 +0100113 further changed with the 'listchars' option.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000114 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000115
116 *:nu* *:number*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000117:[range]nu[mber] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000118 Same as :print, but precede each line with its line
Bram Moolenaarfaa959a2006-02-20 21:37:40 +0000119 number. (See also 'highlight' and 'numberwidth'
120 option).
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000121 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122
123 *:#*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000124:[range]# [count] [flags]
125 synonym for :number.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000126
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000127 *:#!*
128:#!{anything} Ignored, so that you can start a Vim script with: >
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000129 #!vim -S
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000130 echo "this is a Vim script"
131 quit
132<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000133 *:z* *E144*
134:{range}z[+-^.=]{count} Display several lines of text surrounding the line
135 specified with {range}, or around the current line
136 if there is no {range}. If there is a {count}, that's
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000137 how many lines you'll see; if there is only one window
Bram Moolenaar662db672011-03-22 14:05:35 +0100138 then twice the value of the 'scroll' option is used,
139 otherwise the current window height minus 3 is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000140
Bram Moolenaarb6b046b2011-12-30 13:11:27 +0100141 If there is a {count} the 'window' option is set to
142 its value.
143
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144 :z can be used either alone or followed by any of
145 several punctuation marks. These have the following
146 effect:
147
Bram Moolenaar662db672011-03-22 14:05:35 +0100148 mark first line last line new cursor line ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149 ---- ---------- --------- ------------
150 + current line 1 scr forward 1 scr forward
151 - 1 scr back current line current line
152 ^ 2 scr back 1 scr back 1 scr back
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +0000153 . 1/2 scr back 1/2 scr fwd 1/2 scr fwd
154 = 1/2 scr back 1/2 scr fwd current line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000155
156 Specifying no mark at all is the same as "+".
157 If the mark is "=", a line of dashes is printed
158 around the current line.
159
160:{range}z#[+-^.=]{count} *:z#*
161 Like ":z", but number the lines.
162 {not in all versions of Vi, not with these arguments}
163
164 *:=*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000165:= [flags] Print the last line number.
166 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000167
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000168:{range}= [flags] Prints the last line number in {range}. For example,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000169 this prints the current line number: >
170 :.=
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000171< See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000172
173:norm[al][!] {commands} *:norm* *:normal*
174 Execute Normal mode commands {commands}. This makes
175 it possible to execute Normal mode commands typed on
Bram Moolenaar4a748032010-09-30 21:47:56 +0200176 the command-line. {commands} are executed like they
177 are typed. For undo all commands are undone together.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000178 Execution stops when an error is encountered.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100179
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180 If the [!] is given, mappings will not be used.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100181 Without it, when this command is called from a
182 non-remappable mapping (|:noremap|), the argument can
183 be mapped anyway.
184
Bram Moolenaar071d4272004-06-13 20:20:40 +0000185 {commands} should be a complete command. If
186 {commands} does not finish a command, the last one
187 will be aborted as if <Esc> or <C-C> was typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000188 This implies that an insert command must be completed
189 (to start Insert mode, see |:startinsert|). A ":"
Bram Moolenaar7c626922005-02-07 22:01:03 +0000190 command must be completed as well. And you can't use
191 "Q" or "gQ" to start Ex mode.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100192
193 The display is not updated while ":normal" is busy.
194
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100195 {commands} cannot start with a space. Put a count of
196 1 (one) before it, "1 " is one space.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100197
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198 The 'insertmode' option is ignored for {commands}.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100199
Bram Moolenaar071d4272004-06-13 20:20:40 +0000200 This command cannot be followed by another command,
201 since any '|' is considered part of the command.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100202
Bram Moolenaar071d4272004-06-13 20:20:40 +0000203 This command can be used recursively, but the depth is
204 limited by 'maxmapdepth'.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100205
Bram Moolenaar071d4272004-06-13 20:20:40 +0000206 An alternative is to use |:execute|, which uses an
207 expression as argument. This allows the use of
Bram Moolenaar46f9d492010-06-12 20:18:19 +0200208 printable characters to represent special characters.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100209
Bram Moolenaar46f9d492010-06-12 20:18:19 +0200210 Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211 :exe "normal \<c-w>\<c-w>"
212< {not in Vi, of course}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000213
214:{range}norm[al][!] {commands} *:normal-range*
215 Execute Normal mode commands {commands} for each line
216 in the {range}. Before executing the {commands}, the
217 cursor is positioned in the first column of the range,
218 for each line. Otherwise it's the same as the
219 ":normal" command without a range.
220 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000221
222 *:sh* *:shell* *E371*
223:sh[ell] This command starts a shell. When the shell exits
224 (after the "exit" command) you return to Vim. The
225 name for the shell command comes from 'shell' option.
226 *E360*
227 Note: This doesn't work when Vim on the Amiga was
228 started in QuickFix mode from a compiler, because the
229 compiler will have set stdin to a non-interactive
230 mode.
231
232 *:!cmd* *:!* *E34*
233:!{cmd} Execute {cmd} with the shell. See also the 'shell'
234 and 'shelltype' option.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200235
Bram Moolenaar071d4272004-06-13 20:20:40 +0000236 Any '!' in {cmd} is replaced with the previous
237 external command (see also 'cpoptions'). But not when
238 there is a backslash before the '!', then that
239 backslash is removed. Example: ":!ls" followed by
240 ":!echo ! \! \\!" executes "echo ls ! \!".
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200241
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000242 A '|' in {cmd} is passed to the shell, you cannot use
243 it to append a Vim command. See |:bar|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200244
245 If {cmd} contains "%" it is expanded to the current
246 file name. Special characters are not escaped, use
247 quotes to avoid their special meaning: >
248 :!ls "%"
249< If the file name contains a "$" single quotes might
250 work better (but a single quote causes trouble): >
251 :!ls '%'
252< This should always work, but it's more typing: >
253 :exe "!ls " . shellescape(expand("%"))
254<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000255 A newline character ends {cmd}, what follows is
256 interpreted as a following ":" command. However, if
257 there is a backslash before the newline it is removed
258 and {cmd} continues. It doesn't matter how many
259 backslashes are before the newline, only one is
260 removed.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200261
Bram Moolenaar071d4272004-06-13 20:20:40 +0000262 On Unix the command normally runs in a non-interactive
263 shell. If you want an interactive shell to be used
264 (to use aliases) set 'shellcmdflag' to "-ic".
265 For Win32 also see |:!start|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200266
Bram Moolenaare968e362014-05-13 20:23:24 +0200267 After the command has been executed, the timestamp and
268 size of the current file is checked |timestamp|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200269
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270 Vim redraws the screen after the command is finished,
271 because it may have printed any text. This requires a
272 hit-enter prompt, so that you can read any messages.
273 To avoid this use: >
274 :silent !{cmd}
275< The screen is not redrawn then, thus you have to use
276 CTRL-L or ":redraw!" if the command did display
277 something.
278 Also see |shell-window|.
279
280 *:!!*
281:!! Repeat last ":!{cmd}".
282
283 *:ve* *:version*
284:ve[rsion] Print the version number of the editor. If the
285 compiler used understands "__DATE__" the compilation
286 date is mentioned. Otherwise a fixed release-date is
287 shown.
288 The following lines contain information about which
289 features were enabled when Vim was compiled. When
290 there is a preceding '+', the feature is included,
291 when there is a '-' it is excluded. To change this,
292 you have to edit feature.h and recompile Vim.
293 To check for this in an expression, see |has()|.
294 Here is an overview of the features.
295 The first column shows the smallest version in which
296 they are included:
297 T tiny
298 S small
299 N normal
300 B big
301 H huge
302 m manually enabled or depends on other features
303 (none) system dependent
304 Thus if a feature is marked with "N", it is included
305 in the normal, big and huge versions of Vim.
306
307 *+feature-list*
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200308 *+acl* |ACL| support included
Bram Moolenaar071d4272004-06-13 20:20:40 +0000309 *+ARP* Amiga only: ARP support included
310B *+arabic* |Arabic| language support
311N *+autocmd* |:autocmd|, automatic commands
Bram Moolenaare42a6d22017-11-12 19:21:51 +0100312H *+autoservername* Automatically enable |clientserver|
Bram Moolenaara2a80162017-11-21 23:09:50 +0100313m *+balloon_eval* |balloon-eval| support in the GUI. Included when
314 compiling with supported GUI (Motif, GTK, GUI) and
315 either Netbeans/Sun Workshop integration or |+eval|
316 feature.
317H *+balloon_eval_term* |balloon-eval| support in the terminal,
318 'balloonevalterm'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319N *+browse* |:browse| command
320N *+builtin_terms* some terminals builtin |builtin-terms|
321B *++builtin_terms* maximal terminals builtin |builtin-terms|
322N *+byte_offset* support for 'o' flag in 'statusline' option, "go"
323 and ":goto" commands.
Bram Moolenaar298b4402016-01-28 22:38:53 +0100324m *+channel* inter process communication |channel|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000325N *+cindent* |'cindent'|, C indenting
326N *+clientserver* Unix and Win32: Remote invocation |clientserver|
327 *+clipboard* |clipboard| support
328N *+cmdline_compl* command line completion |cmdline-completion|
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200329S *+cmdline_hist* command line history |cmdline-history|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000330N *+cmdline_info* |'showcmd'| and |'ruler'|
331N *+comments* |'comments'| support
Bram Moolenaarca8c9862010-07-24 15:00:38 +0200332B *+conceal* "conceal" support, see |conceal| |:syn-conceal| etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000333N *+cryptv* encryption support |encryption|
334B *+cscope* |cscope| support
Bram Moolenaar860cae12010-06-05 23:22:07 +0200335m *+cursorbind* |'cursorbind'| support
Bram Moolenaarac6e65f2005-08-29 22:25:38 +0000336m *+cursorshape* |termcap-cursor-shape| support
337m *+debug* Compiled for debugging.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000338N *+dialog_gui* Support for |:confirm| with GUI dialog.
339N *+dialog_con* Support for |:confirm| with console dialog.
340N *+dialog_con_gui* Support for |:confirm| with GUI and console dialog.
341N *+diff* |vimdiff| and 'diff'
342N *+digraphs* |digraphs| *E196*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +0200343m *+directx* Win32 GUI only: DirectX and |'renderoptions'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000344 *+dnd* Support for DnD into the "~ register |quote_~|.
345B *+emacs_tags* |emacs-tags| files
346N *+eval* expression evaluation |eval.txt|
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +0100347N *+ex_extra* always on now, used to be for Vim's extra Ex commands
Bram Moolenaar071d4272004-06-13 20:20:40 +0000348N *+extra_search* |'hlsearch'| and |'incsearch'| options.
349B *+farsi* |farsi| language
350N *+file_in_path* |gf|, |CTRL-W_f| and |<cfile>|
351N *+find_in_path* include file searches: |[I|, |:isearch|,
352 |CTRL-W_CTRL-I|, |:checkpath|, etc.
353N *+folding* |folding|
354 *+footer* |gui-footer|
355 *+fork* Unix only: |fork| shell commands
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000356 *+float* Floating point support
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357N *+gettext* message translations |multi-lang|
358 *+GUI_Athena* Unix only: Athena |GUI|
359 *+GUI_neXtaw* Unix only: neXtaw |GUI|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000360 *+GUI_GTK* Unix only: GTK+ |GUI|
361 *+GUI_Motif* Unix only: Motif |GUI|
362 *+GUI_Photon* QNX only: Photon |GUI|
363m *+hangul_input* Hangul input support |hangul|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000364 *+iconv* Compiled with the |iconv()| function
365 *+iconv/dyn* Likewise |iconv-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000366N *+insert_expand* |insert_expand| Insert mode completion
Bram Moolenaar38a55632016-02-15 22:07:32 +0100367m *+job* starting and stopping jobs |job|
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200368S *+jumplist* |jumplist|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000369B *+keymap* |'keymap'|
Bram Moolenaarbc8801c2016-08-02 21:04:33 +0200370N *+lambda* |lambda| and |closure|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000371B *+langmap* |'langmap'|
372N *+libcall* |libcall()|
373N *+linebreak* |'linebreak'|, |'breakat'| and |'showbreak'|
374N *+lispindent* |'lisp'|
375N *+listcmds* Vim commands for the list of buffers |buffer-hidden|
376 and argument list |:argdelete|
377N *+localmap* Support for mappings local to a buffer |:map-local|
Bram Moolenaar0ba04292010-07-14 23:23:17 +0200378m *+lua* |Lua| interface
379m *+lua/dyn* |Lua| interface |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000380N *+menu* |:menu|
381N *+mksession* |:mksession|
382N *+modify_fname* |filename-modifiers|
383N *+mouse* Mouse handling |mouse-using|
384N *+mouseshape* |'mouseshape'|
385B *+mouse_dec* Unix only: Dec terminal mouse handling |dec-mouse|
386N *+mouse_gpm* Unix only: Linux console mouse handling |gpm-mouse|
Bram Moolenaar13600302014-05-22 18:26:40 +0200387N *+mouse_jsbterm* JSB mouse handling |jsbterm-mouse|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000388B *+mouse_netterm* Unix only: netterm mouse handling |netterm-mouse|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100389N *+mouse_pterm* QNX only: pterm mouse handling |qnx-terminal|
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000390N *+mouse_sysmouse* Unix only: *BSD console mouse handling |sysmouse|
Bram Moolenaar9b451252012-08-15 17:43:31 +0200391B *+mouse_sgr* Unix only: sgr mouse handling |sgr-mouse|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100392B *+mouse_urxvt* Unix only: urxvt mouse handling |urxvt-mouse|
393N *+mouse_xterm* Unix only: xterm mouse handling |xterm-mouse|
Bram Moolenaare6ae6222013-05-21 21:01:10 +0200394N *+multi_byte* 16 and 32 bit characters |multibyte|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000395 *+multi_byte_ime* Win32 input method for multibyte chars |multibyte-ime|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100396N *+multi_lang* non-English language support |multi-lang|
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000397m *+mzscheme* Mzscheme interface |mzscheme|
Bram Moolenaar4770d092006-01-12 23:22:24 +0000398m *+mzscheme/dyn* Mzscheme interface |mzscheme-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000399m *+netbeans_intg* |netbeans|
Bram Moolenaar22fcfad2016-07-01 18:17:26 +0200400 *+num64* 64-bit Number support |Number|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100401m *+ole* Win32 GUI only: |ole-interface|
Bram Moolenaar91c49372016-05-08 09:50:29 +0200402N *+packages* Loading |packages|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100403N *+path_extra* Up/downwards search in 'path' and 'tags'
Bram Moolenaara5792f52005-11-23 21:25:05 +0000404m *+perl* Perl interface |perl|
405m *+perl/dyn* Perl interface |perl-dynamic| |/dyn|
Bram Moolenaar7fc0c062010-08-10 21:43:35 +0200406N *+persistent_undo* Persistent undo |undo-persistence|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100407 *+postscript* |:hardcopy| writes a PostScript file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000408N *+printer* |:hardcopy| command
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000409H *+profile* |:profile| command
Bram Moolenaar60aad972010-07-21 20:36:22 +0200410m *+python* Python 2 interface |python|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100411m *+python/dyn* Python 2 interface |python-dynamic| |/dyn|
Bram Moolenaar60aad972010-07-21 20:36:22 +0200412m *+python3* Python 3 interface |python|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100413m *+python3/dyn* Python 3 interface |python-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000414N *+quickfix* |:make| and |quickfix| commands
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000415N *+reltime* |reltime()| function, 'hlsearch'/'incsearch' timeout,
416 'redrawtime' option
Bram Moolenaar071d4272004-06-13 20:20:40 +0000417B *+rightleft* Right to left typing |'rightleft'|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000418m *+ruby* Ruby interface |ruby|
419m *+ruby/dyn* Ruby interface |ruby-dynamic| |/dyn|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100420N *+scrollbind* |'scrollbind'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000421B *+signs* |:sign|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100422N *+smartindent* |'smartindent'|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100423N *+startuptime* |--startuptime| argument
424N *+statusline* Options 'statusline', 'rulerformat' and special
Bram Moolenaar071d4272004-06-13 20:20:40 +0000425 formats of 'titlestring' and 'iconstring'
426m *+sun_workshop* |workshop|
427N *+syntax* Syntax highlighting |syntax|
428 *+system()* Unix only: opposite of |+fork|
Bram Moolenaar64d8e252016-09-06 22:12:34 +0200429T *+tag_binary* binary searching in tags file |tag-binary-search|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000430N *+tag_old_static* old method for static tags |tag-old-static|
431m *+tag_any_white* any white space allowed in tags file |tag-any-white|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100432m *+tcl* Tcl interface |tcl|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000433m *+tcl/dyn* Tcl interface |tcl-dynamic| |/dyn|
Bram Moolenaar1ccd8ff2017-08-11 19:50:37 +0200434m *+terminal* Support for terminal window |terminal|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000435 *+terminfo* uses |terminfo| instead of termcap
436N *+termresponse* support for |t_RV| and |v:termresponse|
Bram Moolenaar61be73b2016-04-29 22:59:22 +0200437B *+termguicolors* 24-bit color in xterm-compatible terminals support
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100438N *+textobjects* |text-objects| selection
Bram Moolenaar071d4272004-06-13 20:20:40 +0000439 *+tgetent* non-Unix only: able to use external termcap
Bram Moolenaare18c0b32016-03-20 21:08:34 +0100440N *+timers* the |timer_start()| function
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000441N *+title* Setting the window 'title' and 'icon'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000442N *+toolbar* |gui-toolbar|
443N *+user_commands* User-defined commands. |user-commands|
444N *+viminfo* |'viminfo'|
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200445 *+vertsplit* Vertically split windows |:vsplit|; Always enabled
446 since 8.0.1118.
447 in sync with the |+windows| feature
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100448N *+virtualedit* |'virtualedit'|
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +0100449S *+visual* Visual mode |Visual-mode| Always enabled since 7.4.200.
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100450N *+visualextra* extra Visual mode commands |blockwise-operators|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000451N *+vreplace* |gR| and |gr|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100452N *+wildignore* |'wildignore'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000453N *+wildmenu* |'wildmenu'|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +0100454 *+windows* more than one window; Always enabled since 8.0.1118.
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100455m *+writebackup* |'writebackup'| is default on
456m *+xim* X input method |xim|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000457 *+xfontset* X fontset support |xfontset|
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200458 *+xpm* pixmap support
Bram Moolenaar9b451252012-08-15 17:43:31 +0200459m *+xpm_w32* Win32 GUI only: pixmap support |w32-xpm-support|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000460 *+xsmp* XSMP (X session management) support
461 *+xsmp_interact* interactive XSMP (X session management) support
462N *+xterm_clipboard* Unix only: xterm clipboard handling
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100463m *+xterm_save* save and restore xterm screen |xterm-screens|
464N *+X11* Unix only: can restore window title |X11|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000465
466 */dyn* *E370* *E448*
467 To some of the features "/dyn" is added when the
468 feature is only available when the related library can
469 be dynamically loaded.
470
471:ve[rsion] {nr} Is now ignored. This was previously used to check the
472 version number of a .vimrc file. It was removed,
473 because you can now use the ":if" command for
474 version-dependent behavior. {not in Vi}
475
476 *:redi* *:redir*
477:redi[r][!] > {file} Redirect messages to file {file}. The messages which
478 are the output of commands are written to that file,
479 until redirection ends. The messages are also still
480 shown on the screen. When [!] is included, an
481 existing file is overwritten. When [!] is omitted,
482 and {file} exists, this command fails.
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200483
Bram Moolenaar071d4272004-06-13 20:20:40 +0000484 Only one ":redir" can be active at a time. Calls to
485 ":redir" will close any active redirection before
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200486 starting redirection to the new target. For recursive
487 use check out |execute()|.
488
Bram Moolenaar071d4272004-06-13 20:20:40 +0000489 To stop the messages and commands from being echoed to
490 the screen, put the commands in a function and call it
491 with ":silent call Function()".
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000492 An alternative is to use the 'verbosefile' option,
493 this can be used in combination with ":redir".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000494 {not in Vi}
495
496:redi[r] >> {file} Redirect messages to file {file}. Append if {file}
497 already exists. {not in Vi}
498
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000499:redi[r] @{a-zA-Z}
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +0000500:redi[r] @{a-zA-Z}> Redirect messages to register {a-z}. Append to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000501 contents of the register if its name is given
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000502 uppercase {A-Z}. The ">" after the register name is
503 optional. {not in Vi}
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +0000504:redi[r] @{a-z}>> Append messages to register {a-z}. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000505
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000506:redi[r] @*>
507:redi[r] @+> Redirect messages to the selection or clipboard. For
508 backward compatibility, the ">" after the register
509 name can be omitted. See |quotestar| and |quoteplus|.
510 {not in Vi}
511:redi[r] @*>>
512:redi[r] @+>> Append messages to the selection or clipboard.
513 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000514
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +0000515:redi[r] @"> Redirect messages to the unnamed register. For
516 backward compatibility, the ">" after the register
517 name can be omitted. {not in Vi}
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +0000518:redi[r] @">> Append messages to the unnamed register. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000519
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000520:redi[r] => {var} Redirect messages to a variable. If the variable
521 doesn't exist, then it is created. If the variable
522 exists, then it is initialized to an empty string.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000523 The variable will remain empty until redirection ends.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000524 Only string variables can be used. After the
525 redirection starts, if the variable is removed or
526 locked or the variable type is changed, then further
527 command output messages will cause errors. {not in Vi}
Bram Moolenaar063b9d12016-07-09 20:21:48 +0200528 To get the output of one command the |execute()|
529 function can be used.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000530
531:redi[r] =>> {var} Append messages to an existing variable. Only string
532 variables can be used. {not in Vi}
533
Bram Moolenaar071d4272004-06-13 20:20:40 +0000534:redi[r] END End redirecting messages. {not in Vi}
535
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200536 *:filt* *:filter*
Bram Moolenaar214641f2017-03-05 17:04:09 +0100537:filt[er][!] {pat} {command}
538:filt[er][!] /{pat}/ {command}
539 Restrict the output of {command} to lines matching
540 with {pat}. For example, to list only xml files: >
Bram Moolenaar818078d2016-08-27 21:58:42 +0200541 :filter /\.xml$/ oldfiles
Bram Moolenaar214641f2017-03-05 17:04:09 +0100542< If the [!] is given, restrict the output of {command}
543 to lines that do NOT match {pat}.
544
Bram Moolenaar7b668e82016-08-23 23:51:21 +0200545 {pat} is a Vim search pattern. Instead of enclosing
546 it in / any non-ID character (see |'isident'|) can be
547 used, so long as it does not appear in {pat}. Without
548 the enclosing character the pattern cannot include the
549 bar character.
550
551 The pattern is matched against the relevant part of
552 the output, not necessarily the whole line. Only some
553 commands support filtering, try it out to check if it
554 works.
555
556 Only normal messages are filtered, error messages are
557 not.
558
Bram Moolenaare0fa3742016-02-20 15:47:01 +0100559 *:sil* *:silent* *:silent!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560:sil[ent][!] {command} Execute {command} silently. Normal messages will not
561 be given or added to the message history.
562 When [!] is added, error messages will also be
563 skipped, and commands and mappings will not be aborted
564 when an error is detected. |v:errmsg| is still set.
565 When [!] is not used, an error message will cause
566 further messages to be displayed normally.
567 Redirection, started with |:redir|, will continue as
568 usual, although there might be small differences.
569 This will allow redirecting the output of a command
570 without seeing it on the screen. Example: >
571 :redir >/tmp/foobar
572 :silent g/Aap/p
573 :redir END
574< To execute a Normal mode command silently, use the
575 |:normal| command. For example, to search for a
576 string without messages: >
577 :silent exe "normal /path\<CR>"
578< ":silent!" is useful to execute a command that may
579 fail, but the failure is to be ignored. Example: >
580 :let v:errmsg = ""
581 :silent! /^begin
582 :if v:errmsg != ""
583 : ... pattern was not found
584< ":silent" will also avoid the hit-enter prompt. When
585 using this for an external command, this may cause the
586 screen to be messed up. Use |CTRL-L| to clean it up
587 then.
588 ":silent menu ..." defines a menu that will not echo a
589 Command-line command. The command will still produce
590 messages though. Use ":silent" in the command itself
591 to avoid that: ":silent menu .... :silent command".
592
Bram Moolenaar8e258a42009-07-09 13:55:43 +0000593 *:uns* *:unsilent*
594:uns[ilent] {command} Execute {command} not silently. Only makes a
595 difference when |:silent| was used to get to this
596 command.
597 Use this for giving a message even when |:silent| was
598 used. In this example |:silent| is used to avoid the
599 message about reading the file and |:unsilent| to be
600 able to list the first line of each file. >
601 :silent argdo unsilent echo expand('%') . ": " . getline(1)
602<
603
Bram Moolenaar071d4272004-06-13 20:20:40 +0000604 *:verb* *:verbose*
605:[count]verb[ose] {command}
606 Execute {command} with 'verbose' set to [count]. If
Bram Moolenaared203462004-06-16 11:19:22 +0000607 [count] is omitted one is used. ":0verbose" can be
608 used to set 'verbose' to zero.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000609 The additional use of ":silent" makes messages
610 generated but not displayed.
611 The combination of ":silent" and ":verbose" can be
612 used to generate messages and check them with
613 |v:statusmsg| and friends. For example: >
614 :let v:statusmsg = ""
615 :silent verbose runtime foobar.vim
616 :if v:statusmsg != ""
617 : " foobar.vim could not be found
618 :endif
619< When concatenating another command, the ":verbose"
620 only applies to the first one: >
621 :4verbose set verbose | set verbose
622< verbose=4 ~
623 verbose=0 ~
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000624 For logging verbose messages in a file use the
625 'verbosefile' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626
Bram Moolenaar8aff23a2005-08-19 20:40:30 +0000627 *:verbose-cmd*
628When 'verbose' is non-zero, listing the value of a Vim option or a key map or
Bram Moolenaare344bea2005-09-01 20:46:49 +0000629an abbreviation or a user-defined function or a command or a highlight group
630or an autocommand will also display where it was last defined. If it was
631defined manually then there will be no "Last set" message. When it was
632defined while executing a function, user command or autocommand, the script in
633which it was defined is reported.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200634{not available when compiled without the |+eval| feature}
Bram Moolenaar8aff23a2005-08-19 20:40:30 +0000635
Bram Moolenaar071d4272004-06-13 20:20:40 +0000636 *K*
637K Run a program to lookup the keyword under the
638 cursor. The name of the program is given with the
639 'keywordprg' (kp) option (default is "man"). The
640 keyword is formed of letters, numbers and the
641 characters in 'iskeyword'. The keyword under or
642 right of the cursor is used. The same can be done
643 with the command >
644 :!{program} {keyword}
645< There is an example of a program to use in the tools
Bram Moolenaar214641f2017-03-05 17:04:09 +0100646 directory of Vim. It is called "ref" and does a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000647 simple spelling check.
648 Special cases:
Bram Moolenaar26852122016-05-24 20:02:38 +0200649 - If 'keywordprg' begins with ":" it is invoked as
650 a Vim Ex command with [count].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000651 - If 'keywordprg' is empty, the ":help" command is
652 used. It's a good idea to include more characters
653 in 'iskeyword' then, to be able to find more help.
Bram Moolenaar26852122016-05-24 20:02:38 +0200654 - When 'keywordprg' is equal to "man" or starts with
655 ":", a [count] before "K" is inserted after
656 keywordprg and before the keyword. For example,
657 using "2K" while the cursor is on "mkdir", results
658 in: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000659 !man 2 mkdir
660< - When 'keywordprg' is equal to "man -s", a count
661 before "K" is inserted after the "-s". If there is
662 no count, the "-s" is removed.
663 {not in Vi}
664
665 *v_K*
666{Visual}K Like "K", but use the visually highlighted text for
667 the keyword. Only works when the highlighted text is
668 not more than one line. {not in Vi}
669
670[N]gs *gs* *:sl* *:sleep*
671:[N]sl[eep] [N] [m] Do nothing for [N] seconds. When [m] is included,
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000672 sleep for [N] milliseconds. The count for "gs" always
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673 uses seconds. The default is one second. >
674 :sleep "sleep for one second
675 :5sleep "sleep for five seconds
676 :sleep 100m "sleep for a hundred milliseconds
677 10gs "sleep for ten seconds
678< Can be interrupted with CTRL-C (CTRL-Break on MS-DOS).
Bram Moolenaar677ee682005-01-27 14:41:15 +0000679 "gs" stands for "goto sleep".
680 While sleeping the cursor is positioned in the text,
681 if at a visible position. {not in Vi}
Bram Moolenaar15146672011-10-20 22:22:38 +0200682 Also process the received netbeans messages. {only
683 available when compiled with the |+netbeans_intg|
684 feature}
685
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686
687 *g_CTRL-A*
688g CTRL-A Only when Vim was compiled with MEM_PROFILING defined
689 (which is very rare): print memory usage statistics.
690 Only useful for debugging Vim.
Bram Moolenaar345efa02016-01-15 20:57:49 +0100691 For incrementing in Visual mode see |v_g_CTRL-A|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000692
693==============================================================================
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +02006942. Using Vim like less or more *less*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695
696If you use the less or more program to view a file, you don't get syntax
697highlighting. Thus you would like to use Vim instead. You can do this by
698using the shell script "$VIMRUNTIME/macros/less.sh".
699
700This shell script uses the Vim script "$VIMRUNTIME/macros/less.vim". It sets
701up mappings to simulate the commands that less supports. Otherwise, you can
702still use the Vim commands.
703
704This isn't perfect. For example, when viewing a short file Vim will still use
705the whole screen. But it works good enough for most uses, and you get syntax
706highlighting.
707
708The "h" key will give you a short overview of the available commands.
709
Bram Moolenaare392eb42015-11-19 20:38:09 +0100710If you want to set options differently when using less, define the
711LessInitFunc in your vimrc, for example: >
712
713 func LessInitFunc()
714 set nocursorcolumn nocursorline
715 endfunc
716<
717
Bram Moolenaar071d4272004-06-13 20:20:40 +0000718 vim:tw=78:ts=8:ft=help:norl: