blob: 7dbfb4ad9995a71a56e22b8d6182ed2a3c4863ad [file] [log] [blame]
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01001*various.txt* For Vim version 7.4. Last change: 2016 Jan 31
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 Moolenaar071d4272004-06-13 20:20:40 +000094
Bram Moolenaar5313dcb2005-02-22 08:56:13 +000095:[range]p[rint] {count} [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +000096 Print {count} lines, starting with [range] (default
97 current line |cmdline-ranges|).
Bram Moolenaar5313dcb2005-02-22 08:56:13 +000098 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +000099
100 *:P* *:Print*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000101:[range]P[rint] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000102 Just as ":print". Was apparently added to Vi for
103 people that keep the shift key pressed too long...
Bram Moolenaar166af9b2010-11-16 20:34:40 +0100104 Note: A user command can overrule this command.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000105 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000106
107 *:l* *:list*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000108:[range]l[ist] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109 Same as :print, but display unprintable characters
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +0200110 with '^' and put $ after the line. This can be
Bram Moolenaard58e9292011-02-09 17:07:58 +0100111 further changed with the 'listchars' option.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000112 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000113
114 *:nu* *:number*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000115:[range]nu[mber] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000116 Same as :print, but precede each line with its line
Bram Moolenaarfaa959a2006-02-20 21:37:40 +0000117 number. (See also 'highlight' and 'numberwidth'
118 option).
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000119 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000120
121 *:#*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000122:[range]# [count] [flags]
123 synonym for :number.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000124
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000125 *:#!*
126:#!{anything} Ignored, so that you can start a Vim script with: >
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000127 #!vim -S
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000128 echo "this is a Vim script"
129 quit
130<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000131 *:z* *E144*
132:{range}z[+-^.=]{count} Display several lines of text surrounding the line
133 specified with {range}, or around the current line
134 if there is no {range}. If there is a {count}, that's
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000135 how many lines you'll see; if there is only one window
Bram Moolenaar662db672011-03-22 14:05:35 +0100136 then twice the value of the 'scroll' option is used,
137 otherwise the current window height minus 3 is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000138
Bram Moolenaarb6b046b2011-12-30 13:11:27 +0100139 If there is a {count} the 'window' option is set to
140 its value.
141
Bram Moolenaar071d4272004-06-13 20:20:40 +0000142 :z can be used either alone or followed by any of
143 several punctuation marks. These have the following
144 effect:
145
Bram Moolenaar662db672011-03-22 14:05:35 +0100146 mark first line last line new cursor line ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000147 ---- ---------- --------- ------------
148 + current line 1 scr forward 1 scr forward
149 - 1 scr back current line current line
150 ^ 2 scr back 1 scr back 1 scr back
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +0000151 . 1/2 scr back 1/2 scr fwd 1/2 scr fwd
152 = 1/2 scr back 1/2 scr fwd current line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000153
154 Specifying no mark at all is the same as "+".
155 If the mark is "=", a line of dashes is printed
156 around the current line.
157
158:{range}z#[+-^.=]{count} *:z#*
159 Like ":z", but number the lines.
160 {not in all versions of Vi, not with these arguments}
161
162 *:=*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000163:= [flags] Print the last line number.
164 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000165
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000166:{range}= [flags] Prints the last line number in {range}. For example,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000167 this prints the current line number: >
168 :.=
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000169< See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000170
171:norm[al][!] {commands} *:norm* *:normal*
172 Execute Normal mode commands {commands}. This makes
173 it possible to execute Normal mode commands typed on
Bram Moolenaar4a748032010-09-30 21:47:56 +0200174 the command-line. {commands} are executed like they
175 are typed. For undo all commands are undone together.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000176 Execution stops when an error is encountered.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100177
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178 If the [!] is given, mappings will not be used.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100179 Without it, when this command is called from a
180 non-remappable mapping (|:noremap|), the argument can
181 be mapped anyway.
182
Bram Moolenaar071d4272004-06-13 20:20:40 +0000183 {commands} should be a complete command. If
184 {commands} does not finish a command, the last one
185 will be aborted as if <Esc> or <C-C> was typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000186 This implies that an insert command must be completed
187 (to start Insert mode, see |:startinsert|). A ":"
Bram Moolenaar7c626922005-02-07 22:01:03 +0000188 command must be completed as well. And you can't use
189 "Q" or "gQ" to start Ex mode.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100190
191 The display is not updated while ":normal" is busy.
192
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100193 {commands} cannot start with a space. Put a count of
194 1 (one) before it, "1 " is one space.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100195
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196 The 'insertmode' option is ignored for {commands}.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100197
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198 This command cannot be followed by another command,
199 since any '|' is considered part of the command.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100200
Bram Moolenaar071d4272004-06-13 20:20:40 +0000201 This command can be used recursively, but the depth is
202 limited by 'maxmapdepth'.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100203
Bram Moolenaar071d4272004-06-13 20:20:40 +0000204 An alternative is to use |:execute|, which uses an
205 expression as argument. This allows the use of
Bram Moolenaar46f9d492010-06-12 20:18:19 +0200206 printable characters to represent special characters.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100207
Bram Moolenaar46f9d492010-06-12 20:18:19 +0200208 Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000209 :exe "normal \<c-w>\<c-w>"
210< {not in Vi, of course}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211
212:{range}norm[al][!] {commands} *:normal-range*
213 Execute Normal mode commands {commands} for each line
214 in the {range}. Before executing the {commands}, the
215 cursor is positioned in the first column of the range,
216 for each line. Otherwise it's the same as the
217 ":normal" command without a range.
218 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000219
220 *:sh* *:shell* *E371*
221:sh[ell] This command starts a shell. When the shell exits
222 (after the "exit" command) you return to Vim. The
223 name for the shell command comes from 'shell' option.
224 *E360*
225 Note: This doesn't work when Vim on the Amiga was
226 started in QuickFix mode from a compiler, because the
227 compiler will have set stdin to a non-interactive
228 mode.
229
230 *:!cmd* *:!* *E34*
231:!{cmd} Execute {cmd} with the shell. See also the 'shell'
232 and 'shelltype' option.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200233
Bram Moolenaar071d4272004-06-13 20:20:40 +0000234 Any '!' in {cmd} is replaced with the previous
235 external command (see also 'cpoptions'). But not when
236 there is a backslash before the '!', then that
237 backslash is removed. Example: ":!ls" followed by
238 ":!echo ! \! \\!" executes "echo ls ! \!".
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200239
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000240 A '|' in {cmd} is passed to the shell, you cannot use
241 it to append a Vim command. See |:bar|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200242
243 If {cmd} contains "%" it is expanded to the current
244 file name. Special characters are not escaped, use
245 quotes to avoid their special meaning: >
246 :!ls "%"
247< If the file name contains a "$" single quotes might
248 work better (but a single quote causes trouble): >
249 :!ls '%'
250< This should always work, but it's more typing: >
251 :exe "!ls " . shellescape(expand("%"))
252<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000253 A newline character ends {cmd}, what follows is
254 interpreted as a following ":" command. However, if
255 there is a backslash before the newline it is removed
256 and {cmd} continues. It doesn't matter how many
257 backslashes are before the newline, only one is
258 removed.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200259
Bram Moolenaar071d4272004-06-13 20:20:40 +0000260 On Unix the command normally runs in a non-interactive
261 shell. If you want an interactive shell to be used
262 (to use aliases) set 'shellcmdflag' to "-ic".
263 For Win32 also see |:!start|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200264
Bram Moolenaare968e362014-05-13 20:23:24 +0200265 After the command has been executed, the timestamp and
266 size of the current file is checked |timestamp|.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200267
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268 Vim redraws the screen after the command is finished,
269 because it may have printed any text. This requires a
270 hit-enter prompt, so that you can read any messages.
271 To avoid this use: >
272 :silent !{cmd}
273< The screen is not redrawn then, thus you have to use
274 CTRL-L or ":redraw!" if the command did display
275 something.
276 Also see |shell-window|.
277
278 *:!!*
279:!! Repeat last ":!{cmd}".
280
281 *:ve* *:version*
282:ve[rsion] Print the version number of the editor. If the
283 compiler used understands "__DATE__" the compilation
284 date is mentioned. Otherwise a fixed release-date is
285 shown.
286 The following lines contain information about which
287 features were enabled when Vim was compiled. When
288 there is a preceding '+', the feature is included,
289 when there is a '-' it is excluded. To change this,
290 you have to edit feature.h and recompile Vim.
291 To check for this in an expression, see |has()|.
292 Here is an overview of the features.
293 The first column shows the smallest version in which
294 they are included:
295 T tiny
296 S small
297 N normal
298 B big
299 H huge
300 m manually enabled or depends on other features
301 (none) system dependent
302 Thus if a feature is marked with "N", it is included
303 in the normal, big and huge versions of Vim.
304
305 *+feature-list*
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200306 *+acl* |ACL| support included
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 *+ARP* Amiga only: ARP support included
308B *+arabic* |Arabic| language support
309N *+autocmd* |:autocmd|, automatic commands
Bram Moolenaar4d34b432005-03-07 23:22:00 +0000310m *+balloon_eval* |balloon-eval| support. Included when compiling with
311 supported GUI (Motif, GTK, GUI) and either
312 Netbeans/Sun Workshop integration or |+eval| feature.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000313N *+browse* |:browse| command
314N *+builtin_terms* some terminals builtin |builtin-terms|
315B *++builtin_terms* maximal terminals builtin |builtin-terms|
316N *+byte_offset* support for 'o' flag in 'statusline' option, "go"
317 and ":goto" commands.
Bram Moolenaar298b4402016-01-28 22:38:53 +0100318m *+channel* inter process communication |channel|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319N *+cindent* |'cindent'|, C indenting
320N *+clientserver* Unix and Win32: Remote invocation |clientserver|
321 *+clipboard* |clipboard| support
322N *+cmdline_compl* command line completion |cmdline-completion|
323N *+cmdline_hist* command line history |cmdline-history|
324N *+cmdline_info* |'showcmd'| and |'ruler'|
325N *+comments* |'comments'| support
Bram Moolenaarca8c9862010-07-24 15:00:38 +0200326B *+conceal* "conceal" support, see |conceal| |:syn-conceal| etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000327N *+cryptv* encryption support |encryption|
328B *+cscope* |cscope| support
Bram Moolenaar860cae12010-06-05 23:22:07 +0200329m *+cursorbind* |'cursorbind'| support
Bram Moolenaarac6e65f2005-08-29 22:25:38 +0000330m *+cursorshape* |termcap-cursor-shape| support
331m *+debug* Compiled for debugging.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332N *+dialog_gui* Support for |:confirm| with GUI dialog.
333N *+dialog_con* Support for |:confirm| with console dialog.
334N *+dialog_con_gui* Support for |:confirm| with GUI and console dialog.
335N *+diff* |vimdiff| and 'diff'
336N *+digraphs* |digraphs| *E196*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +0200337m *+directx* Win32 GUI only: DirectX and |'renderoptions'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000338 *+dnd* Support for DnD into the "~ register |quote_~|.
339B *+emacs_tags* |emacs-tags| files
340N *+eval* expression evaluation |eval.txt|
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +0100341N *+ex_extra* always on now, used to be for Vim's extra Ex commands
Bram Moolenaar071d4272004-06-13 20:20:40 +0000342N *+extra_search* |'hlsearch'| and |'incsearch'| options.
343B *+farsi* |farsi| language
344N *+file_in_path* |gf|, |CTRL-W_f| and |<cfile>|
345N *+find_in_path* include file searches: |[I|, |:isearch|,
346 |CTRL-W_CTRL-I|, |:checkpath|, etc.
347N *+folding* |folding|
348 *+footer* |gui-footer|
349 *+fork* Unix only: |fork| shell commands
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000350 *+float* Floating point support
Bram Moolenaar071d4272004-06-13 20:20:40 +0000351N *+gettext* message translations |multi-lang|
352 *+GUI_Athena* Unix only: Athena |GUI|
353 *+GUI_neXtaw* Unix only: neXtaw |GUI|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 *+GUI_GTK* Unix only: GTK+ |GUI|
355 *+GUI_Motif* Unix only: Motif |GUI|
356 *+GUI_Photon* QNX only: Photon |GUI|
357m *+hangul_input* Hangul input support |hangul|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000358 *+iconv* Compiled with the |iconv()| function
359 *+iconv/dyn* Likewise |iconv-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000360N *+insert_expand* |insert_expand| Insert mode completion
361N *+jumplist* |jumplist|
362B *+keymap* |'keymap'|
363B *+langmap* |'langmap'|
364N *+libcall* |libcall()|
365N *+linebreak* |'linebreak'|, |'breakat'| and |'showbreak'|
366N *+lispindent* |'lisp'|
367N *+listcmds* Vim commands for the list of buffers |buffer-hidden|
368 and argument list |:argdelete|
369N *+localmap* Support for mappings local to a buffer |:map-local|
Bram Moolenaar0ba04292010-07-14 23:23:17 +0200370m *+lua* |Lua| interface
371m *+lua/dyn* |Lua| interface |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000372N *+menu* |:menu|
373N *+mksession* |:mksession|
374N *+modify_fname* |filename-modifiers|
375N *+mouse* Mouse handling |mouse-using|
376N *+mouseshape* |'mouseshape'|
377B *+mouse_dec* Unix only: Dec terminal mouse handling |dec-mouse|
378N *+mouse_gpm* Unix only: Linux console mouse handling |gpm-mouse|
Bram Moolenaar13600302014-05-22 18:26:40 +0200379N *+mouse_jsbterm* JSB mouse handling |jsbterm-mouse|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000380B *+mouse_netterm* Unix only: netterm mouse handling |netterm-mouse|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100381N *+mouse_pterm* QNX only: pterm mouse handling |qnx-terminal|
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000382N *+mouse_sysmouse* Unix only: *BSD console mouse handling |sysmouse|
Bram Moolenaar9b451252012-08-15 17:43:31 +0200383B *+mouse_sgr* Unix only: sgr mouse handling |sgr-mouse|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100384B *+mouse_urxvt* Unix only: urxvt mouse handling |urxvt-mouse|
385N *+mouse_xterm* Unix only: xterm mouse handling |xterm-mouse|
Bram Moolenaare6ae6222013-05-21 21:01:10 +0200386N *+multi_byte* 16 and 32 bit characters |multibyte|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000387 *+multi_byte_ime* Win32 input method for multibyte chars |multibyte-ime|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100388N *+multi_lang* non-English language support |multi-lang|
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000389m *+mzscheme* Mzscheme interface |mzscheme|
Bram Moolenaar4770d092006-01-12 23:22:24 +0000390m *+mzscheme/dyn* Mzscheme interface |mzscheme-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000391m *+netbeans_intg* |netbeans|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100392m *+ole* Win32 GUI only: |ole-interface|
393N *+path_extra* Up/downwards search in 'path' and 'tags'
Bram Moolenaara5792f52005-11-23 21:25:05 +0000394m *+perl* Perl interface |perl|
395m *+perl/dyn* Perl interface |perl-dynamic| |/dyn|
Bram Moolenaar7fc0c062010-08-10 21:43:35 +0200396N *+persistent_undo* Persistent undo |undo-persistence|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100397 *+postscript* |:hardcopy| writes a PostScript file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000398N *+printer* |:hardcopy| command
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000399H *+profile* |:profile| command
Bram Moolenaar60aad972010-07-21 20:36:22 +0200400m *+python* Python 2 interface |python|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100401m *+python/dyn* Python 2 interface |python-dynamic| |/dyn|
Bram Moolenaar60aad972010-07-21 20:36:22 +0200402m *+python3* Python 3 interface |python|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100403m *+python3/dyn* Python 3 interface |python-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000404N *+quickfix* |:make| and |quickfix| commands
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000405N *+reltime* |reltime()| function, 'hlsearch'/'incsearch' timeout,
406 'redrawtime' option
Bram Moolenaar071d4272004-06-13 20:20:40 +0000407B *+rightleft* Right to left typing |'rightleft'|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000408m *+ruby* Ruby interface |ruby|
409m *+ruby/dyn* Ruby interface |ruby-dynamic| |/dyn|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100410N *+scrollbind* |'scrollbind'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000411B *+signs* |:sign|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100412N *+smartindent* |'smartindent'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000413m *+sniff* SniFF interface |sniff|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100414N *+startuptime* |--startuptime| argument
415N *+statusline* Options 'statusline', 'rulerformat' and special
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416 formats of 'titlestring' and 'iconstring'
417m *+sun_workshop* |workshop|
418N *+syntax* Syntax highlighting |syntax|
419 *+system()* Unix only: opposite of |+fork|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100420N *+tag_binary* binary searching in tags file |tag-binary-search|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000421N *+tag_old_static* old method for static tags |tag-old-static|
422m *+tag_any_white* any white space allowed in tags file |tag-any-white|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100423m *+tcl* Tcl interface |tcl|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000424m *+tcl/dyn* Tcl interface |tcl-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000425 *+terminfo* uses |terminfo| instead of termcap
426N *+termresponse* support for |t_RV| and |v:termresponse|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100427N *+textobjects* |text-objects| selection
Bram Moolenaar071d4272004-06-13 20:20:40 +0000428 *+tgetent* non-Unix only: able to use external termcap
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000429N *+title* Setting the window 'title' and 'icon'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000430N *+toolbar* |gui-toolbar|
431N *+user_commands* User-defined commands. |user-commands|
432N *+viminfo* |'viminfo'|
433N *+vertsplit* Vertically split windows |:vsplit|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100434N *+virtualedit* |'virtualedit'|
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +0100435S *+visual* Visual mode |Visual-mode| Always enabled since 7.4.200.
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100436N *+visualextra* extra Visual mode commands |blockwise-operators|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437N *+vreplace* |gR| and |gr|
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100438N *+wildignore* |'wildignore'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000439N *+wildmenu* |'wildmenu'|
440S *+windows* more than one window
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100441m *+writebackup* |'writebackup'| is default on
442m *+xim* X input method |xim|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000443 *+xfontset* X fontset support |xfontset|
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200444 *+xpm* pixmap support
Bram Moolenaar9b451252012-08-15 17:43:31 +0200445m *+xpm_w32* Win32 GUI only: pixmap support |w32-xpm-support|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446 *+xsmp* XSMP (X session management) support
447 *+xsmp_interact* interactive XSMP (X session management) support
448N *+xterm_clipboard* Unix only: xterm clipboard handling
Bram Moolenaar34feacb2012-12-05 19:01:43 +0100449m *+xterm_save* save and restore xterm screen |xterm-screens|
450N *+X11* Unix only: can restore window title |X11|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000451
452 */dyn* *E370* *E448*
453 To some of the features "/dyn" is added when the
454 feature is only available when the related library can
455 be dynamically loaded.
456
457:ve[rsion] {nr} Is now ignored. This was previously used to check the
458 version number of a .vimrc file. It was removed,
459 because you can now use the ":if" command for
460 version-dependent behavior. {not in Vi}
461
462 *:redi* *:redir*
463:redi[r][!] > {file} Redirect messages to file {file}. The messages which
464 are the output of commands are written to that file,
465 until redirection ends. The messages are also still
466 shown on the screen. When [!] is included, an
467 existing file is overwritten. When [!] is omitted,
468 and {file} exists, this command fails.
469 Only one ":redir" can be active at a time. Calls to
470 ":redir" will close any active redirection before
471 starting redirection to the new target.
472 To stop the messages and commands from being echoed to
473 the screen, put the commands in a function and call it
474 with ":silent call Function()".
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000475 An alternative is to use the 'verbosefile' option,
476 this can be used in combination with ":redir".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000477 {not in Vi}
478
479:redi[r] >> {file} Redirect messages to file {file}. Append if {file}
480 already exists. {not in Vi}
481
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000482:redi[r] @{a-zA-Z}
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +0000483:redi[r] @{a-zA-Z}> Redirect messages to register {a-z}. Append to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000484 contents of the register if its name is given
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000485 uppercase {A-Z}. The ">" after the register name is
486 optional. {not in Vi}
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +0000487:redi[r] @{a-z}>> Append messages to register {a-z}. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000488
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000489:redi[r] @*>
490:redi[r] @+> Redirect messages to the selection or clipboard. For
491 backward compatibility, the ">" after the register
492 name can be omitted. See |quotestar| and |quoteplus|.
493 {not in Vi}
494:redi[r] @*>>
495:redi[r] @+>> Append messages to the selection or clipboard.
496 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000497
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +0000498:redi[r] @"> Redirect messages to the unnamed register. For
499 backward compatibility, the ">" after the register
500 name can be omitted. {not in Vi}
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +0000501:redi[r] @">> Append messages to the unnamed register. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000502
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000503:redi[r] => {var} Redirect messages to a variable. If the variable
504 doesn't exist, then it is created. If the variable
505 exists, then it is initialized to an empty string.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000506 The variable will remain empty until redirection ends.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000507 Only string variables can be used. After the
508 redirection starts, if the variable is removed or
509 locked or the variable type is changed, then further
510 command output messages will cause errors. {not in Vi}
511
512:redi[r] =>> {var} Append messages to an existing variable. Only string
513 variables can be used. {not in Vi}
514
Bram Moolenaar071d4272004-06-13 20:20:40 +0000515:redi[r] END End redirecting messages. {not in Vi}
516
517 *:sil* *:silent*
518:sil[ent][!] {command} Execute {command} silently. Normal messages will not
519 be given or added to the message history.
520 When [!] is added, error messages will also be
521 skipped, and commands and mappings will not be aborted
522 when an error is detected. |v:errmsg| is still set.
523 When [!] is not used, an error message will cause
524 further messages to be displayed normally.
525 Redirection, started with |:redir|, will continue as
526 usual, although there might be small differences.
527 This will allow redirecting the output of a command
528 without seeing it on the screen. Example: >
529 :redir >/tmp/foobar
530 :silent g/Aap/p
531 :redir END
532< To execute a Normal mode command silently, use the
533 |:normal| command. For example, to search for a
534 string without messages: >
535 :silent exe "normal /path\<CR>"
536< ":silent!" is useful to execute a command that may
537 fail, but the failure is to be ignored. Example: >
538 :let v:errmsg = ""
539 :silent! /^begin
540 :if v:errmsg != ""
541 : ... pattern was not found
542< ":silent" will also avoid the hit-enter prompt. When
543 using this for an external command, this may cause the
544 screen to be messed up. Use |CTRL-L| to clean it up
545 then.
546 ":silent menu ..." defines a menu that will not echo a
547 Command-line command. The command will still produce
548 messages though. Use ":silent" in the command itself
549 to avoid that: ":silent menu .... :silent command".
550
Bram Moolenaar8e258a42009-07-09 13:55:43 +0000551 *:uns* *:unsilent*
552:uns[ilent] {command} Execute {command} not silently. Only makes a
553 difference when |:silent| was used to get to this
554 command.
555 Use this for giving a message even when |:silent| was
556 used. In this example |:silent| is used to avoid the
557 message about reading the file and |:unsilent| to be
558 able to list the first line of each file. >
559 :silent argdo unsilent echo expand('%') . ": " . getline(1)
560<
561
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562 *:verb* *:verbose*
563:[count]verb[ose] {command}
564 Execute {command} with 'verbose' set to [count]. If
Bram Moolenaared203462004-06-16 11:19:22 +0000565 [count] is omitted one is used. ":0verbose" can be
566 used to set 'verbose' to zero.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567 The additional use of ":silent" makes messages
568 generated but not displayed.
569 The combination of ":silent" and ":verbose" can be
570 used to generate messages and check them with
571 |v:statusmsg| and friends. For example: >
572 :let v:statusmsg = ""
573 :silent verbose runtime foobar.vim
574 :if v:statusmsg != ""
575 : " foobar.vim could not be found
576 :endif
577< When concatenating another command, the ":verbose"
578 only applies to the first one: >
579 :4verbose set verbose | set verbose
580< verbose=4 ~
581 verbose=0 ~
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000582 For logging verbose messages in a file use the
583 'verbosefile' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000584
Bram Moolenaar8aff23a2005-08-19 20:40:30 +0000585 *:verbose-cmd*
586When 'verbose' is non-zero, listing the value of a Vim option or a key map or
Bram Moolenaare344bea2005-09-01 20:46:49 +0000587an abbreviation or a user-defined function or a command or a highlight group
588or an autocommand will also display where it was last defined. If it was
589defined manually then there will be no "Last set" message. When it was
590defined while executing a function, user command or autocommand, the script in
591which it was defined is reported.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200592{not available when compiled without the |+eval| feature}
Bram Moolenaar8aff23a2005-08-19 20:40:30 +0000593
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594 *K*
595K Run a program to lookup the keyword under the
596 cursor. The name of the program is given with the
597 'keywordprg' (kp) option (default is "man"). The
598 keyword is formed of letters, numbers and the
599 characters in 'iskeyword'. The keyword under or
600 right of the cursor is used. The same can be done
601 with the command >
602 :!{program} {keyword}
603< There is an example of a program to use in the tools
604 directory of Vim. It is called 'ref' and does a
605 simple spelling check.
606 Special cases:
607 - If 'keywordprg' is empty, the ":help" command is
608 used. It's a good idea to include more characters
609 in 'iskeyword' then, to be able to find more help.
610 - When 'keywordprg' is equal to "man", a count before
611 "K" is inserted after the "man" command and before
612 the keyword. For example, using "2K" while the
613 cursor is on "mkdir", results in: >
614 !man 2 mkdir
615< - When 'keywordprg' is equal to "man -s", a count
616 before "K" is inserted after the "-s". If there is
617 no count, the "-s" is removed.
618 {not in Vi}
619
620 *v_K*
621{Visual}K Like "K", but use the visually highlighted text for
622 the keyword. Only works when the highlighted text is
623 not more than one line. {not in Vi}
624
625[N]gs *gs* *:sl* *:sleep*
626:[N]sl[eep] [N] [m] Do nothing for [N] seconds. When [m] is included,
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000627 sleep for [N] milliseconds. The count for "gs" always
Bram Moolenaar071d4272004-06-13 20:20:40 +0000628 uses seconds. The default is one second. >
629 :sleep "sleep for one second
630 :5sleep "sleep for five seconds
631 :sleep 100m "sleep for a hundred milliseconds
632 10gs "sleep for ten seconds
633< Can be interrupted with CTRL-C (CTRL-Break on MS-DOS).
Bram Moolenaar677ee682005-01-27 14:41:15 +0000634 "gs" stands for "goto sleep".
635 While sleeping the cursor is positioned in the text,
636 if at a visible position. {not in Vi}
Bram Moolenaar15146672011-10-20 22:22:38 +0200637 Also process the received netbeans messages. {only
638 available when compiled with the |+netbeans_intg|
639 feature}
640
Bram Moolenaar071d4272004-06-13 20:20:40 +0000641
642 *g_CTRL-A*
643g CTRL-A Only when Vim was compiled with MEM_PROFILING defined
644 (which is very rare): print memory usage statistics.
645 Only useful for debugging Vim.
Bram Moolenaar345efa02016-01-15 20:57:49 +0100646 For incrementing in Visual mode see |v_g_CTRL-A|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000647
648==============================================================================
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +02006492. Using Vim like less or more *less*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650
651If you use the less or more program to view a file, you don't get syntax
652highlighting. Thus you would like to use Vim instead. You can do this by
653using the shell script "$VIMRUNTIME/macros/less.sh".
654
655This shell script uses the Vim script "$VIMRUNTIME/macros/less.vim". It sets
656up mappings to simulate the commands that less supports. Otherwise, you can
657still use the Vim commands.
658
659This isn't perfect. For example, when viewing a short file Vim will still use
660the whole screen. But it works good enough for most uses, and you get syntax
661highlighting.
662
663The "h" key will give you a short overview of the available commands.
664
Bram Moolenaare392eb42015-11-19 20:38:09 +0100665If you want to set options differently when using less, define the
666LessInitFunc in your vimrc, for example: >
667
668 func LessInitFunc()
669 set nocursorcolumn nocursorline
670 endfunc
671<
672
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673 vim:tw=78:ts=8:ft=help:norl: