Mercurial > vim
annotate runtime/doc/various.txt @ 2154:7c8c7c95a865 vim73
First step in the Vim 7.3 branch. Changed version numbers.
author | Bram Moolenaar <bram@zimbu.org> |
---|---|
date | Sat, 15 May 2010 13:56:02 +0200 |
parents | b9e314fe473f |
children | 733f0dc510c3 f8222d1f9a73 |
rev | line source |
---|---|
2154
7c8c7c95a865
First step in the Vim 7.3 branch. Changed version numbers.
Bram Moolenaar <bram@zimbu.org>
parents:
2152
diff
changeset
|
1 *various.txt* For Vim version 7.3a. Last change: 2010 May 13 |
7 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Bram Moolenaar | |
5 | |
6 | |
7 Various commands *various* | |
8 | |
9 1. Various commands |various-cmds| | |
10 2. Online help |online-help| | |
15 | 11 3. Using Vim like less or more |less| |
7 | 12 |
13 ============================================================================== | |
14 1. Various commands *various-cmds* | |
15 | |
16 *CTRL-L* | |
348 | 17 CTRL-L Clear and redraw the screen. The redraw may happen |
18 later, after processing typeahead. | |
7 | 19 |
20 *:redr* *:redraw* | |
21 :redr[aw][!] Redraw the screen right now. When ! is included it is | |
22 cleared first. | |
23 Useful to update the screen halfway executing a script | |
24 or function. Also when halfway a mapping and | |
25 'lazyredraw' is set. | |
26 | |
27 *:redraws* *:redrawstatus* | |
28 :redraws[tatus][!] Redraw the status line of the current window. When ! | |
29 is included all status lines are redrawn. | |
30 Useful to update the status line(s) when 'statusline' | |
31 includes an item that doesn't cause automatic | |
32 updating. | |
33 | |
34 *N<Del>* | |
35 <Del> When entering a number: Remove the last digit. | |
36 Note: if you like to use <BS> for this, add this | |
37 mapping to your .vimrc: > | |
38 :map CTRL-V <BS> CTRL-V <Del> | |
39 < See |:fixdel| if your <Del> key does not do what you | |
40 want. | |
41 | |
42 :as[cii] or *ga* *:as* *:ascii* | |
43 ga Print the ascii value of the character under the | |
44 cursor in decimal, hexadecimal and octal. For | |
45 example, when the cursor is on a 'R': | |
46 <R> 82, Hex 52, Octal 122 ~ | |
47 When the character is a non-standard ASCII character, | |
48 but printable according to the 'isprint' option, the | |
49 non-printable version is also given. When the | |
50 character is larger than 127, the <M-x> form is also | |
51 printed. For example: | |
52 <~A> <M-^A> 129, Hex 81, Octal 201 ~ | |
53 <p> <|~> <M-~> 254, Hex fe, Octal 376 ~ | |
54 (where <p> is a special character) | |
55 The <Nul> character in a file is stored internally as | |
56 <NL>, but it will be shown as: | |
57 <^@> 0, Hex 00, Octal 000 ~ | |
714 | 58 If the character has composing characters these are |
59 also shown. The value of 'maxcombine' doesn't matter. | |
7 | 60 Mnemonic: Get Ascii value. {not in Vi} |
61 | |
62 *g8* | |
63 g8 Print the hex values of the bytes used in the | |
64 character under the cursor, assuming it is in |UTF-8| | |
714 | 65 encoding. This also shows composing characters. The |
66 value of 'maxcombine' doesn't matter. | |
67 Example of a character with two composing characters: | |
7 | 68 e0 b8 81 + e0 b8 b9 + e0 b9 89 ~ |
777 | 69 {not in Vi} {only when compiled with the |+multi_byte| |
70 feature} | |
71 | |
72 *8g8* | |
73 8g8 Find an illegal UTF-8 byte sequence at or after the | |
74 cursor. This works in two situations: | |
75 1. when 'encoding' is any 8-bit encoding | |
76 2. when 'encoding' is "utf-8" and 'fileencoding' is | |
77 any 8-bit encoding | |
78 Thus it can be used when editing a file that was | |
79 supposed to be UTF-8 but was read as if it is an 8-bit | |
80 encoding because it contains illegal bytes. | |
81 Does not wrap around the end of the file. | |
82 Note that when the cursor is on an illegal byte or the | |
83 cursor is halfway a multi-byte character the command | |
84 won't move the cursor. | |
85 {not in Vi} {only when compiled with the |+multi_byte| | |
86 feature} | |
7 | 87 |
843 | 88 *:p* *:pr* *:print* *E749* |
169 | 89 :[range]p[rint] [flags] |
90 Print [range] lines (default current line). | |
7 | 91 Note: If you are looking for a way to print your text |
169 | 92 on paper see |:hardcopy|. In the GUI you can use the |
93 File.Print menu entry. | |
94 See |ex-flags| for [flags]. | |
7 | 95 |
169 | 96 :[range]p[rint] {count} [flags] |
7 | 97 Print {count} lines, starting with [range] (default |
98 current line |cmdline-ranges|). | |
169 | 99 See |ex-flags| for [flags]. |
7 | 100 |
101 *:P* *:Print* | |
169 | 102 :[range]P[rint] [count] [flags] |
7 | 103 Just as ":print". Was apparently added to Vi for |
104 people that keep the shift key pressed too long... | |
169 | 105 See |ex-flags| for [flags]. |
7 | 106 |
107 *:l* *:list* | |
169 | 108 :[range]l[ist] [count] [flags] |
7 | 109 Same as :print, but display unprintable characters |
169 | 110 with '^' and put $ after the line. |
111 See |ex-flags| for [flags]. | |
7 | 112 |
113 *:nu* *:number* | |
169 | 114 :[range]nu[mber] [count] [flags] |
7 | 115 Same as :print, but precede each line with its line |
677 | 116 number. (See also 'highlight' and 'numberwidth' |
117 option). | |
169 | 118 See |ex-flags| for [flags]. |
7 | 119 |
120 *:#* | |
169 | 121 :[range]# [count] [flags] |
122 synonym for :number. | |
7 | 123 |
1125 | 124 *:#!* |
125 :#!{anything} Ignored, so that you can start a Vim script with: > | |
1624 | 126 #!vim -S |
1125 | 127 echo "this is a Vim script" |
128 quit | |
129 < | |
7 | 130 *:z* *E144* |
131 :{range}z[+-^.=]{count} Display several lines of text surrounding the line | |
132 specified with {range}, or around the current line | |
133 if there is no {range}. If there is a {count}, that's | |
164 | 134 how many lines you'll see; if there is only one window |
135 then the 'window' option is used, otherwise the | |
136 current window size is used. | |
7 | 137 |
138 :z can be used either alone or followed by any of | |
139 several punctuation marks. These have the following | |
140 effect: | |
141 | |
142 mark first line last line new location ~ | |
143 ---- ---------- --------- ------------ | |
144 + current line 1 scr forward 1 scr forward | |
145 - 1 scr back current line current line | |
146 ^ 2 scr back 1 scr back 1 scr back | |
159 | 147 . 1/2 scr back 1/2 scr fwd 1/2 scr fwd |
148 = 1/2 scr back 1/2 scr fwd current line | |
7 | 149 |
150 Specifying no mark at all is the same as "+". | |
151 If the mark is "=", a line of dashes is printed | |
152 around the current line. | |
153 | |
154 :{range}z#[+-^.=]{count} *:z#* | |
155 Like ":z", but number the lines. | |
156 {not in all versions of Vi, not with these arguments} | |
157 | |
158 *:=* | |
169 | 159 := [flags] Print the last line number. |
160 See |ex-flags| for [flags]. | |
7 | 161 |
169 | 162 :{range}= [flags] Prints the last line number in {range}. For example, |
7 | 163 this prints the current line number: > |
164 :.= | |
169 | 165 < See |ex-flags| for [flags]. |
7 | 166 |
167 :norm[al][!] {commands} *:norm* *:normal* | |
168 Execute Normal mode commands {commands}. This makes | |
169 it possible to execute Normal mode commands typed on | |
170 the command-line. {commands} is executed like it is | |
171 typed. For undo all commands are undone together. | |
1125 | 172 Execution stops when an error is encountered. |
7 | 173 If the [!] is given, mappings will not be used. |
174 {commands} should be a complete command. If | |
175 {commands} does not finish a command, the last one | |
176 will be aborted as if <Esc> or <C-C> was typed. | |
177 The display isn't updated while ":normal" is busy. | |
178 This implies that an insert command must be completed | |
179 (to start Insert mode, see |:startinsert|). A ":" | |
161 | 180 command must be completed as well. And you can't use |
181 "Q" or "gQ" to start Ex mode. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
182 {commands} cannot start with a space. Put a count of |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
183 1 (one) before it, "1 " is one space. |
7 | 184 The 'insertmode' option is ignored for {commands}. |
185 This command cannot be followed by another command, | |
186 since any '|' is considered part of the command. | |
187 This command can be used recursively, but the depth is | |
188 limited by 'maxmapdepth'. | |
189 When this command is called from a non-remappable | |
190 mapping |:noremap|, the argument can be mapped anyway. | |
191 An alternative is to use |:execute|, which uses an | |
192 expression as argument. This allows the use of | |
193 printable characters. Example: > | |
194 :exe "normal \<c-w>\<c-w>" | |
195 < {not in Vi, of course} | |
196 {not available when the |+ex_extra| feature was | |
197 disabled at compile time} | |
198 | |
199 :{range}norm[al][!] {commands} *:normal-range* | |
200 Execute Normal mode commands {commands} for each line | |
201 in the {range}. Before executing the {commands}, the | |
202 cursor is positioned in the first column of the range, | |
203 for each line. Otherwise it's the same as the | |
204 ":normal" command without a range. | |
205 {not in Vi} | |
206 Not available when |+ex_extra| feature was disabled at | |
207 compile time. | |
208 | |
209 *:sh* *:shell* *E371* | |
210 :sh[ell] This command starts a shell. When the shell exits | |
211 (after the "exit" command) you return to Vim. The | |
212 name for the shell command comes from 'shell' option. | |
213 *E360* | |
214 Note: This doesn't work when Vim on the Amiga was | |
215 started in QuickFix mode from a compiler, because the | |
216 compiler will have set stdin to a non-interactive | |
217 mode. | |
218 | |
219 *:!cmd* *:!* *E34* | |
220 :!{cmd} Execute {cmd} with the shell. See also the 'shell' | |
221 and 'shelltype' option. | |
222 Any '!' in {cmd} is replaced with the previous | |
223 external command (see also 'cpoptions'). But not when | |
224 there is a backslash before the '!', then that | |
225 backslash is removed. Example: ":!ls" followed by | |
226 ":!echo ! \! \\!" executes "echo ls ! \!". | |
227 After the command has been executed, the timestamp of | |
228 the current file is checked |timestamp|. | |
1624 | 229 A '|' in {cmd} is passed to the shell, you cannot use |
230 it to append a Vim command. See |:bar|. | |
7 | 231 A newline character ends {cmd}, what follows is |
232 interpreted as a following ":" command. However, if | |
233 there is a backslash before the newline it is removed | |
234 and {cmd} continues. It doesn't matter how many | |
235 backslashes are before the newline, only one is | |
236 removed. | |
237 On Unix the command normally runs in a non-interactive | |
238 shell. If you want an interactive shell to be used | |
239 (to use aliases) set 'shellcmdflag' to "-ic". | |
240 For Win32 also see |:!start|. | |
241 Vim redraws the screen after the command is finished, | |
242 because it may have printed any text. This requires a | |
243 hit-enter prompt, so that you can read any messages. | |
244 To avoid this use: > | |
245 :silent !{cmd} | |
246 < The screen is not redrawn then, thus you have to use | |
247 CTRL-L or ":redraw!" if the command did display | |
248 something. | |
249 Also see |shell-window|. | |
250 | |
251 *:!!* | |
252 :!! Repeat last ":!{cmd}". | |
253 | |
254 *:ve* *:version* | |
255 :ve[rsion] Print the version number of the editor. If the | |
256 compiler used understands "__DATE__" the compilation | |
257 date is mentioned. Otherwise a fixed release-date is | |
258 shown. | |
259 The following lines contain information about which | |
260 features were enabled when Vim was compiled. When | |
261 there is a preceding '+', the feature is included, | |
262 when there is a '-' it is excluded. To change this, | |
263 you have to edit feature.h and recompile Vim. | |
264 To check for this in an expression, see |has()|. | |
265 Here is an overview of the features. | |
266 The first column shows the smallest version in which | |
267 they are included: | |
268 T tiny | |
269 S small | |
270 N normal | |
271 B big | |
272 H huge | |
273 m manually enabled or depends on other features | |
274 (none) system dependent | |
275 Thus if a feature is marked with "N", it is included | |
276 in the normal, big and huge versions of Vim. | |
277 | |
278 *+feature-list* | |
279 *+ARP* Amiga only: ARP support included | |
280 B *+arabic* |Arabic| language support | |
281 N *+autocmd* |:autocmd|, automatic commands | |
191 | 282 m *+balloon_eval* |balloon-eval| support. Included when compiling with |
283 supported GUI (Motif, GTK, GUI) and either | |
284 Netbeans/Sun Workshop integration or |+eval| feature. | |
7 | 285 N *+browse* |:browse| command |
286 N *+builtin_terms* some terminals builtin |builtin-terms| | |
287 B *++builtin_terms* maximal terminals builtin |builtin-terms| | |
288 N *+byte_offset* support for 'o' flag in 'statusline' option, "go" | |
289 and ":goto" commands. | |
290 N *+cindent* |'cindent'|, C indenting | |
291 N *+clientserver* Unix and Win32: Remote invocation |clientserver| | |
292 *+clipboard* |clipboard| support | |
293 N *+cmdline_compl* command line completion |cmdline-completion| | |
294 N *+cmdline_hist* command line history |cmdline-history| | |
295 N *+cmdline_info* |'showcmd'| and |'ruler'| | |
296 N *+comments* |'comments'| support | |
297 N *+cryptv* encryption support |encryption| | |
298 B *+cscope* |cscope| support | |
500 | 299 m *+cursorshape* |termcap-cursor-shape| support |
300 m *+debug* Compiled for debugging. | |
7 | 301 N *+dialog_gui* Support for |:confirm| with GUI dialog. |
302 N *+dialog_con* Support for |:confirm| with console dialog. | |
303 N *+dialog_con_gui* Support for |:confirm| with GUI and console dialog. | |
304 N *+diff* |vimdiff| and 'diff' | |
305 N *+digraphs* |digraphs| *E196* | |
306 *+dnd* Support for DnD into the "~ register |quote_~|. | |
307 B *+emacs_tags* |emacs-tags| files | |
308 N *+eval* expression evaluation |eval.txt| | |
309 N *+ex_extra* Vim's extra Ex commands: |:center|, |:left|, | |
310 |:normal|, |:retab| and |:right| | |
311 N *+extra_search* |'hlsearch'| and |'incsearch'| options. | |
312 B *+farsi* |farsi| language | |
313 N *+file_in_path* |gf|, |CTRL-W_f| and |<cfile>| | |
314 N *+find_in_path* include file searches: |[I|, |:isearch|, | |
315 |CTRL-W_CTRL-I|, |:checkpath|, etc. | |
316 N *+folding* |folding| | |
317 *+footer* |gui-footer| | |
318 *+fork* Unix only: |fork| shell commands | |
1624 | 319 *+float* Floating point support |
7 | 320 N *+gettext* message translations |multi-lang| |
321 *+GUI_Athena* Unix only: Athena |GUI| | |
322 *+GUI_neXtaw* Unix only: neXtaw |GUI| | |
323 *+GUI_GTK* Unix only: GTK+ |GUI| | |
324 *+GUI_Motif* Unix only: Motif |GUI| | |
325 *+GUI_Photon* QNX only: Photon |GUI| | |
326 m *+hangul_input* Hangul input support |hangul| | |
557 | 327 *+iconv* Compiled with the |iconv()| function |
328 *+iconv/dyn* Likewise |iconv-dynamic| |/dyn| | |
7 | 329 N *+insert_expand* |insert_expand| Insert mode completion |
330 N *+jumplist* |jumplist| | |
331 B *+keymap* |'keymap'| | |
332 B *+langmap* |'langmap'| | |
333 N *+libcall* |libcall()| | |
334 N *+linebreak* |'linebreak'|, |'breakat'| and |'showbreak'| | |
335 N *+lispindent* |'lisp'| | |
336 N *+listcmds* Vim commands for the list of buffers |buffer-hidden| | |
337 and argument list |:argdelete| | |
338 N *+localmap* Support for mappings local to a buffer |:map-local| | |
339 N *+menu* |:menu| | |
340 N *+mksession* |:mksession| | |
341 N *+modify_fname* |filename-modifiers| | |
342 N *+mouse* Mouse handling |mouse-using| | |
343 N *+mouseshape* |'mouseshape'| | |
344 B *+mouse_dec* Unix only: Dec terminal mouse handling |dec-mouse| | |
345 N *+mouse_gpm* Unix only: Linux console mouse handling |gpm-mouse| | |
346 B *+mouse_netterm* Unix only: netterm mouse handling |netterm-mouse| | |
347 N *+mouse_pterm* QNX only: pterm mouse handling |qnx-terminal| | |
1624 | 348 N *+mouse_sysmouse* Unix only: *BSD console mouse handling |sysmouse| |
7 | 349 N *+mouse_xterm* Unix only: xterm mouse handling |xterm-mouse| |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
350 B *+multi_byte* 16 and 32 bit characters |multibyte| |
7 | 351 *+multi_byte_ime* Win32 input method for multibyte chars |multibyte-ime| |
352 N *+multi_lang* non-English language support |multi-lang| | |
14 | 353 m *+mzscheme* Mzscheme interface |mzscheme| |
625 | 354 m *+mzscheme/dyn* Mzscheme interface |mzscheme-dynamic| |/dyn| |
7 | 355 m *+netbeans_intg* |netbeans| |
356 m *+ole* Win32 GUI only: |ole-interface| | |
357 *+osfiletype* Support for the 'osfiletype' option and filetype | |
358 checking in automatic commands. |autocmd-osfiletypes| | |
359 N *+path_extra* Up/downwards search in 'path' and 'tags' | |
557 | 360 m *+perl* Perl interface |perl| |
361 m *+perl/dyn* Perl interface |perl-dynamic| |/dyn| | |
7 | 362 *+postscript* |:hardcopy| writes a PostScript file |
363 N *+printer* |:hardcopy| command | |
179 | 364 H *+profile* |:profile| command |
557 | 365 m *+python* Python interface |python| |
366 m *+python/dyn* Python interface |python-dynamic| |/dyn| | |
7 | 367 N *+quickfix* |:make| and |quickfix| commands |
1624 | 368 N *+reltime* |reltime()| function, 'hlsearch'/'incsearch' timeout, |
369 'redrawtime' option | |
7 | 370 B *+rightleft* Right to left typing |'rightleft'| |
557 | 371 m *+ruby* Ruby interface |ruby| |
372 m *+ruby/dyn* Ruby interface |ruby-dynamic| |/dyn| | |
7 | 373 N *+scrollbind* |'scrollbind'| |
374 B *+signs* |:sign| | |
375 N *+smartindent* |'smartindent'| | |
376 m *+sniff* SniFF interface |sniff| | |
1989 | 377 N *+startuptime* |--startuptime| argument |
7 | 378 N *+statusline* Options 'statusline', 'rulerformat' and special |
379 formats of 'titlestring' and 'iconstring' | |
380 m *+sun_workshop* |workshop| | |
381 N *+syntax* Syntax highlighting |syntax| | |
382 *+system()* Unix only: opposite of |+fork| | |
383 N *+tag_binary* binary searching in tags file |tag-binary-search| | |
384 N *+tag_old_static* old method for static tags |tag-old-static| | |
385 m *+tag_any_white* any white space allowed in tags file |tag-any-white| | |
557 | 386 m *+tcl* Tcl interface |tcl| |
387 m *+tcl/dyn* Tcl interface |tcl-dynamic| |/dyn| | |
7 | 388 *+terminfo* uses |terminfo| instead of termcap |
389 N *+termresponse* support for |t_RV| and |v:termresponse| | |
390 N *+textobjects* |text-objects| selection | |
391 *+tgetent* non-Unix only: able to use external termcap | |
1125 | 392 N *+title* Setting the window 'title' and 'icon' |
7 | 393 N *+toolbar* |gui-toolbar| |
394 N *+user_commands* User-defined commands. |user-commands| | |
395 N *+viminfo* |'viminfo'| | |
396 N *+vertsplit* Vertically split windows |:vsplit| | |
397 N *+virtualedit* |'virtualedit'| | |
398 S *+visual* Visual mode |Visual-mode| | |
399 N *+visualextra* extra Visual mode commands |blockwise-operators| | |
400 N *+vreplace* |gR| and |gr| | |
401 N *+wildignore* |'wildignore'| | |
402 N *+wildmenu* |'wildmenu'| | |
403 S *+windows* more than one window | |
404 m *+writebackup* |'writebackup'| is default on | |
405 m *+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 | |
409 N *+xterm_clipboard* Unix only: xterm clipboard handling | |
410 m *+xterm_save* save and restore xterm screen |xterm-screens| | |
411 N *+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()". | |
294 | 436 An alternative is to use the 'verbosefile' option, |
437 this can be used in combination with ":redir". | |
7 | 438 {not in Vi} |
439 | |
440 :redi[r] >> {file} Redirect messages to file {file}. Append if {file} | |
441 already exists. {not in Vi} | |
442 | |
1624 | 443 :redi[r] @{a-zA-Z} |
298 | 444 :redi[r] @{a-zA-Z}> Redirect messages to register {a-z}. Append to the |
7 | 445 contents of the register if its name is given |
1624 | 446 uppercase {A-Z}. The ">" after the register name is |
447 optional. {not in Vi} | |
271 | 448 :redi[r] @{a-z}>> Append messages to register {a-z}. {not in Vi} |
7 | 449 |
1125 | 450 :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} | |
7 | 458 |
298 | 459 :redi[r] @"> Redirect messages to the unnamed register. For |
460 backward compatibility, the ">" after the register | |
461 name can be omitted. {not in Vi} | |
271 | 462 :redi[r] @">> Append messages to the unnamed register. {not in Vi} |
7 | 463 |
169 | 464 :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. | |
1125 | 467 The variable will remain empty until redirection ends. |
169 | 468 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 | |
7 | 476 :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 | |
1926 | 512 *: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 | |
7 | 523 *:verb* *:verbose* |
524 :[count]verb[ose] {command} | |
525 Execute {command} with 'verbose' set to [count]. If | |
8 | 526 [count] is omitted one is used. ":0verbose" can be |
527 used to set 'verbose' to zero. | |
7 | 528 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 ~ | |
294 | 543 For logging verbose messages in a file use the |
544 'verbosefile' option. | |
7 | 545 |
484 | 546 *:verbose-cmd* |
547 When 'verbose' is non-zero, listing the value of a Vim option or a key map or | |
502 | 548 an abbreviation or a user-defined function or a command or a highlight group |
549 or an autocommand will also display where it was last defined. If it was | |
550 defined manually then there will be no "Last set" message. When it was | |
551 defined while executing a function, user command or autocommand, the script in | |
552 which it was defined is reported. | |
484 | 553 {not available when compiled without the +eval feature} |
554 | |
7 | 555 *K* |
556 K 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, | |
237 | 588 sleep for [N] milliseconds. The count for "gs" always |
7 | 589 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). | |
140 | 595 "gs" stands for "goto sleep". |
596 While sleeping the cursor is positioned in the text, | |
597 if at a visible position. {not in Vi} | |
7 | 598 |
599 *g_CTRL-A* | |
600 g 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 ============================================================================== | |
605 2. Online help *online-help* | |
606 | |
607 *help* *<Help>* *:h* *:help* *<F1>* *i_<F1>* *i_<Help>* | |
608 <Help> or | |
609 :h[elp] Open a window and display the help file in read-only | |
610 mode. If there is a help window open already, use | |
611 that one. Otherwise, if the current window uses the | |
612 full width of the screen or is at least 80 characters | |
613 wide, the help window will appear just above the | |
614 current window. Otherwise the new window is put at | |
615 the very top. | |
616 The 'helplang' option is used to select a language, if | |
617 the main help file is available in several languages. | |
618 {not in Vi} | |
619 | |
620 *{subject}* *E149* *E661* | |
621 :h[elp] {subject} Like ":help", additionally jump to the tag {subject}. | |
622 {subject} can include wildcards like "*", "?" and | |
623 "[a-z]": | |
624 :help z? jump to help for any "z" command | |
625 :help z. jump to the help for "z." | |
626 If there is no full match for the pattern, or there | |
627 are several matches, the "best" match will be used. | |
628 A sophisticated algorithm is used to decide which | |
629 match is better than another one. These items are | |
630 considered in the computation: | |
631 - A match with same case is much better than a match | |
632 with different case. | |
633 - A match that starts after a non-alphanumeric | |
634 character is better than a match in the middle of a | |
635 word. | |
636 - A match at or near the beginning of the tag is | |
637 better than a match further on. | |
638 - The more alphanumeric characters match, the better. | |
639 - The shorter the length of the match, the better. | |
640 | |
641 The 'helplang' option is used to select a language, if | |
642 the {subject} is available in several languages. | |
643 To find a tag in a specific language, append "@ab", | |
644 where "ab" is the two-letter language code. See | |
645 |help-translated|. | |
646 | |
647 Note that the longer the {subject} you give, the less | |
648 matches will be found. You can get an idea how this | |
649 all works by using commandline completion (type CTRL-D | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1989
diff
changeset
|
650 after ":help subject" |c_CTRL-D|). |
7 | 651 If there are several matches, you can have them listed |
652 by hitting CTRL-D. Example: > | |
653 :help cont<Ctrl-D> | |
654 < To use a regexp |pattern|, first do ":help" and then | |
655 use ":tag {pattern}" in the help window. The | |
656 ":tnext" command can then be used to jump to other | |
657 matches, "tselect" to list matches and choose one. > | |
658 :help index| :tse z. | |
1698 | 659 < When there is no argument you will see matches for |
660 "help", to avoid listing all possible matches (that | |
661 would be very slow). | |
662 The number of matches displayed is limited to 300. | |
663 | |
664 This command can be followed by '|' and another | |
7 | 665 command, but you don't need to escape the '|' inside a |
666 help command. So these both work: > | |
667 :help | | |
668 :help k| only | |
669 < Note that a space before the '|' is seen as part of | |
670 the ":help" argument. | |
671 You can also use <LF> or <CR> to separate the help | |
672 command from a following command. You need to type | |
673 CTRL-V first to insert the <LF> or <CR>. Example: > | |
674 :help so<C-V><CR>only | |
675 < {not in Vi} | |
676 | |
677 :h[elp]! [subject] Like ":help", but in non-English help files prefer to | |
678 find a tag in a file with the same language as the | |
679 current file. See |help-translated|. | |
680 | |
681 *:helpg* *:helpgrep* | |
9 | 682 :helpg[rep] {pattern}[@xx] |
7 | 683 Search all help text files and make a list of lines |
684 in which {pattern} matches. Jumps to the first match. | |
9 | 685 The optional [@xx] specifies that only matches in the |
686 "xx" language are to be found. | |
7 | 687 You can navigate through the matches with the |
688 |quickfix| commands, e.g., |:cnext| to jump to the | |
689 next one. Or use |:cwindow| to get the list of | |
690 matches in the quickfix window. | |
691 {pattern} is used as a Vim regexp |pattern|. | |
692 'ignorecase' is not used, add "\c" to ignore case. | |
693 Example for case sensitive search: > | |
694 :helpgrep Uganda | |
695 < Example for case ignoring search: > | |
696 :helpgrep uganda\c | |
9 | 697 < Example for searching in French help: > |
698 :helpgrep backspace@fr | |
1624 | 699 < The pattern does not support line breaks, it must |
700 match within one line. You can use |:grep| instead, | |
701 but then you need to get the list of help files in a | |
702 complicated way. | |
703 Cannot be followed by another command, everything is | |
7 | 704 used as part of the pattern. But you can use |
705 |:execute| when needed. | |
1624 | 706 Compressed help files will not be searched (Fedora |
7 | 707 compresses the help files). |
708 {not in Vi} | |
709 | |
659 | 710 *:lh* *:lhelpgrep* |
711 :lh[elpgrep] {pattern}[@xx] | |
712 Same as ":helpgrep", except the location list is used | |
713 instead of the quickfix list. If the help window is | |
714 already opened, then the location list for that window | |
715 is used. Otherwise, a new help window is opened and | |
716 the location list for that window is set. The | |
717 location list for the current window is not changed. | |
718 | |
40 | 719 *:exu* *:exusage* |
720 :exu[sage] Show help on Ex commands. Added to simulate the Nvi | |
721 command. {not in Vi} | |
722 | |
723 *:viu* *:viusage* | |
724 :viu[sage] Show help on Normal mode commands. Added to simulate | |
725 the Nvi command. {not in Vi} | |
7 | 726 |
727 When no argument is given to |:help| the file given with the 'helpfile' option | |
728 will be opened. Otherwise the specified tag is searched for in all "doc/tags" | |
729 files in the directories specified in the 'runtimepath' option. | |
730 | |
731 The initial height of the help window can be set with the 'helpheight' option | |
732 (default 20). | |
733 | |
734 Jump to specific subjects by using tags. This can be done in two ways: | |
735 - Use the "CTRL-]" command while standing on the name of a command or option. | |
736 This only works when the tag is a keyword. "<C-Leftmouse>" and | |
737 "g<LeftMouse>" work just like "CTRL-]". | |
738 - use the ":ta {subject}" command. This also works with non-keyword | |
739 characters. | |
740 | |
741 Use CTRL-T or CTRL-O to jump back. | |
742 Use ":q" to close the help window. | |
743 | |
744 If there are several matches for an item you are looking for, this is how you | |
745 can jump to each one of them: | |
746 1. Open a help window | |
747 2. Use the ":tag" command with a slash prepended to the tag. E.g.: > | |
748 :tag /min | |
749 3. Use ":tnext" to jump to the next matching tag. | |
750 | |
751 It is possible to add help files for plugins and other items. You don't need | |
752 to change the distributed help files for that. See |add-local-help|. | |
753 | |
754 To write a local help file, see |write-local-help|. | |
755 | |
756 Note that the title lines from the local help files are automagically added to | |
757 the "LOCAL ADDITIONS" section in the "help.txt" help file |local-additions|. | |
758 This is done when viewing the file in Vim, the file itself is not changed. It | |
759 is done by going through all help files and obtaining the first line of each | |
760 file. The files in $VIMRUNTIME/doc are skipped. | |
761 | |
762 *help-xterm-window* | |
763 If you want to have the help in another xterm window, you could use this | |
764 command: > | |
765 :!xterm -e vim +help & | |
766 < | |
767 | |
768 *:helpfind* *:helpf* | |
769 :helpf[ind] Like |:help|, but use a dialog to enter the argument. | |
770 Only for backwards compatibility. It now executes the | |
771 ToolBar.FindHelp menu entry instead of using a builtin | |
772 dialog. {only when compiled with |+GUI_GTK|} | |
773 < {not in Vi} | |
774 | |
775 *:helpt* *:helptags* | |
776 *E154* *E150* *E151* *E152* *E153* *E670* | |
1502 | 777 :helpt[ags] [++t] {dir} |
778 Generate the help tags file(s) for directory {dir}. | |
7 | 779 All "*.txt" and "*.??x" files in the directory are |
780 scanned for a help tag definition in between stars. | |
781 The "*.??x" files are for translated docs, they | |
782 generate the "tags-??" file, see |help-translated|. | |
783 The generated tags files are sorted. | |
784 When there are duplicates an error message is given. | |
785 An existing tags file is silently overwritten. | |
1502 | 786 The optional "++t" argument forces adding the |
787 "help-tags" tag. This is also done when the {dir} is | |
788 equal to $VIMRUNTIME/doc. | |
7 | 789 To rebuild the help tags in the runtime directory |
790 (requires write permission there): > | |
791 :helptags $VIMRUNTIME/doc | |
792 < {not in Vi} | |
793 | |
794 | |
795 TRANSLATED HELP *help-translated* | |
796 | |
797 It is possible to add translated help files, next to the original English help | |
798 files. Vim will search for all help in "doc" directories in 'runtimepath'. | |
799 This is only available when compiled with the |+multi_lang| feature. | |
800 | |
798 | 801 At this moment translations are available for: |
802 Chinese - multiple authors | |
803 French - translated by David Blanchet | |
804 Italian - translated by Antonio Colombo | |
806 | 805 Polish - translated by Mikolaj Machowski |
798 | 806 Russian - translated by Vassily Ragosin |
807 See the Vim website to find them: http://www.vim.org/translations.php | |
808 | |
7 | 809 A set of translated help files consists of these files: |
810 | |
811 help.abx | |
812 howto.abx | |
813 ... | |
814 tags-ab | |
815 | |
816 "ab" is the two-letter language code. Thus for Italian the names are: | |
817 | |
818 help.itx | |
819 howto.itx | |
820 ... | |
821 tags-it | |
822 | |
823 The 'helplang' option can be set to the preferred language(s). The default is | |
824 set according to the environment. Vim will first try to find a matching tag | |
825 in the preferred language(s). English is used when it cannot be found. | |
826 | |
827 To find a tag in a specific language, append "@ab" to a tag, where "ab" is the | |
828 two-letter language code. Example: > | |
829 :he user-manual@it | |
830 :he user-manual@en | |
831 The first one finds the Italian user manual, even when 'helplang' is empty. | |
832 The second one finds the English user manual, even when 'helplang' is set to | |
833 "it". | |
834 | |
835 When using command-line completion for the ":help" command, the "@en" | |
1668 | 836 extension is only shown when a tag exists for multiple languages. When the |
7 | 837 tag only exists for English "@en" is omitted. |
838 | |
839 When using |CTRL-]| or ":help!" in a non-English help file Vim will try to | |
840 find the tag in the same language. If not found then 'helplang' will be used | |
841 to select a language. | |
842 | |
843 Help files must use latin1 or utf-8 encoding. Vim assumes the encoding is | |
844 utf-8 when finding non-ASCII characters in the first line. Thus you must | |
845 translate the header with "For Vim version". | |
846 | |
847 The same encoding must be used for the help files of one language in one | |
848 directory. You can use a different encoding for different languages and use | |
849 a different encoding for help files of the same language but in a different | |
850 directory. | |
851 | |
852 Hints for translators: | |
853 - Do not translate the tags. This makes it possible to use 'helplang' to | |
854 specify the preferred language. You may add new tags in your language. | |
855 - When you do not translate a part of a file, add tags to the English version, | |
856 using the "tag@en" notation. | |
857 - Make a package with all the files and the tags file available for download. | |
858 Users can drop it in one of the "doc" directories and start use it. | |
859 Report this to Bram, so that he can add a link on www.vim.org. | |
860 - Use the |:helptags| command to generate the tags files. It will find all | |
861 languages in the specified directory. | |
862 | |
863 ============================================================================== | |
840 | 864 3. Using Vim like less or more *less* |
7 | 865 |
866 If you use the less or more program to view a file, you don't get syntax | |
867 highlighting. Thus you would like to use Vim instead. You can do this by | |
868 using the shell script "$VIMRUNTIME/macros/less.sh". | |
869 | |
870 This shell script uses the Vim script "$VIMRUNTIME/macros/less.vim". It sets | |
871 up mappings to simulate the commands that less supports. Otherwise, you can | |
872 still use the Vim commands. | |
873 | |
874 This isn't perfect. For example, when viewing a short file Vim will still use | |
875 the whole screen. But it works good enough for most uses, and you get syntax | |
876 highlighting. | |
877 | |
878 The "h" key will give you a short overview of the available commands. | |
879 | |
880 vim:tw=78:ts=8:ft=help:norl: |