blob: a04dd30cb58ecc7888648a2d25ebba14a008f15f [file] [log] [blame]
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001*various.txt* For Vim version 7.0aa. Last change: 2005 Jan 20
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|
102. Online help |online-help|
Bram Moolenaar8299df92004-07-10 09:47:34 +0000113. Using Vim like less or more |less|
Bram Moolenaar071d4272004-06-13 20:20:40 +000012
13==============================================================================
141. Various commands *various-cmds*
15
16 *CTRL-L*
17CTRL-L Clear and redraw the screen (later).
18
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 ~
57 Mnemonic: Get Ascii value. {not in Vi}
58
59 *g8*
60g8 Print the hex values of the bytes used in the
61 character under the cursor, assuming it is in |UTF-8|
62 encoding. This also shows composing characters.
63 Example of a character with three composing
64 characters:
65 e0 b8 81 + e0 b8 b9 + e0 b9 89 ~
66 {not in Vi}
67
68 *:p* *:pr* *:print*
69:[range]p[rint] Print [range] lines (default current line).
70 Note: If you are looking for a way to print your text
71 file, you need an external program for that. In the
72 GUI you can use the File.Print menu entry.
73 (For printing on paper see |:hardcopy|)
74
75:[range]p[rint] {count}
76 Print {count} lines, starting with [range] (default
77 current line |cmdline-ranges|).
78
79 *:P* *:Print*
80:[range]P[rint] [count]
81 Just as ":print". Was apparently added to Vi for
82 people that keep the shift key pressed too long...
83
84 *:l* *:list*
85:[range]l[ist] [count]
86 Same as :print, but display unprintable characters
87 with '^'.
88
89 *:nu* *:number*
90:[range]nu[mber] [count]
91 Same as :print, but precede each line with its line
92 number. (See also 'highlight' option).
93
94 *:#*
95:[range]# [count] synonym for :number.
96
97 *:z* *E144*
98:{range}z[+-^.=]{count} Display several lines of text surrounding the line
99 specified with {range}, or around the current line
100 if there is no {range}. If there is a {count}, that's
101 how many lines you'll see; otherwise, the current
102 window size is used.
103
104 :z can be used either alone or followed by any of
105 several punctuation marks. These have the following
106 effect:
107
108 mark first line last line new location ~
109 ---- ---------- --------- ------------
110 + current line 1 scr forward 1 scr forward
111 - 1 scr back current line current line
112 ^ 2 scr back 1 scr back 1 scr back
113 . 1/2 scr back 1/2 scr fwd 1/2 src fwd
114 = 1/2 src back 1/2 scr fwd current line
115
116 Specifying no mark at all is the same as "+".
117 If the mark is "=", a line of dashes is printed
118 around the current line.
119
120:{range}z#[+-^.=]{count} *:z#*
121 Like ":z", but number the lines.
122 {not in all versions of Vi, not with these arguments}
123
124 *:=*
125:= Print the last line number.
126
127:{range}= Prints the last line number in {range}. For example,
128 this prints the current line number: >
129 :.=
130
131:norm[al][!] {commands} *:norm* *:normal*
132 Execute Normal mode commands {commands}. This makes
133 it possible to execute Normal mode commands typed on
134 the command-line. {commands} is executed like it is
135 typed. For undo all commands are undone together.
136 If the [!] is given, mappings will not be used.
137 {commands} should be a complete command. If
138 {commands} does not finish a command, the last one
139 will be aborted as if <Esc> or <C-C> was typed.
140 The display isn't updated while ":normal" is busy.
141 This implies that an insert command must be completed
142 (to start Insert mode, see |:startinsert|). A ":"
143 command must be completed as well.
144 {commands} cannot start with a space. Put a 1 (one)
145 before it, 1 space is one space.
146 The 'insertmode' option is ignored for {commands}.
147 This command cannot be followed by another command,
148 since any '|' is considered part of the command.
149 This command can be used recursively, but the depth is
150 limited by 'maxmapdepth'.
151 When this command is called from a non-remappable
152 mapping |:noremap|, the argument can be mapped anyway.
153 An alternative is to use |:execute|, which uses an
154 expression as argument. This allows the use of
155 printable characters. Example: >
156 :exe "normal \<c-w>\<c-w>"
157< {not in Vi, of course}
158 {not available when the |+ex_extra| feature was
159 disabled at compile time}
160
161:{range}norm[al][!] {commands} *:normal-range*
162 Execute Normal mode commands {commands} for each line
163 in the {range}. Before executing the {commands}, the
164 cursor is positioned in the first column of the range,
165 for each line. Otherwise it's the same as the
166 ":normal" command without a range.
167 {not in Vi}
168 Not available when |+ex_extra| feature was disabled at
169 compile time.
170
171 *:sh* *:shell* *E371*
172:sh[ell] This command starts a shell. When the shell exits
173 (after the "exit" command) you return to Vim. The
174 name for the shell command comes from 'shell' option.
175 *E360*
176 Note: This doesn't work when Vim on the Amiga was
177 started in QuickFix mode from a compiler, because the
178 compiler will have set stdin to a non-interactive
179 mode.
180
181 *:!cmd* *:!* *E34*
182:!{cmd} Execute {cmd} with the shell. See also the 'shell'
183 and 'shelltype' option.
184 Any '!' in {cmd} is replaced with the previous
185 external command (see also 'cpoptions'). But not when
186 there is a backslash before the '!', then that
187 backslash is removed. Example: ":!ls" followed by
188 ":!echo ! \! \\!" executes "echo ls ! \!".
189 After the command has been executed, the timestamp of
190 the current file is checked |timestamp|.
191 There cannot be a '|' in {cmd}, see |:bar|.
192 A newline character ends {cmd}, what follows is
193 interpreted as a following ":" command. However, if
194 there is a backslash before the newline it is removed
195 and {cmd} continues. It doesn't matter how many
196 backslashes are before the newline, only one is
197 removed.
198 On Unix the command normally runs in a non-interactive
199 shell. If you want an interactive shell to be used
200 (to use aliases) set 'shellcmdflag' to "-ic".
201 For Win32 also see |:!start|.
202 Vim redraws the screen after the command is finished,
203 because it may have printed any text. This requires a
204 hit-enter prompt, so that you can read any messages.
205 To avoid this use: >
206 :silent !{cmd}
207< The screen is not redrawn then, thus you have to use
208 CTRL-L or ":redraw!" if the command did display
209 something.
210 Also see |shell-window|.
211
212 *:!!*
213:!! Repeat last ":!{cmd}".
214
215 *:ve* *:version*
216:ve[rsion] Print the version number of the editor. If the
217 compiler used understands "__DATE__" the compilation
218 date is mentioned. Otherwise a fixed release-date is
219 shown.
220 The following lines contain information about which
221 features were enabled when Vim was compiled. When
222 there is a preceding '+', the feature is included,
223 when there is a '-' it is excluded. To change this,
224 you have to edit feature.h and recompile Vim.
225 To check for this in an expression, see |has()|.
226 Here is an overview of the features.
227 The first column shows the smallest version in which
228 they are included:
229 T tiny
230 S small
231 N normal
232 B big
233 H huge
234 m manually enabled or depends on other features
235 (none) system dependent
236 Thus if a feature is marked with "N", it is included
237 in the normal, big and huge versions of Vim.
238
239 *+feature-list*
240 *+ARP* Amiga only: ARP support included
241B *+arabic* |Arabic| language support
242N *+autocmd* |:autocmd|, automatic commands
243m *+balloon_eval* |balloon-eval| support
244N *+browse* |:browse| command
245N *+builtin_terms* some terminals builtin |builtin-terms|
246B *++builtin_terms* maximal terminals builtin |builtin-terms|
247N *+byte_offset* support for 'o' flag in 'statusline' option, "go"
248 and ":goto" commands.
249N *+cindent* |'cindent'|, C indenting
250N *+clientserver* Unix and Win32: Remote invocation |clientserver|
251 *+clipboard* |clipboard| support
252N *+cmdline_compl* command line completion |cmdline-completion|
253N *+cmdline_hist* command line history |cmdline-history|
254N *+cmdline_info* |'showcmd'| and |'ruler'|
255N *+comments* |'comments'| support
256N *+cryptv* encryption support |encryption|
257B *+cscope* |cscope| support
258N *+dialog_gui* Support for |:confirm| with GUI dialog.
259N *+dialog_con* Support for |:confirm| with console dialog.
260N *+dialog_con_gui* Support for |:confirm| with GUI and console dialog.
261N *+diff* |vimdiff| and 'diff'
262N *+digraphs* |digraphs| *E196*
263 *+dnd* Support for DnD into the "~ register |quote_~|.
264B *+emacs_tags* |emacs-tags| files
265N *+eval* expression evaluation |eval.txt|
266N *+ex_extra* Vim's extra Ex commands: |:center|, |:left|,
267 |:normal|, |:retab| and |:right|
268N *+extra_search* |'hlsearch'| and |'incsearch'| options.
269B *+farsi* |farsi| language
270N *+file_in_path* |gf|, |CTRL-W_f| and |<cfile>|
271N *+find_in_path* include file searches: |[I|, |:isearch|,
272 |CTRL-W_CTRL-I|, |:checkpath|, etc.
273N *+folding* |folding|
274 *+footer* |gui-footer|
275 *+fork* Unix only: |fork| shell commands
276N *+gettext* message translations |multi-lang|
277 *+GUI_Athena* Unix only: Athena |GUI|
278 *+GUI_neXtaw* Unix only: neXtaw |GUI|
279 *+GUI_BeOS* BeOS only: BeOS |GUI|
280 *+GUI_GTK* Unix only: GTK+ |GUI|
281 *+GUI_Motif* Unix only: Motif |GUI|
282 *+GUI_Photon* QNX only: Photon |GUI|
283m *+hangul_input* Hangul input support |hangul|
284 *+iconv* Compiled with the |iconv()| function, may have |/dyn|
285N *+insert_expand* |insert_expand| Insert mode completion
286N *+jumplist* |jumplist|
287B *+keymap* |'keymap'|
288B *+langmap* |'langmap'|
289N *+libcall* |libcall()|
290N *+linebreak* |'linebreak'|, |'breakat'| and |'showbreak'|
291N *+lispindent* |'lisp'|
292N *+listcmds* Vim commands for the list of buffers |buffer-hidden|
293 and argument list |:argdelete|
294N *+localmap* Support for mappings local to a buffer |:map-local|
295N *+menu* |:menu|
296N *+mksession* |:mksession|
297N *+modify_fname* |filename-modifiers|
298N *+mouse* Mouse handling |mouse-using|
299N *+mouseshape* |'mouseshape'|
300B *+mouse_dec* Unix only: Dec terminal mouse handling |dec-mouse|
301N *+mouse_gpm* Unix only: Linux console mouse handling |gpm-mouse|
302B *+mouse_netterm* Unix only: netterm mouse handling |netterm-mouse|
303N *+mouse_pterm* QNX only: pterm mouse handling |qnx-terminal|
304N *+mouse_xterm* Unix only: xterm mouse handling |xterm-mouse|
305B *+multi_byte* Korean and other languages |multibyte|
306 *+multi_byte_ime* Win32 input method for multibyte chars |multibyte-ime|
307N *+multi_lang* non-English language support |multi-lang|
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000308m *+mzscheme* Mzscheme interface |mzscheme|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000309m *+netbeans_intg* |netbeans|
310m *+ole* Win32 GUI only: |ole-interface|
311 *+osfiletype* Support for the 'osfiletype' option and filetype
312 checking in automatic commands. |autocmd-osfiletypes|
313N *+path_extra* Up/downwards search in 'path' and 'tags'
314m *+perl* Perl interface |perl|, may have |/dyn|
315 *+postscript* |:hardcopy| writes a PostScript file
316N *+printer* |:hardcopy| command
317m *+python* Python interface |python|, may have |/dyn|
318N *+quickfix* |:make| and |quickfix| commands
319B *+rightleft* Right to left typing |'rightleft'|
320m *+ruby* Ruby interface |ruby|, may have |/dyn|
321N *+scrollbind* |'scrollbind'|
322B *+signs* |:sign|
323N *+smartindent* |'smartindent'|
324m *+sniff* SniFF interface |sniff|
325N *+statusline* Options 'statusline', 'rulerformat' and special
326 formats of 'titlestring' and 'iconstring'
327m *+sun_workshop* |workshop|
328N *+syntax* Syntax highlighting |syntax|
329 *+system()* Unix only: opposite of |+fork|
330N *+tag_binary* binary searching in tags file |tag-binary-search|
331N *+tag_old_static* old method for static tags |tag-old-static|
332m *+tag_any_white* any white space allowed in tags file |tag-any-white|
333m *+tcl* Tcl interface |tcl|, may have |/dyn|
334 *+terminfo* uses |terminfo| instead of termcap
335N *+termresponse* support for |t_RV| and |v:termresponse|
336N *+textobjects* |text-objects| selection
337 *+tgetent* non-Unix only: able to use external termcap
338N *+title* Setting the window title |'title'|
339N *+toolbar* |gui-toolbar|
340N *+user_commands* User-defined commands. |user-commands|
341N *+viminfo* |'viminfo'|
342N *+vertsplit* Vertically split windows |:vsplit|
343N *+virtualedit* |'virtualedit'|
344S *+visual* Visual mode |Visual-mode|
345N *+visualextra* extra Visual mode commands |blockwise-operators|
346N *+vreplace* |gR| and |gr|
347N *+wildignore* |'wildignore'|
348N *+wildmenu* |'wildmenu'|
349S *+windows* more than one window
350m *+writebackup* |'writebackup'| is default on
351m *+xim* X input method |xim|
352 *+xfontset* X fontset support |xfontset|
353 *+xsmp* XSMP (X session management) support
354 *+xsmp_interact* interactive XSMP (X session management) support
355N *+xterm_clipboard* Unix only: xterm clipboard handling
356m *+xterm_save* save and restore xterm screen |xterm-screens|
357N *+X11* Unix only: can restore window title |X11|
358
359 */dyn* *E370* *E448*
360 To some of the features "/dyn" is added when the
361 feature is only available when the related library can
362 be dynamically loaded.
363
364:ve[rsion] {nr} Is now ignored. This was previously used to check the
365 version number of a .vimrc file. It was removed,
366 because you can now use the ":if" command for
367 version-dependent behavior. {not in Vi}
368
369 *:redi* *:redir*
370:redi[r][!] > {file} Redirect messages to file {file}. The messages which
371 are the output of commands are written to that file,
372 until redirection ends. The messages are also still
373 shown on the screen. When [!] is included, an
374 existing file is overwritten. When [!] is omitted,
375 and {file} exists, this command fails.
376 Only one ":redir" can be active at a time. Calls to
377 ":redir" will close any active redirection before
378 starting redirection to the new target.
379 To stop the messages and commands from being echoed to
380 the screen, put the commands in a function and call it
381 with ":silent call Function()".
382 {not in Vi}
383
384:redi[r] >> {file} Redirect messages to file {file}. Append if {file}
385 already exists. {not in Vi}
386
387:redi[r] @{a-zA-Z} Redirect messages to register {a-z}. Append to the
388 contents of the register if its name is given
389 uppercase {A-Z}. {not in Vi}
Bram Moolenaardcaf10e2005-01-21 11:55:25 +0000390:redi[r] @{a-z}> Append messages to register {a-z}. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000391
392:redi[r] @* Redirect messages to the clipboard. {not in Vi}
Bram Moolenaardcaf10e2005-01-21 11:55:25 +0000393:redi[r] @*> Append messages to the clipboard. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000394
395:redi[r] @" Redirect messages to the unnamed register. {not in Vi}
Bram Moolenaardcaf10e2005-01-21 11:55:25 +0000396:redi[r] @"> Append messages to the unnamed register. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000397
398:redi[r] END End redirecting messages. {not in Vi}
399
400 *:sil* *:silent*
401:sil[ent][!] {command} Execute {command} silently. Normal messages will not
402 be given or added to the message history.
403 When [!] is added, error messages will also be
404 skipped, and commands and mappings will not be aborted
405 when an error is detected. |v:errmsg| is still set.
406 When [!] is not used, an error message will cause
407 further messages to be displayed normally.
408 Redirection, started with |:redir|, will continue as
409 usual, although there might be small differences.
410 This will allow redirecting the output of a command
411 without seeing it on the screen. Example: >
412 :redir >/tmp/foobar
413 :silent g/Aap/p
414 :redir END
415< To execute a Normal mode command silently, use the
416 |:normal| command. For example, to search for a
417 string without messages: >
418 :silent exe "normal /path\<CR>"
419< ":silent!" is useful to execute a command that may
420 fail, but the failure is to be ignored. Example: >
421 :let v:errmsg = ""
422 :silent! /^begin
423 :if v:errmsg != ""
424 : ... pattern was not found
425< ":silent" will also avoid the hit-enter prompt. When
426 using this for an external command, this may cause the
427 screen to be messed up. Use |CTRL-L| to clean it up
428 then.
429 ":silent menu ..." defines a menu that will not echo a
430 Command-line command. The command will still produce
431 messages though. Use ":silent" in the command itself
432 to avoid that: ":silent menu .... :silent command".
433
434 *:verb* *:verbose*
435:[count]verb[ose] {command}
436 Execute {command} with 'verbose' set to [count]. If
Bram Moolenaared203462004-06-16 11:19:22 +0000437 [count] is omitted one is used. ":0verbose" can be
438 used to set 'verbose' to zero.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000439 The additional use of ":silent" makes messages
440 generated but not displayed.
441 The combination of ":silent" and ":verbose" can be
442 used to generate messages and check them with
443 |v:statusmsg| and friends. For example: >
444 :let v:statusmsg = ""
445 :silent verbose runtime foobar.vim
446 :if v:statusmsg != ""
447 : " foobar.vim could not be found
448 :endif
449< When concatenating another command, the ":verbose"
450 only applies to the first one: >
451 :4verbose set verbose | set verbose
452< verbose=4 ~
453 verbose=0 ~
454
455 *K*
456K Run a program to lookup the keyword under the
457 cursor. The name of the program is given with the
458 'keywordprg' (kp) option (default is "man"). The
459 keyword is formed of letters, numbers and the
460 characters in 'iskeyword'. The keyword under or
461 right of the cursor is used. The same can be done
462 with the command >
463 :!{program} {keyword}
464< There is an example of a program to use in the tools
465 directory of Vim. It is called 'ref' and does a
466 simple spelling check.
467 Special cases:
468 - If 'keywordprg' is empty, the ":help" command is
469 used. It's a good idea to include more characters
470 in 'iskeyword' then, to be able to find more help.
471 - When 'keywordprg' is equal to "man", a count before
472 "K" is inserted after the "man" command and before
473 the keyword. For example, using "2K" while the
474 cursor is on "mkdir", results in: >
475 !man 2 mkdir
476< - When 'keywordprg' is equal to "man -s", a count
477 before "K" is inserted after the "-s". If there is
478 no count, the "-s" is removed.
479 {not in Vi}
480
481 *v_K*
482{Visual}K Like "K", but use the visually highlighted text for
483 the keyword. Only works when the highlighted text is
484 not more than one line. {not in Vi}
485
486[N]gs *gs* *:sl* *:sleep*
487:[N]sl[eep] [N] [m] Do nothing for [N] seconds. When [m] is included,
488 sleep for [N] milliseconds. The count for "gs" always
489 uses seconds. The default is one second. >
490 :sleep "sleep for one second
491 :5sleep "sleep for five seconds
492 :sleep 100m "sleep for a hundred milliseconds
493 10gs "sleep for ten seconds
494< Can be interrupted with CTRL-C (CTRL-Break on MS-DOS).
495 "gs" stands for "goto sleep". While sleeping the
496 cursor is positioned in the text (if visible). {not
497 in Vi}
498
499 *g_CTRL-A*
500g CTRL-A Only when Vim was compiled with MEM_PROFILING defined
501 (which is very rare): print memory usage statistics.
502 Only useful for debugging Vim.
503
504==============================================================================
5052. Online help *online-help*
506
507 *help* *<Help>* *:h* *:help* *<F1>* *i_<F1>* *i_<Help>*
508<Help> or
509:h[elp] Open a window and display the help file in read-only
510 mode. If there is a help window open already, use
511 that one. Otherwise, if the current window uses the
512 full width of the screen or is at least 80 characters
513 wide, the help window will appear just above the
514 current window. Otherwise the new window is put at
515 the very top.
516 The 'helplang' option is used to select a language, if
517 the main help file is available in several languages.
518 {not in Vi}
519
520 *{subject}* *E149* *E661*
521:h[elp] {subject} Like ":help", additionally jump to the tag {subject}.
522 {subject} can include wildcards like "*", "?" and
523 "[a-z]":
524 :help z? jump to help for any "z" command
525 :help z. jump to the help for "z."
526 If there is no full match for the pattern, or there
527 are several matches, the "best" match will be used.
528 A sophisticated algorithm is used to decide which
529 match is better than another one. These items are
530 considered in the computation:
531 - A match with same case is much better than a match
532 with different case.
533 - A match that starts after a non-alphanumeric
534 character is better than a match in the middle of a
535 word.
536 - A match at or near the beginning of the tag is
537 better than a match further on.
538 - The more alphanumeric characters match, the better.
539 - The shorter the length of the match, the better.
540
541 The 'helplang' option is used to select a language, if
542 the {subject} is available in several languages.
543 To find a tag in a specific language, append "@ab",
544 where "ab" is the two-letter language code. See
545 |help-translated|.
546
547 Note that the longer the {subject} you give, the less
548 matches will be found. You can get an idea how this
549 all works by using commandline completion (type CTRL-D
550 after ":help subject").
551 If there are several matches, you can have them listed
552 by hitting CTRL-D. Example: >
553 :help cont<Ctrl-D>
554< To use a regexp |pattern|, first do ":help" and then
555 use ":tag {pattern}" in the help window. The
556 ":tnext" command can then be used to jump to other
557 matches, "tselect" to list matches and choose one. >
558 :help index| :tse z.
559< This command can be followed by '|' and another
560 command, but you don't need to escape the '|' inside a
561 help command. So these both work: >
562 :help |
563 :help k| only
564< Note that a space before the '|' is seen as part of
565 the ":help" argument.
566 You can also use <LF> or <CR> to separate the help
567 command from a following command. You need to type
568 CTRL-V first to insert the <LF> or <CR>. Example: >
569 :help so<C-V><CR>only
570< {not in Vi}
571
572:h[elp]! [subject] Like ":help", but in non-English help files prefer to
573 find a tag in a file with the same language as the
574 current file. See |help-translated|.
575
576 *:helpg* *:helpgrep*
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000577:helpg[rep] {pattern}[@xx]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000578 Search all help text files and make a list of lines
579 in which {pattern} matches. Jumps to the first match.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000580 The optional [@xx] specifies that only matches in the
581 "xx" language are to be found.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582 You can navigate through the matches with the
583 |quickfix| commands, e.g., |:cnext| to jump to the
584 next one. Or use |:cwindow| to get the list of
585 matches in the quickfix window.
586 {pattern} is used as a Vim regexp |pattern|.
587 'ignorecase' is not used, add "\c" to ignore case.
588 Example for case sensitive search: >
589 :helpgrep Uganda
590< Example for case ignoring search: >
591 :helpgrep uganda\c
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000592< Example for searching in French help: >
593 :helpgrep backspace@fr
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594< Cannot be followed by another command, everything is
595 used as part of the pattern. But you can use
596 |:execute| when needed.
597 Compressed help files will not be searched (Debian
598 compresses the help files).
599 {not in Vi}
600
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000601 *:exu* *:exusage*
602:exu[sage] Show help on Ex commands. Added to simulate the Nvi
603 command. {not in Vi}
604
605 *:viu* *:viusage*
606:viu[sage] Show help on Normal mode commands. Added to simulate
607 the Nvi command. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000608
609When no argument is given to |:help| the file given with the 'helpfile' option
610will be opened. Otherwise the specified tag is searched for in all "doc/tags"
611files in the directories specified in the 'runtimepath' option.
612
613The initial height of the help window can be set with the 'helpheight' option
614(default 20).
615
616Jump to specific subjects by using tags. This can be done in two ways:
617- Use the "CTRL-]" command while standing on the name of a command or option.
618 This only works when the tag is a keyword. "<C-Leftmouse>" and
619 "g<LeftMouse>" work just like "CTRL-]".
620- use the ":ta {subject}" command. This also works with non-keyword
621 characters.
622
623Use CTRL-T or CTRL-O to jump back.
624Use ":q" to close the help window.
625
626If there are several matches for an item you are looking for, this is how you
627can jump to each one of them:
6281. Open a help window
6292. Use the ":tag" command with a slash prepended to the tag. E.g.: >
630 :tag /min
6313. Use ":tnext" to jump to the next matching tag.
632
633It is possible to add help files for plugins and other items. You don't need
634to change the distributed help files for that. See |add-local-help|.
635
636To write a local help file, see |write-local-help|.
637
638Note that the title lines from the local help files are automagically added to
639the "LOCAL ADDITIONS" section in the "help.txt" help file |local-additions|.
640This is done when viewing the file in Vim, the file itself is not changed. It
641is done by going through all help files and obtaining the first line of each
642file. The files in $VIMRUNTIME/doc are skipped.
643
644 *help-xterm-window*
645If you want to have the help in another xterm window, you could use this
646command: >
647 :!xterm -e vim +help &
648<
649
650 *:helpfind* *:helpf*
651:helpf[ind] Like |:help|, but use a dialog to enter the argument.
652 Only for backwards compatibility. It now executes the
653 ToolBar.FindHelp menu entry instead of using a builtin
654 dialog. {only when compiled with |+GUI_GTK|}
655< {not in Vi}
656
657 *:helpt* *:helptags*
658 *E154* *E150* *E151* *E152* *E153* *E670*
659:helpt[ags] {dir} Generate the help tags file(s) for directory {dir}.
660 All "*.txt" and "*.??x" files in the directory are
661 scanned for a help tag definition in between stars.
662 The "*.??x" files are for translated docs, they
663 generate the "tags-??" file, see |help-translated|.
664 The generated tags files are sorted.
665 When there are duplicates an error message is given.
666 An existing tags file is silently overwritten.
667 To rebuild the help tags in the runtime directory
668 (requires write permission there): >
669 :helptags $VIMRUNTIME/doc
670< {not in Vi}
671
672
673TRANSLATED HELP *help-translated*
674
675It is possible to add translated help files, next to the original English help
676files. Vim will search for all help in "doc" directories in 'runtimepath'.
677This is only available when compiled with the |+multi_lang| feature.
678
679A set of translated help files consists of these files:
680
681 help.abx
682 howto.abx
683 ...
684 tags-ab
685
686"ab" is the two-letter language code. Thus for Italian the names are:
687
688 help.itx
689 howto.itx
690 ...
691 tags-it
692
693The 'helplang' option can be set to the preferred language(s). The default is
694set according to the environment. Vim will first try to find a matching tag
695in the preferred language(s). English is used when it cannot be found.
696
697To find a tag in a specific language, append "@ab" to a tag, where "ab" is the
698two-letter language code. Example: >
699 :he user-manual@it
700 :he user-manual@en
701The first one finds the Italian user manual, even when 'helplang' is empty.
702The second one finds the English user manual, even when 'helplang' is set to
703"it".
704
705When using command-line completion for the ":help" command, the "@en"
706extention is only shown when a tag exists for multiple languages. When the
707tag only exists for English "@en" is omitted.
708
709When using |CTRL-]| or ":help!" in a non-English help file Vim will try to
710find the tag in the same language. If not found then 'helplang' will be used
711to select a language.
712
713Help files must use latin1 or utf-8 encoding. Vim assumes the encoding is
714utf-8 when finding non-ASCII characters in the first line. Thus you must
715translate the header with "For Vim version".
716
717The same encoding must be used for the help files of one language in one
718directory. You can use a different encoding for different languages and use
719a different encoding for help files of the same language but in a different
720directory.
721
722Hints for translators:
723- Do not translate the tags. This makes it possible to use 'helplang' to
724 specify the preferred language. You may add new tags in your language.
725- When you do not translate a part of a file, add tags to the English version,
726 using the "tag@en" notation.
727- Make a package with all the files and the tags file available for download.
728 Users can drop it in one of the "doc" directories and start use it.
729 Report this to Bram, so that he can add a link on www.vim.org.
730- Use the |:helptags| command to generate the tags files. It will find all
731 languages in the specified directory.
732
733==============================================================================
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344. Using Vim like less or more *less*
735
736If you use the less or more program to view a file, you don't get syntax
737highlighting. Thus you would like to use Vim instead. You can do this by
738using the shell script "$VIMRUNTIME/macros/less.sh".
739
740This shell script uses the Vim script "$VIMRUNTIME/macros/less.vim". It sets
741up mappings to simulate the commands that less supports. Otherwise, you can
742still use the Vim commands.
743
744This isn't perfect. For example, when viewing a short file Vim will still use
745the whole screen. But it works good enough for most uses, and you get syntax
746highlighting.
747
748The "h" key will give you a short overview of the available commands.
749
750 vim:tw=78:ts=8:ft=help:norl: