blob: 3f1d061ba5bcbbde585518584288e3c1a8f5903f [file] [log] [blame]
Bram Moolenaarfff2bee2010-05-15 13:56:02 +02001*various.txt* For Vim version 7.3a. Last change: 2010 May 13
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 Moolenaar5313dcb2005-02-22 08:56:13 +0000104 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000105
106 *:l* *:list*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000107:[range]l[ist] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000108 Same as :print, but display unprintable characters
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000109 with '^' and put $ after the line.
110 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000111
112 *:nu* *:number*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000113:[range]nu[mber] [count] [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000114 Same as :print, but precede each line with its line
Bram Moolenaarfaa959a2006-02-20 21:37:40 +0000115 number. (See also 'highlight' and 'numberwidth'
116 option).
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000117 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000118
119 *:#*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000120:[range]# [count] [flags]
121 synonym for :number.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000123 *:#!*
124:#!{anything} Ignored, so that you can start a Vim script with: >
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000125 #!vim -S
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000126 echo "this is a Vim script"
127 quit
128<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000129 *:z* *E144*
130:{range}z[+-^.=]{count} Display several lines of text surrounding the line
131 specified with {range}, or around the current line
132 if there is no {range}. If there is a {count}, that's
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000133 how many lines you'll see; if there is only one window
134 then the 'window' option is used, otherwise the
135 current window size is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000136
137 :z can be used either alone or followed by any of
138 several punctuation marks. These have the following
139 effect:
140
141 mark first line last line new location ~
142 ---- ---------- --------- ------------
143 + current line 1 scr forward 1 scr forward
144 - 1 scr back current line current line
145 ^ 2 scr back 1 scr back 1 scr back
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +0000146 . 1/2 scr back 1/2 scr fwd 1/2 scr fwd
147 = 1/2 scr back 1/2 scr fwd current line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148
149 Specifying no mark at all is the same as "+".
150 If the mark is "=", a line of dashes is printed
151 around the current line.
152
153:{range}z#[+-^.=]{count} *:z#*
154 Like ":z", but number the lines.
155 {not in all versions of Vi, not with these arguments}
156
157 *:=*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000158:= [flags] Print the last line number.
159 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000160
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000161:{range}= [flags] Prints the last line number in {range}. For example,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000162 this prints the current line number: >
163 :.=
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000164< See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000165
166:norm[al][!] {commands} *:norm* *:normal*
167 Execute Normal mode commands {commands}. This makes
168 it possible to execute Normal mode commands typed on
169 the command-line. {commands} is executed like it is
170 typed. For undo all commands are undone together.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000171 Execution stops when an error is encountered.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000172 If the [!] is given, mappings will not be used.
173 {commands} should be a complete command. If
174 {commands} does not finish a command, the last one
175 will be aborted as if <Esc> or <C-C> was typed.
176 The display isn't updated while ":normal" is busy.
177 This implies that an insert command must be completed
178 (to start Insert mode, see |:startinsert|). A ":"
Bram Moolenaar7c626922005-02-07 22:01:03 +0000179 command must be completed as well. And you can't use
180 "Q" or "gQ" to start Ex mode.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100181 {commands} cannot start with a space. Put a count of
182 1 (one) before it, "1 " is one space.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000183 The 'insertmode' option is ignored for {commands}.
184 This command cannot be followed by another command,
185 since any '|' is considered part of the command.
186 This command can be used recursively, but the depth is
187 limited by 'maxmapdepth'.
188 When this command is called from a non-remappable
189 mapping |:noremap|, the argument can be mapped anyway.
190 An alternative is to use |:execute|, which uses an
191 expression as argument. This allows the use of
192 printable characters. Example: >
193 :exe "normal \<c-w>\<c-w>"
194< {not in Vi, of course}
195 {not available when the |+ex_extra| feature was
196 disabled at compile time}
197
198:{range}norm[al][!] {commands} *:normal-range*
199 Execute Normal mode commands {commands} for each line
200 in the {range}. Before executing the {commands}, the
201 cursor is positioned in the first column of the range,
202 for each line. Otherwise it's the same as the
203 ":normal" command without a range.
204 {not in Vi}
205 Not available when |+ex_extra| feature was disabled at
206 compile time.
207
208 *:sh* *:shell* *E371*
209:sh[ell] This command starts a shell. When the shell exits
210 (after the "exit" command) you return to Vim. The
211 name for the shell command comes from 'shell' option.
212 *E360*
213 Note: This doesn't work when Vim on the Amiga was
214 started in QuickFix mode from a compiler, because the
215 compiler will have set stdin to a non-interactive
216 mode.
217
218 *:!cmd* *:!* *E34*
219:!{cmd} Execute {cmd} with the shell. See also the 'shell'
220 and 'shelltype' option.
221 Any '!' in {cmd} is replaced with the previous
222 external command (see also 'cpoptions'). But not when
223 there is a backslash before the '!', then that
224 backslash is removed. Example: ":!ls" followed by
225 ":!echo ! \! \\!" executes "echo ls ! \!".
226 After the command has been executed, the timestamp of
227 the current file is checked |timestamp|.
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000228 A '|' in {cmd} is passed to the shell, you cannot use
229 it to append a Vim command. See |:bar|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000230 A newline character ends {cmd}, what follows is
231 interpreted as a following ":" command. However, if
232 there is a backslash before the newline it is removed
233 and {cmd} continues. It doesn't matter how many
234 backslashes are before the newline, only one is
235 removed.
236 On Unix the command normally runs in a non-interactive
237 shell. If you want an interactive shell to be used
238 (to use aliases) set 'shellcmdflag' to "-ic".
239 For Win32 also see |:!start|.
240 Vim redraws the screen after the command is finished,
241 because it may have printed any text. This requires a
242 hit-enter prompt, so that you can read any messages.
243 To avoid this use: >
244 :silent !{cmd}
245< The screen is not redrawn then, thus you have to use
246 CTRL-L or ":redraw!" if the command did display
247 something.
248 Also see |shell-window|.
249
250 *:!!*
251:!! Repeat last ":!{cmd}".
252
253 *:ve* *:version*
254:ve[rsion] Print the version number of the editor. If the
255 compiler used understands "__DATE__" the compilation
256 date is mentioned. Otherwise a fixed release-date is
257 shown.
258 The following lines contain information about which
259 features were enabled when Vim was compiled. When
260 there is a preceding '+', the feature is included,
261 when there is a '-' it is excluded. To change this,
262 you have to edit feature.h and recompile Vim.
263 To check for this in an expression, see |has()|.
264 Here is an overview of the features.
265 The first column shows the smallest version in which
266 they are included:
267 T tiny
268 S small
269 N normal
270 B big
271 H huge
272 m manually enabled or depends on other features
273 (none) system dependent
274 Thus if a feature is marked with "N", it is included
275 in the normal, big and huge versions of Vim.
276
277 *+feature-list*
278 *+ARP* Amiga only: ARP support included
279B *+arabic* |Arabic| language support
280N *+autocmd* |:autocmd|, automatic commands
Bram Moolenaar4d34b432005-03-07 23:22:00 +0000281m *+balloon_eval* |balloon-eval| support. Included when compiling with
282 supported GUI (Motif, GTK, GUI) and either
283 Netbeans/Sun Workshop integration or |+eval| feature.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000284N *+browse* |:browse| command
285N *+builtin_terms* some terminals builtin |builtin-terms|
286B *++builtin_terms* maximal terminals builtin |builtin-terms|
287N *+byte_offset* support for 'o' flag in 'statusline' option, "go"
288 and ":goto" commands.
289N *+cindent* |'cindent'|, C indenting
290N *+clientserver* Unix and Win32: Remote invocation |clientserver|
291 *+clipboard* |clipboard| support
292N *+cmdline_compl* command line completion |cmdline-completion|
293N *+cmdline_hist* command line history |cmdline-history|
294N *+cmdline_info* |'showcmd'| and |'ruler'|
295N *+comments* |'comments'| support
296N *+cryptv* encryption support |encryption|
297B *+cscope* |cscope| support
Bram Moolenaarac6e65f2005-08-29 22:25:38 +0000298m *+cursorshape* |termcap-cursor-shape| support
299m *+debug* Compiled for debugging.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000300N *+dialog_gui* Support for |:confirm| with GUI dialog.
301N *+dialog_con* Support for |:confirm| with console dialog.
302N *+dialog_con_gui* Support for |:confirm| with GUI and console dialog.
303N *+diff* |vimdiff| and 'diff'
304N *+digraphs* |digraphs| *E196*
305 *+dnd* Support for DnD into the "~ register |quote_~|.
306B *+emacs_tags* |emacs-tags| files
307N *+eval* expression evaluation |eval.txt|
308N *+ex_extra* Vim's extra Ex commands: |:center|, |:left|,
309 |:normal|, |:retab| and |:right|
310N *+extra_search* |'hlsearch'| and |'incsearch'| options.
311B *+farsi* |farsi| language
312N *+file_in_path* |gf|, |CTRL-W_f| and |<cfile>|
313N *+find_in_path* include file searches: |[I|, |:isearch|,
314 |CTRL-W_CTRL-I|, |:checkpath|, etc.
315N *+folding* |folding|
316 *+footer* |gui-footer|
317 *+fork* Unix only: |fork| shell commands
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000318 *+float* Floating point support
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319N *+gettext* message translations |multi-lang|
320 *+GUI_Athena* Unix only: Athena |GUI|
321 *+GUI_neXtaw* Unix only: neXtaw |GUI|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000322 *+GUI_GTK* Unix only: GTK+ |GUI|
323 *+GUI_Motif* Unix only: Motif |GUI|
324 *+GUI_Photon* QNX only: Photon |GUI|
325m *+hangul_input* Hangul input support |hangul|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000326 *+iconv* Compiled with the |iconv()| function
327 *+iconv/dyn* Likewise |iconv-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000328N *+insert_expand* |insert_expand| Insert mode completion
329N *+jumplist* |jumplist|
330B *+keymap* |'keymap'|
331B *+langmap* |'langmap'|
332N *+libcall* |libcall()|
333N *+linebreak* |'linebreak'|, |'breakat'| and |'showbreak'|
334N *+lispindent* |'lisp'|
335N *+listcmds* Vim commands for the list of buffers |buffer-hidden|
336 and argument list |:argdelete|
337N *+localmap* Support for mappings local to a buffer |:map-local|
338N *+menu* |:menu|
339N *+mksession* |:mksession|
340N *+modify_fname* |filename-modifiers|
341N *+mouse* Mouse handling |mouse-using|
342N *+mouseshape* |'mouseshape'|
343B *+mouse_dec* Unix only: Dec terminal mouse handling |dec-mouse|
344N *+mouse_gpm* Unix only: Linux console mouse handling |gpm-mouse|
345B *+mouse_netterm* Unix only: netterm mouse handling |netterm-mouse|
346N *+mouse_pterm* QNX only: pterm mouse handling |qnx-terminal|
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000347N *+mouse_sysmouse* Unix only: *BSD console mouse handling |sysmouse|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000348N *+mouse_xterm* Unix only: xterm mouse handling |xterm-mouse|
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100349B *+multi_byte* 16 and 32 bit characters |multibyte|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350 *+multi_byte_ime* Win32 input method for multibyte chars |multibyte-ime|
351N *+multi_lang* non-English language support |multi-lang|
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000352m *+mzscheme* Mzscheme interface |mzscheme|
Bram Moolenaar4770d092006-01-12 23:22:24 +0000353m *+mzscheme/dyn* Mzscheme interface |mzscheme-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354m *+netbeans_intg* |netbeans|
355m *+ole* Win32 GUI only: |ole-interface|
356 *+osfiletype* Support for the 'osfiletype' option and filetype
357 checking in automatic commands. |autocmd-osfiletypes|
358N *+path_extra* Up/downwards search in 'path' and 'tags'
Bram Moolenaara5792f52005-11-23 21:25:05 +0000359m *+perl* Perl interface |perl|
360m *+perl/dyn* Perl interface |perl-dynamic| |/dyn|
Bram Moolenaar55debbe2010-05-23 23:34:36 +0200361H *+persistent_undo* Persistent undo |undo-persistence|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000362 *+postscript* |:hardcopy| writes a PostScript file
363N *+printer* |:hardcopy| command
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000364H *+profile* |:profile| command
Bram Moolenaara5792f52005-11-23 21:25:05 +0000365m *+python* Python interface |python|
366m *+python/dyn* Python interface |python-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367N *+quickfix* |:make| and |quickfix| commands
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000368N *+reltime* |reltime()| function, 'hlsearch'/'incsearch' timeout,
369 'redrawtime' option
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370B *+rightleft* Right to left typing |'rightleft'|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000371m *+ruby* Ruby interface |ruby|
372m *+ruby/dyn* Ruby interface |ruby-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373N *+scrollbind* |'scrollbind'|
374B *+signs* |:sign|
375N *+smartindent* |'smartindent'|
376m *+sniff* SniFF interface |sniff|
Bram Moolenaaref94eec2009-11-11 13:22:11 +0000377N *+startuptime* |--startuptime| argument
Bram Moolenaar071d4272004-06-13 20:20:40 +0000378N *+statusline* Options 'statusline', 'rulerformat' and special
379 formats of 'titlestring' and 'iconstring'
380m *+sun_workshop* |workshop|
381N *+syntax* Syntax highlighting |syntax|
382 *+system()* Unix only: opposite of |+fork|
383N *+tag_binary* binary searching in tags file |tag-binary-search|
384N *+tag_old_static* old method for static tags |tag-old-static|
385m *+tag_any_white* any white space allowed in tags file |tag-any-white|
Bram Moolenaara5792f52005-11-23 21:25:05 +0000386m *+tcl* Tcl interface |tcl|
387m *+tcl/dyn* Tcl interface |tcl-dynamic| |/dyn|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000388 *+terminfo* uses |terminfo| instead of termcap
389N *+termresponse* support for |t_RV| and |v:termresponse|
390N *+textobjects* |text-objects| selection
391 *+tgetent* non-Unix only: able to use external termcap
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000392N *+title* Setting the window 'title' and 'icon'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000393N *+toolbar* |gui-toolbar|
394N *+user_commands* User-defined commands. |user-commands|
395N *+viminfo* |'viminfo'|
396N *+vertsplit* Vertically split windows |:vsplit|
397N *+virtualedit* |'virtualedit'|
398S *+visual* Visual mode |Visual-mode|
399N *+visualextra* extra Visual mode commands |blockwise-operators|
400N *+vreplace* |gR| and |gr|
401N *+wildignore* |'wildignore'|
402N *+wildmenu* |'wildmenu'|
403S *+windows* more than one window
404m *+writebackup* |'writebackup'| is default on
405m *+xim* X input method |xim|
406 *+xfontset* X fontset support |xfontset|
407 *+xsmp* XSMP (X session management) support
408 *+xsmp_interact* interactive XSMP (X session management) support
409N *+xterm_clipboard* Unix only: xterm clipboard handling
410m *+xterm_save* save and restore xterm screen |xterm-screens|
411N *+X11* Unix only: can restore window title |X11|
412
413 */dyn* *E370* *E448*
414 To some of the features "/dyn" is added when the
415 feature is only available when the related library can
416 be dynamically loaded.
417
418:ve[rsion] {nr} Is now ignored. This was previously used to check the
419 version number of a .vimrc file. It was removed,
420 because you can now use the ":if" command for
421 version-dependent behavior. {not in Vi}
422
423 *:redi* *:redir*
424:redi[r][!] > {file} Redirect messages to file {file}. The messages which
425 are the output of commands are written to that file,
426 until redirection ends. The messages are also still
427 shown on the screen. When [!] is included, an
428 existing file is overwritten. When [!] is omitted,
429 and {file} exists, this command fails.
430 Only one ":redir" can be active at a time. Calls to
431 ":redir" will close any active redirection before
432 starting redirection to the new target.
433 To stop the messages and commands from being echoed to
434 the screen, put the commands in a function and call it
435 with ":silent call Function()".
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000436 An alternative is to use the 'verbosefile' option,
437 this can be used in combination with ":redir".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438 {not in Vi}
439
440:redi[r] >> {file} Redirect messages to file {file}. Append if {file}
441 already exists. {not in Vi}
442
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000443:redi[r] @{a-zA-Z}
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +0000444:redi[r] @{a-zA-Z}> Redirect messages to register {a-z}. Append to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000445 contents of the register if its name is given
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000446 uppercase {A-Z}. The ">" after the register name is
447 optional. {not in Vi}
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +0000448:redi[r] @{a-z}>> Append messages to register {a-z}. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000449
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000450:redi[r] @*>
451:redi[r] @+> Redirect messages to the selection or clipboard. For
452 backward compatibility, the ">" after the register
453 name can be omitted. See |quotestar| and |quoteplus|.
454 {not in Vi}
455:redi[r] @*>>
456:redi[r] @+>> Append messages to the selection or clipboard.
457 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000458
Bram Moolenaar6c0b44b2005-06-01 21:56:33 +0000459:redi[r] @"> Redirect messages to the unnamed register. For
460 backward compatibility, the ">" after the register
461 name can be omitted. {not in Vi}
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +0000462:redi[r] @">> Append messages to the unnamed register. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000463
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000464:redi[r] => {var} Redirect messages to a variable. If the variable
465 doesn't exist, then it is created. If the variable
466 exists, then it is initialized to an empty string.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000467 The variable will remain empty until redirection ends.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000468 Only string variables can be used. After the
469 redirection starts, if the variable is removed or
470 locked or the variable type is changed, then further
471 command output messages will cause errors. {not in Vi}
472
473:redi[r] =>> {var} Append messages to an existing variable. Only string
474 variables can be used. {not in Vi}
475
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476:redi[r] END End redirecting messages. {not in Vi}
477
478 *:sil* *:silent*
479:sil[ent][!] {command} Execute {command} silently. Normal messages will not
480 be given or added to the message history.
481 When [!] is added, error messages will also be
482 skipped, and commands and mappings will not be aborted
483 when an error is detected. |v:errmsg| is still set.
484 When [!] is not used, an error message will cause
485 further messages to be displayed normally.
486 Redirection, started with |:redir|, will continue as
487 usual, although there might be small differences.
488 This will allow redirecting the output of a command
489 without seeing it on the screen. Example: >
490 :redir >/tmp/foobar
491 :silent g/Aap/p
492 :redir END
493< To execute a Normal mode command silently, use the
494 |:normal| command. For example, to search for a
495 string without messages: >
496 :silent exe "normal /path\<CR>"
497< ":silent!" is useful to execute a command that may
498 fail, but the failure is to be ignored. Example: >
499 :let v:errmsg = ""
500 :silent! /^begin
501 :if v:errmsg != ""
502 : ... pattern was not found
503< ":silent" will also avoid the hit-enter prompt. When
504 using this for an external command, this may cause the
505 screen to be messed up. Use |CTRL-L| to clean it up
506 then.
507 ":silent menu ..." defines a menu that will not echo a
508 Command-line command. The command will still produce
509 messages though. Use ":silent" in the command itself
510 to avoid that: ":silent menu .... :silent command".
511
Bram Moolenaar8e258a42009-07-09 13:55:43 +0000512 *:uns* *:unsilent*
513:uns[ilent] {command} Execute {command} not silently. Only makes a
514 difference when |:silent| was used to get to this
515 command.
516 Use this for giving a message even when |:silent| was
517 used. In this example |:silent| is used to avoid the
518 message about reading the file and |:unsilent| to be
519 able to list the first line of each file. >
520 :silent argdo unsilent echo expand('%') . ": " . getline(1)
521<
522
Bram Moolenaar071d4272004-06-13 20:20:40 +0000523 *:verb* *:verbose*
524:[count]verb[ose] {command}
525 Execute {command} with 'verbose' set to [count]. If
Bram Moolenaared203462004-06-16 11:19:22 +0000526 [count] is omitted one is used. ":0verbose" can be
527 used to set 'verbose' to zero.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000528 The additional use of ":silent" makes messages
529 generated but not displayed.
530 The combination of ":silent" and ":verbose" can be
531 used to generate messages and check them with
532 |v:statusmsg| and friends. For example: >
533 :let v:statusmsg = ""
534 :silent verbose runtime foobar.vim
535 :if v:statusmsg != ""
536 : " foobar.vim could not be found
537 :endif
538< When concatenating another command, the ":verbose"
539 only applies to the first one: >
540 :4verbose set verbose | set verbose
541< verbose=4 ~
542 verbose=0 ~
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000543 For logging verbose messages in a file use the
544 'verbosefile' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000545
Bram Moolenaar8aff23a2005-08-19 20:40:30 +0000546 *:verbose-cmd*
547When 'verbose' is non-zero, listing the value of a Vim option or a key map or
Bram Moolenaare344bea2005-09-01 20:46:49 +0000548an abbreviation or a user-defined function or a command or a highlight group
549or an autocommand will also display where it was last defined. If it was
550defined manually then there will be no "Last set" message. When it was
551defined while executing a function, user command or autocommand, the script in
552which it was defined is reported.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +0000553{not available when compiled without the +eval feature}
554
Bram Moolenaar071d4272004-06-13 20:20:40 +0000555 *K*
556K Run a program to lookup the keyword under the
557 cursor. The name of the program is given with the
558 'keywordprg' (kp) option (default is "man"). The
559 keyword is formed of letters, numbers and the
560 characters in 'iskeyword'. The keyword under or
561 right of the cursor is used. The same can be done
562 with the command >
563 :!{program} {keyword}
564< There is an example of a program to use in the tools
565 directory of Vim. It is called 'ref' and does a
566 simple spelling check.
567 Special cases:
568 - If 'keywordprg' is empty, the ":help" command is
569 used. It's a good idea to include more characters
570 in 'iskeyword' then, to be able to find more help.
571 - When 'keywordprg' is equal to "man", a count before
572 "K" is inserted after the "man" command and before
573 the keyword. For example, using "2K" while the
574 cursor is on "mkdir", results in: >
575 !man 2 mkdir
576< - When 'keywordprg' is equal to "man -s", a count
577 before "K" is inserted after the "-s". If there is
578 no count, the "-s" is removed.
579 {not in Vi}
580
581 *v_K*
582{Visual}K Like "K", but use the visually highlighted text for
583 the keyword. Only works when the highlighted text is
584 not more than one line. {not in Vi}
585
586[N]gs *gs* *:sl* *:sleep*
587:[N]sl[eep] [N] [m] Do nothing for [N] seconds. When [m] is included,
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000588 sleep for [N] milliseconds. The count for "gs" always
Bram Moolenaar071d4272004-06-13 20:20:40 +0000589 uses seconds. The default is one second. >
590 :sleep "sleep for one second
591 :5sleep "sleep for five seconds
592 :sleep 100m "sleep for a hundred milliseconds
593 10gs "sleep for ten seconds
594< Can be interrupted with CTRL-C (CTRL-Break on MS-DOS).
Bram Moolenaar677ee682005-01-27 14:41:15 +0000595 "gs" stands for "goto sleep".
596 While sleeping the cursor is positioned in the text,
597 if at a visible position. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598
599 *g_CTRL-A*
600g CTRL-A Only when Vim was compiled with MEM_PROFILING defined
601 (which is very rare): print memory usage statistics.
602 Only useful for debugging Vim.
603
604==============================================================================
Bram Moolenaareb3593b2006-04-22 22:33:57 +00006053. Using Vim like less or more *less*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000606
607If you use the less or more program to view a file, you don't get syntax
608highlighting. Thus you would like to use Vim instead. You can do this by
609using the shell script "$VIMRUNTIME/macros/less.sh".
610
611This shell script uses the Vim script "$VIMRUNTIME/macros/less.vim". It sets
612up mappings to simulate the commands that less supports. Otherwise, you can
613still use the Vim commands.
614
615This isn't perfect. For example, when viewing a short file Vim will still use
616the whole screen. But it works good enough for most uses, and you get syntax
617highlighting.
618
619The "h" key will give you a short overview of the available commands.
620
621 vim:tw=78:ts=8:ft=help:norl: