annotate runtime/doc/various.txt @ 502:52e76e2b5b65 v7.0140

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