|
555
|
1 *syntax.txt* For Vim version 7.0aa. Last change: 2005 Oct 12
|
|
7
|
2
|
|
|
3
|
|
|
4 VIM REFERENCE MANUAL by Bram Moolenaar
|
|
|
5
|
|
|
6
|
|
|
7 Syntax highlighting *syntax* *syntax-highlighting* *coloring*
|
|
|
8
|
|
|
9 Syntax highlighting enables Vim to show parts of the text in another font or
|
|
|
10 color. Those parts can be specific keywords or text matching a pattern. Vim
|
|
|
11 doesn't parse the whole file (to keep it fast), so the highlighting has its
|
|
|
12 limitations. Lexical highlighting might be a better name, but since everybody
|
|
|
13 calls it syntax highlighting we'll stick with that.
|
|
|
14
|
|
|
15 Vim supports syntax highlighting on all terminals. But since most ordinary
|
|
|
16 terminals have very limited highlighting possibilities, it works best in the
|
|
|
17 GUI version, gvim.
|
|
|
18
|
|
|
19 In the User Manual:
|
|
|
20 |usr_06.txt| introduces syntax highlighting.
|
|
|
21 |usr_44.txt| introduces writing a syntax file.
|
|
|
22
|
|
|
23 1. Quick start |:syn-qstart|
|
|
|
24 2. Syntax files |:syn-files|
|
|
|
25 3. Syntax loading procedure |syntax-loading|
|
|
|
26 4. Syntax file remarks |:syn-file-remarks|
|
|
|
27 5. Defining a syntax |:syn-define|
|
|
|
28 6. :syntax arguments |:syn-arguments|
|
|
|
29 7. Syntax patterns |:syn-pattern|
|
|
|
30 8. Syntax clusters |:syn-cluster|
|
|
|
31 9. Including syntax files |:syn-include|
|
|
|
32 10. Synchronizing |:syn-sync|
|
|
|
33 11. Listing syntax items |:syntax|
|
|
|
34 12. Highlight command |:highlight|
|
|
|
35 13. Linking groups |:highlight-link|
|
|
|
36 14. Cleaning up |:syn-clear|
|
|
|
37 15. Highlighting tags |tag-highlight|
|
|
|
38 16. Color xterms |xterm-color|
|
|
|
39
|
|
|
40 {Vi does not have any of these commands}
|
|
|
41
|
|
|
42 Syntax highlighting is not available when the |+syntax| feature has been
|
|
|
43 disabled at compile time.
|
|
|
44
|
|
|
45 ==============================================================================
|
|
|
46 1. Quick start *:syn-qstart*
|
|
|
47
|
|
|
48 *:syn-enable* *:syntax-enable*
|
|
|
49 This command switches on syntax highlighting: >
|
|
|
50
|
|
|
51 :syntax enable
|
|
|
52
|
|
|
53 What this command actually does is to execute the command >
|
|
|
54 :source $VIMRUNTIME/syntax/syntax.vim
|
|
|
55
|
|
|
56 If the VIM environment variable is not set, Vim will try to find
|
|
|
57 the path in another way (see |$VIMRUNTIME|). Usually this works just
|
|
|
58 fine. If it doesn't, try setting the VIM environment variable to the
|
|
|
59 directory where the Vim stuff is located. For example, if your syntax files
|
|
|
60 are in the "/usr/vim/vim50/syntax" directory, set $VIMRUNTIME to
|
|
|
61 "/usr/vim/vim50". You must do this in the shell, before starting Vim.
|
|
|
62
|
|
|
63 *:syn-on* *:syntax-on*
|
|
|
64 The ":syntax enable" command will keep your current color settings. This
|
|
|
65 allows using ":highlight" commands to set your preferred colors before or
|
|
|
66 after using this command. If you want Vim to overrule your settings with the
|
|
|
67 defaults, use: >
|
|
|
68 :syntax on
|
|
|
69 <
|
|
|
70 *:hi-normal* *:highlight-normal*
|
|
|
71 If you are running in the GUI, you can get white text on a black background
|
|
|
72 with: >
|
|
|
73 :highlight Normal guibg=Black guifg=White
|
|
|
74 For a color terminal see |:hi-normal-cterm|.
|
|
|
75 For setting up your own colors syntax highlighting see |syncolor|.
|
|
|
76
|
|
|
77 NOTE: The syntax files on MS-DOS and Windows have lines that end in <CR><NL>.
|
|
|
78 The files for Unix end in <NL>. This means you should use the right type of
|
|
|
79 file for your system. Although on MS-DOS and Windows the right format is
|
|
|
80 automatically selected if the 'fileformats' option is not empty.
|
|
|
81
|
|
|
82 NOTE: When using reverse video ("gvim -fg white -bg black"), the default value
|
|
|
83 of 'background' will not be set until the GUI window is opened, which is after
|
|
|
84 reading the .gvimrc. This will cause the wrong default highlighting to be
|
|
|
85 used. To set the default value of 'background' before switching on
|
|
|
86 highlighting, include the ":gui" command in the .gvimrc: >
|
|
|
87
|
|
|
88 :gui " open window and set default for 'background'
|
|
|
89 :syntax on " start highlighting, use 'background' to set colors
|
|
|
90
|
|
|
91 NOTE: Using ":gui" in the .gvimrc means that "gvim -f" won't start in the
|
|
|
92 foreground! Use ":gui -f" then.
|
|
|
93
|
|
|
94
|
|
|
95 You can toggle the syntax on/off with this command >
|
|
|
96 :if exists("syntax_on") | syntax off | else | syntax enable | endif
|
|
|
97
|
|
|
98 To put this into a mapping, you can use: >
|
|
|
99 :map <F7> :if exists("syntax_on") <Bar>
|
|
|
100 \ syntax off <Bar>
|
|
|
101 \ else <Bar>
|
|
|
102 \ syntax enable <Bar>
|
|
|
103 \ endif <CR>
|
|
|
104 [using the |<>| notation, type this literally]
|
|
|
105
|
|
|
106 Details
|
|
|
107 The ":syntax" commands are implemented by sourcing a file. To see exactly how
|
|
|
108 this works, look in the file:
|
|
|
109 command file ~
|
|
|
110 :syntax enable $VIMRUNTIME/syntax/syntax.vim
|
|
|
111 :syntax on $VIMRUNTIME/syntax/syntax.vim
|
|
|
112 :syntax manual $VIMRUNTIME/syntax/manual.vim
|
|
|
113 :syntax off $VIMRUNTIME/syntax/nosyntax.vim
|
|
|
114 Also see |syntax-loading|.
|
|
|
115
|
|
|
116 ==============================================================================
|
|
|
117 2. Syntax files *:syn-files*
|
|
|
118
|
|
|
119 The syntax and highlighting commands for one language are normally stored in
|
|
|
120 a syntax file. The name convention is: "{name}.vim". Where {name} is the
|
|
|
121 name of the language, or an abbreviation (to fit the name in 8.3 characters,
|
|
|
122 a requirement in case the file is used on a DOS filesystem).
|
|
|
123 Examples:
|
|
|
124 c.vim perl.vim java.vim html.vim
|
|
|
125 cpp.vim sh.vim csh.vim
|
|
|
126
|
|
|
127 The syntax file can contain any Ex commands, just like a vimrc file. But
|
|
|
128 the idea is that only commands for a specific language are included. When a
|
|
|
129 language is a superset of another language, it may include the other one,
|
|
|
130 for example, the cpp.vim file could include the c.vim file: >
|
|
|
131 :so $VIMRUNTIME/syntax/c.vim
|
|
|
132
|
|
|
133 The .vim files are normally loaded with an autocommand. For example: >
|
|
|
134 :au Syntax c runtime! syntax/c.vim
|
|
|
135 :au Syntax cpp runtime! syntax/cpp.vim
|
|
|
136 These commands are normally in the file $VIMRUNTIME/syntax/synload.vim.
|
|
|
137
|
|
|
138
|
|
|
139 MAKING YOUR OWN SYNTAX FILES *mysyntaxfile*
|
|
|
140
|
|
|
141 When you create your own syntax files, and you want to have Vim use these
|
|
|
142 automatically with ":syntax enable", do this:
|
|
|
143
|
|
|
144 1. Create your user runtime directory. You would normally use the first item
|
|
|
145 of the 'runtimepath' option. Example for Unix: >
|
|
|
146 mkdir ~/.vim
|
|
|
147
|
|
|
148 2. Create a directory in there called "syntax". For Unix: >
|
|
|
149 mkdir ~/.vim/syntax
|
|
|
150
|
|
|
151 3. Write the Vim syntax file. Or download one from the internet. Then write
|
|
|
152 it in your syntax directory. For example, for the "mine" syntax: >
|
|
|
153 :w ~/.vim/syntax/mine.vim
|
|
|
154
|
|
|
155 Now you can start using your syntax file manually: >
|
|
|
156 :set syntax=mine
|
|
|
157 You don't have to exit Vim to use this.
|
|
|
158
|
|
|
159 If you also want Vim to detect the type of file, see |new-filetype|.
|
|
|
160
|
|
|
161 If you are setting up a system with many users and you don't want each user
|
|
|
162 to add the same syntax file, you can use another directory from 'runtimepath'.
|
|
|
163
|
|
|
164
|
|
|
165 ADDING TO AN EXISTING SYNTAX FILE *mysyntaxfile-add*
|
|
|
166
|
|
|
167 If you are mostly satisfied with an existing syntax file, but would like to
|
|
|
168 add a few items or change the highlighting, follow these steps:
|
|
|
169
|
|
|
170 1. Create your user directory from 'runtimepath', see above.
|
|
|
171
|
|
|
172 2. Create a directory in there called "after/syntax". For Unix: >
|
|
|
173 mkdir ~/.vim/after
|
|
|
174 mkdir ~/.vim/after/syntax
|
|
|
175
|
|
|
176 3. Write a Vim script that contains the commands you want to use. For
|
|
|
177 example, to change the colors for the C syntax: >
|
|
|
178 highlight cComment ctermfg=Green guifg=Green
|
|
|
179
|
|
|
180 4. Write that file in the "after/syntax" directory. Use the name of the
|
|
|
181 syntax, with ".vim" added. For our C syntax: >
|
|
|
182 :w ~/.vim/after/syntax/c.vim
|
|
|
183
|
|
|
184 That's it. The next time you edit a C file the Comment color will be
|
|
|
185 different. You don't even have to restart Vim.
|
|
|
186
|
|
169
|
187 If you have multiple files, you can use the filetype as the directory name.
|
|
|
188 All the "*.vim" files in this directory will be used, for example:
|
|
|
189 ~/.vim/after/syntax/c/one.vim
|
|
|
190 ~/.vim/after/syntax/c/two.vim
|
|
|
191
|
|
7
|
192
|
|
|
193 REPLACING AN EXISTING SYNTAX FILE *mysyntaxfile-replace*
|
|
|
194
|
|
|
195 If you don't like a distributed syntax file, or you have downloaded a new
|
|
|
196 version, follow the same steps as for |mysyntaxfile| above. Just make sure
|
|
|
197 that you write the syntax file in a directory that is early in 'runtimepath'.
|
|
|
198 Vim will only load the first syntax file found.
|
|
|
199
|
|
|
200
|
|
|
201 NAMING CONVENTIONS
|
|
|
202 *group-name* *{group-name}* *E669* *W18*
|
|
|
203 The name for a highlight or syntax group must consist of ASCII letters, digits
|
|
|
204 and the underscore. As a regexp: "[a-zA-Z0-9_]*"
|
|
|
205
|
|
|
206 To be able to allow each user to pick his favorite set of colors, there must
|
|
|
207 be preferred names for highlight groups that are common for many languages.
|
|
|
208 These are the suggested group names (if syntax highlighting works properly
|
|
|
209 you can see the actual color, except for "Ignore"):
|
|
|
210
|
|
|
211 *Comment any comment
|
|
|
212
|
|
|
213 *Constant any constant
|
|
|
214 String a string constant: "this is a string"
|
|
|
215 Character a character constant: 'c', '\n'
|
|
|
216 Number a number constant: 234, 0xff
|
|
|
217 Boolean a boolean constant: TRUE, false
|
|
|
218 Float a floating point constant: 2.3e10
|
|
|
219
|
|
|
220 *Identifier any variable name
|
|
|
221 Function function name (also: methods for classes)
|
|
|
222
|
|
|
223 *Statement any statement
|
|
|
224 Conditional if, then, else, endif, switch, etc.
|
|
|
225 Repeat for, do, while, etc.
|
|
|
226 Label case, default, etc.
|
|
|
227 Operator "sizeof", "+", "*", etc.
|
|
|
228 Keyword any other keyword
|
|
|
229 Exception try, catch, throw
|
|
|
230
|
|
|
231 *PreProc generic Preprocessor
|
|
|
232 Include preprocessor #include
|
|
|
233 Define preprocessor #define
|
|
|
234 Macro same as Define
|
|
|
235 PreCondit preprocessor #if, #else, #endif, etc.
|
|
|
236
|
|
|
237 *Type int, long, char, etc.
|
|
|
238 StorageClass static, register, volatile, etc.
|
|
|
239 Structure struct, union, enum, etc.
|
|
|
240 Typedef A typedef
|
|
|
241
|
|
|
242 *Special any special symbol
|
|
|
243 SpecialChar special character in a constant
|
|
|
244 Tag you can use CTRL-] on this
|
|
|
245 Delimiter character that needs attention
|
|
|
246 SpecialComment special things inside a comment
|
|
|
247 Debug debugging statements
|
|
|
248
|
|
|
249 *Underlined text that stands out, HTML links
|
|
|
250
|
|
|
251 *Ignore left blank, hidden
|
|
|
252
|
|
|
253 *Error any erroneous construct
|
|
|
254
|
|
|
255 *Todo anything that needs extra attention; mostly the
|
|
|
256 keywords TODO FIXME and XXX
|
|
|
257
|
|
|
258 The names marked with * are the preferred groups; the others are minor groups.
|
|
|
259 For the preferred groups, the "syntax.vim" file contains default highlighting.
|
|
|
260 The minor groups are linked to the preferred groups, so they get the same
|
|
|
261 highlighting. You can override these defaults by using ":highlight" commands
|
|
|
262 after sourcing the "syntax.vim" file.
|
|
|
263
|
|
|
264 Note that highlight group names are not case sensitive. "String" and "string"
|
|
|
265 can be used for the same group.
|
|
|
266
|
|
|
267 The following names are reserved and cannot be used as a group name:
|
|
|
268 NONE ALL ALLBUT contains contained
|
|
|
269
|
|
|
270 ==============================================================================
|
|
|
271 3. Syntax loading procedure *syntax-loading*
|
|
|
272
|
|
|
273 This explains the details that happen when the command ":syntax enable" is
|
|
|
274 issued. When Vim initializes itself, it finds out where the runtime files are
|
|
|
275 located. This is used here as the variable |$VIMRUNTIME|.
|
|
|
276
|
|
|
277 ":syntax enable" and ":syntax on" do the following:
|
|
|
278
|
|
|
279 Source $VIMRUNTIME/syntax/syntax.vim
|
|
|
280 |
|
|
|
281 +- Clear out any old syntax by sourcing $VIMRUNTIME/syntax/nosyntax.vim
|
|
|
282 |
|
|
|
283 +- Source first syntax/synload.vim in 'runtimepath'
|
|
|
284 | |
|
|
|
285 | +- Setup the colors for syntax highlighting. If a color scheme is
|
|
|
286 | | defined it is loaded again with ":colors {name}". Otherwise
|
|
|
287 | | ":runtime! syntax/syncolor.vim" is used. ":syntax on" overrules
|
|
|
288 | | existing colors, ":syntax enable" only sets groups that weren't
|
|
|
289 | | set yet.
|
|
|
290 | |
|
|
|
291 | +- Set up syntax autocmds to load the appropriate syntax file when
|
|
|
292 | | the 'syntax' option is set. *synload-1*
|
|
|
293 | |
|
|
|
294 | +- Source the user's optional file, from the |mysyntaxfile| variable.
|
|
|
295 | This is for backwards compatibility with Vim 5.x only. *synload-2*
|
|
|
296 |
|
|
|
297 +- Do ":filetype on", which does ":runtime! filetype.vim". It loads any
|
|
|
298 | filetype.vim files found. It should always Source
|
|
|
299 | $VIMRUNTIME/filetype.vim, which does the following.
|
|
|
300 | |
|
|
|
301 | +- Install autocmds based on suffix to set the 'filetype' option
|
|
|
302 | | This is where the connection between file name and file type is
|
|
|
303 | | made for known file types. *synload-3*
|
|
|
304 | |
|
|
|
305 | +- Source the user's optional file, from the *myfiletypefile*
|
|
|
306 | | variable. This is for backwards compatibility with Vim 5.x only.
|
|
|
307 | | *synload-4*
|
|
|
308 | |
|
|
|
309 | +- Install one autocommand which sources scripts.vim when no file
|
|
|
310 | | type was detected yet. *synload-5*
|
|
|
311 | |
|
|
|
312 | +- Source $VIMRUNTIME/menu.vim, to setup the Syntax menu. |menu.vim|
|
|
|
313 |
|
|
|
314 +- Install a FileType autocommand to set the 'syntax' option when a file
|
|
|
315 | type has been detected. *synload-6*
|
|
|
316 |
|
|
|
317 +- Execute syntax autocommands to start syntax highlighting for each
|
|
|
318 already loaded buffer.
|
|
|
319
|
|
|
320
|
|
|
321 Upon loading a file, Vim finds the relevant syntax file as follows:
|
|
|
322
|
|
|
323 Loading the file triggers the BufReadPost autocommands.
|
|
|
324 |
|
|
|
325 +- If there is a match with one of the autocommands from |synload-3|
|
|
|
326 | (known file types) or |synload-4| (user's file types), the 'filetype'
|
|
|
327 | option is set to the file type.
|
|
|
328 |
|
|
|
329 +- The autocommand at |synload-5| is triggered. If the file type was not
|
|
|
330 | found yet, then scripts.vim is searched for in 'runtimepath'. This
|
|
|
331 | should always load $VIMRUNTIME/scripts.vim, which does the following.
|
|
|
332 | |
|
|
|
333 | +- Source the user's optional file, from the *myscriptsfile*
|
|
|
334 | | variable. This is for backwards compatibility with Vim 5.x only.
|
|
|
335 | |
|
|
|
336 | +- If the file type is still unknown, check the contents of the file,
|
|
|
337 | again with checks like "getline(1) =~ pattern" as to whether the
|
|
|
338 | file type can be recognized, and set 'filetype'.
|
|
|
339 |
|
|
|
340 +- When the file type was determined and 'filetype' was set, this
|
|
|
341 | triggers the FileType autocommand |synload-6| above. It sets
|
|
|
342 | 'syntax' to the determined file type.
|
|
|
343 |
|
|
|
344 +- When the 'syntax' option was set above, this triggers an autocommand
|
|
|
345 | from |synload-1| (and |synload-2|). This find the main syntax file in
|
|
|
346 | 'runtimepath', with this command:
|
|
|
347 | runtime! syntax/<name>.vim
|
|
|
348 |
|
|
|
349 +- Any other user installed FileType or Syntax autocommands are
|
|
|
350 triggered. This can be used to change the highlighting for a specific
|
|
|
351 syntax.
|
|
|
352
|
|
|
353 ==============================================================================
|
|
|
354 4. Syntax file remarks *:syn-file-remarks*
|
|
|
355
|
|
|
356 *b:current_syntax-variable*
|
|
|
357 Vim stores the name of the syntax that has been loaded in the
|
|
|
358 "b:current_syntax" variable. You can use this if you want to load other
|
|
|
359 settings, depending on which syntax is active. Example: >
|
|
|
360 :au BufReadPost * if b:current_syntax == "csh"
|
|
|
361 :au BufReadPost * do-some-things
|
|
|
362 :au BufReadPost * endif
|
|
|
363
|
|
|
364
|
|
|
365 2HTML *2html.vim* *convert-to-HTML*
|
|
|
366
|
|
|
367 This is not a syntax file itself, but a script that converts the current
|
|
|
368 window into HTML. Vim opens a new window in which it builds the HTML file.
|
|
|
369
|
|
|
370 You are not supposed to set the 'filetype' or 'syntax' option to "2html"!
|
|
|
371 Source the script to convert the current file: >
|
|
|
372
|
|
|
373 :runtime! syntax/2html.vim
|
|
|
374 <
|
|
|
375 Warning: This is slow!
|
|
|
376 *:TOhtml*
|
|
|
377 Or use the ":TOhtml" user command. It is defined in a standard plugin.
|
|
|
378 ":TOhtml" also works with a range and in a Visual area: >
|
|
|
379
|
|
|
380 :10,40TOhtml
|
|
|
381
|
|
|
382 After you save the resulting file, you can view it with any HTML viewer, such
|
|
|
383 as Netscape. The colors should be exactly the same as you see them in Vim.
|
|
|
384
|
|
|
385 To restrict the conversion to a range of lines set "html_start_line" and
|
|
|
386 "html_end_line" to the first and last line to be converted. Example, using
|
|
|
387 the last set Visual area: >
|
|
|
388
|
|
|
389 :let html_start_line = line("'<")
|
|
|
390 :let html_end_line = line("'>")
|
|
|
391
|
|
|
392 The lines are numbered according to 'number' option and the Number
|
|
|
393 highlighting. You can force lines to be numbered in the HTML output by
|
|
|
394 setting "html_number_lines" to non-zero value: >
|
|
|
395 :let html_number_lines = 1
|
|
|
396 Force to omit the line numbers by using a zero value: >
|
|
|
397 :let html_number_lines = 0
|
|
|
398 Go back to the default to use 'number' by deleting the variable: >
|
|
|
399 :unlet html_number_lines
|
|
|
400
|
|
29
|
401 Closed folds are put in the HTML as they are displayed. If you don't want
|
|
477
|
402 this, use the |zR| command before invoking 2html, or use: >
|
|
279
|
403 :let html_ignore_folding = 1
|
|
29
|
404
|
|
7
|
405 By default, HTML optimized for old browsers is generated. If you prefer using
|
|
|
406 cascading style sheets (CSS1) for the attributes (resulting in considerably
|
|
|
407 shorter and valid HTML 4 file), use: >
|
|
|
408 :let html_use_css = 1
|
|
|
409
|
|
|
410 By default "<pre>" and "</pre>" is used around the text. This makes it show
|
|
|
411 up as you see it in Vim, but without wrapping. If you prefer wrapping, at the
|
|
|
412 risk of making some things look a bit different, use: >
|
|
|
413 :let html_no_pre = 1
|
|
|
414 This will use <br> at the end of each line and use " " for repeated
|
|
|
415 spaces.
|
|
|
416
|
|
|
417 The current value of 'encoding' is used to specify the charset of the HTML
|
|
|
418 file. This only works for those values of 'encoding' that have an equivalent
|
|
|
419 HTML charset name. To overrule this set g:html_use_encoding to the name of
|
|
|
420 the charset to be used: >
|
|
|
421 :let html_use_encoding = "foobar"
|
|
|
422 To omit the line that specifies the charset, set g:html_use_encoding to an
|
|
|
423 empty string: >
|
|
|
424 :let html_use_encoding = ""
|
|
|
425 To go back to the automatic mechanism, delete the g:html_use_encoding
|
|
|
426 variable: >
|
|
|
427 :unlet html_use_encoding
|
|
|
428 <
|
|
32
|
429 For diff mode a sequence of more than 3 filler lines is displayed as three
|
|
|
430 lines with the middle line mentioning the total number of inserted lines. If
|
|
|
431 you prefer to see all the inserted lines use: >
|
|
|
432 :let html_whole_filler = 1
|
|
|
433 And to go back to displaying up to three lines again: >
|
|
|
434 :unlet html_whole_filler
|
|
477
|
435 <
|
|
7
|
436 *convert-to-XML* *convert-to-XHTML*
|
|
|
437 An alternative is to have the script generate XHTML (XML compliant HTML). To
|
|
|
438 do this set the "use_xhtml" variable: >
|
|
|
439 :let use_xhtml = 1
|
|
|
440 To disable it again delete the variable: >
|
|
|
441 :unlet use_xhtml
|
|
|
442 The generated XHTML file can be used in DocBook XML documents. See:
|
|
|
443 http://people.mech.kuleuven.ac.be/~pissaris/howto/src2db.html
|
|
|
444
|
|
|
445 Remarks:
|
|
|
446 - This only works in a version with GUI support. If the GUI is not actually
|
|
|
447 running (possible for X11) it still works, but not very well (the colors
|
|
|
448 may be wrong).
|
|
|
449 - Older browsers will not show the background colors.
|
|
|
450 - From most browsers you can also print the file (in color)!
|
|
|
451
|
|
|
452 Here is an example how to run the script over all .c and .h files from a
|
|
|
453 Unix shell: >
|
|
|
454 for f in *.[ch]; do gvim -f +"syn on" +"run! syntax/2html.vim" +"wq" +"q" $f; done
|
|
|
455 <
|
|
|
456
|
|
501
|
457 ABEL *abel.vim* *ft-abel-syntax*
|
|
7
|
458
|
|
|
459 ABEL highlighting provides some user-defined options. To enable them, assign
|
|
|
460 any value to the respective variable. Example: >
|
|
|
461 :let abel_obsolete_ok=1
|
|
|
462 To disable them use ":unlet". Example: >
|
|
|
463 :unlet abel_obsolete_ok
|
|
|
464
|
|
|
465 Variable Highlight ~
|
|
|
466 abel_obsolete_ok obsolete keywords are statements, not errors
|
|
|
467 abel_cpp_comments_illegal do not interpret '//' as inline comment leader
|
|
|
468
|
|
|
469
|
|
501
|
470 ADA *ada.vim* *ft-ada-syntax*
|
|
7
|
471
|
|
|
472 This mode is designed for the 1995 edition of Ada ("Ada95"), which
|
|
|
473 includes support for objected-programming, protected types, and so on.
|
|
|
474 It handles code written for the original Ada language
|
|
|
475 ("Ada83" or "Ada87") as well, though Ada83 code which uses Ada95-only
|
|
|
476 keywords will be wrongly colored (such code should be fixed anyway).
|
|
|
477 For more information about Ada, see http://www.adapower.com.
|
|
|
478
|
|
|
479 The Ada mode handles a number of situations cleanly.
|
|
|
480 For example, it knows that the "-" in "-5" is a number, but the same
|
|
|
481 character in "A-5" is an operator. Normally, a "with" or "use" clause
|
|
|
482 referencing another compilation unit is colored the same way as C's
|
|
|
483 "#include" is colored. If you have "Conditional" or "Repeat"
|
|
|
484 groups colored differently, then "end if" and "end loop" will be
|
|
|
485 colored as part of those respective groups.
|
|
|
486 You can set these to different colors using vim's "highlight" command
|
|
|
487 (e.g., to change how loops are displayed, enter the command
|
|
|
488 ":hi Repeat" followed by the color specification; on simple terminals
|
|
|
489 the color specification ctermfg=White often shows well).
|
|
|
490
|
|
|
491 There are several options you can select in this Ada mode.
|
|
|
492 To enable them, assign a value to the option. For example, to turn one on:
|
|
|
493 let ada_standard_types = 1
|
|
|
494 To disable them use ":unlet". Example:
|
|
|
495 unlet ada_standard_types = 1
|
|
|
496 You can just use ":" and type these into the command line to set these
|
|
|
497 temporarily before loading an Ada file. You can make these option settings
|
|
|
498 permanent by adding the "let" command(s), without a colon,
|
|
|
499 to your "~/.vimrc" file.
|
|
|
500
|
|
|
501 Here are the Ada mode options:
|
|
|
502
|
|
|
503 Variable Action ~
|
|
|
504 ada_standard_types Highlight types in package Standard (e.g., "Float")
|
|
|
505 ada_space_errors Highlight extraneous errors in spaces...
|
|
|
506 ada_no_trail_space_error but ignore trailing spaces at the end of a line
|
|
|
507 ada_no_tab_space_error but ignore tabs after spaces
|
|
|
508 ada_withuse_ordinary Show "with" and "use" as ordinary keywords
|
|
|
509 (when used to reference other compilation units
|
|
|
510 they're normally highlighted specially).
|
|
|
511 ada_begin_preproc Show all begin-like keywords using the coloring
|
|
|
512 of C preprocessor commands.
|
|
|
513
|
|
|
514 Even on a slow (90Mhz) PC this mode works quickly, but if you find
|
|
|
515 the performance unacceptable, turn on ada_withuse_ordinary.
|
|
|
516
|
|
|
517
|
|
501
|
518 ANT *ant.vim* *ft-ant-syntax*
|
|
7
|
519
|
|
|
520 The ant syntax file provides syntax highlighting for javascript and python
|
|
237
|
521 by default. Syntax highlighting for other script languages can be installed
|
|
7
|
522 by the function AntSyntaxScript(), which takes the tag name as first argument
|
|
237
|
523 and the script syntax file name as second argument. Example: >
|
|
7
|
524
|
|
|
525 :call AntSyntaxScript('perl', 'perl.vim')
|
|
|
526
|
|
|
527 will install syntax perl highlighting for the following ant code >
|
|
|
528
|
|
|
529 <script language = 'perl'><![CDATA[
|
|
|
530 # everything inside is highlighted as perl
|
|
|
531 ]]></script>
|
|
|
532
|
|
|
533 See |mysyntaxfile-add| for installing script languages permanently.
|
|
|
534
|
|
|
535
|
|
501
|
536 APACHE *apache.vim* *ft-apache-syntax*
|
|
7
|
537
|
|
|
538 The apache syntax file provides syntax highlighting depending on Apache HTTP
|
|
|
539 server version, by default for 1.3.x. Set "apache_version" to Apache version
|
|
|
540 (as a string) to get highlighting for another version. Example: >
|
|
|
541
|
|
|
542 :let apache_version = "2.0"
|
|
|
543 <
|
|
|
544
|
|
|
545 *asm.vim* *asmh8300.vim* *nasm.vim* *masm.vim* *asm68k*
|
|
501
|
546 ASSEMBLY *ft-asm-syntax* *ft-asmh8300-syntax* *ft-nasm-syntax*
|
|
|
547 *ft-masm-syntax* *ft-asm68k-syntax* *fasm.vim*
|
|
7
|
548
|
|
|
549 Files matching "*.i" could be Progress or Assembly. If the automatic detection
|
|
|
550 doesn't work for you, or you don't edit Progress at all, use this in your
|
|
|
551 startup vimrc: >
|
|
|
552 :let filetype_i = "asm"
|
|
|
553 Replace "asm" with the type of assembly you use.
|
|
|
554
|
|
|
555 There are many types of assembly languages that all use the same file name
|
|
|
556 extensions. Therefore you will have to select the type yourself, or add a
|
|
|
557 line in the assembly file that Vim will recognize. Currently these syntax
|
|
|
558 files are included:
|
|
|
559 asm GNU assembly (the default)
|
|
|
560 asm68k Motorola 680x0 assembly
|
|
|
561 asmh8300 Hitachi H-8300 version of GNU assembly
|
|
|
562 ia64 Intel Itanium 64
|
|
|
563 fasm Flat assembly (http://flatassembler.net)
|
|
|
564 masm Microsoft assembly (probably works for any 80x86)
|
|
|
565 nasm Netwide assembly
|
|
|
566 tasm Turbo Assembly (with opcodes 80x86 up to Pentium, and
|
|
|
567 MMX)
|
|
|
568 pic PIC assembly (currently for PIC16F84)
|
|
|
569
|
|
|
570 The most flexible is to add a line in your assembly file containing: >
|
|
|
571 :asmsyntax=nasm
|
|
|
572 Replace "nasm" with the name of the real assembly syntax. This line must be
|
|
|
573 one of the first five lines in the file.
|
|
|
574
|
|
|
575 The syntax type can always be overruled for a specific buffer by setting the
|
|
|
576 b:asmsyntax variable: >
|
|
|
577 :let b:asmsyntax=nasm
|
|
|
578
|
|
|
579 If b:asmsyntax is not set, either automatically or by hand, then the value of
|
|
|
580 the global variable asmsyntax is used. This can be seen as a default assembly
|
|
|
581 language: >
|
|
|
582 :let asmsyntax=nasm
|
|
|
583
|
|
|
584 As a last resort, if nothing is defined, the "asm" syntax is used.
|
|
|
585
|
|
|
586
|
|
|
587 Netwide assembler (nasm.vim) optional highlighting ~
|
|
|
588
|
|
|
589 To enable a feature: >
|
|
|
590 :let {variable}=1|set syntax=nasm
|
|
|
591 To disable a feature: >
|
|
|
592 :unlet {variable} |set syntax=nasm
|
|
|
593
|
|
|
594 Variable Highlight ~
|
|
|
595 nasm_loose_syntax unofficial parser allowed syntax not as Error
|
|
|
596 (parser dependent; not recommended)
|
|
|
597 nasm_ctx_outside_macro contexts outside macro not as Error
|
|
|
598 nasm_no_warn potentially risky syntax not as ToDo
|
|
|
599
|
|
|
600
|
|
501
|
601 ASPPERL and ASPVBS *ft-aspperl-syntax* *ft-aspvbs-syntax*
|
|
7
|
602
|
|
|
603 *.asp and *.asa files could be either Perl or Visual Basic script. Since it's
|
|
|
604 hard to detect this you can set two global variables to tell Vim what you are
|
|
|
605 using. For Perl script use: >
|
|
|
606 :let g:filetype_asa = "aspperl"
|
|
|
607 :let g:filetype_asp = "aspperl"
|
|
|
608 For Visual Basic use: >
|
|
|
609 :let g:filetype_asa = "aspvbs"
|
|
|
610 :let g:filetype_asp = "aspvbs"
|
|
|
611
|
|
|
612
|
|
501
|
613 BASIC *basic.vim* *vb.vim* *ft-basic-syntax* *ft-vb-syntax*
|
|
7
|
614
|
|
|
615 Both Visual Basic and "normal" basic use the extension ".bas". To detect
|
|
|
616 which one should be used, Vim checks for the string "VB_Name" in the first
|
|
|
617 five lines of the file. If it is not found, filetype will be "basic",
|
|
|
618 otherwise "vb". Files with the ".frm" extension will always be seen as Visual
|
|
|
619 Basic.
|
|
|
620
|
|
|
621
|
|
501
|
622 C *c.vim* *ft-c-syntax*
|
|
7
|
623
|
|
|
624 A few things in C highlighting are optional. To enable them assign any value
|
|
|
625 to the respective variable. Example: >
|
|
|
626 :let c_comment_strings=1
|
|
|
627 To disable them use ":unlet". Example: >
|
|
|
628 :unlet c_comment_strings
|
|
|
629
|
|
|
630 Variable Highlight ~
|
|
|
631 c_gnu GNU gcc specific items
|
|
|
632 c_comment_strings strings and numbers inside a comment
|
|
|
633 c_space_errors trailing white space and spaces before a <Tab>
|
|
|
634 c_no_trail_space_error ... but no trailing spaces
|
|
|
635 c_no_tab_space_error ... but no spaces before a <Tab>
|
|
|
636 c_no_bracket_error don't highlight {}; inside [] as errors
|
|
140
|
637 c_no_curly_error don't highlight {}; inside [] and () as errors;
|
|
|
638 except { and } in first column
|
|
7
|
639 c_no_ansi don't do standard ANSI types and constants
|
|
|
640 c_ansi_typedefs ... but do standard ANSI types
|
|
|
641 c_ansi_constants ... but do standard ANSI constants
|
|
|
642 c_no_utf don't highlight \u and \U in strings
|
|
|
643 c_syntax_for_h use C syntax for *.h files, instead of C++
|
|
|
644 c_no_if0 don't highlight "#if 0" blocks as comments
|
|
|
645 c_no_cformat don't highlight %-formats in strings
|
|
|
646 c_no_c99 don't highlight C99 standard items
|
|
|
647
|
|
36
|
648 When 'foldmethod' is set to "syntax" then /* */ comments and { } blocks will
|
|
|
649 become a fold. If you don't want comments to become a fold use: >
|
|
|
650 :let c_no_comment_fold = 1
|
|
|
651
|
|
7
|
652 If you notice highlighting errors while scrolling backwards, which are fixed
|
|
|
653 when redrawing with CTRL-L, try setting the "c_minlines" internal variable
|
|
|
654 to a larger number: >
|
|
|
655 :let c_minlines = 100
|
|
|
656 This will make the syntax synchronization start 100 lines before the first
|
|
|
657 displayed line. The default value is 50 (15 when c_no_if0 is set). The
|
|
|
658 disadvantage of using a larger number is that redrawing can become slow.
|
|
|
659
|
|
|
660 When using the "#if 0" / "#endif" comment highlighting, notice that this only
|
|
|
661 works when the "#if 0" is within "c_minlines" from the top of the window. If
|
|
|
662 you have a long "#if 0" construct it will not be highlighted correctly.
|
|
|
663
|
|
|
664 To match extra items in comments, use the cCommentGroup cluster.
|
|
|
665 Example: >
|
|
|
666 :au Syntax c call MyCadd()
|
|
|
667 :function MyCadd()
|
|
|
668 : syn keyword cMyItem contained Ni
|
|
|
669 : syn cluster cCommentGroup add=cMyItem
|
|
|
670 : hi link cMyItem Title
|
|
|
671 :endfun
|
|
|
672
|
|
|
673 ANSI constants will be highlighted with the "cConstant" group. This includes
|
|
|
674 "NULL", "SIG_IGN" and others. But not "TRUE", for example, because this is
|
|
|
675 not in the ANSI standard. If you find this confusing, remove the cConstant
|
|
|
676 highlighting: >
|
|
|
677 :hi link cConstant NONE
|
|
|
678
|
|
|
679 If you see '{' and '}' highlighted as an error where they are OK, reset the
|
|
|
680 highlighting for cErrInParen and cErrInBracket.
|
|
|
681
|
|
|
682 If you want to use folding in your C files, you can add these lines in a file
|
|
|
683 an the "after" directory in 'runtimepath'. For Unix this would be
|
|
|
684 ~/.vim/after/syntax/c.vim. >
|
|
|
685 syn region myFold start="{" end="}" transparent fold
|
|
|
686 syn sync fromstart
|
|
|
687 set foldmethod=syntax
|
|
|
688
|
|
501
|
689 CH *ch.vim* *ft-ch-syntax*
|
|
22
|
690
|
|
|
691 C/C++ interpreter. Ch has similar syntax highlighting to C and builds upon
|
|
|
692 the C syntax file. See |c.vim| for all the settings that are available for C.
|
|
|
693
|
|
|
694 By setting a variable you can tell Vim to use Ch syntax for *.h files, instead
|
|
|
695 of C or C++: >
|
|
|
696 :let ch_syntax_for_h = 1
|
|
|
697
|
|
7
|
698
|
|
501
|
699 CHILL *chill.vim* *ft-chill-syntax*
|
|
7
|
700
|
|
|
701 Chill syntax highlighting is similar to C. See |c.vim| for all the settings
|
|
|
702 that are available. Additionally there is:
|
|
|
703
|
|
|
704 chill_space_errors like c_space_errors
|
|
|
705 chill_comment_string like c_comment_strings
|
|
|
706 chill_minlines like c_minlines
|
|
|
707
|
|
|
708
|
|
501
|
709 CHANGELOG *changelog.vim* *ft-changelog-syntax*
|
|
7
|
710
|
|
|
711 ChangeLog supports highlighting spaces at the start of a line.
|
|
|
712 If you do not like this, add following line to your .vimrc: >
|
|
|
713 let g:changelog_spacing_errors = 0
|
|
|
714 This works the next time you edit a changelog file. You can also use
|
|
|
715 "b:changelog_spacing_errors" to set this per buffer (before loading the syntax
|
|
|
716 file).
|
|
|
717
|
|
|
718 You can change the highlighting used, e.g., to flag the spaces as an error: >
|
|
|
719 :hi link ChangelogError Error
|
|
|
720 Or to avoid the highlighting: >
|
|
|
721 :hi link ChangelogError NONE
|
|
|
722 This works immediately.
|
|
|
723
|
|
|
724
|
|
501
|
725 COBOL *cobol.vim* *ft-cobol-syntax*
|
|
7
|
726
|
|
|
727 COBOL highlighting has different needs for legacy code than it does for fresh
|
|
|
728 development. This is due to differences in what is being done (maintenance
|
|
|
729 versus development) and other factors. To enable legacy code highlighting,
|
|
|
730 add this line to your .vimrc: >
|
|
|
731 :let cobol_legacy_code = 1
|
|
|
732 To disable it again, use this: >
|
|
|
733 :unlet cobol_legacy_code
|
|
|
734
|
|
|
735
|
|
501
|
736 COLD FUSION *coldfusion.vim* *ft-coldfusion-syntax*
|
|
7
|
737
|
|
237
|
738 The ColdFusion has its own version of HTML comments. To turn on ColdFusion
|
|
7
|
739 comment highlighting, add the following line to your startup file: >
|
|
|
740
|
|
|
741 :let html_wrong_comments = 1
|
|
|
742
|
|
|
743 The ColdFusion syntax file is based on the HTML syntax file.
|
|
|
744
|
|
|
745
|
|
501
|
746 CSH *csh.vim* *ft-csh-syntax*
|
|
7
|
747
|
|
|
748 This covers the shell named "csh". Note that on some systems tcsh is actually
|
|
|
749 used.
|
|
|
750
|
|
|
751 Detecting whether a file is csh or tcsh is notoriously hard. Some systems
|
|
|
752 symlink /bin/csh to /bin/tcsh, making it almost impossible to distinguish
|
|
|
753 between csh and tcsh. In case VIM guesses wrong you can set the
|
|
|
754 "filetype_csh" variable. For using csh: >
|
|
|
755
|
|
|
756 :let filetype_csh = "csh"
|
|
|
757
|
|
|
758 For using tcsh: >
|
|
|
759
|
|
|
760 :let filetype_csh = "tcsh"
|
|
|
761
|
|
|
762 Any script with a tcsh extension or a standard tcsh filename (.tcshrc,
|
|
|
763 tcsh.tcshrc, tcsh.login) will have filetype tcsh. All other tcsh/csh scripts
|
|
237
|
764 will be classified as tcsh, UNLESS the "filetype_csh" variable exists. If the
|
|
7
|
765 "filetype_csh" variable exists, the filetype will be set to the value of the
|
|
|
766 variable.
|
|
|
767
|
|
|
768
|
|
501
|
769 CYNLIB *cynlib.vim* *ft-cynlib-syntax*
|
|
7
|
770
|
|
|
771 Cynlib files are C++ files that use the Cynlib class library to enable
|
|
237
|
772 hardware modelling and simulation using C++. Typically Cynlib files have a .cc
|
|
7
|
773 or a .cpp extension, which makes it very difficult to distinguish them from a
|
|
237
|
774 normal C++ file. Thus, to enable Cynlib highlighting for .cc files, add this
|
|
7
|
775 line to your .vimrc file: >
|
|
|
776
|
|
|
777 :let cynlib_cyntax_for_cc=1
|
|
|
778
|
|
|
779 Similarly for cpp files (this extension is only usually used in Windows) >
|
|
|
780
|
|
|
781 :let cynlib_cyntax_for_cpp=1
|
|
|
782
|
|
|
783 To disable these again, use this: >
|
|
|
784
|
|
|
785 :unlet cynlib_cyntax_for_cc
|
|
|
786 :unlet cynlib_cyntax_for_cpp
|
|
|
787 <
|
|
|
788
|
|
501
|
789 CWEB *cweb.vim* *ft-cweb-syntax*
|
|
7
|
790
|
|
|
791 Files matching "*.w" could be Progress or cweb. If the automatic detection
|
|
|
792 doesn't work for you, or you don't edit Progress at all, use this in your
|
|
|
793 startup vimrc: >
|
|
|
794 :let filetype_w = "cweb"
|
|
|
795
|
|
|
796
|
|
501
|
797 DESKTOP *desktop.vim* *ft-desktop-syntax*
|
|
7
|
798
|
|
|
799 Primary goal of this syntax file is to highlight .desktop and .directory files
|
|
|
800 according to freedesktop.org standard: http://pdx.freedesktop.org/Standards/
|
|
|
801 But actually almost none implements this standard fully. Thus it will
|
|
237
|
802 highlight all Unix ini files. But you can force strict highlighting according
|
|
7
|
803 to standard by placing this in your vimrc file: >
|
|
|
804 :let enforce_freedesktop_standard = 1
|
|
|
805
|
|
|
806
|
|
501
|
807 DIRCOLORS *dircolors.vim* *ft-dircolors-syntax*
|
|
7
|
808
|
|
|
809 The dircolors utility highlighting definition has one option. It exists to
|
|
|
810 provide compatibility with the Slackware GNU/Linux distributions version of
|
|
|
811 the command. It adds a few keywords that are generally ignored by most
|
|
|
812 versions. On Slackware systems, however, the utility accepts the keywords and
|
|
|
813 uses them for processing. To enable the Slackware keywords add the following
|
|
|
814 line to your startup file: >
|
|
|
815 let dircolors_is_slackware = 1
|
|
|
816
|
|
|
817
|
|
501
|
818 DOCBOOK *docbk.vim* *ft-docbk-syntax* *docbook*
|
|
|
819 DOCBOOK XML *docbkxml.vim* *ft-docbkxml-syntax*
|
|
|
820 DOCBOOK SGML *docbksgml.vim* *ft-docbksgml-syntax*
|
|
7
|
821
|
|
|
822 There are two types of DocBook files: SGML and XML. To specify what type you
|
|
|
823 are using the "b:docbk_type" variable should be set. Vim does this for you
|
|
|
824 automatically if it can recognize the type. When Vim can't guess it the type
|
|
|
825 defaults to XML.
|
|
|
826 You can set the type manually: >
|
|
|
827 :let docbk_type = "sgml"
|
|
|
828 or: >
|
|
|
829 :let docbk_type = "xml"
|
|
|
830 You need to do this before loading the syntax file, which is complicated.
|
|
|
831 Simpler is setting the filetype to "docbkxml" or "docbksgml": >
|
|
|
832 :set filetype=docbksgml
|
|
|
833 or: >
|
|
|
834 :set filetype=docbkxml
|
|
|
835
|
|
|
836
|
|
501
|
837 DOSBATCH *dosbatch.vim* *ft-dosbatch-syntax*
|
|
7
|
838
|
|
|
839 There is one option with highlighting DOS batch files. This covers new
|
|
|
840 extensions to the Command Interpreter introduced with Windows 2000 and
|
|
|
841 is controlled by the variable dosbatch_cmdextversion. For Windows NT
|
|
|
842 this should have the value 1, and for Windows 2000 it should be 2.
|
|
|
843 Select the version you want with the following line: >
|
|
|
844
|
|
15
|
845 :let dosbatch_cmdextversion = 1
|
|
7
|
846
|
|
|
847 If this variable is not defined it defaults to a value of 2 to support
|
|
|
848 Windows 2000.
|
|
|
849
|
|
15
|
850 A second option covers whether *.btm files should be detected as type
|
|
237
|
851 "dosbatch" (MS-DOS batch files) or type "btm" (4DOS batch files). The latter
|
|
|
852 is used by default. You may select the former with the following line: >
|
|
15
|
853
|
|
|
854 :let g:dosbatch_syntax_for_btm = 1
|
|
|
855
|
|
|
856 If this variable is undefined or zero, btm syntax is selected.
|
|
|
857
|
|
|
858
|
|
7
|
859
|
|
501
|
860 DTD *dtd.vim* *ft-dtd-syntax*
|
|
7
|
861
|
|
237
|
862 The DTD syntax highlighting is case sensitive by default. To disable
|
|
7
|
863 case-sensitive highlighting, add the following line to your startup file: >
|
|
|
864
|
|
|
865 :let dtd_ignore_case=1
|
|
|
866
|
|
237
|
867 The DTD syntax file will highlight unknown tags as errors. If
|
|
7
|
868 this is annoying, it can be turned off by setting: >
|
|
|
869
|
|
|
870 :let dtd_no_tag_errors=1
|
|
|
871
|
|
|
872 before sourcing the dtd.vim syntax file.
|
|
|
873 Parameter entity names are highlighted in the definition using the
|
|
|
874 'Type' highlighting group and 'Comment' for punctuation and '%'.
|
|
|
875 Parameter entity instances are highlighted using the 'Constant'
|
|
|
876 highlighting group and the 'Type' highlighting group for the
|
|
237
|
877 delimiters % and ;. This can be turned off by setting: >
|
|
7
|
878
|
|
|
879 :let dtd_no_param_entities=1
|
|
|
880
|
|
|
881 The DTD syntax file is also included by xml.vim to highlight included dtd's.
|
|
|
882
|
|
|
883
|
|
501
|
884 EIFFEL *eiffel.vim* *ft-eiffel-syntax*
|
|
7
|
885
|
|
|
886 While Eiffel is not case-sensitive, its style guidelines are, and the
|
|
237
|
887 syntax highlighting file encourages their use. This also allows to
|
|
|
888 highlight class names differently. If you want to disable case-sensitive
|
|
7
|
889 highlighting, add the following line to your startup file: >
|
|
|
890
|
|
|
891 :let eiffel_ignore_case=1
|
|
|
892
|
|
|
893 Case still matters for class names and TODO marks in comments.
|
|
|
894
|
|
|
895 Conversely, for even stricter checks, add one of the following lines: >
|
|
|
896
|
|
|
897 :let eiffel_strict=1
|
|
|
898 :let eiffel_pedantic=1
|
|
|
899
|
|
|
900 Setting eiffel_strict will only catch improper capitalization for the
|
|
|
901 five predefined words "Current", "Void", "Result", "Precursor", and
|
|
|
902 "NONE", to warn against their accidental use as feature or class names.
|
|
|
903
|
|
|
904 Setting eiffel_pedantic will enforce adherence to the Eiffel style
|
|
|
905 guidelines fairly rigorously (like arbitrary mixes of upper- and
|
|
|
906 lowercase letters as well as outdated ways to capitalize keywords).
|
|
|
907
|
|
|
908 If you want to use the lower-case version of "Current", "Void",
|
|
|
909 "Result", and "Precursor", you can use >
|
|
|
910
|
|
|
911 :let eiffel_lower_case_predef=1
|
|
|
912
|
|
|
913 instead of completely turning case-sensitive highlighting off.
|
|
|
914
|
|
|
915 Support for ISE's proposed new creation syntax that is already
|
|
|
916 experimentally handled by some compilers can be enabled by: >
|
|
|
917
|
|
|
918 :let eiffel_ise=1
|
|
|
919
|
|
237
|
920 Finally, some vendors support hexadecimal constants. To handle them, add >
|
|
7
|
921
|
|
|
922 :let eiffel_hex_constants=1
|
|
|
923
|
|
|
924 to your startup file.
|
|
|
925
|
|
|
926
|
|
501
|
927 ERLANG *erlang.vim* *ft-erlang-syntax*
|
|
7
|
928
|
|
|
929 The erlang highlighting supports Erlang (ERicsson LANGuage).
|
|
|
930 Erlang is case sensitive and default extension is ".erl".
|
|
|
931
|
|
|
932 If you want to disable keywords highlighting, put in your .vimrc: >
|
|
|
933 :let erlang_keywords = 1
|
|
|
934 If you want to disable built-in-functions highlighting, put in your
|
|
|
935 .vimrc file: >
|
|
|
936 :let erlang_functions = 1
|
|
|
937 If you want to disable special characters highlighting, put in
|
|
|
938 your .vimrc: >
|
|
|
939 :let erlang_characters = 1
|
|
|
940
|
|
|
941
|
|
501
|
942 FORM *form.vim* *ft-form-syntax*
|
|
7
|
943
|
|
|
944 The coloring scheme for syntax elements in the FORM file uses the default
|
|
|
945 modes Conditional, Number, Statement, Comment, PreProc, Type, and String,
|
|
|
946 following the language specifications in 'Symbolic Manipulation with FORM'' by
|
|
|
947 J.A.M. Vermaseren, CAN, Netherlands, 1991.
|
|
|
948
|
|
|
949 If you want include your own changes to the default colors, you have to
|
|
|
950 redefine the following syntax groups:
|
|
|
951
|
|
|
952 - formConditional
|
|
|
953 - formNumber
|
|
|
954 - formStatement
|
|
|
955 - formHeaderStatement
|
|
|
956 - formComment
|
|
|
957 - formPreProc
|
|
|
958 - formDirective
|
|
|
959 - formType
|
|
|
960 - formString
|
|
|
961
|
|
|
962 Note that the form.vim syntax file implements FORM preprocessor commands and
|
|
|
963 directives per default in the same syntax group.
|
|
|
964
|
|
|
965 A predefined enhanced color mode for FORM is available to distinguish between
|
|
237
|
966 header statements and statements in the body of a FORM program. To activate
|
|
7
|
967 this mode define the following variable in your vimrc file >
|
|
|
968
|
|
|
969 :let form_enhanced_color=1
|
|
|
970
|
|
|
971 The enhanced mode also takes advantage of additional color features for a dark
|
|
237
|
972 gvim display. Here, statements are colored LightYellow instead of Yellow, and
|
|
7
|
973 conditionals are LightBlue for better distinction.
|
|
|
974
|
|
|
975
|
|
501
|
976 FORTRAN *fortran.vim* *ft-fortran-syntax*
|
|
7
|
977
|
|
|
978 Default highlighting and dialect ~
|
|
237
|
979 Highlighting appropriate for f95 (Fortran 95) is used by default. This choice
|
|
7
|
980 should be appropriate for most users most of the time because Fortran 95 is a
|
|
|
981 superset of Fortran 90 and almost a superset of Fortran 77.
|
|
|
982
|
|
|
983 Fortran source code form ~
|
|
237
|
984 Fortran 9x code can be in either fixed or free source form. Note that the
|
|
7
|
985 syntax highlighting will not be correct if the form is incorrectly set.
|
|
|
986
|
|
|
987 When you create a new fortran file, the syntax script assumes fixed source
|
|
237
|
988 form. If you always use free source form, then >
|
|
7
|
989 :let fortran_free_source=1
|
|
237
|
990 in your .vimrc prior to the :syntax on command. If you always use fixed source
|
|
7
|
991 form, then >
|
|
|
992 :let fortran_fixed_source=1
|
|
|
993 in your .vimrc prior to the :syntax on command.
|
|
|
994
|
|
|
995 If the form of the source code depends upon the file extension, then it is
|
|
237
|
996 most convenient to set fortran_free_source in a ftplugin file. For more
|
|
|
997 information on ftplugin files, see |ftplugin|. For example, if all your
|
|
7
|
998 fortran files with an .f90 extension are written in free source form and the
|
|
|
999 rest in fixed source form, add the following code to your ftplugin file >
|
|
|
1000 let s:extfname = expand("%:e")
|
|
|
1001 if s:extfname ==? "f90"
|
|
|
1002 let fortran_free_source=1
|
|
|
1003 unlet! fortran_fixed_source
|
|
|
1004 else
|
|
|
1005 let fortran_fixed_source=1
|
|
|
1006 unlet! fortran_free_source
|
|
|
1007 endif
|
|
|
1008 Note that this will work only if the "filetype plugin indent on" command
|
|
|
1009 precedes the "syntax on" command in your .vimrc file.
|
|
|
1010
|
|
|
1011 When you edit an existing fortran file, the syntax script will assume free
|
|
|
1012 source form if the fortran_free_source variable has been set, and assumes
|
|
237
|
1013 fixed source form if the fortran_fixed_source variable has been set. If
|
|
7
|
1014 neither of these variables have been set, the syntax script attempts to
|
|
|
1015 determine which source form has been used by examining the first five columns
|
|
237
|
1016 of the first 25 lines of your file. If no signs of free source form are
|
|
|
1017 detected, then the file is assumed to be in fixed source form. The algorithm
|
|
|
1018 should work in the vast majority of cases. In some cases, such as a file that
|
|
7
|
1019 begins with 25 or more full-line comments, the script may incorrectly decide
|
|
237
|
1020 that the fortran code is in fixed form. If that happens, just add a
|
|
7
|
1021 non-comment statement beginning anywhere in the first five columns of the
|
|
|
1022 first twenty five lines, save (:w) and then reload (:e!) the file.
|
|
|
1023
|
|
|
1024 Tabs in fortran files ~
|
|
237
|
1025 Tabs are not recognized by the Fortran standards. Tabs are not a good idea in
|
|
7
|
1026 fixed format fortran source code which requires fixed column boundaries.
|
|
237
|
1027 Therefore, tabs are marked as errors. Nevertheless, some programmers like
|
|
|
1028 using tabs. If your fortran files contain tabs, then you should set the
|
|
7
|
1029 variable fortran_have_tabs in your .vimrc with a command such as >
|
|
|
1030 :let fortran_have_tabs=1
|
|
237
|
1031 placed prior to the :syntax on command. Unfortunately, the use of tabs will
|
|
7
|
1032 mean that the syntax file will not be able to detect incorrect margins.
|
|
|
1033
|
|
|
1034 Syntax folding of fortran files ~
|
|
|
1035 If you wish to use foldmethod=syntax, then you must first set the variable
|
|
|
1036 fortran_fold with a command such as >
|
|
|
1037 :let fortran_fold=1
|
|
|
1038 to instruct the syntax script to define fold regions for program units, that
|
|
|
1039 is main programs starting with a program statement, subroutines, function
|
|
237
|
1040 subprograms, block data subprograms, interface blocks, and modules. If you
|
|
7
|
1041 also set the variable fortran_fold_conditionals with a command such as >
|
|
|
1042 :let fortran_fold_conditionals=1
|
|
|
1043 then fold regions will also be defined for do loops, if blocks, and select
|
|
237
|
1044 case constructs. If you also set the variable
|
|
7
|
1045 fortran_fold_multilinecomments with a command such as >
|
|
|
1046 :let fortran_fold_multilinecomments=1
|
|
|
1047 then fold regions will also be defined for three or more consecutive comment
|
|
237
|
1048 lines. Note that defining fold regions can be slow for large files.
|
|
7
|
1049
|
|
|
1050 If fortran_fold, and possibly fortran_fold_conditionals and/or
|
|
|
1051 fortran_fold_multilinecomments, have been set, then vim will fold your file if
|
|
237
|
1052 you set foldmethod=syntax. Comments or blank lines placed between two program
|
|
7
|
1053 units are not folded because they are seen as not belonging to any program
|
|
|
1054 unit.
|
|
|
1055
|
|
|
1056 More precise fortran syntax ~
|
|
|
1057 If you set the variable fortran_more_precise with a command such as >
|
|
|
1058 :let fortran_more_precise=1
|
|
237
|
1059 then the syntax coloring will be more precise but slower. In particular,
|
|
7
|
1060 statement labels used in do, goto and arithmetic if statements will be
|
|
|
1061 recognized, as will construct names at the end of a do, if, select or forall
|
|
|
1062 construct.
|
|
|
1063
|
|
|
1064 Non-default fortran dialects ~
|
|
|
1065 The syntax script supports five Fortran dialects: f95, f90, f77, the Lahey
|
|
|
1066 subset elf90, and the Imagine1 subset F.
|
|
|
1067
|
|
|
1068 If you use f77 with extensions, even common ones like do/enddo loops, do/while
|
|
|
1069 loops and free source form that are supported by most f77 compilers including
|
|
|
1070 g77 (GNU Fortran), then you will probably find the default highlighting
|
|
237
|
1071 satisfactory. However, if you use strict f77 with no extensions, not even free
|
|
7
|
1072 source form or the MIL STD 1753 extensions, then the advantages of setting the
|
|
|
1073 dialect to f77 are that names such as SUM are recognized as user variable
|
|
|
1074 names and not highlighted as f9x intrinsic functions, that obsolete constructs
|
|
|
1075 such as ASSIGN statements are not highlighted as todo items, and that fixed
|
|
|
1076 source form will be assumed.
|
|
|
1077
|
|
|
1078 If you use elf90 or F, the advantage of setting the dialect appropriately is
|
|
|
1079 that f90 features excluded from these dialects will be highlighted as todo
|
|
|
1080 items and that free source form will be assumed as required for these
|
|
|
1081 dialects.
|
|
|
1082
|
|
237
|
1083 The dialect can be selected by setting the variable fortran_dialect. The
|
|
7
|
1084 permissible values of fortran_dialect are case-sensitive and must be "f95",
|
|
237
|
1085 "f90", "f77", "elf" or "F". Invalid values of fortran_dialect are ignored.
|
|
7
|
1086
|
|
|
1087 If all your fortran files use the same dialect, set fortran_dialect in your
|
|
237
|
1088 .vimrc prior to your syntax on statement. If the dialect depends upon the file
|
|
|
1089 extension, then it is most convenient to set it in a ftplugin file. For more
|
|
|
1090 information on ftplugin files, see |ftplugin|. For example, if all your
|
|
7
|
1091 fortran files with an .f90 extension are written in the elf subset, your
|
|
|
1092 ftplugin file should contain the code >
|
|
|
1093 let s:extfname = expand("%:e")
|
|
|
1094 if s:extfname ==? "f90"
|
|
|
1095 let fortran_dialect="elf"
|
|
|
1096 else
|
|
|
1097 unlet! fortran_dialect
|
|
|
1098 endif
|
|
|
1099 Note that this will work only if the "filetype plugin indent on" command
|
|
|
1100 precedes the "syntax on" command in your .vimrc file.
|
|
|
1101
|
|
|
1102 Finer control is necessary if the file extension does not uniquely identify
|
|
237
|
1103 the dialect. You can override the default dialect, on a file-by-file basis, by
|
|
7
|
1104 including a comment with the directive "fortran_dialect=xx" (where xx=f77 or
|
|
237
|
1105 elf or F or f90 or f95) in one of the first three lines in your file. For
|
|
7
|
1106 example, your older .f files may be written in extended f77 but your newer
|
|
|
1107 ones may be F codes, and you would identify the latter by including in the
|
|
|
1108 first three lines of those files a Fortran comment of the form >
|
|
|
1109 ! fortran_dialect=F
|
|
|
1110 F overrides elf if both directives are present.
|
|
|
1111
|
|
|
1112 Limitations ~
|
|
237
|
1113 Parenthesis checking does not catch too few closing parentheses. Hollerith
|
|
|
1114 strings are not recognized. Some keywords may be highlighted incorrectly
|
|
7
|
1115 because Fortran90 has no reserved words.
|
|
|
1116
|
|
501
|
1117 For further information related to fortran, see |ft-fortran-indent| and
|
|
|
1118 |ft-fortran-plugin|.
|
|
|
1119
|
|
|
1120
|
|
|
1121 FVWM CONFIGURATION FILES *fvwm.vim* *ft-fvwm-syntax*
|
|
7
|
1122
|
|
|
1123 In order for Vim to recognize Fvwm configuration files that do not match
|
|
|
1124 the patterns *fvwmrc* or *fvwm2rc* , you must put additional patterns
|
|
|
1125 appropriate to your system in your myfiletypes.vim file. For these
|
|
|
1126 patterns, you must set the variable "b:fvwm_version" to the major version
|
|
|
1127 number of Fvwm, and the 'filetype' option to fvwm.
|
|
|
1128
|
|
|
1129 For example, to make Vim identify all files in /etc/X11/fvwm2/
|
|
|
1130 as Fvwm2 configuration files, add the following: >
|
|
|
1131
|
|
|
1132 :au! BufNewFile,BufRead /etc/X11/fvwm2/* let b:fvwm_version = 2 |
|
|
|
1133 \ set filetype=fvwm
|
|
|
1134
|
|
|
1135 If you'd like Vim to highlight all valid color names, tell it where to
|
|
|
1136 find the color database (rgb.txt) on your system. Do this by setting
|
|
|
1137 "rgb_file" to its location. Assuming your color database is located
|
|
|
1138 in /usr/X11/lib/X11/, you should add the line >
|
|
|
1139
|
|
|
1140 :let rgb_file = "/usr/X11/lib/X11/rgb.txt"
|
|
|
1141
|
|
|
1142 to your .vimrc file.
|
|
|
1143
|
|
|
1144
|
|
501
|
1145 GSP *gsp.vim* *ft-gsp-syntax*
|
|
7
|
1146
|
|
|
1147 The default coloring style for GSP pages is defined by |html.vim|, and
|
|
|
1148 the coloring for java code (within java tags or inline between backticks)
|
|
|
1149 is defined by |java.vim|. The following HTML groups defined in |html.vim|
|
|
|
1150 are redefined to incorporate and highlight inline java code:
|
|
|
1151
|
|
|
1152 htmlString
|
|
|
1153 htmlValue
|
|
|
1154 htmlEndTag
|
|
|
1155 htmlTag
|
|
|
1156 htmlTagN
|
|
|
1157
|
|
|
1158 Highlighting should look fine most of the places where you'd see inline
|
|
|
1159 java code, but in some special cases it may not. To add another HTML
|
|
|
1160 group where you will have inline java code where it does not highlight
|
|
|
1161 correctly, just copy the line you want from |html.vim| and add gspJava
|
|
|
1162 to the contains clause.
|
|
|
1163
|
|
|
1164 The backticks for inline java are highlighted according to the htmlError
|
|
|
1165 group to make them easier to see.
|
|
|
1166
|
|
|
1167
|
|
501
|
1168 GROFF *groff.vim* *ft-groff-syntax*
|
|
7
|
1169
|
|
|
1170 The groff syntax file is a wrapper for |nroff.vim|, see the notes
|
|
237
|
1171 under that heading for examples of use and configuration. The purpose
|
|
7
|
1172 of this wrapper is to set up groff syntax extensions by setting the
|
|
|
1173 filetype from a |modeline| or in a personal filetype definitions file
|
|
|
1174 (see |filetype.txt|).
|
|
|
1175
|
|
|
1176
|
|
501
|
1177 HASKELL *haskell.vim* *lhaskell.vim* *ft-haskell-syntax*
|
|
7
|
1178
|
|
|
1179 The Haskell syntax files support plain Haskell code as well as literate
|
|
237
|
1180 Haskell code, the latter in both Bird style and TeX style. The Haskell
|
|
7
|
1181 syntax highlighting will also highlight C preprocessor directives.
|
|
|
1182
|
|
|
1183 If you want to highlight delimiter characters (useful if you have a
|
|
|
1184 light-coloured background), add to your .vimrc: >
|
|
|
1185 :let hs_highlight_delimiters = 1
|
|
|
1186 To treat True and False as keywords as opposed to ordinary identifiers,
|
|
|
1187 add: >
|
|
|
1188 :let hs_highlight_boolean = 1
|
|
|
1189 To also treat the names of primitive types as keywords: >
|
|
|
1190 :let hs_highlight_types = 1
|
|
|
1191 And to treat the names of even more relatively common types as keywords: >
|
|
|
1192 :let hs_highlight_more_types = 1
|
|
|
1193 If you want to highlight the names of debugging functions, put in
|
|
|
1194 your .vimrc: >
|
|
|
1195 :let hs_highlight_debug = 1
|
|
|
1196
|
|
|
1197 The Haskell syntax highlighting also highlights C preprocessor
|
|
|
1198 directives, and flags lines that start with # but are not valid
|
|
237
|
1199 directives as erroneous. This interferes with Haskell's syntax for
|
|
|
1200 operators, as they may start with #. If you want to highlight those
|
|
7
|
1201 as operators as opposed to errors, put in your .vimrc: >
|
|
|
1202 :let hs_allow_hash_operator = 1
|
|
|
1203
|
|
|
1204 The syntax highlighting for literate Haskell code will try to
|
|
|
1205 automatically guess whether your literate Haskell code contains
|
|
|
1206 TeX markup or not, and correspondingly highlight TeX constructs
|
|
237
|
1207 or nothing at all. You can override this globally by putting
|
|
7
|
1208 in your .vimrc >
|
|
|
1209 :let lhs_markup = none
|
|
|
1210 for no highlighting at all, or >
|
|
|
1211 :let lhs_markup = tex
|
|
|
1212 to force the highlighting to always try to highlight TeX markup.
|
|
|
1213 For more flexibility, you may also use buffer local versions of
|
|
|
1214 this variable, so e.g. >
|
|
|
1215 :let b:lhs_markup = tex
|
|
237
|
1216 will force TeX highlighting for a particular buffer. It has to be
|
|
7
|
1217 set before turning syntax highlighting on for the buffer or
|
|
|
1218 loading a file.
|
|
|
1219
|
|
|
1220
|
|
501
|
1221 HTML *html.vim* *ft-html-syntax*
|
|
7
|
1222
|
|
|
1223 The coloring scheme for tags in the HTML file works as follows.
|
|
|
1224
|
|
|
1225 The <> of opening tags are colored differently than the </> of a closing tag.
|
|
|
1226 This is on purpose! For opening tags the 'Function' color is used, while for
|
|
|
1227 closing tags the 'Type' color is used (See syntax.vim to check how those are
|
|
|
1228 defined for you)
|
|
|
1229
|
|
|
1230 Known tag names are colored the same way as statements in C. Unknown tag
|
|
|
1231 names are colored with the same color as the <> or </> respectively which
|
|
|
1232 makes it easy to spot errors
|
|
|
1233
|
|
237
|
1234 Note that the same is true for argument (or attribute) names. Known attribute
|
|
7
|
1235 names are colored differently than unknown ones.
|
|
|
1236
|
|
237
|
1237 Some HTML tags are used to change the rendering of text. The following tags
|
|
7
|
1238 are recognized by the html.vim syntax coloring file and change the way normal
|
|
|
1239 text is shown: <B> <I> <U> <EM> <STRONG> (<EM> is used as an alias for <I>,
|
|
|
1240 while <STRONG> as an alias for <B>), <H1> - <H6>, <HEAD>, <TITLE> and <A>, but
|
|
237
|
1241 only if used as a link (that is, it must include a href as in
|
|
7
|
1242 <A href="somfile.html">).
|
|
|
1243
|
|
|
1244 If you want to change how such text is rendered, you must redefine the
|
|
|
1245 following syntax groups:
|
|
|
1246
|
|
|
1247 - htmlBold
|
|
|
1248 - htmlBoldUnderline
|
|
|
1249 - htmlBoldUnderlineItalic
|
|
|
1250 - htmlUnderline
|
|
|
1251 - htmlUnderlineItalic
|
|
|
1252 - htmlItalic
|
|
|
1253 - htmlTitle for titles
|
|
|
1254 - htmlH1 - htmlH6 for headings
|
|
|
1255
|
|
|
1256 To make this redefinition work you must redefine them all with the exception
|
|
|
1257 of the last two (htmlTitle and htmlH[1-6], which are optional) and define the
|
|
|
1258 following variable in your vimrc (this is due to the order in which the files
|
|
|
1259 are read during initialization) >
|
|
|
1260 :let html_my_rendering=1
|
|
|
1261
|
|
|
1262 If you'd like to see an example download mysyntax.vim at
|
|
|
1263 http://www.fleiner.com/vim/download.html
|
|
|
1264
|
|
|
1265 You can also disable this rendering by adding the following line to your
|
|
|
1266 vimrc file: >
|
|
|
1267 :let html_no_rendering=1
|
|
|
1268
|
|
|
1269 HTML comments are rather special (see an HTML reference document for the
|
|
|
1270 details), and the syntax coloring scheme will highlight all errors.
|
|
|
1271 However, if you prefer to use the wrong style (starts with <!-- and
|
|
|
1272 ends with --!>) you can define >
|
|
|
1273 :let html_wrong_comments=1
|
|
|
1274
|
|
|
1275 JavaScript and Visual Basic embedded inside HTML documents are highlighted as
|
|
|
1276 'Special' with statements, comments, strings and so on colored as in standard
|
|
237
|
1277 programming languages. Note that only JavaScript and Visual Basic are currently
|
|
7
|
1278 supported, no other scripting language has been added yet.
|
|
|
1279
|
|
|
1280 Embedded and inlined cascading style sheets (CSS) are highlighted too.
|
|
|
1281
|
|
237
|
1282 There are several html preprocessor languages out there. html.vim has been
|
|
|
1283 written such that it should be trivial to include it. To do so add the
|
|
7
|
1284 following two lines to the syntax coloring file for that language
|
|
|
1285 (the example comes from the asp.vim file):
|
|
|
1286
|
|
|
1287 runtime! syntax/html.vim
|
|
|
1288 syn cluster htmlPreproc add=asp
|
|
|
1289
|
|
|
1290 Now you just need to make sure that you add all regions that contain
|
|
|
1291 the preprocessor language to the cluster htmlPreproc.
|
|
|
1292
|
|
|
1293
|
|
501
|
1294 HTML/OS (by Aestiva) *htmlos.vim* *ft-htmlos-syntax*
|
|
7
|
1295
|
|
|
1296 The coloring scheme for HTML/OS works as follows:
|
|
|
1297
|
|
|
1298 Functions and variable names are the same color by default, because VIM
|
|
|
1299 doesn't specify different colors for Functions and Identifiers. To change
|
|
|
1300 this (which is recommended if you want function names to be recognizable in a
|
|
|
1301 different color) you need to add the following line to either your ~/.vimrc: >
|
|
|
1302 :hi Function term=underline cterm=bold ctermfg=LightGray
|
|
|
1303
|
|
|
1304 Of course, the ctermfg can be a different color if you choose.
|
|
|
1305
|
|
|
1306 Another issues that HTML/OS runs into is that there is no special filetype to
|
|
|
1307 signify that it is a file with HTML/OS coding. You can change this by opening
|
|
|
1308 a file and turning on HTML/OS syntax by doing the following: >
|
|
|
1309 :set syntax=htmlos
|
|
|
1310
|
|
|
1311 Lastly, it should be noted that the opening and closing characters to begin a
|
|
|
1312 block of HTML/OS code can either be << or [[ and >> or ]], respectively.
|
|
|
1313
|
|
|
1314
|
|
501
|
1315 IA64 *ia64.vim* *intel-itanium* *ft-ia64-syntax*
|
|
7
|
1316
|
|
|
1317 Highlighting for the Intel Itanium 64 assembly language. See |asm.vim| for
|
|
|
1318 how to recognize this filetype.
|
|
|
1319
|
|
|
1320 To have *.inc files be recognized as IA64, add this to your .vimrc file: >
|
|
|
1321 :let g:filetype_inc = "ia64"
|
|
|
1322
|
|
|
1323
|
|
501
|
1324 INFORM *inform.vim* *ft-inform-syntax*
|
|
7
|
1325
|
|
|
1326 Inform highlighting includes symbols provided by the Inform Library, as
|
|
|
1327 most programs make extensive use of it. If do not wish Library symbols
|
|
|
1328 to be highlighted add this to your vim startup: >
|
|
|
1329 :let inform_highlight_simple=1
|
|
|
1330
|
|
|
1331 By default it is assumed that Inform programs are Z-machine targeted,
|
|
|
1332 and highlights Z-machine assembly language symbols appropriately. If
|
|
|
1333 you intend your program to be targeted to a Glulx/Glk environment you
|
|
|
1334 need to add this to your startup sequence: >
|
|
|
1335 :let inform_highlight_glulx=1
|
|
|
1336
|
|
|
1337 This will highlight Glulx opcodes instead, and also adds glk() to the
|
|
|
1338 set of highlighted system functions.
|
|
|
1339
|
|
|
1340 The Inform compiler will flag certain obsolete keywords as errors when
|
|
|
1341 it encounters them. These keywords are normally highlighted as errors
|
|
|
1342 by Vim. To prevent such error highlighting, you must add this to your
|
|
|
1343 startup sequence: >
|
|
|
1344 :let inform_suppress_obsolete=1
|
|
|
1345
|
|
|
1346 By default, the language features highlighted conform to Compiler
|
|
|
1347 version 6.30 and Library version 6.11. If you are using an older
|
|
|
1348 Inform development environment, you may with to add this to your
|
|
|
1349 startup sequence: >
|
|
|
1350 :let inform_highlight_old=1
|
|
|
1351
|
|
|
1352
|
|
501
|
1353 JAVA *java.vim* *ft-java-syntax*
|
|
7
|
1354
|
|
|
1355 The java.vim syntax highlighting file offers several options:
|
|
|
1356
|
|
|
1357 In Java 1.0.2 it was never possible to have braces inside parens, so this was
|
|
|
1358 flagged as an error. Since Java 1.1 this is possible (with anonymous
|
|
237
|
1359 classes), and therefore is no longer marked as an error. If you prefer the old
|
|
7
|
1360 way, put the following line into your vim startup file: >
|
|
|
1361 :let java_mark_braces_in_parens_as_errors=1
|
|
|
1362
|
|
|
1363 All identifiers in java.lang.* are always visible in all classes. To
|
|
|
1364 highlight them use: >
|
|
|
1365 :let java_highlight_java_lang_ids=1
|
|
|
1366
|
|
237
|
1367 You can also highlight identifiers of most standard Java packages if you
|
|
7
|
1368 download the javaid.vim script at http://www.fleiner.com/vim/download.html.
|
|
|
1369 If you prefer to only highlight identifiers of a certain package, say java.io
|
|
|
1370 use the following: >
|
|
|
1371 :let java_highlight_java_io=1
|
|
|
1372 Check the javaid.vim file for a list of all the packages that are supported.
|
|
|
1373
|
|
|
1374 Function names are not highlighted, as the way to find functions depends on
|
|
237
|
1375 how you write Java code. The syntax file knows two possible ways to highlight
|
|
7
|
1376 functions:
|
|
|
1377
|
|
|
1378 If you write function declarations that are always indented by either
|
|
|
1379 a tab, 8 spaces or 2 spaces you may want to set >
|
|
|
1380 :let java_highlight_functions="indent"
|
|
|
1381 However, if you follow the Java guidelines about how functions and classes are
|
|
|
1382 supposed to be named (with respect to upper and lowercase), use >
|
|
|
1383 :let java_highlight_functions="style"
|
|
|
1384 If both options do not work for you, but you would still want function
|
|
|
1385 declarations to be highlighted create your own definitions by changing the
|
|
|
1386 definitions in java.vim or by creating your own java.vim which includes the
|
|
|
1387 original one and then adds the code to highlight functions.
|
|
|
1388
|
|
237
|
1389 In Java 1.1 the functions System.out.println() and System.err.println() should
|
|
8
|
1390 only be used for debugging. Therefore it is possible to highlight debugging
|
|
237
|
1391 statements differently. To do this you must add the following definition in
|
|
7
|
1392 your startup file: >
|
|
|
1393 :let java_highlight_debug=1
|
|
|
1394 The result will be that those statements are highlighted as 'Special'
|
|
237
|
1395 characters. If you prefer to have them highlighted differently you must define
|
|
7
|
1396 new highlightings for the following groups.:
|
|
|
1397 Debug, DebugSpecial, DebugString, DebugBoolean, DebugType
|
|
|
1398 which are used for the statement itself, special characters used in debug
|
|
237
|
1399 strings, strings, boolean constants and types (this, super) respectively. I
|
|
7
|
1400 have opted to chose another background for those statements.
|
|
|
1401
|
|
|
1402 In order to help you to write code that can be easily ported between
|
|
237
|
1403 Java and C++, all C++ keywords are marked as error in a Java program.
|
|
7
|
1404 However, if you use them regularly, you may want to define the following
|
|
|
1405 variable in your .vimrc file: >
|
|
|
1406 :let java_allow_cpp_keywords=1
|
|
|
1407
|
|
237
|
1408 Javadoc is a program that takes special comments out of Java program files and
|
|
|
1409 creates HTML pages. The standard configuration will highlight this HTML code
|
|
|
1410 similarly to HTML files (see |html.vim|). You can even add Javascript
|
|
|
1411 and CSS inside this code (see below). There are four differences however:
|
|
7
|
1412 1. The title (all characters up to the first '.' which is followed by
|
|
|
1413 some white space or up to the first '@') is colored differently (to change
|
|
|
1414 the color change the group CommentTitle).
|
|
|
1415 2. The text is colored as 'Comment'.
|
|
|
1416 3. HTML comments are colored as 'Special'
|
|
237
|
1417 4. The special Javadoc tags (@see, @param, ...) are highlighted as specials
|
|
7
|
1418 and the argument (for @see, @param, @exception) as Function.
|
|
|
1419 To turn this feature off add the following line to your startup file: >
|
|
|
1420 :let java_ignore_javadoc=1
|
|
|
1421
|
|
237
|
1422 If you use the special Javadoc comment highlighting described above you
|
|
|
1423 can also turn on special highlighting for Javascript, visual basic
|
|
|
1424 scripts and embedded CSS (stylesheets). This makes only sense if you
|
|
|
1425 actually have Javadoc comments that include either Javascript or embedded
|
|
|
1426 CSS. The options to use are >
|
|
7
|
1427 :let java_javascript=1
|
|
|
1428 :let java_css=1
|
|
|
1429 :let java_vb=1
|
|
|
1430
|
|
|
1431 In order to highlight nested parens with different colors define colors
|
|
|
1432 for javaParen, javaParen1 and javaParen2, for example with >
|
|
|
1433 :hi link javaParen Comment
|
|
|
1434 or >
|
|
|
1435 :hi javaParen ctermfg=blue guifg=#0000ff
|
|
|
1436
|
|
|
1437 If you notice highlighting errors while scrolling backwards, which are fixed
|
|
|
1438 when redrawing with CTRL-L, try setting the "java_minlines" internal variable
|
|
|
1439 to a larger number: >
|
|
|
1440 :let java_minlines = 50
|
|
|
1441 This will make the syntax synchronization start 50 lines before the first
|
|
|
1442 displayed line. The default value is 10. The disadvantage of using a larger
|
|
|
1443 number is that redrawing can become slow.
|
|
|
1444
|
|
|
1445
|
|
501
|
1446 LACE *lace.vim* *ft-lace-syntax*
|
|
7
|
1447
|
|
|
1448 Lace (Language for Assembly of Classes in Eiffel) is case insensitive, but the
|
|
|
1449 style guide lines are not. If you prefer case insensitive highlighting, just
|
|
|
1450 define the vim variable 'lace_case_insensitive' in your startup file: >
|
|
|
1451 :let lace_case_insensitive=1
|
|
|
1452
|
|
|
1453
|
|
501
|
1454 LEX *lex.vim* *ft-lex-syntax*
|
|
7
|
1455
|
|
|
1456 Lex uses brute-force synchronizing as the "^%%$" section delimiter
|
|
|
1457 gives no clue as to what section follows. Consequently, the value for >
|
|
|
1458 :syn sync minlines=300
|
|
|
1459 may be changed by the user if s/he is experiencing synchronization
|
|
|
1460 difficulties (such as may happen with large lex files).
|
|
|
1461
|
|
|
1462
|
|
555
|
1463 LISP *lisp.vim* *ft-lisp-syntax*
|
|
|
1464
|
|
|
1465 The lisp syntax highlighting provides two options: >
|
|
|
1466
|
|
|
1467 g:lisp_instring : if it exists, then "(...)" strings are highlighted
|
|
|
1468 as if the contents of the string were lisp.
|
|
|
1469 Useful for AutoLisp.
|
|
|
1470 g:lisp_rainbow : if it exists and is nonzero, then differing levels
|
|
|
1471 of parenthesization will receive different
|
|
|
1472 highlighting.
|
|
|
1473 <
|
|
|
1474 The g:lisp_rainbow option provides 10 levels of individual colorization for
|
|
|
1475 the parentheses and backquoted parentheses. Because of the quantity of
|
|
|
1476 colorization levels, unlike non-rainbow highlighting, the rainbow mode
|
|
|
1477 specifies its highlighting using ctermfg and guifg, thereby bypassing the
|
|
|
1478 usual colorscheme control using standard highlighting groups. The actual
|
|
|
1479 highlighting used depends on the dark/bright setting (see |'bg'|).
|
|
|
1480
|
|
|
1481
|
|
501
|
1482 LITE *lite.vim* *ft-lite-syntax*
|
|
7
|
1483
|
|
|
1484 There are two options for the lite syntax highlighting.
|
|
|
1485
|
|
|
1486 If you like SQL syntax highlighting inside Strings, use this: >
|
|
|
1487
|
|
|
1488 :let lite_sql_query = 1
|
|
|
1489
|
|
|
1490 For syncing, minlines defaults to 100. If you prefer another value, you can
|
|
|
1491 set "lite_minlines" to the value you desire. Example: >
|
|
|
1492
|
|
|
1493 :let lite_minlines = 200
|
|
|
1494
|
|
|
1495
|
|
501
|
1496 LPC *lpc.vim* *ft-lpc-syntax*
|
|
7
|
1497
|
|
237
|
1498 LPC stands for a simple, memory-efficient language: Lars Pensj| C. The
|
|
7
|
1499 file name of LPC is usually *.c. Recognizing these files as LPC would bother
|
|
|
1500 users writing only C programs. If you want to use LPC syntax in Vim, you
|
|
|
1501 should set a variable in your .vimrc file: >
|
|
|
1502
|
|
|
1503 :let lpc_syntax_for_c = 1
|
|
|
1504
|
|
|
1505 If it doesn't work properly for some particular C or LPC files, use a
|
|
|
1506 modeline. For a LPC file:
|
|
|
1507
|
|
|
1508 // vim:set ft=lpc:
|
|
|
1509
|
|
|
1510 For a C file that is recognized as LPC:
|
|
|
1511
|
|
|
1512 // vim:set ft=c:
|
|
|
1513
|
|
|
1514 If you don't want to set the variable, use the modeline in EVERY LPC file.
|
|
|
1515
|
|
|
1516 There are several implementations for LPC, we intend to support most widely
|
|
237
|
1517 used ones. Here the default LPC syntax is for MudOS series, for MudOS v22
|
|
7
|
1518 and before, you should turn off the sensible modifiers, and this will also
|
|
|
1519 asserts the new efuns after v22 to be invalid, don't set this variable when
|
|
|
1520 you are using the latest version of MudOS: >
|
|
|
1521
|
|
|
1522 :let lpc_pre_v22 = 1
|
|
|
1523
|
|
|
1524 For LpMud 3.2 series of LPC: >
|
|
|
1525
|
|
|
1526 :let lpc_compat_32 = 1
|
|
|
1527
|
|
|
1528 For LPC4 series of LPC: >
|
|
|
1529
|
|
|
1530 :let lpc_use_lpc4_syntax = 1
|
|
|
1531
|
|
|
1532 For uLPC series of LPC:
|
|
|
1533 uLPC has been developed to Pike, so you should use Pike syntax
|
|
|
1534 instead, and the name of your source file should be *.pike
|
|
|
1535
|
|
|
1536
|
|
501
|
1537 LUA *lua.vim* *ft-lua-syntax*
|
|
7
|
1538
|
|
237
|
1539 This syntax file may be used for Lua 4.0 and Lua 5.0 (default). If you are
|
|
7
|
1540 programming in Lua 4.0, use this: >
|
|
|
1541
|
|
|
1542 :let lua_version = 4
|
|
|
1543
|
|
|
1544 If lua_version variable doesn't exist, it is set to 5.
|
|
|
1545
|
|
|
1546
|
|
501
|
1547 MAIL *mail.vim* *ft-mail.vim*
|
|
7
|
1548
|
|
|
1549 Vim highlights all the standard elements of an email (headers, signatures,
|
|
237
|
1550 quoted text and URLs / email addresses). In keeping with standard conventions,
|
|
7
|
1551 signatures begin in a line containing only "--" followed optionally by
|
|
|
1552 whitespaces and end with a newline.
|
|
|
1553
|
|
|
1554 Vim treats lines beginning with ']', '}', '|', '>' or a word followed by '>'
|
|
237
|
1555 as quoted text. However Vim highlights headers and signatures in quoted text
|
|
7
|
1556 only if the text is quoted with '>' (optionally followed by one space).
|
|
|
1557
|
|
|
1558 By default mail.vim synchronises syntax to 100 lines before the first
|
|
237
|
1559 displayed line. If you have a slow machine, and generally deal with emails
|
|
7
|
1560 with short headers, you can change this to a smaller value: >
|
|
|
1561
|
|
|
1562 :let mail_minlines = 30
|
|
|
1563
|
|
|
1564
|
|
501
|
1565 MAKE *make.vim* *ft-make-syntax*
|
|
7
|
1566
|
|
|
1567 In makefiles, commands are usually highlighted to make it easy for you to spot
|
|
|
1568 errors. However, this may be too much coloring for you. You can turn this
|
|
|
1569 feature off by using: >
|
|
|
1570
|
|
|
1571 :let make_no_commands = 1
|
|
|
1572
|
|
|
1573
|
|
501
|
1574 MAPLE *maple.vim* *ft-maple-syntax*
|
|
7
|
1575
|
|
|
1576 Maple V, by Waterloo Maple Inc, supports symbolic algebra. The language
|
|
|
1577 supports many packages of functions which are selectively loaded by the user.
|
|
|
1578 The standard set of packages' functions as supplied in Maple V release 4 may be
|
|
|
1579 highlighted at the user's discretion. Users may place in their .vimrc file: >
|
|
|
1580
|
|
|
1581 :let mvpkg_all= 1
|
|
|
1582
|
|
|
1583 to get all package functions highlighted, or users may select any subset by
|
|
|
1584 choosing a variable/package from the table below and setting that variable to
|
|
|
1585 1, also in their .vimrc file (prior to sourcing
|
|
|
1586 $VIMRUNTIME/syntax/syntax.vim).
|
|
|
1587
|
|
|
1588 Table of Maple V Package Function Selectors >
|
|
|
1589 mv_DEtools mv_genfunc mv_networks mv_process
|
|
|
1590 mv_Galois mv_geometry mv_numapprox mv_simplex
|
|
|
1591 mv_GaussInt mv_grobner mv_numtheory mv_stats
|
|
|
1592 mv_LREtools mv_group mv_orthopoly mv_student
|
|
|
1593 mv_combinat mv_inttrans mv_padic mv_sumtools
|
|
|
1594 mv_combstruct mv_liesymm mv_plots mv_tensor
|
|
|
1595 mv_difforms mv_linalg mv_plottools mv_totorder
|
|
|
1596 mv_finance mv_logic mv_powseries
|
|
|
1597
|
|
|
1598
|
|
501
|
1599 MATHEMATICA *mma.vim* *ft-mma-syntax* *ft-mathematica-syntax*
|
|
271
|
1600
|
|
|
1601 Empty *.m files will automatically be presumed to be Matlab files unless you
|
|
|
1602 have the following in your .vimrc: >
|
|
|
1603
|
|
|
1604 let filetype_m = "mma"
|
|
|
1605
|
|
|
1606
|
|
501
|
1607 MOO *moo.vim* *ft-moo-syntax*
|
|
7
|
1608
|
|
|
1609 If you use C-style comments inside expressions and find it mangles your
|
|
|
1610 highlighting, you may want to use extended (slow!) matches for C-style
|
|
|
1611 comments: >
|
|
|
1612
|
|
|
1613 :let moo_extended_cstyle_comments = 1
|
|
|
1614
|
|
|
1615 To disable highlighting of pronoun substitution patterns inside strings: >
|
|
|
1616
|
|
|
1617 :let moo_no_pronoun_sub = 1
|
|
|
1618
|
|
|
1619 To disable highlighting of the regular expression operator '%|', and matching
|
|
|
1620 '%(' and '%)' inside strings: >
|
|
|
1621
|
|
|
1622 :let moo_no_regexp = 1
|
|
|
1623
|
|
|
1624 Unmatched double quotes can be recognized and highlighted as errors: >
|
|
|
1625
|
|
|
1626 :let moo_unmatched_quotes = 1
|
|
|
1627
|
|
|
1628 To highlight builtin properties (.name, .location, .programmer etc.): >
|
|
|
1629
|
|
|
1630 :let moo_builtin_properties = 1
|
|
|
1631
|
|
237
|
1632 Unknown builtin functions can be recognized and highlighted as errors. If you
|
|
7
|
1633 use this option, add your own extensions to the mooKnownBuiltinFunction group.
|
|
|
1634 To enable this option: >
|
|
|
1635
|
|
|
1636 :let moo_unknown_builtin_functions = 1
|
|
|
1637
|
|
|
1638 An example of adding sprintf() to the list of known builtin functions: >
|
|
|
1639
|
|
|
1640 :syn keyword mooKnownBuiltinFunction sprintf contained
|
|
|
1641
|
|
|
1642
|
|
501
|
1643 MSQL *msql.vim* *ft-msql-syntax*
|
|
7
|
1644
|
|
|
1645 There are two options for the msql syntax highlighting.
|
|
|
1646
|
|
|
1647 If you like SQL syntax highlighting inside Strings, use this: >
|
|
|
1648
|
|
|
1649 :let msql_sql_query = 1
|
|
|
1650
|
|
|
1651 For syncing, minlines defaults to 100. If you prefer another value, you can
|
|
|
1652 set "msql_minlines" to the value you desire. Example: >
|
|
|
1653
|
|
|
1654 :let msql_minlines = 200
|
|
|
1655
|
|
|
1656
|
|
501
|
1657 NCF *ncf.vim* *ft-ncf-syntax*
|
|
7
|
1658
|
|
|
1659 There is one option for NCF syntax highlighting.
|
|
|
1660
|
|
|
1661 If you want to have unrecognized (by ncf.vim) statements highlighted as
|
|
|
1662 errors, use this: >
|
|
|
1663
|
|
|
1664 :let ncf_highlight_unknowns = 1
|
|
|
1665
|
|
|
1666 If you don't want to highlight these errors, leave it unset.
|
|
|
1667
|
|
|
1668
|
|
501
|
1669 NROFF *nroff.vim* *ft-nroff-syntax*
|
|
7
|
1670
|
|
|
1671 The nroff syntax file works with AT&T n/troff out of the box. You need to
|
|
|
1672 activate the GNU groff extra features included in the syntax file before you
|
|
|
1673 can use them.
|
|
|
1674
|
|
|
1675 For example, Linux and BSD distributions use groff as their default text
|
|
237
|
1676 processing package. In order to activate the extra syntax highlighting
|
|
7
|
1677 features for groff, add the following option to your start-up files: >
|
|
|
1678
|
|
|
1679 :let b:nroff_is_groff = 1
|
|
|
1680
|
|
|
1681 Groff is different from the old AT&T n/troff that you may still find in
|
|
|
1682 Solaris. Groff macro and request names can be longer than 2 characters and
|
|
|
1683 there are extensions to the language primitives. For example, in AT&T troff
|
|
237
|
1684 you access the year as a 2-digit number with the request \(yr. In groff you
|
|
7
|
1685 can use the same request, recognized for compatibility, or you can use groff's
|
|
|
1686 native syntax, \[yr]. Furthermore, you can use a 4-digit year directly:
|
|
|
1687 \[year]. Macro requests can be longer than 2 characters, for example, GNU mm
|
|
|
1688 accepts the requests ".VERBON" and ".VERBOFF" for creating verbatim
|
|
|
1689 environments.
|
|
|
1690
|
|
|
1691 In order to obtain the best formatted output g/troff can give you, you should
|
|
|
1692 follow a few simple rules about spacing and punctuation.
|
|
|
1693
|
|
|
1694 1. Do not leave empty spaces at the end of lines.
|
|
|
1695
|
|
|
1696 2. Leave one space and one space only after an end-of-sentence period,
|
|
|
1697 exclamation mark, etc.
|
|
|
1698
|
|
|
1699 3. For reasons stated below, it is best to follow all period marks with a
|
|
|
1700 carriage return.
|
|
|
1701
|
|
|
1702 The reason behind these unusual tips is that g/n/troff have a line breaking
|
|
|
1703 algorithm that can be easily upset if you don't follow the rules given above.
|
|
|
1704
|
|
|
1705 Unlike TeX, troff fills text line-by-line, not paragraph-by-paragraph and,
|
|
|
1706 furthermore, it does not have a concept of glue or stretch, all horizontal and
|
|
|
1707 vertical space input will be output as is.
|
|
|
1708
|
|
|
1709 Therefore, you should be careful about not using more space between sentences
|
|
|
1710 than you intend to have in your final document. For this reason, the common
|
|
|
1711 practice is to insert a carriage return immediately after all punctuation
|
|
237
|
1712 marks. If you want to have "even" text in your final processed output, you
|
|
7
|
1713 need to maintaining regular spacing in the input text. To mark both trailing
|
|
|
1714 spaces and two or more spaces after a punctuation as an error, use: >
|
|
|
1715
|
|
|
1716 :let nroff_space_errors = 1
|
|
|
1717
|
|
|
1718 Another technique to detect extra spacing and other errors that will interfere
|
|
|
1719 with the correct typesetting of your file, is to define an eye-catching
|
|
|
1720 highlighting definition for the syntax groups "nroffDefinition" and
|
|
237
|
1721 "nroffDefSpecial" in your configuration files. For example: >
|
|
7
|
1722
|
|
|
1723 hi def nroffDefinition term=italic cterm=italic gui=reverse
|
|
|
1724 hi def nroffDefSpecial term=italic,bold cterm=italic,bold
|
|
|
1725 \ gui=reverse,bold
|
|
|
1726
|
|
|
1727 If you want to navigate preprocessor entries in your source file as easily as
|
|
|
1728 with section markers, you can activate the following option in your .vimrc
|
|
|
1729 file: >
|
|
|
1730
|
|
|
1731 let b:preprocs_as_sections = 1
|
|
|
1732
|
|
9
|
1733 As well, the syntax file adds an extra paragraph marker for the extended
|
|
7
|
1734 paragraph macro (.XP) in the ms package.
|
|
|
1735
|
|
|
1736 Finally, there is a |groff.vim| syntax file that can be used for enabling
|
|
|
1737 groff syntax highlighting either on a file basis or globally by default.
|
|
|
1738
|
|
|
1739
|
|
501
|
1740 OCAML *ocaml.vim* *ft-ocaml-syntax*
|
|
7
|
1741
|
|
|
1742 The OCaml syntax file handles files having the following prefixes: .ml,
|
|
|
1743 .mli, .mll and .mly. By setting the following variable >
|
|
|
1744
|
|
|
1745 :let ocaml_revised = 1
|
|
|
1746
|
|
|
1747 you can switch from standard OCaml-syntax to revised syntax as supported
|
|
|
1748 by the camlp4 preprocessor. Setting the variable >
|
|
|
1749
|
|
|
1750 :let ocaml_noend_error = 1
|
|
|
1751
|
|
|
1752 prevents highlighting of "end" as error, which is useful when sources
|
|
|
1753 contain very long structures that Vim does not synchronize anymore.
|
|
|
1754
|
|
|
1755
|
|
501
|
1756 PAPP *papp.vim* *ft-papp-syntax*
|
|
7
|
1757
|
|
|
1758 The PApp syntax file handles .papp files and, to a lesser extend, .pxml
|
|
|
1759 and .pxsl files which are all a mixture of perl/xml/html/other using xml
|
|
237
|
1760 as the top-level file format. By default everything inside phtml or pxml
|
|
|
1761 sections is treated as a string with embedded preprocessor commands. If
|
|
7
|
1762 you set the variable: >
|
|
|
1763
|
|
|
1764 :let papp_include_html=1
|
|
|
1765
|
|
|
1766 in your startup file it will try to syntax-hilight html code inside phtml
|
|
|
1767 sections, but this is relatively slow and much too colourful to be able to
|
|
237
|
1768 edit sensibly. ;)
|
|
7
|
1769
|
|
|
1770 The newest version of the papp.vim syntax file can usually be found at
|
|
|
1771 http://papp.plan9.de.
|
|
|
1772
|
|
|
1773
|
|
501
|
1774 PASCAL *pascal.vim* *ft-pascal-syntax*
|
|
7
|
1775
|
|
|
1776 Files matching "*.p" could be Progress or Pascal. If the automatic detection
|
|
|
1777 doesn't work for you, or you don't edit Progress at all, use this in your
|
|
|
1778 startup vimrc: >
|
|
|
1779
|
|
|
1780 :let filetype_p = "pascal"
|
|
|
1781
|
|
|
1782 The Pascal syntax file has been extended to take into account some extensions
|
|
|
1783 provided by Turbo Pascal, Free Pascal Compiler and GNU Pascal Compiler.
|
|
237
|
1784 Delphi keywords are also supported. By default, Turbo Pascal 7.0 features are
|
|
7
|
1785 enabled. If you prefer to stick with the standard Pascal keywords, add the
|
|
|
1786 following line to your startup file: >
|
|
|
1787
|
|
|
1788 :let pascal_traditional=1
|
|
|
1789
|
|
|
1790 To switch on Delphi specific constructions (such as one-line comments,
|
|
|
1791 keywords, etc): >
|
|
|
1792
|
|
|
1793 :let pascal_delphi=1
|
|
|
1794
|
|
|
1795
|
|
|
1796 The option pascal_symbol_operator controls whether symbol operators such as +,
|
|
|
1797 *, .., etc. are displayed using the Operator color or not. To colorize symbol
|
|
|
1798 operators, add the following line to your startup file: >
|
|
|
1799
|
|
|
1800 :let pascal_symbol_operator=1
|
|
|
1801
|
|
|
1802 Some functions are highlighted by default. To switch it off: >
|
|
|
1803
|
|
|
1804 :let pascal_no_functions=1
|
|
|
1805
|
|
|
1806 Furthermore, there are specific variable for some compiler. Besides
|
|
|
1807 pascal_delphi, there are pascal_gpc and pascal_fpc. Default extensions try to
|
|
|
1808 match Turbo Pascal. >
|
|
|
1809
|
|
|
1810 :let pascal_gpc=1
|
|
|
1811
|
|
|
1812 or >
|
|
|
1813
|
|
|
1814 :let pascal_fpc=1
|
|
|
1815
|
|
|
1816 To ensure that strings are defined on a single line, you can define the
|
|
|
1817 pascal_one_line_string variable. >
|
|
|
1818
|
|
|
1819 :let pascal_one_line_string=1
|
|
|
1820
|
|
|
1821 If you dislike <Tab> chars, you can set the pascal_no_tabs variable. Tabs
|
|
|
1822 will be highlighted as Error. >
|
|
|
1823
|
|
|
1824 :let pascal_no_tabs=1
|
|
|
1825
|
|
|
1826
|
|
|
1827
|
|
501
|
1828 PERL *perl.vim* *ft-perl-syntax*
|
|
7
|
1829
|
|
|
1830 There are a number of possible options to the perl syntax highlighting.
|
|
|
1831
|
|
|
1832 If you use POD files or POD segments, you might: >
|
|
|
1833
|
|
|
1834 :let perl_include_pod = 1
|
|
|
1835
|
|
22
|
1836 The reduce the complexity of parsing (and increase performance) you can switch
|
|
|
1837 off two elements in the parsing of variable names and contents. >
|
|
|
1838
|
|
|
1839 To handle package references in variable and function names not differently
|
|
|
1840 from the rest of the name (like 'PkgName::' in '$PkgName::VarName'): >
|
|
|
1841
|
|
|
1842 :let perl_no_scope_in_variables = 1
|
|
|
1843
|
|
|
1844 (In Vim 6.x it was the other way around: "perl_want_scope_in_variables"
|
|
|
1845 enabled it.)
|
|
|
1846
|
|
|
1847 If you do not want complex things like '@{${"foo"}}' to be parsed: >
|
|
|
1848
|
|
|
1849 :let perl_no_extended_vars = 1
|
|
|
1850
|
|
26
|
1851 (In Vim 6.x it was the other way around: "perl_extended_vars" enabled it.)
|
|
7
|
1852
|
|
237
|
1853 The coloring strings can be changed. By default strings and qq friends will be
|
|
|
1854 highlighted like the first line. If you set the variable
|
|
7
|
1855 perl_string_as_statement, it will be highlighted as in the second line.
|
|
|
1856
|
|
|
1857 "hello world!"; qq|hello world|;
|
|
|
1858 ^^^^^^^^^^^^^^NN^^^^^^^^^^^^^^^N (unlet perl_string_as_statement)
|
|
|
1859 S^^^^^^^^^^^^SNNSSS^^^^^^^^^^^SN (let perl_string_as_statement)
|
|
|
1860
|
|
|
1861 (^ = perlString, S = perlStatement, N = None at all)
|
|
|
1862
|
|
237
|
1863 The syncing has 3 options. The first two switch off some triggering of
|
|
7
|
1864 synchronization and should only be needed in case it fails to work properly.
|
|
|
1865 If while scrolling all of a sudden the whole screen changes color completely
|
|
237
|
1866 then you should try and switch off one of those. Let me know if you can figure
|
|
7
|
1867 out the line that causes the mistake.
|
|
|
1868
|
|
|
1869 One triggers on "^\s*sub\s*" and the other on "^[$@%]" more or less. >
|
|
|
1870
|
|
|
1871 :let perl_no_sync_on_sub
|
|
|
1872 :let perl_no_sync_on_global_var
|
|
|
1873
|
|
|
1874 Below you can set the maximum distance VIM should look for starting points for
|
|
|
1875 its attempts in syntax highlighting. >
|
|
|
1876
|
|
|
1877 :let perl_sync_dist = 100
|
|
|
1878
|
|
|
1879 If you want to use folding with perl, set perl_fold: >
|
|
|
1880
|
|
22
|
1881 :let perl_fold = 1
|
|
|
1882
|
|
|
1883 If you want to fold blocks in if statements, etc. as well set the following: >
|
|
|
1884
|
|
|
1885 :let perl_fold_blocks = 1
|
|
7
|
1886
|
|
|
1887
|
|
501
|
1888 PHP3 and PHP4 *php.vim* *php3.vim* *ft-php-syntax* *ft-php3-syntax*
|
|
7
|
1889
|
|
|
1890 [note: previously this was called "php3", but since it now also supports php4
|
|
|
1891 it has been renamed to "php"]
|
|
|
1892
|
|
|
1893 There are the following options for the php syntax highlighting.
|
|
|
1894
|
|
|
1895 If you like SQL syntax highlighting inside Strings: >
|
|
|
1896
|
|
|
1897 let php_sql_query = 1
|
|
|
1898
|
|
|
1899 For highlighting the Baselib methods: >
|
|
|
1900
|
|
|
1901 let php_baselib = 1
|
|
|
1902
|
|
|
1903 Enable HTML syntax highlighting inside strings: >
|
|
|
1904
|
|
|
1905 let php_htmlInStrings = 1
|
|
|
1906
|
|
|
1907 Using the old colorstyle: >
|
|
|
1908
|
|
|
1909 let php_oldStyle = 1
|
|
|
1910
|
|
|
1911 Enable highlighting ASP-style short tags: >
|
|
|
1912
|
|
|
1913 let php_asp_tags = 1
|
|
|
1914
|
|
|
1915 Disable short tags: >
|
|
|
1916
|
|
|
1917 let php_noShortTags = 1
|
|
|
1918
|
|
|
1919 For highlighting parent error ] or ): >
|
|
|
1920
|
|
|
1921 let php_parent_error_close = 1
|
|
|
1922
|
|
|
1923 For skipping an php end tag, if there exists an open ( or [ without a closing
|
|
|
1924 one: >
|
|
|
1925
|
|
|
1926 let php_parent_error_open = 1
|
|
|
1927
|
|
|
1928 Enable folding for classes and functions: >
|
|
|
1929
|
|
|
1930 let php_folding = 1
|
|
|
1931
|
|
|
1932 Selecting syncing method: >
|
|
|
1933
|
|
|
1934 let php_sync_method = x
|
|
|
1935
|
|
|
1936 x = -1 to sync by search (default),
|
|
|
1937 x > 0 to sync at least x lines backwards,
|
|
|
1938 x = 0 to sync from start.
|
|
|
1939
|
|
|
1940
|
|
501
|
1941 PPWIZARD *ppwiz.vim* *ft-ppwiz-syntax*
|
|
7
|
1942
|
|
|
1943 PPWizard is a preprocessor for HTML and OS/2 INF files
|
|
|
1944
|
|
|
1945 This syntax file has the options:
|
|
|
1946
|
|
|
1947 - ppwiz_highlight_defs : determines highlighting mode for PPWizard's
|
|
237
|
1948 definitions. Possible values are
|
|
7
|
1949
|
|
|
1950 ppwiz_highlight_defs = 1 : PPWizard #define statements retain the
|
|
237
|
1951 colors of their contents (e.g. PPWizard macros and variables)
|
|
7
|
1952
|
|
|
1953 ppwiz_highlight_defs = 2 : preprocessor #define and #evaluate
|
|
|
1954 statements are shown in a single color with the exception of line
|
|
|
1955 continuation symbols
|
|
|
1956
|
|
|
1957 The default setting for ppwiz_highlight_defs is 1.
|
|
|
1958
|
|
|
1959 - ppwiz_with_html : If the value is 1 (the default), highlight literal
|
|
|
1960 HTML code; if 0, treat HTML code like ordinary text.
|
|
|
1961
|
|
|
1962
|
|
501
|
1963 PHTML *phtml.vim* *ft-phtml-syntax*
|
|
7
|
1964
|
|
|
1965 There are two options for the phtml syntax highlighting.
|
|
|
1966
|
|
|
1967 If you like SQL syntax highlighting inside Strings, use this: >
|
|
|
1968
|
|
|
1969 :let phtml_sql_query = 1
|
|
|
1970
|
|
|
1971 For syncing, minlines defaults to 100. If you prefer another value, you can
|
|
|
1972 set "phtml_minlines" to the value you desire. Example: >
|
|
|
1973
|
|
|
1974 :let phtml_minlines = 200
|
|
|
1975
|
|
|
1976
|
|
501
|
1977 POSTSCRIPT *postscr.vim* *ft-postscr-syntax*
|
|
7
|
1978
|
|
|
1979 There are several options when it comes to highlighting PostScript.
|
|
|
1980
|
|
|
1981 First which version of the PostScript language to highlight. There are
|
|
|
1982 currently three defined language versions, or levels. Level 1 is the original
|
|
|
1983 and base version, and includes all extensions prior to the release of level 2.
|
|
|
1984 Level 2 is the most common version around, and includes its own set of
|
|
|
1985 extensions prior to the release of level 3. Level 3 is currently the highest
|
|
|
1986 level supported. You select which level of the PostScript language you want
|
|
|
1987 highlighted by defining the postscr_level variable as follows: >
|
|
|
1988
|
|
|
1989 :let postscr_level=2
|
|
|
1990
|
|
|
1991 If this variable is not defined it defaults to 2 (level 2) since this is
|
|
|
1992 the most prevalent version currently.
|
|
|
1993
|
|
|
1994 Note, not all PS interpreters will support all language features for a
|
|
|
1995 particular language level. In particular the %!PS-Adobe-3.0 at the start of
|
|
|
1996 PS files does NOT mean the PostScript present is level 3 PostScript!
|
|
|
1997
|
|
|
1998 If you are working with Display PostScript, you can include highlighting of
|
|
|
1999 Display PS language features by defining the postscr_display variable as
|
|
|
2000 follows: >
|
|
|
2001
|
|
|
2002 :let postscr_display=1
|
|
|
2003
|
|
|
2004 If you are working with Ghostscript, you can include highlighting of
|
|
|
2005 Ghostscript specific language features by defining the variable
|
|
|
2006 postscr_ghostscript as follows: >
|
|
|
2007
|
|
|
2008 :let postscr_ghostscript=1
|
|
|
2009
|
|
|
2010 PostScript is a large language, with many predefined elements. While it
|
|
|
2011 useful to have all these elements highlighted, on slower machines this can
|
|
|
2012 cause Vim to slow down. In an attempt to be machine friendly font names and
|
|
|
2013 character encodings are not highlighted by default. Unless you are working
|
|
|
2014 explicitly with either of these this should be ok. If you want them to be
|
|
|
2015 highlighted you should set one or both of the following variables: >
|
|
|
2016
|
|
|
2017 :let postscr_fonts=1
|
|
|
2018 :let postscr_encodings=1
|
|
|
2019
|
|
|
2020 There is a stylistic option to the highlighting of and, or, and not. In
|
|
|
2021 PostScript the function of these operators depends on the types of their
|
|
|
2022 operands - if the operands are booleans then they are the logical operators,
|
|
|
2023 if they are integers then they are binary operators. As binary and logical
|
|
|
2024 operators can be highlighted differently they have to be highlighted one way
|
|
|
2025 or the other. By default they are treated as logical operators. They can be
|
|
|
2026 highlighted as binary operators by defining the variable
|
|
|
2027 postscr_andornot_binary as follows: >
|
|
|
2028
|
|
|
2029 :let postscr_andornot_binary=1
|
|
|
2030 <
|
|
|
2031
|
|
501
|
2032 *ptcap.vim* *ft-printcap-syntax*
|
|
|
2033 PRINTCAP + TERMCAP *ft-ptcap-syntax* *ft-termcap-syntax*
|
|
7
|
2034
|
|
|
2035 This syntax file applies to the printcap and termcap databases.
|
|
|
2036
|
|
|
2037 In order for Vim to recognize printcap/termcap files that do not match
|
|
|
2038 the patterns *printcap*, or *termcap*, you must put additional patterns
|
|
|
2039 appropriate to your system in your |myfiletypefile| file. For these
|
|
|
2040 patterns, you must set the variable "b:ptcap_type" to either "print" or
|
|
|
2041 "term", and then the 'filetype' option to ptcap.
|
|
|
2042
|
|
|
2043 For example, to make Vim identify all files in /etc/termcaps/ as termcap
|
|
|
2044 files, add the following: >
|
|
|
2045
|
|
|
2046 :au BufNewFile,BufRead /etc/termcaps/* let b:ptcap_type = "term" |
|
|
|
2047 \ set filetype=ptcap
|
|
|
2048
|
|
|
2049 If you notice highlighting errors while scrolling backwards, which
|
|
|
2050 are fixed when redrawing with CTRL-L, try setting the "ptcap_minlines"
|
|
|
2051 internal variable to a larger number: >
|
|
|
2052
|
|
|
2053 :let ptcap_minlines = 50
|
|
|
2054
|
|
|
2055 (The default is 20 lines.)
|
|
|
2056
|
|
|
2057
|
|
501
|
2058 PROGRESS *progress.vim* *ft-progress-syntax*
|
|
7
|
2059
|
|
|
2060 Files matching "*.w" could be Progress or cweb. If the automatic detection
|
|
|
2061 doesn't work for you, or you don't edit cweb at all, use this in your
|
|
|
2062 startup vimrc: >
|
|
|
2063 :let filetype_w = "progress"
|
|
|
2064 The same happens for "*.i", which could be assembly, and "*.p", which could be
|
|
|
2065 Pascal. Use this if you don't use assembly and Pascal: >
|
|
|
2066 :let filetype_i = "progress"
|
|
|
2067 :let filetype_p = "progress"
|
|
|
2068
|
|
|
2069
|
|
501
|
2070 PYTHON *python.vim* *ft-python-syntax*
|
|
7
|
2071
|
|
|
2072 There are four options to control Python syntax highlighting.
|
|
|
2073
|
|
|
2074 For highlighted numbers: >
|
|
|
2075 :let python_highlight_numbers = 1
|
|
|
2076
|
|
|
2077 For highlighted builtin functions: >
|
|
|
2078 :let python_highlight_builtins = 1
|
|
|
2079
|
|
|
2080 For highlighted standard exceptions: >
|
|
|
2081 :let python_highlight_exceptions = 1
|
|
|
2082
|
|
|
2083 For highlighted trailing whitespace and mix of spaces and tabs:
|
|
|
2084 :let python_highlight_space_errors = 1
|
|
|
2085
|
|
|
2086 If you want all possible Python highlighting (the same as setting the
|
|
|
2087 preceding three options): >
|
|
|
2088 :let python_highlight_all = 1
|
|
|
2089
|
|
|
2090
|
|
501
|
2091 QUAKE *quake.vim* *ft-quake-syntax*
|
|
7
|
2092
|
|
|
2093 The Quake syntax definition should work for most any FPS (First Person
|
|
237
|
2094 Shooter) based on one of the Quake engines. However, the command names vary
|
|
7
|
2095 a bit between the three games (Quake, Quake 2, and Quake 3 Arena) so the
|
|
|
2096 syntax definition checks for the existence of three global variables to allow
|
|
237
|
2097 users to specify what commands are legal in their files. The three variables
|
|
7
|
2098 can be set for the following effects:
|
|
|
2099
|
|
|
2100 set to highlight commands only available in Quake: >
|
|
|
2101 :let quake_is_quake1 = 1
|
|
|
2102
|
|
|
2103 set to highlight commands only available in Quake 2: >
|
|
|
2104 :let quake_is_quake2 = 1
|
|
|
2105
|
|
|
2106 set to highlight commands only available in Quake 3 Arena: >
|
|
|
2107 :let quake_is_quake3 = 1
|
|
|
2108
|
|
|
2109 Any combination of these three variables is legal, but might highlight more
|
|
|
2110 commands than are actually available to you by the game.
|
|
|
2111
|
|
|
2112
|
|
501
|
2113 READLINE *readline.vim* *ft-readline-syntax*
|
|
7
|
2114
|
|
|
2115 The readline library is primarily used by the BASH shell, which adds quite a
|
|
237
|
2116 few commands and options to the ones already available. To highlight these
|
|
7
|
2117 items as well you can add the following to your |vimrc| or just type it in the
|
|
|
2118 command line before loading a file with the readline syntax: >
|
|
|
2119 let readline_has_bash = 1
|
|
|
2120
|
|
|
2121 This will add highlighting for the commands that BASH (version 2.05a and
|
|
|
2122 later, and part earlier) adds.
|
|
|
2123
|
|
|
2124
|
|
501
|
2125 REXX *rexx.vim* *ft-rexx-syntax*
|
|
7
|
2126
|
|
|
2127 If you notice highlighting errors while scrolling backwards, which are fixed
|
|
|
2128 when redrawing with CTRL-L, try setting the "rexx_minlines" internal variable
|
|
|
2129 to a larger number: >
|
|
|
2130 :let rexx_minlines = 50
|
|
|
2131 This will make the syntax synchronization start 50 lines before the first
|
|
|
2132 displayed line. The default value is 10. The disadvantage of using a larger
|
|
|
2133 number is that redrawing can become slow.
|
|
|
2134
|
|
|
2135
|
|
501
|
2136 RUBY *ruby.vim* *ft-ruby-syntax*
|
|
7
|
2137
|
|
|
2138 There are a few options to the Ruby syntax highlighting.
|
|
|
2139
|
|
|
2140 By default, the "end" keyword is colorized according to the opening statement
|
|
237
|
2141 of the block it closes. While useful, this feature can be expensive: if you
|
|
7
|
2142 experience slow redrawing (or you are on a terminal with poor color support)
|
|
|
2143 you may want to turn it off by defining the "ruby_no_expensive" variable: >
|
|
|
2144 :let ruby_no_expensive = 1
|
|
|
2145 In this case the same color will be used for all control keywords.
|
|
|
2146
|
|
|
2147 If you do want this feature enabled, but notice highlighting errors while
|
|
|
2148 scrolling backwards, which are fixed when redrawing with CTRL-L, try setting
|
|
|
2149 the "ruby_minlines" variable to a value larger than 50: >
|
|
|
2150 :let ruby_minlines = 100
|
|
|
2151 Ideally, this value should be a number of lines large enough to embrace your
|
|
|
2152 largest class or module.
|
|
|
2153
|
|
|
2154 Finally, if you do not like to see too many color items around, you can define
|
|
|
2155 "ruby_no_identifiers": >
|
|
|
2156 :let ruby_no_identifiers = 1
|
|
|
2157 This will prevent highlighting of special identifiers like "ConstantName",
|
|
|
2158 "$global_var", "@instance_var", "| iterator |", and ":symbol".
|
|
|
2159
|
|
|
2160
|
|
501
|
2161 SCHEME *scheme.vim* *ft-scheme-syntax*
|
|
17
|
2162
|
|
|
2163 By default only R5RS keywords are highlighted and properly indented.
|
|
|
2164
|
|
|
2165 MzScheme-specific stuff will be used if b:is_mzscheme or g:is_mzscheme
|
|
|
2166 variables are defined.
|
|
36
|
2167
|
|
|
2168 Also scheme.vim supports keywords of the Chicken Scheme->C compiler. Define
|
|
|
2169 b:is_chicken or g:is_chicken, if you need them.
|
|
17
|
2170
|
|
|
2171
|
|
501
|
2172 SDL *sdl.vim* *ft-sdl-syntax*
|
|
7
|
2173
|
|
|
2174 The SDL highlighting probably misses a few keywords, but SDL has so many
|
|
|
2175 of them it's almost impossibly to cope.
|
|
|
2176
|
|
|
2177 The new standard, SDL-2000, specifies that all identifiers are
|
|
|
2178 case-sensitive (which was not so before), and that all keywords can be
|
|
237
|
2179 used either completely lowercase or completely uppercase. To have the
|
|
7
|
2180 highlighting reflect this, you can set the following variable: >
|
|
|
2181 :let sdl_2000=1
|
|
|
2182
|
|
237
|
2183 This also sets many new keywords. If you want to disable the old
|
|
7
|
2184 keywords, which is probably a good idea, use: >
|
|
|
2185 :let SDL_no_96=1
|
|
|
2186
|
|
|
2187
|
|
|
2188 The indentation is probably also incomplete, but right now I am very
|
|
|
2189 satisfied with it for my own projects.
|
|
|
2190
|
|
|
2191
|
|
501
|
2192 SED *sed.vim* *ft-sed-syntax*
|
|
7
|
2193
|
|
|
2194 To make tabs stand out from regular blanks (accomplished by using Todo
|
|
|
2195 highlighting on the tabs), define "highlight_sedtabs" by putting >
|
|
|
2196
|
|
|
2197 :let highlight_sedtabs = 1
|
|
|
2198
|
|
|
2199 in the vimrc file. (This special highlighting only applies for tabs
|
|
|
2200 inside search patterns, replacement texts, addresses or text included
|
|
|
2201 by an Append/Change/Insert command.) If you enable this option, it is
|
|
|
2202 also a good idea to set the tab width to one character; by doing that,
|
|
|
2203 you can easily count the number of tabs in a string.
|
|
|
2204
|
|
|
2205 Bugs:
|
|
|
2206
|
|
|
2207 The transform command (y) is treated exactly like the substitute
|
|
|
2208 command. This means that, as far as this syntax file is concerned,
|
|
|
2209 transform accepts the same flags as substitute, which is wrong.
|
|
|
2210 (Transform accepts no flags.) I tolerate this bug because the
|
|
|
2211 involved commands need very complex treatment (95 patterns, one for
|
|
|
2212 each plausible pattern delimiter).
|
|
|
2213
|
|
|
2214
|
|
501
|
2215 SGML *sgml.vim* *ft-sgml-syntax*
|
|
7
|
2216
|
|
|
2217 The coloring scheme for tags in the SGML file works as follows.
|
|
|
2218
|
|
|
2219 The <> of opening tags are colored differently than the </> of a closing tag.
|
|
|
2220 This is on purpose! For opening tags the 'Function' color is used, while for
|
|
|
2221 closing tags the 'Type' color is used (See syntax.vim to check how those are
|
|
|
2222 defined for you)
|
|
|
2223
|
|
|
2224 Known tag names are colored the same way as statements in C. Unknown tag
|
|
|
2225 names are not colored which makes it easy to spot errors.
|
|
|
2226
|
|
237
|
2227 Note that the same is true for argument (or attribute) names. Known attribute
|
|
7
|
2228 names are colored differently than unknown ones.
|
|
|
2229
|
|
237
|
2230 Some SGML tags are used to change the rendering of text. The following tags
|
|
7
|
2231 are recognized by the sgml.vim syntax coloring file and change the way normal
|
|
|
2232 text is shown: <varname> <emphasis> <command> <function> <literal>
|
|
|
2233 <replaceable> <ulink> and <link>.
|
|
|
2234
|
|
|
2235 If you want to change how such text is rendered, you must redefine the
|
|
|
2236 following syntax groups:
|
|
|
2237
|
|
|
2238 - sgmlBold
|
|
|
2239 - sgmlBoldItalic
|
|
|
2240 - sgmlUnderline
|
|
|
2241 - sgmlItalic
|
|
|
2242 - sgmlLink for links
|
|
|
2243
|
|
|
2244 To make this redefinition work you must redefine them all and define the
|
|
|
2245 following variable in your vimrc (this is due to the order in which the files
|
|
|
2246 are read during initialization) >
|
|
|
2247 let sgml_my_rendering=1
|
|
|
2248
|
|
|
2249 You can also disable this rendering by adding the following line to your
|
|
|
2250 vimrc file: >
|
|
|
2251 let sgml_no_rendering=1
|
|
|
2252
|
|
|
2253 (Adapted from the html.vim help text by Claudio Fleiner <claudio@fleiner.com>)
|
|
|
2254
|
|
|
2255
|
|
501
|
2256 SH *sh.vim* *ft-sh-syntax* *ft-bash-syntax* *ft-ksh-syntax*
|
|
7
|
2257
|
|
|
2258 This covers the "normal" Unix (Bourne) sh, bash and the Korn shell.
|
|
|
2259
|
|
|
2260 Vim attempts to determine which shell type is in use by specifying that
|
|
|
2261 various filenames are of specific types: >
|
|
|
2262
|
|
|
2263 ksh : .kshrc* *.ksh
|
|
|
2264 bash: .bashrc* bashrc bash.bashrc .bash_profile* *.bash
|
|
|
2265 <
|
|
|
2266 If none of these cases pertain, then the first line of the file is examined
|
|
|
2267 (ex. /bin/sh /bin/ksh /bin/bash). If the first line specifies a shelltype,
|
|
|
2268 then that shelltype is used. However some files (ex. .profile) are known to
|
|
|
2269 be shell files but the type is not apparent. Furthermore, on many systems
|
|
|
2270 sh is symbolically linked to "bash" (linux) or "ksh" (posix).
|
|
|
2271
|
|
|
2272 One may specify a global default by instantiating one of the following three
|
|
|
2273 variables in your <.vimrc>:
|
|
|
2274
|
|
|
2275 ksh: >
|
|
|
2276 let is_kornshell = 1
|
|
|
2277 < bash: >
|
|
|
2278 let is_bash = 1
|
|
|
2279 < sh: >
|
|
|
2280 let is_sh = 1
|
|
|
2281
|
|
|
2282 If, in your <.vimrc>, you set >
|
|
|
2283 let g:sh_fold_enabled= 1
|
|
|
2284 >
|
|
|
2285 then various syntax items (HereDocuments and function bodies) become
|
|
|
2286 syntax-foldable (see |:syn-fold|).
|
|
|
2287
|
|
|
2288 If you notice highlighting errors while scrolling backwards, which are fixed
|
|
|
2289 when redrawing with CTRL-L, try setting the "sh_minlines" internal variable
|
|
|
2290 to a larger number. Example: >
|
|
|
2291
|
|
|
2292 let sh_minlines = 500
|
|
|
2293
|
|
|
2294 This will make syntax synchronization start 500 lines before the first
|
|
|
2295 displayed line. The default value is 200. The disadvantage of using a larger
|
|
|
2296 number is that redrawing can become slow.
|
|
|
2297
|
|
|
2298 If you don't have much to synchronize on, displaying can be very slow. To
|
|
|
2299 reduce this, the "sh_maxlines" internal variable can be set. Example: >
|
|
|
2300
|
|
|
2301 let sh_maxlines = 100
|
|
|
2302 <
|
|
|
2303 The default is to use the twice sh_minlines. Set it to a smaller number to
|
|
|
2304 speed up displaying. The disadvantage is that highlight errors may appear.
|
|
|
2305
|
|
|
2306
|
|
501
|
2307 SPEEDUP (AspenTech plant simulator) *spup.vim* *ft-spup-syntax*
|
|
7
|
2308
|
|
|
2309 The Speedup syntax file has some options:
|
|
|
2310
|
|
|
2311 - strict_subsections : If this variable is defined, only keywords for
|
|
|
2312 sections and subsections will be highlighted as statements but not
|
|
|
2313 other keywords (like WITHIN in the OPERATION section).
|
|
|
2314
|
|
|
2315 - highlight_types : Definition of this variable causes stream types
|
|
|
2316 like temperature or pressure to be highlighted as Type, not as a
|
|
237
|
2317 plain Identifier. Included are the types that are usually found in
|
|
7
|
2318 the DECLARE section; if you defined own types, you have to include
|
|
|
2319 them in the syntax file.
|
|
|
2320
|
|
|
2321 - oneline_comments : this value ranges from 1 to 3 and determines the
|
|
|
2322 highlighting of # style comments.
|
|
|
2323
|
|
|
2324 oneline_comments = 1 : allow normal Speedup code after an even
|
|
|
2325 number of #s.
|
|
|
2326
|
|
|
2327 oneline_comments = 2 : show code starting with the second # as
|
|
237
|
2328 error. This is the default setting.
|
|
7
|
2329
|
|
|
2330 oneline_comments = 3 : show the whole line as error if it contains
|
|
|
2331 more than one #.
|
|
|
2332
|
|
|
2333 Since especially OPERATION sections tend to become very large due to
|
|
237
|
2334 PRESETting variables, syncing may be critical. If your computer is
|
|
7
|
2335 fast enough, you can increase minlines and/or maxlines near the end of
|
|
|
2336 the syntax file.
|
|
|
2337
|
|
|
2338
|
|
501
|
2339 SQL *sql.vim* *ft-sql-syntax*
|
|
|
2340 *sqlinformix.vim* *ft-sqlinformix-syntax*
|
|
22
|
2341
|
|
|
2342 While there is an ANSI standard for SQL, most database engines add their
|
|
|
2343 own custom extensions. Vim currently supports the Oracle and Informix
|
|
|
2344 dialects of SQL. Vim assumes "*.sql" files are Oracle SQL by default.
|
|
|
2345
|
|
|
2346 If you want to use the Informix dialect, put this in your startup vimrc: >
|
|
|
2347 :let g:filetype_sql = "sqlinformix"
|
|
|
2348
|
|
|
2349
|
|
501
|
2350 TCSH *tcsh.vim* *ft-tcsh-syntax*
|
|
7
|
2351
|
|
|
2352 This covers the shell named "tcsh". It is a superset of csh. See |csh.vim|
|
|
|
2353 for how the filetype is detected.
|
|
|
2354
|
|
|
2355 Tcsh does not allow \" in strings unless the "backslash_quote" shell variable
|
|
237
|
2356 is set. If you want VIM to assume that no backslash quote constructs exist add
|
|
7
|
2357 this line to your .vimrc: >
|
|
|
2358
|
|
|
2359 :let tcsh_backslash_quote = 0
|
|
|
2360
|
|
|
2361 If you notice highlighting errors while scrolling backwards, which are fixed
|
|
|
2362 when redrawing with CTRL-L, try setting the "tcsh_minlines" internal variable
|
|
|
2363 to a larger number: >
|
|
|
2364
|
|
|
2365 :let tcsh_minlines = 100
|
|
|
2366
|
|
|
2367 This will make the syntax synchronization start 100 lines before the first
|
|
237
|
2368 displayed line. The default value is 15. The disadvantage of using a larger
|
|
7
|
2369 number is that redrawing can become slow.
|
|
|
2370
|
|
|
2371
|
|
501
|
2372 TEX *tex.vim* *ft-tex-syntax*
|
|
7
|
2373
|
|
477
|
2374 *tex-folding*
|
|
|
2375 Want Syntax Folding? ~
|
|
|
2376
|
|
|
2377 As of version 28 of <syntax/tex.vim>, syntax-based folding of parts, chapters,
|
|
|
2378 sections, subsections, etc are supported. Put >
|
|
|
2379 let g:tex_fold_enabled=1
|
|
|
2380 in your <.vimrc>, and :set fdm=syntax. I suggest doing the latter via a
|
|
|
2381 modeline at the end of your LaTeX file: >
|
|
|
2382 % vim: fdm=syntax
|
|
|
2383 <
|
|
|
2384 *tex-runon*
|
|
7
|
2385 Run-on Comments/Math? ~
|
|
|
2386
|
|
477
|
2387 The <syntax/tex.vim> highlighting supports TeX, LaTeX, and some AmsTeX. The
|
|
|
2388 highlighting supports three primary zones/regions: normal, texZone, and
|
|
|
2389 texMathZone. Although considerable effort has been made to have these zones
|
|
|
2390 terminate properly, zones delineated by $..$ and $$..$$ cannot be synchronized
|
|
|
2391 as there's no difference between start and end patterns. Consequently, a
|
|
7
|
2392 special "TeX comment" has been provided >
|
|
|
2393 %stopzone
|
|
|
2394 which will forcibly terminate the highlighting of either a texZone or a
|
|
|
2395 texMathZone.
|
|
|
2396
|
|
477
|
2397 *tex-slow*
|
|
7
|
2398 Slow Syntax Highlighting? ~
|
|
|
2399
|
|
|
2400 If you have a slow computer, you may wish to reduce the values for >
|
|
|
2401 :syn sync maxlines=200
|
|
|
2402 :syn sync minlines=50
|
|
|
2403 (especially the latter). If your computer is fast, you may wish to
|
|
237
|
2404 increase them. This primarily affects synchronizing (i.e. just what group,
|
|
7
|
2405 if any, is the text at the top of the screen supposed to be in?).
|
|
|
2406
|
|
477
|
2407 *tex-error*
|
|
7
|
2408 Excessive Error Highlighting? ~
|
|
|
2409
|
|
|
2410 The <tex.vim> supports lexical error checking of various sorts. Thus,
|
|
|
2411 although the error checking is ofttimes very useful, it can indicate
|
|
|
2412 errors where none actually are. If this proves to be a problem for you,
|
|
|
2413 you may put in your <.vimrc> the following statement: >
|
|
|
2414 let tex_no_error=1
|
|
477
|
2415 and all error checking by <syntax/tex.vim> will be suppressed.
|
|
|
2416
|
|
|
2417 *tex-math*
|
|
7
|
2418 Need a new Math Group? ~
|
|
|
2419
|
|
|
2420 If you want to include a new math group in your LaTeX, the following
|
|
|
2421 code shows you an example as to how you might do so: >
|
|
477
|
2422 call TexNewMathZone(sfx,mathzone,starform)
|
|
|
2423 You'll want to provide the new math group with a unique suffix
|
|
|
2424 (currently, A-L and V-Z are taken by <syntax/tex.vim> itself).
|
|
|
2425 As an example, consider how eqnarray is set up by <syntax/tex.vim>: >
|
|
|
2426 call TexNewMathZone("D","eqnarray",1)
|
|
|
2427 You'll need to change "mathzone" to the name of your new math group,
|
|
|
2428 and then to the call to it in .vim/after/syntax/tex.vim.
|
|
|
2429 The "starform" variable, if true, implies that your new math group
|
|
|
2430 has a starred form (ie. eqnarray*).
|
|
|
2431
|
|
|
2432 *tex-style*
|
|
7
|
2433 Starting a New Style? ~
|
|
|
2434
|
|
|
2435 One may use "\makeatletter" in *.tex files, thereby making the use of "@" in
|
|
|
2436 commands available. However, since the *.tex file doesn't have one of the
|
|
|
2437 following suffices: sty cls clo dtx ltx, the syntax highlighting will flag
|
|
|
2438 such use of @ as an error. To solve this: >
|
|
|
2439
|
|
|
2440 :let b:tex_stylish = 1
|
|
|
2441 :set ft=tex
|
|
|
2442
|
|
|
2443 Putting "let g:tex_stylish=1" into your <.vimrc> will make <syntax/tex.vim>
|
|
|
2444 always accept such use of @.
|
|
|
2445
|
|
|
2446
|
|
501
|
2447 TF *tf.vim* *ft-tf-syntax*
|
|
7
|
2448
|
|
|
2449 There is one option for the tf syntax highlighting.
|
|
|
2450
|
|
|
2451 For syncing, minlines defaults to 100. If you prefer another value, you can
|
|
|
2452 set "tf_minlines" to the value you desire. Example: >
|
|
|
2453
|
|
|
2454 :let tf_minlines = your choice
|
|
|
2455
|
|
|
2456
|
|
501
|
2457 VIM *vim.vim* *ft-vim-syntax*
|
|
7
|
2458
|
|
|
2459 There is a tradeoff between more accurate syntax highlighting versus
|
|
|
2460 screen updating speed. To improve accuracy, you may wish to increase
|
|
|
2461 the g:vim_minlines variable. The g:vim_maxlines variable may be used
|
|
|
2462 to improve screen updating rates (see |:syn-sync| for more on this).
|
|
|
2463
|
|
|
2464 g:vim_minlines : used to set synchronization minlines
|
|
|
2465 g:vim_maxlines : used to set synchronization maxlines
|
|
|
2466
|
|
|
2467 The g:vimembedscript option allows for somewhat faster loading of syntax
|
|
|
2468 highlighting for vim scripts at the expense of supporting syntax highlighting
|
|
|
2469 for external scripting languages (currently perl, python, ruby, and tcl).
|
|
|
2470
|
|
|
2471 g:vimembedscript == 1 (default) <vim.vim> will allow highlighting
|
|
|
2472 g:vimembedscript doesn't exist of supported embedded scripting
|
|
|
2473 languages: perl, python, ruby and
|
|
|
2474 tcl.
|
|
|
2475
|
|
|
2476 g:vimembedscript == 0 Syntax highlighting for embedded
|
|
|
2477 scripting languages will not be
|
|
|
2478 loaded.
|
|
|
2479
|
|
|
2480
|
|
501
|
2481 XF86CONFIG *xf86conf.vim* *ft-xf86conf-syntax*
|
|
7
|
2482
|
|
|
2483 The syntax of XF86Config file differs in XFree86 v3.x and v4.x. Both
|
|
|
2484 variants are supported. Automatic detection is used, but is far from perfect.
|
|
|
2485 You may need to specify the version manually. Set the variable
|
|
|
2486 xf86conf_xfree86_version to 3 or 4 according to your XFree86 version in
|
|
|
2487 your .vimrc. Example: >
|
|
|
2488 :let xf86conf_xfree86_version=3
|
|
|
2489 When using a mix of versions, set the b:xf86conf_xfree86_version variable.
|
|
|
2490
|
|
|
2491 Note that spaces and underscores in option names are not supported. Use
|
|
|
2492 "SyncOnGreen" instead of "__s yn con gr_e_e_n" if you want the option name
|
|
|
2493 highlighted.
|
|
|
2494
|
|
|
2495
|
|
501
|
2496 XML *xml.vim* *ft-xml-syntax*
|
|
7
|
2497
|
|
237
|
2498 Xml namespaces are highlighted by default. This can be inhibited by
|
|
7
|
2499 setting a global variable: >
|
|
|
2500
|
|
|
2501 :let g:xml_namespace_transparent=1
|
|
|
2502 <
|
|
|
2503 *xml-folding*
|
|
|
2504 The xml syntax file provides syntax |folding| (see |:syn-fold|) between
|
|
237
|
2505 start and end tags. This can be turned on by >
|
|
7
|
2506
|
|
|
2507 :let g:xml_syntax_folding = 1
|
|
|
2508 :set foldmethod=syntax
|
|
|
2509
|
|
|
2510 Note: syntax folding might slow down syntax highlighting significantly,
|
|
|
2511 especially for large files.
|
|
|
2512
|
|
|
2513
|
|
501
|
2514 X Pixmaps (XPM) *xpm.vim* *ft-xpm-syntax*
|
|
7
|
2515
|
|
|
2516 xpm.vim creates its syntax items dynamically based upon the contents of the
|
|
|
2517 XPM file. Thus if you make changes e.g. in the color specification strings,
|
|
|
2518 you have to source it again e.g. with ":set syn=xpm".
|
|
|
2519
|
|
|
2520 To copy a pixel with one of the colors, yank a "pixel" with "yl" and insert it
|
|
|
2521 somewhere else with "P".
|
|
|
2522
|
|
|
2523 Do you want to draw with the mouse? Try the following: >
|
|
|
2524 :function! GetPixel()
|
|
|
2525 : let c = getline(line("."))[col(".") - 1]
|
|
|
2526 : echo c
|
|
|
2527 : exe "noremap <LeftMouse> <LeftMouse>r".c
|
|
|
2528 : exe "noremap <LeftDrag> <LeftMouse>r".c
|
|
|
2529 :endfunction
|
|
|
2530 :noremap <RightMouse> <LeftMouse>:call GetPixel()<CR>
|
|
|
2531 :set guicursor=n:hor20 " to see the color beneath the cursor
|
|
|
2532 This turns the right button into a pipette and the left button into a pen.
|
|
|
2533 It will work with XPM files that have one character per pixel only and you
|
|
|
2534 must not click outside of the pixel strings, but feel free to improve it.
|
|
|
2535
|
|
|
2536 It will look much better with a font in a quadratic cell size, e.g. for X: >
|
|
|
2537 :set guifont=-*-clean-medium-r-*-*-8-*-*-*-*-80-*
|
|
|
2538
|
|
|
2539 ==============================================================================
|
|
|
2540 5. Defining a syntax *:syn-define* *E410*
|
|
|
2541
|
|
|
2542 Vim understands three types of syntax items:
|
|
|
2543
|
|
419
|
2544 1. Keyword
|
|
7
|
2545 It can only contain keyword characters, according to the 'iskeyword'
|
|
|
2546 option. It cannot contain other syntax items. It will only match with a
|
|
|
2547 complete word (there are no keyword characters before or after the match).
|
|
|
2548 The keyword "if" would match in "if(a=b)", but not in "ifdef x", because
|
|
|
2549 "(" is not a keyword character and "d" is.
|
|
|
2550
|
|
419
|
2551 2. Match
|
|
7
|
2552 This is a match with a single regexp pattern.
|
|
|
2553
|
|
419
|
2554 3. Region
|
|
7
|
2555 This starts at a match of the "start" regexp pattern and ends with a match
|
|
|
2556 with the "end" regexp pattern. Any other text can appear in between. A
|
|
|
2557 "skip" regexp pattern can be used to avoid matching the "end" pattern.
|
|
|
2558
|
|
|
2559 Several syntax ITEMs can be put into one syntax GROUP. For a syntax group
|
|
|
2560 you can give highlighting attributes. For example, you could have an item
|
|
|
2561 to define a "/* .. */" comment and another one that defines a "// .." comment,
|
|
|
2562 and put them both in the "Comment" group. You can then specify that a
|
|
|
2563 "Comment" will be in bold font and have a blue color. You are free to make
|
|
|
2564 one highlight group for one syntax item, or put all items into one group.
|
|
|
2565 This depends on how you want to specify your highlighting attributes. Putting
|
|
|
2566 each item in its own group results in having to specify the highlighting
|
|
|
2567 for a lot of groups.
|
|
|
2568
|
|
|
2569 Note that a syntax group and a highlight group are similar. For a highlight
|
|
|
2570 group you will have given highlight attributes. These attributes will be used
|
|
|
2571 for the syntax group with the same name.
|
|
|
2572
|
|
|
2573 In case more than one item matches at the same position, the one that was
|
|
|
2574 defined LAST wins. Thus you can override previously defined syntax items by
|
|
|
2575 using an item that matches the same text. But a keyword always goes before a
|
|
|
2576 match or region. And a keyword with matching case always goes before a
|
|
|
2577 keyword with ignoring case.
|
|
|
2578
|
|
|
2579
|
|
|
2580 PRIORITY *:syn-priority*
|
|
|
2581
|
|
|
2582 When several syntax items may match, these rules are used:
|
|
|
2583
|
|
|
2584 1. When multiple Match or Region items start in the same position, the item
|
|
|
2585 defined last has priority.
|
|
|
2586 2. A Keyword has priority over Match and Region items.
|
|
|
2587 3. An item that starts in an earlier position has priority over items that
|
|
|
2588 start in later positions.
|
|
|
2589
|
|
|
2590
|
|
|
2591 DEFINING CASE *:syn-case* *E390*
|
|
|
2592
|
|
419
|
2593 :sy[ntax] case [match | ignore]
|
|
7
|
2594 This defines if the following ":syntax" commands will work with
|
|
|
2595 matching case, when using "match", or with ignoring case, when using
|
|
|
2596 "ignore". Note that any items before this are not affected, and all
|
|
|
2597 items until the next ":syntax case" command are affected.
|
|
|
2598
|
|
|
2599
|
|
419
|
2600 SPELL CHECKING *:syn-spell*
|
|
|
2601
|
|
|
2602 :sy[ntax] spell [toplevel | notoplevel | default]
|
|
|
2603 This defines where spell checking is to be done for text that is not
|
|
|
2604 in a syntax item:
|
|
|
2605
|
|
|
2606 toplevel: Text is spell checked.
|
|
|
2607 notoplevel: Text is not spell checked.
|
|
|
2608 default: When there is a @Spell cluster no spell checking.
|
|
|
2609
|
|
|
2610 For text in syntax items use the @Spell and @NoSpell clusters
|
|
|
2611 |spell-syntax|. When there is no @Spell and no @NoSpell cluster then
|
|
|
2612 spell checking is done for "default" and "toplevel".
|
|
|
2613
|
|
|
2614 To activate spell checking the 'spell' option must be set.
|
|
|
2615
|
|
|
2616
|
|
7
|
2617 DEFINING KEYWORDS *:syn-keyword*
|
|
|
2618
|
|
|
2619 :sy[ntax] keyword {group-name} [{options}] {keyword} .. [{options}]
|
|
|
2620
|
|
|
2621 This defines a number of keywords.
|
|
|
2622
|
|
|
2623 {group-name} Is a syntax group name such as "Comment".
|
|
|
2624 [{options}] See |:syn-arguments| below.
|
|
|
2625 {keyword} .. Is a list of keywords which are part of this group.
|
|
|
2626
|
|
|
2627 Example: >
|
|
|
2628 :syntax keyword Type int long char
|
|
|
2629 <
|
|
|
2630 The {options} can be given anywhere in the line. They will apply to
|
|
|
2631 all keywords given, also for options that come after a keyword.
|
|
|
2632 These examples do exactly the same: >
|
|
|
2633 :syntax keyword Type contained int long char
|
|
|
2634 :syntax keyword Type int long contained char
|
|
|
2635 :syntax keyword Type int long char contained
|
|
169
|
2636 < *E747*
|
|
7
|
2637 When you have a keyword with an optional tail, like Ex commands in
|
|
|
2638 Vim, you can put the optional characters inside [], to define all the
|
|
|
2639 variations at once: >
|
|
|
2640 :syntax keyword vimCommand ab[breviate] n[ext]
|
|
|
2641 <
|
|
|
2642 Don't forget that a keyword can only be recognized if all the
|
|
|
2643 characters are included in the 'iskeyword' option. If one character
|
|
|
2644 isn't, the keyword will never be recognized.
|
|
|
2645 Multi-byte characters can also be used. These do not have to be in
|
|
|
2646 'iskeyword'.
|
|
|
2647
|
|
|
2648 A keyword always has higher priority than a match or region, the
|
|
|
2649 keyword is used if more than one item matches. Keywords do not nest
|
|
|
2650 and a keyword can't contain anything else.
|
|
|
2651
|
|
|
2652 Note that when you have a keyword that is the same as an option (even
|
|
|
2653 one that isn't allowed here), you can not use it. Use a match
|
|
|
2654 instead.
|
|
|
2655
|
|
|
2656 The maximum length of a keyword is 80 characters.
|
|
|
2657
|
|
|
2658 The same keyword can be defined multiple times, when its containment
|
|
|
2659 differs. For example, you can define the keyword once not contained
|
|
|
2660 and use one highlight group, and once contained, and use a different
|
|
237
|
2661 highlight group. Example: >
|
|
7
|
2662 :syn keyword vimCommand tag
|
|
|
2663 :syn keyword vimSetting contained tag
|
|
|
2664 < When finding "tag" outside of any syntax item, the "vimCommand"
|
|
|
2665 highlight group is used. When finding "tag" in a syntax item that
|
|
|
2666 contains "vimSetting", the "vimSetting" group is used.
|
|
|
2667
|
|
|
2668
|
|
|
2669 DEFINING MATCHES *:syn-match*
|
|
|
2670
|
|
|
2671 :sy[ntax] match {group-name} [{options}] [excludenl] {pattern} [{options}]
|
|
|
2672
|
|
|
2673 This defines one match.
|
|
|
2674
|
|
|
2675 {group-name} A syntax group name such as "Comment".
|
|
|
2676 [{options}] See |:syn-arguments| below.
|
|
|
2677 [excludenl] Don't make a pattern with the end-of-line "$"
|
|
|
2678 extend a containing match or region. Must be
|
|
|
2679 given before the pattern. |:syn-excludenl|
|
|
|
2680 {pattern} The search pattern that defines the match.
|
|
|
2681 See |:syn-pattern| below.
|
|
|
2682 Note that the pattern may match more than one
|
|
|
2683 line, which makes the match depend on where
|
|
|
2684 Vim starts searching for the pattern. You
|
|
|
2685 need to make sure syncing takes care of this.
|
|
|
2686
|
|
|
2687 Example (match a character constant): >
|
|
|
2688 :syntax match Character /'.'/hs=s+1,he=e-1
|
|
|
2689 <
|
|
|
2690
|
|
|
2691 DEFINING REGIONS *:syn-region* *:syn-start* *:syn-skip* *:syn-end*
|
|
|
2692 *E398* *E399*
|
|
|
2693 :sy[ntax] region {group-name} [{options}]
|
|
|
2694 [matchgroup={group-name}]
|
|
|
2695 [keepend]
|
|
|
2696 [extend]
|
|
|
2697 [excludenl]
|
|
|
2698 start={start_pattern} ..
|
|
|
2699 [skip={skip_pattern}]
|
|
|
2700 end={end_pattern} ..
|
|
|
2701 [{options}]
|
|
|
2702
|
|
|
2703 This defines one region. It may span several lines.
|
|
|
2704
|
|
|
2705 {group-name} A syntax group name such as "Comment".
|
|
|
2706 [{options}] See |:syn-arguments| below.
|
|
|
2707 [matchgroup={group-name}] The syntax group to use for the following
|
|
|
2708 start or end pattern matches only. Not used
|
|
|
2709 for the text in between the matched start and
|
|
|
2710 end patterns. Use NONE to reset to not using
|
|
|
2711 a different group for the start or end match.
|
|
|
2712 See |:syn-matchgroup|.
|
|
|
2713 keepend Don't allow contained matches to go past a
|
|
|
2714 match with the end pattern. See
|
|
|
2715 |:syn-keepend|.
|
|
|
2716 extend Override a "keepend" for an item this region
|
|
237
|
2717 is contained in. See |:syn-extend|.
|
|
7
|
2718 excludenl Don't make a pattern with the end-of-line "$"
|
|
|
2719 extend a containing match or item. Only
|
|
|
2720 useful for end patterns. Must be given before
|
|
|
2721 the patterns it applies to. |:syn-excludenl|
|
|
|
2722 start={start_pattern} The search pattern that defines the start of
|
|
|
2723 the region. See |:syn-pattern| below.
|
|
|
2724 skip={skip_pattern} The search pattern that defines text inside
|
|
|
2725 the region where not to look for the end
|
|
|
2726 pattern. See |:syn-pattern| below.
|
|
|
2727 end={end_pattern} The search pattern that defines the end of
|
|
|
2728 the region. See |:syn-pattern| below.
|
|
|
2729
|
|
|
2730 Example: >
|
|
|
2731 :syntax region String start=+"+ skip=+\\"+ end=+"+
|
|
|
2732 <
|
|
|
2733 The start/skip/end patterns and the options can be given in any order.
|
|
|
2734 There can be zero or one skip pattern. There must be one or more
|
|
|
2735 start and end patterns. This means that you can omit the skip
|
|
|
2736 pattern, but you must give at least one start and one end pattern. It
|
|
|
2737 is allowed to have white space before and after the equal sign
|
|
|
2738 (although it mostly looks better without white space).
|
|
|
2739
|
|
|
2740 When more than one start pattern is given, a match with one of these
|
|
|
2741 is sufficient. This means there is an OR relation between the start
|
|
|
2742 patterns. The last one that matches is used. The same is true for
|
|
|
2743 the end patterns.
|
|
|
2744
|
|
|
2745 The search for the end pattern starts right after the start pattern.
|
|
|
2746 Offsets are not used for this. This implies that the match for the
|
|
|
2747 end pattern will never overlap with the start pattern.
|
|
|
2748
|
|
|
2749 The skip and end pattern can match across line breaks, but since the
|
|
|
2750 search for the pattern can start in any line it often does not do what
|
|
|
2751 you want. The skip pattern doesn't avoid a match of an end pattern in
|
|
|
2752 the next line. Use single-line patterns to avoid trouble.
|
|
|
2753
|
|
|
2754 Note: The decision to start a region is only based on a matching start
|
|
|
2755 pattern. There is no check for a matching end pattern. This does NOT
|
|
|
2756 work: >
|
|
|
2757 :syn region First start="(" end=":"
|
|
|
2758 :syn region Second start="(" end=";"
|
|
|
2759 < The Second always matches before the First (last defined pattern has
|
|
|
2760 higher priority). The Second region then continues until the next
|
|
|
2761 ';', no matter if there is a ':' before it. Using a match does work: >
|
|
|
2762 :syn match First "(\_.\{-}:"
|
|
|
2763 :syn match Second "(\_.\{-};"
|
|
|
2764 < This pattern matches any character or line break with "\_." and
|
|
|
2765 repeats that with "\{-}" (repeat as few as possible).
|
|
|
2766
|
|
|
2767 *:syn-keepend*
|
|
|
2768 By default, a contained match can obscure a match for the end pattern.
|
|
|
2769 This is useful for nesting. For example, a region that starts with
|
|
|
2770 "{" and ends with "}", can contain another region. An encountered "}"
|
|
|
2771 will then end the contained region, but not the outer region:
|
|
|
2772 { starts outer "{}" region
|
|
|
2773 { starts contained "{}" region
|
|
|
2774 } ends contained "{}" region
|
|
|
2775 } ends outer "{} region
|
|
|
2776 If you don't want this, the "keepend" argument will make the matching
|
|
|
2777 of an end pattern of the outer region also end any contained item.
|
|
|
2778 This makes it impossible to nest the same region, but allows for
|
|
|
2779 contained items to highlight parts of the end pattern, without causing
|
|
|
2780 that to skip the match with the end pattern. Example: >
|
|
|
2781 :syn match vimComment +"[^"]\+$+
|
|
|
2782 :syn region vimCommand start="set" end="$" contains=vimComment keepend
|
|
|
2783 < The "keepend" makes the vimCommand always end at the end of the line,
|
|
|
2784 even though the contained vimComment includes a match with the <EOL>.
|
|
|
2785
|
|
|
2786 When "keepend" is not used, a match with an end pattern is retried
|
|
|
2787 after each contained match. When "keepend" is included, the first
|
|
|
2788 encountered match with an end pattern is used, truncating any
|
|
|
2789 contained matches.
|
|
|
2790 *:syn-extend*
|
|
|
2791 The "keepend" behavior can be changed by using the "extend" argument.
|
|
|
2792 When an item with "extend" is contained in an item that uses
|
|
|
2793 "keepend", the "keepend" is ignored and the containing region will be
|
|
|
2794 extended.
|
|
|
2795 This can be used to have some contained items extend a region while
|
|
|
2796 others don't. Example: >
|
|
|
2797
|
|
|
2798 :syn region htmlRef start=+<a>+ end=+</a>+ keepend contains=htmlItem,htmlScript
|
|
|
2799 :syn match htmlItem +<[^>]*>+ contained
|
|
|
2800 :syn region htmlScript start=+<script+ end=+</script[^>]*>+ contained extend
|
|
|
2801
|
|
|
2802 < Here the htmlItem item does not make the htmlRef item continue
|
|
|
2803 further, it is only used to highlight the <> items. The htmlScript
|
|
|
2804 item does extend the htmlRef item.
|
|
|
2805
|
|
|
2806 Another example: >
|
|
|
2807 :syn region xmlFold start="<a>" end="</a>" fold transparent keepend extend
|
|
|
2808 < This defines a region with "keepend", so that its end cannot be
|
|
|
2809 changed by contained items, like when the "</a>" is matched to
|
|
|
2810 highlight it differently. But when the xmlFold region is nested (it
|
|
|
2811 includes itself), the "extend" applies, so that the "</a>" of a nested
|
|
|
2812 region only ends that region, and not the one it is contained in.
|
|
|
2813
|
|
|
2814 *:syn-excludenl*
|
|
|
2815 When a pattern for a match or end pattern of a region includes a '$'
|
|
|
2816 to match the end-of-line, it will make a region item that it is
|
|
|
2817 contained in continue on the next line. For example, a match with
|
|
|
2818 "\\$" (backslash at the end of the line) can make a region continue
|
|
|
2819 that would normally stop at the end of the line. This is the default
|
|
|
2820 behavior. If this is not wanted, there are two ways to avoid it:
|
|
|
2821 1. Use "keepend" for the containing item. This will keep all
|
|
|
2822 contained matches from extending the match or region. It can be
|
|
|
2823 used when all contained items must not extend the containing item.
|
|
|
2824 2. Use "excludenl" in the contained item. This will keep that match
|
|
|
2825 from extending the containing match or region. It can be used if
|
|
|
2826 only some contained items must not extend the containing item.
|
|
|
2827 "excludenl" must be given before the pattern it applies to.
|
|
|
2828
|
|
|
2829 *:syn-matchgroup*
|
|
|
2830 "matchgroup" can be used to highlight the start and/or end pattern
|
|
|
2831 differently than the body of the region. Example: >
|
|
|
2832 :syntax region String matchgroup=Quote start=+"+ skip=+\\"+ end=+"+
|
|
|
2833 < This will highlight the quotes with the "Quote" group, and the text in
|
|
|
2834 between with the "String" group.
|
|
|
2835 The "matchgroup" is used for all start and end patterns that follow,
|
|
|
2836 until the next "matchgroup". Use "matchgroup=NONE" to go back to not
|
|
|
2837 using a matchgroup.
|
|
|
2838
|
|
|
2839 In a start or end pattern that is highlighted with "matchgroup" the
|
|
|
2840 contained items of the region are not used. This can be used to avoid
|
|
|
2841 that a contained item matches in the start or end pattern match. When
|
|
|
2842 using "transparent", this does not apply to a start or end pattern
|
|
|
2843 match that is highlighted with "matchgroup".
|
|
|
2844
|
|
|
2845 Here is an example, which highlights three levels of parentheses in
|
|
|
2846 different colors: >
|
|
|
2847 :sy region par1 matchgroup=par1 start=/(/ end=/)/ contains=par2
|
|
|
2848 :sy region par2 matchgroup=par2 start=/(/ end=/)/ contains=par3 contained
|
|
|
2849 :sy region par3 matchgroup=par3 start=/(/ end=/)/ contains=par1 contained
|
|
|
2850 :hi par1 ctermfg=red guifg=red
|
|
|
2851 :hi par2 ctermfg=blue guifg=blue
|
|
|
2852 :hi par3 ctermfg=darkgreen guifg=darkgreen
|
|
|
2853
|
|
|
2854 ==============================================================================
|
|
|
2855 6. :syntax arguments *:syn-arguments*
|
|
|
2856
|
|
|
2857 The :syntax commands that define syntax items take a number of arguments.
|
|
|
2858 The common ones are explained here. The arguments may be given in any order
|
|
|
2859 and may be mixed with patterns.
|
|
|
2860
|
|
|
2861 Not all commands accept all arguments. This table shows which arguments
|
|
|
2862 can not be used for all commands:
|
|
|
2863 *E395* *E396*
|
|
|
2864 contains oneline fold display extend ~
|
|
|
2865 :syntax keyword - - - - -
|
|
|
2866 :syntax match yes - yes yes yes
|
|
|
2867 :syntax region yes yes yes yes yes
|
|
|
2868
|
|
|
2869 These arguments can be used for all three commands:
|
|
|
2870 contained
|
|
|
2871 containedin
|
|
|
2872 nextgroup
|
|
|
2873 transparent
|
|
|
2874 skipwhite
|
|
|
2875 skipnl
|
|
|
2876 skipempty
|
|
|
2877
|
|
|
2878
|
|
|
2879 contained *:syn-contained*
|
|
|
2880
|
|
|
2881 When the "contained" argument is given, this item will not be recognized at
|
|
|
2882 the top level, but only when it is mentioned in the "contains" field of
|
|
|
2883 another match. Example: >
|
|
|
2884 :syntax keyword Todo TODO contained
|
|
|
2885 :syntax match Comment "//.*" contains=Todo
|
|
|
2886
|
|
|
2887
|
|
|
2888 display *:syn-display*
|
|
|
2889
|
|
|
2890 If the "display" argument is given, this item will be skipped when the
|
|
|
2891 detected highlighting will not be displayed. This will speed up highlighting,
|
|
|
2892 by skipping this item when only finding the syntax state for the text that is
|
|
|
2893 to be displayed.
|
|
|
2894
|
|
|
2895 Generally, you can use "display" for match and region items that meet these
|
|
|
2896 conditions:
|
|
|
2897 - The item does not continue past the end of a line. Example for C: A region
|
|
|
2898 for a "/*" comment can't contain "display", because it continues on the next
|
|
|
2899 line.
|
|
|
2900 - The item does not contain items that continue past the end of the line or
|
|
|
2901 make it continue on the next line.
|
|
|
2902 - The item does not change the size of any item it is contained in. Example
|
|
|
2903 for C: A match with "\\$" in a preprocessor match can't have "display",
|
|
|
2904 because it may make that preprocessor match shorter.
|
|
|
2905 - The item does not allow other items to match that didn't match otherwise,
|
|
|
2906 and that item may extend the match too far. Example for C: A match for a
|
|
|
2907 "//" comment can't use "display", because a "/*" inside that comment would
|
|
|
2908 match then and start a comment which extends past the end of the line.
|
|
|
2909
|
|
|
2910 Examples, for the C language, where "display" can be used:
|
|
|
2911 - match with a number
|
|
|
2912 - match with a label
|
|
|
2913
|
|
|
2914
|
|
|
2915 transparent *:syn-transparent*
|
|
|
2916
|
|
|
2917 If the "transparent" argument is given, this item will not be highlighted
|
|
|
2918 itself, but will take the highlighting of the item it is contained in. This
|
|
|
2919 is useful for syntax items that don't need any highlighting but are used
|
|
|
2920 only to skip over a part of the text.
|
|
|
2921
|
|
|
2922 The "contains=" argument is also inherited from the item it is contained in,
|
|
|
2923 unless a "contains" argument is given for the transparent item itself. To
|
|
|
2924 avoid that unwanted items are contained, use "contains=NONE". Example, which
|
|
|
2925 highlights words in strings, but makes an exception for "vim": >
|
|
|
2926 :syn match myString /'[^']*'/ contains=myWord,myVim
|
|
|
2927 :syn match myWord /\<[a-z]*\>/ contained
|
|
|
2928 :syn match myVim /\<vim\>/ transparent contained contains=NONE
|
|
|
2929 :hi link myString String
|
|
|
2930 :hi link myWord Comment
|
|
|
2931 Since the "myVim" match comes after "myWord" it is the preferred match (last
|
|
|
2932 match in the same position overrules an earlier one). The "transparent"
|
|
|
2933 argument makes the "myVim" match use the same highlighting as "myString". But
|
|
|
2934 it does not contain anything. If the "contains=NONE" argument would be left
|
|
|
2935 out, then "myVim" would use the contains argument from myString and allow
|
|
|
2936 "myWord" to be contained, which will be highlighted as a Constant. This
|
|
|
2937 happens because a contained match doesn't match inside itself in the same
|
|
|
2938 position, thus the "myVim" match doesn't overrule the "myWord" match here.
|
|
|
2939
|
|
|
2940 When you look at the colored text, it is like looking at layers of contained
|
|
|
2941 items. The contained item is on top of the item it is contained in, thus you
|
|
|
2942 see the contained item. When a contained item is transparent, you can look
|
|
|
2943 through, thus you see the item it is contained in. In a picture:
|
|
|
2944
|
|
|
2945 look from here
|
|
|
2946
|
|
|
2947 | | | | | |
|
|
|
2948 V V V V V V
|
|
|
2949
|
|
|
2950 xxxx yyy more contained items
|
|
|
2951 .................... contained item (transparent)
|
|
|
2952 ============================= first item
|
|
|
2953
|
|
|
2954 The 'x', 'y' and '=' represent a highlighted syntax item. The '.' represent a
|
|
|
2955 transparent group.
|
|
|
2956
|
|
|
2957 What you see is:
|
|
|
2958
|
|
|
2959 =======xxxx=======yyy========
|
|
|
2960
|
|
|
2961 Thus you look through the transparent "....".
|
|
|
2962
|
|
|
2963
|
|
|
2964 oneline *:syn-oneline*
|
|
|
2965
|
|
|
2966 The "oneline" argument indicates that the region does not cross a line
|
|
|
2967 boundary. It must match completely in the current line. However, when the
|
|
|
2968 region has a contained item that does cross a line boundary, it continues on
|
|
|
2969 the next line anyway. A contained item can be used to recognize a line
|
|
|
2970 continuation pattern. But the "end" pattern must still match in the first
|
|
|
2971 line, otherwise the region doesn't even start.
|
|
|
2972
|
|
|
2973 When the start pattern includes a "\n" to match an end-of-line, the end
|
|
|
2974 pattern must be found in the same line as where the start pattern ends. The
|
|
|
2975 end pattern may also include an end-of-line. Thus the "oneline" argument
|
|
|
2976 means that the end of the start pattern and the start of the end pattern must
|
|
|
2977 be within one line. This can't be changed by a skip pattern that matches a
|
|
|
2978 line break.
|
|
|
2979
|
|
|
2980
|
|
|
2981 fold *:syn-fold*
|
|
|
2982
|
|
|
2983 The "fold" argument makes the fold level increased by one for this item.
|
|
|
2984 Example: >
|
|
|
2985 :syn region myFold start="{" end="}" transparent fold
|
|
|
2986 :syn sync fromstart
|
|
|
2987 :set foldmethod=syntax
|
|
|
2988 This will make each {} block form one fold.
|
|
|
2989
|
|
|
2990 The fold will start on the line where the item starts, and end where the item
|
|
|
2991 ends. If the start and end are within the same line, there is no fold.
|
|
|
2992 The 'foldnestmax' option limits the nesting of syntax folds.
|
|
|
2993 {not available when Vim was compiled without |+folding| feature}
|
|
|
2994
|
|
|
2995
|
|
|
2996 *:syn-contains* *E405* *E406* *E407* *E408* *E409*
|
|
|
2997 contains={groupname},..
|
|
|
2998
|
|
|
2999 The "contains" argument is followed by a list of syntax group names. These
|
|
|
3000 groups will be allowed to begin inside the item (they may extend past the
|
|
|
3001 containing group's end). This allows for recursive nesting of matches and
|
|
|
3002 regions. If there is no "contains" argument, no groups will be contained in
|
|
|
3003 this item. The group names do not need to be defined before they can be used
|
|
|
3004 here.
|
|
|
3005
|
|
|
3006 contains=ALL
|
|
|
3007 If the only item in the contains list is "ALL", then all
|
|
|
3008 groups will be accepted inside the item.
|
|
|
3009
|
|
|
3010 contains=ALLBUT,{group-name},..
|
|
|
3011 If the first item in the contains list is "ALLBUT", then all
|
|
|
3012 groups will be accepted inside the item, except the ones that
|
|
|
3013 are listed. Example: >
|
|
|
3014 :syntax region Block start="{" end="}" ... contains=ALLBUT,Function
|
|
|
3015
|
|
|
3016 contains=TOP
|
|
|
3017 If the first item in the contains list is "TOP", then all
|
|
|
3018 groups will be accepted that don't have the "contained"
|
|
|
3019 argument.
|
|
|
3020 contains=TOP,{group-name},..
|
|
|
3021 Like "TOP", but excluding the groups that are listed.
|
|
|
3022
|
|
|
3023 contains=CONTAINED
|
|
|
3024 If the first item in the contains list is "CONTAINED", then
|
|
|
3025 all groups will be accepted that have the "contained"
|
|
|
3026 argument.
|
|
|
3027 contains=CONTAINED,{group-name},..
|
|
|
3028 Like "CONTAINED", but excluding the groups that are
|
|
|
3029 listed.
|
|
|
3030
|
|
|
3031
|
|
|
3032 The {group-name} in the "contains" list can be a pattern. All group names
|
|
|
3033 that match the pattern will be included (or excluded, if "ALLBUT" is used).
|
|
|
3034 The pattern cannot contain white space or a ','. Example: >
|
|
|
3035 ... contains=Comment.*,Keyw[0-3]
|
|
|
3036 The matching will be done at moment the syntax command is executed. Groups
|
|
|
3037 that are defined later will not be matched. Also, if the current syntax
|
|
|
3038 command defines a new group, it is not matched. Be careful: When putting
|
|
|
3039 syntax commands in a file you can't rely on groups NOT being defined, because
|
|
|
3040 the file may have been sourced before, and ":syn clear" doesn't remove the
|
|
|
3041 group names.
|
|
|
3042
|
|
|
3043 The contained groups will also match in the start and end patterns of a
|
|
|
3044 region. If this is not wanted, the "matchgroup" argument can be used
|
|
|
3045 |:syn-matchgroup|. The "ms=" and "me=" offsets can be used to change the
|
|
|
3046 region where contained items do match. Note that this may also limit the
|
|
|
3047 area that is highlighted
|
|
|
3048
|
|
|
3049
|
|
|
3050 containedin={groupname}... *:syn-containedin*
|
|
|
3051
|
|
|
3052 The "containedin" argument is followed by a list of syntax group names. The
|
|
|
3053 item will be allowed to begin inside these groups. This works as if the
|
|
|
3054 containing item has a "contains=" argument that includes this item.
|
|
|
3055
|
|
|
3056 The {groupname}... can be used just like for "contains", as explained above.
|
|
|
3057
|
|
|
3058 This is useful when adding a syntax item afterwards. An item can be told to
|
|
|
3059 be included inside an already existing item, without changing the definition
|
|
|
3060 of that item. For example, to highlight a word in a C comment after loading
|
|
|
3061 the C syntax: >
|
|
|
3062 :syn keyword myword HELP containedin=cComment contained
|
|
|
3063 Note that "contained" is also used, to avoid that the item matches at the top
|
|
|
3064 level.
|
|
|
3065
|
|
|
3066 Matches for "containedin" are added to the other places where the item can
|
|
|
3067 appear. A "contains" argument may also be added as usual. Don't forget that
|
|
|
3068 keywords never contain another item, thus adding them to "containedin" won't
|
|
|
3069 work.
|
|
|
3070
|
|
|
3071
|
|
|
3072 nextgroup={groupname},.. *:syn-nextgroup*
|
|
|
3073
|
|
|
3074 The "nextgroup" argument is followed by a list of syntax group names,
|
|
|
3075 separated by commas (just like with "contains", so you can also use patterns).
|
|
|
3076
|
|
|
3077 If the "nextgroup" argument is given, the mentioned syntax groups will be
|
|
|
3078 tried for a match, after the match or region ends. If none of the groups have
|
|
|
3079 a match, highlighting continues normally. If there is a match, this group
|
|
|
3080 will be used, even when it is not mentioned in the "contains" field of the
|
|
|
3081 current group. This is like giving the mentioned group priority over all
|
|
|
3082 other groups. Example: >
|
|
|
3083 :syntax match ccFoobar "Foo.\{-}Bar" contains=ccFoo
|
|
|
3084 :syntax match ccFoo "Foo" contained nextgroup=ccFiller
|
|
|
3085 :syntax region ccFiller start="." matchgroup=ccBar end="Bar" contained
|
|
|
3086
|
|
|
3087 This will highlight "Foo" and "Bar" differently, and only when there is a
|
|
|
3088 "Bar" after "Foo". In the text line below, "f" shows where ccFoo is used for
|
|
|
3089 highlighting, and "bbb" where ccBar is used. >
|
|
|
3090
|
|
|
3091 Foo asdfasd Bar asdf Foo asdf Bar asdf
|
|
|
3092 fff bbb fff bbb
|
|
|
3093
|
|
|
3094 Note the use of ".\{-}" to skip as little as possible until the next Bar.
|
|
|
3095 when ".*" would be used, the "asdf" in between "Bar" and "Foo" would be
|
|
|
3096 highlighted according to the "ccFoobar" group, because the ccFooBar match
|
|
|
3097 would include the first "Foo" and the last "Bar" in the line (see |pattern|).
|
|
|
3098
|
|
|
3099
|
|
|
3100 skipwhite *:syn-skipwhite*
|
|
|
3101 skipnl *:syn-skipnl*
|
|
|
3102 skipempty *:syn-skipempty*
|
|
|
3103
|
|
|
3104 These arguments are only used in combination with "nextgroup". They can be
|
|
|
3105 used to allow the next group to match after skipping some text:
|
|
|
3106 skipwhite skip over space and Tab characters
|
|
|
3107 skipnl skip over the end of a line
|
|
|
3108 skipempty skip over empty lines (implies a "skipnl")
|
|
|
3109
|
|
|
3110 When "skipwhite" is present, the white space is only skipped if there is no
|
|
|
3111 next group that matches the white space.
|
|
|
3112
|
|
|
3113 When "skipnl" is present, the match with nextgroup may be found in the next
|
|
|
3114 line. This only happens when the current item ends at the end of the current
|
|
|
3115 line! When "skipnl" is not present, the nextgroup will only be found after
|
|
|
3116 the current item in the same line.
|
|
|
3117
|
|
|
3118 When skipping text while looking for a next group, the matches for other
|
|
|
3119 groups are ignored. Only when no next group matches, other items are tried
|
|
|
3120 for a match again. This means that matching a next group and skipping white
|
|
|
3121 space and <EOL>s has a higher priority than other items.
|
|
|
3122
|
|
|
3123 Example: >
|
|
|
3124 :syn match ifstart "\<if.*" nextgroup=ifline skipwhite skipempty
|
|
|
3125 :syn match ifline "[^ \t].*" nextgroup=ifline skipwhite skipempty contained
|
|
|
3126 :syn match ifline "endif" contained
|
|
|
3127 Note that the "[^ \t].*" match matches all non-white text. Thus it would also
|
|
|
3128 match "endif". Therefore the "endif" match is put last, so that it takes
|
|
|
3129 precedence.
|
|
|
3130 Note that this example doesn't work for nested "if"s. You need to add
|
|
|
3131 "contains" arguments to make that work (omitted for simplicity of the
|
|
|
3132 example).
|
|
|
3133
|
|
|
3134 ==============================================================================
|
|
|
3135 7. Syntax patterns *:syn-pattern* *E401* *E402*
|
|
|
3136
|
|
|
3137 In the syntax commands, a pattern must be surrounded by two identical
|
|
|
3138 characters. This is like it works for the ":s" command. The most common to
|
|
|
3139 use is the double quote. But if the pattern contains a double quote, you can
|
|
|
3140 use another character that is not used in the pattern. Examples: >
|
|
|
3141 :syntax region Comment start="/\*" end="\*/"
|
|
|
3142 :syntax region String start=+"+ end=+"+ skip=+\\"+
|
|
|
3143
|
|
|
3144 See |pattern| for the explanation of what a pattern is. Syntax patterns are
|
|
|
3145 always interpreted like the 'magic' options is set, no matter what the actual
|
|
|
3146 value of 'magic' is. And the patterns are interpreted like the 'l' flag is
|
|
|
3147 not included in 'cpoptions'. This was done to make syntax files portable and
|
|
|
3148 independent of 'compatible' and 'magic' settings.
|
|
|
3149
|
|
|
3150 Try to avoid patterns that can match an empty string, such as "[a-z]*".
|
|
|
3151 This slows down the highlighting a lot, because it matches everywhere.
|
|
|
3152
|
|
|
3153 *:syn-pattern-offset*
|
|
|
3154 The pattern can be followed by a character offset. This can be used to
|
|
|
3155 change the highlighted part, and to change the text area included in the
|
|
|
3156 match or region (which only matters when trying to match other items). Both
|
|
|
3157 are relative to the matched pattern. The character offset for a skip
|
|
|
3158 pattern can be used to tell where to continue looking for an end pattern.
|
|
|
3159
|
|
|
3160 The offset takes the form of "{what}={offset}"
|
|
|
3161 The {what} can be one of seven strings:
|
|
|
3162
|
|
|
3163 ms Match Start offset for the start of the matched text
|
|
|
3164 me Match End offset for the end of the matched text
|
|
|
3165 hs Highlight Start offset for where the highlighting starts
|
|
|
3166 he Highlight End offset for where the highlighting ends
|
|
|
3167 rs Region Start offset for where the body of a region starts
|
|
|
3168 re Region End offset for where the body of a region ends
|
|
|
3169 lc Leading Context offset past "leading context" of pattern
|
|
|
3170
|
|
|
3171 The {offset} can be:
|
|
|
3172
|
|
|
3173 s start of the matched pattern
|
|
|
3174 s+{nr} start of the matched pattern plus {nr} chars to the right
|
|
|
3175 s-{nr} start of the matched pattern plus {nr} chars to the left
|
|
|
3176 e end of the matched pattern
|
|
|
3177 e+{nr} end of the matched pattern plus {nr} chars to the right
|
|
|
3178 e-{nr} end of the matched pattern plus {nr} chars to the left
|
|
|
3179 {nr} (for "lc" only): start matching {nr} chars to the left
|
|
|
3180
|
|
|
3181 Examples: "ms=s+1", "hs=e-2", "lc=3".
|
|
|
3182
|
|
|
3183 Although all offsets are accepted after any pattern, they are not always
|
|
|
3184 meaningful. This table shows which offsets are actually used:
|
|
|
3185
|
|
|
3186 ms me hs he rs re lc ~
|
|
|
3187 match item yes yes yes yes - - yes
|
|
|
3188 region item start yes - yes - yes - yes
|
|
|
3189 region item skip - yes - - - - yes
|
|
|
3190 region item end - yes - yes - yes yes
|
|
|
3191
|
|
|
3192 Offsets can be concatenated, with a ',' in between. Example: >
|
|
|
3193 :syn match String /"[^"]*"/hs=s+1,he=e-1
|
|
|
3194 <
|
|
|
3195 some "string" text
|
|
|
3196 ^^^^^^ highlighted
|
|
|
3197
|
|
|
3198 Notes:
|
|
|
3199 - There must be no white space between the pattern and the character
|
|
|
3200 offset(s).
|
|
|
3201 - The highlighted area will never be outside of the matched text.
|
|
|
3202 - A negative offset for an end pattern may not always work, because the end
|
|
|
3203 pattern may be detected when the highlighting should already have stopped.
|
|
|
3204 - The start of a match cannot be in a line other than where the pattern
|
|
|
3205 matched. This doesn't work: "a\nb"ms=e. You can make the highlighting
|
|
|
3206 start in another line, this does work: "a\nb"hs=e.
|
|
|
3207
|
|
|
3208 Example (match a comment but don't highlight the /* and */): >
|
|
|
3209 :syntax region Comment start="/\*"hs=e+1 end="\*/"he=s-1
|
|
|
3210 <
|
|
|
3211 /* this is a comment */
|
|
|
3212 ^^^^^^^^^^^^^^^^^^^ highlighted
|
|
|
3213
|
|
|
3214 A more complicated Example: >
|
|
|
3215 :syn region Exa matchgroup=Foo start="foo"hs=s+2,rs=e+2 matchgroup=Bar end="bar"me=e-1,he=e-1,re=s-1
|
|
|
3216 <
|
|
|
3217 abcfoostringbarabc
|
|
|
3218 mmmmmmmmmmm match
|
|
|
3219 ssrrrreee highlight start/region/end ("Foo", "Exa" and "Bar")
|
|
|
3220
|
|
|
3221 Leading context *:syn-lc* *:syn-leading* *:syn-context*
|
|
|
3222
|
|
|
3223 Note: This is an obsolete feature, only included for backwards compatibility
|
|
|
3224 with previous Vim versions. It's now recommended to use the |/\@<=| construct
|
|
|
3225 in the pattern.
|
|
|
3226
|
|
|
3227 The "lc" offset specifies leading context -- a part of the pattern that must
|
|
|
3228 be present, but is not considered part of the match. An offset of "lc=n" will
|
|
|
3229 cause Vim to step back n columns before attempting the pattern match, allowing
|
|
|
3230 characters which have already been matched in previous patterns to also be
|
|
|
3231 used as leading context for this match. This can be used, for instance, to
|
|
|
3232 specify that an "escaping" character must not precede the match: >
|
|
|
3233
|
|
|
3234 :syn match ZNoBackslash "[^\\]z"ms=s+1
|
|
|
3235 :syn match WNoBackslash "[^\\]w"lc=1
|
|
|
3236 :syn match Underline "_\+"
|
|
|
3237 <
|
|
|
3238 ___zzzz ___wwww
|
|
|
3239 ^^^ ^^^ matches Underline
|
|
|
3240 ^ ^ matches ZNoBackslash
|
|
|
3241 ^^^^ matches WNoBackslash
|
|
|
3242
|
|
|
3243 The "ms" offset is automatically set to the same value as the "lc" offset,
|
|
|
3244 unless you set "ms" explicitly.
|
|
|
3245
|
|
|
3246
|
|
|
3247 Multi-line patterns *:syn-multi-line*
|
|
|
3248
|
|
|
3249 The patterns can include "\n" to match an end-of-line. Mostly this works as
|
|
|
3250 expected, but there are a few exceptions.
|
|
|
3251
|
|
|
3252 When using a start pattern with an offset, the start of the match is not
|
|
|
3253 allowed to start in a following line. The highlighting can start in a
|
|
|
3254 following line though.
|
|
|
3255
|
|
|
3256 The skip pattern can include the "\n", but the search for an end pattern will
|
|
|
3257 continue in the first character of the next line, also when that character is
|
|
|
3258 matched by the skip pattern. This is because redrawing may start in any line
|
|
|
3259 halfway a region and there is no check if the skip pattern started in a
|
|
|
3260 previous line. For example, if the skip pattern is "a\nb" and an end pattern
|
|
|
3261 is "b", the end pattern does match in the second line of this: >
|
|
|
3262 x x a
|
|
|
3263 b x x
|
|
|
3264 Generally this means that the skip pattern should not match any characters
|
|
|
3265 after the "\n".
|
|
|
3266
|
|
|
3267
|
|
|
3268 External matches *:syn-ext-match*
|
|
|
3269
|
|
|
3270 These extra regular expression items are available in region patterns:
|
|
|
3271
|
|
|
3272 */\z(* */\z(\)* *E50* *E52*
|
|
|
3273 \z(\) Marks the sub-expression as "external", meaning that it is can
|
|
|
3274 be accessed from another pattern match. Currently only usable
|
|
|
3275 in defining a syntax region start pattern.
|
|
|
3276
|
|
|
3277 */\z1* */\z2* */\z3* */\z4* */\z5*
|
|
|
3278 \z1 ... \z9 */\z6* */\z7* */\z8* */\z9* *E66* *E67*
|
|
|
3279 Matches the same string that was matched by the corresponding
|
|
|
3280 sub-expression in a previous start pattern match.
|
|
|
3281
|
|
|
3282 Sometimes the start and end patterns of a region need to share a common
|
|
|
3283 sub-expression. A common example is the "here" document in Perl and many Unix
|
|
|
3284 shells. This effect can be achieved with the "\z" special regular expression
|
|
|
3285 items, which marks a sub-expression as "external", in the sense that it can be
|
|
|
3286 referenced from outside the pattern in which it is defined. The here-document
|
|
|
3287 example, for instance, can be done like this: >
|
|
|
3288 :syn region hereDoc start="<<\z(\I\i*\)" end="^\z1$"
|
|
|
3289
|
|
|
3290 As can be seen here, the \z actually does double duty. In the start pattern,
|
|
|
3291 it marks the "\(\I\i*\)" sub-expression as external; in the end pattern, it
|
|
|
3292 changes the \1 back-reference into an external reference referring to the
|
|
|
3293 first external sub-expression in the start pattern. External references can
|
|
|
3294 also be used in skip patterns: >
|
|
|
3295 :syn region foo start="start \(\I\i*\)" skip="not end \z1" end="end \z1"
|
|
|
3296
|
|
|
3297 Note that normal and external sub-expressions are completely orthogonal and
|
|
|
3298 indexed separately; for instance, if the pattern "\z(..\)\(..\)" is applied
|
|
|
3299 to the string "aabb", then \1 will refer to "bb" and \z1 will refer to "aa".
|
|
|
3300 Note also that external sub-expressions cannot be accessed as back-references
|
|
|
3301 within the same pattern like normal sub-expressions. If you want to use one
|
|
|
3302 sub-expression as both a normal and an external sub-expression, you can nest
|
|
|
3303 the two, as in "\(\z(...\)\)".
|
|
|
3304
|
|
|
3305 Note that only matches within a single line can be used. Multi-line matches
|
|
|
3306 cannot be referred to.
|
|
|
3307
|
|
|
3308 ==============================================================================
|
|
|
3309 8. Syntax clusters *:syn-cluster* *E400*
|
|
|
3310
|
|
|
3311 :sy[ntax] cluster {cluster-name} [contains={group-name}..]
|
|
|
3312 [add={group-name}..]
|
|
|
3313 [remove={group-name}..]
|
|
|
3314
|
|
|
3315 This command allows you to cluster a list of syntax groups together under a
|
|
|
3316 single name.
|
|
|
3317
|
|
|
3318 contains={group-name}..
|
|
|
3319 The cluster is set to the specified list of groups.
|
|
|
3320 add={group-name}..
|
|
|
3321 The specified groups are added to the cluster.
|
|
|
3322 remove={group-name}..
|
|
|
3323 The specified groups are removed from the cluster.
|
|
|
3324
|
|
|
3325 A cluster so defined may be referred to in a contains=.., nextgroup=.., add=..
|
|
|
3326 or remove=.. list with a "@" prefix. You can also use this notation to
|
|
|
3327 implicitly declare a cluster before specifying its contents.
|
|
|
3328
|
|
|
3329 Example: >
|
|
|
3330 :syntax match Thing "# [^#]\+ #" contains=@ThingMembers
|
|
|
3331 :syntax cluster ThingMembers contains=ThingMember1,ThingMember2
|
|
|
3332
|
|
|
3333 As the previous example suggests, modifications to a cluster are effectively
|
|
|
3334 retroactive; the membership of the cluster is checked at the last minute, so
|
|
|
3335 to speak: >
|
|
|
3336 :syntax keyword A aaa
|
|
|
3337 :syntax keyword B bbb
|
|
|
3338 :syntax cluster AandB contains=A
|
|
|
3339 :syntax match Stuff "( aaa bbb )" contains=@AandB
|
|
|
3340 :syntax cluster AandB add=B " now both keywords are matched in Stuff
|
|
|
3341
|
|
|
3342 This also has implications for nested clusters: >
|
|
|
3343 :syntax keyword A aaa
|
|
|
3344 :syntax keyword B bbb
|
|
|
3345 :syntax cluster SmallGroup contains=B
|
|
|
3346 :syntax cluster BigGroup contains=A,@SmallGroup
|
|
|
3347 :syntax match Stuff "( aaa bbb )" contains=@BigGroup
|
|
|
3348 :syntax cluster BigGroup remove=B " no effect, since B isn't in BigGroup
|
|
|
3349 :syntax cluster SmallGroup remove=B " now bbb isn't matched within Stuff
|
|
|
3350
|
|
|
3351 ==============================================================================
|
|
|
3352 9. Including syntax files *:syn-include* *E397*
|
|
|
3353
|
|
|
3354 It is often useful for one language's syntax file to include a syntax file for
|
|
|
3355 a related language. Depending on the exact relationship, this can be done in
|
|
|
3356 two different ways:
|
|
|
3357
|
|
|
3358 - If top-level syntax items in the included syntax file are to be
|
|
|
3359 allowed at the top level in the including syntax, you can simply use
|
|
|
3360 the |:runtime| command: >
|
|
|
3361
|
|
|
3362 " In cpp.vim:
|
|
|
3363 :runtime! syntax/c.vim
|
|
|
3364 :unlet b:current_syntax
|
|
|
3365
|
|
|
3366 < - If top-level syntax items in the included syntax file are to be
|
|
|
3367 contained within a region in the including syntax, you can use the
|
|
|
3368 ":syntax include" command:
|
|
|
3369
|
|
|
3370 :sy[ntax] include [@{grouplist-name}] {file-name}
|
|
|
3371
|
|
|
3372 All syntax items declared in the included file will have the
|
|
|
3373 "contained" flag added. In addition, if a group list is specified,
|
|
|
3374 all top-level syntax items in the included file will be added to
|
|
|
3375 that list. >
|
|
|
3376
|
|
|
3377 " In perl.vim:
|
|
|
3378 :syntax include @Pod <sfile>:p:h/pod.vim
|
|
|
3379 :syntax region perlPOD start="^=head" end="^=cut" contains=@Pod
|
|
|
3380 <
|
|
|
3381 When {file-name} is an absolute path (starts with "/", "c:", "$VAR"
|
|
|
3382 or "<sfile>") that file is sourced. When it is a relative path
|
|
|
3383 (e.g., "syntax/pod.vim") the file is searched for in 'runtimepath'.
|
|
|
3384 All matching files are loaded. Using a relative path is
|
|
|
3385 recommended, because it allows a user to replace the included file
|
|
|
3386 with his own version, without replacing the file that does the ":syn
|
|
|
3387 include".
|
|
|
3388
|
|
|
3389 ==============================================================================
|
|
|
3390 10. Synchronizing *:syn-sync* *E403* *E404*
|
|
|
3391
|
|
|
3392 Vim wants to be able to start redrawing in any position in the document. To
|
|
|
3393 make this possible it needs to know the syntax state at the position where
|
|
|
3394 redrawing starts.
|
|
|
3395
|
|
|
3396 :sy[ntax] sync [ccomment [group-name] | minlines={N} | ...]
|
|
|
3397
|
|
|
3398 There are four ways to synchronize:
|
|
|
3399 1. Always parse from the start of the file.
|
|
|
3400 |:syn-sync-first|
|
|
|
3401 2. Based on C-style comments. Vim understands how C-comments work and can
|
|
|
3402 figure out if the current line starts inside or outside a comment.
|
|
|
3403 |:syn-sync-second|
|
|
|
3404 3. Jumping back a certain number of lines and start parsing there.
|
|
|
3405 |:syn-sync-third|
|
|
|
3406 4. Searching backwards in the text for a pattern to sync on.
|
|
|
3407 |:syn-sync-fourth|
|
|
|
3408
|
|
|
3409 *:syn-sync-maxlines* *:syn-sync-minlines*
|
|
|
3410 For the last three methods, the line range where the parsing can start is
|
|
|
3411 limited by "minlines" and "maxlines".
|
|
|
3412
|
|
|
3413 If the "minlines={N}" argument is given, the parsing always starts at least
|
|
|
3414 that many lines backwards. This can be used if the parsing may take a few
|
|
|
3415 lines before it's correct, or when it's not possible to use syncing.
|
|
|
3416
|
|
|
3417 If the "maxlines={N}" argument is given, the number of lines that are searched
|
|
|
3418 for a comment or syncing pattern is restricted to N lines backwards (after
|
|
|
3419 adding "minlines"). This is useful if you have few things to sync on and a
|
|
|
3420 slow machine. Example: >
|
|
|
3421 :syntax sync ccomment maxlines=500
|
|
|
3422 <
|
|
|
3423 *:syn-sync-linebreaks*
|
|
|
3424 When using a pattern that matches multiple lines, a change in one line may
|
|
|
3425 cause a pattern to no longer match in a previous line. This means has to
|
|
|
3426 start above where the change was made. How many lines can be specified with
|
|
|
3427 the "linebreaks" argument. For example, when a pattern may include one line
|
|
|
3428 break use this: >
|
|
|
3429 :syntax sync linebreaks=1
|
|
|
3430 The result is that redrawing always starts at least one line before where a
|
|
|
3431 change was made. The default value for "linebreaks" is zero. Usually the
|
|
|
3432 value for "minlines" is bigger than "linebreaks".
|
|
|
3433
|
|
|
3434
|
|
|
3435 First syncing method: *:syn-sync-first*
|
|
|
3436 >
|
|
|
3437 :syntax sync fromstart
|
|
|
3438
|
|
|
3439 The file will be parsed from the start. This makes syntax highlighting
|
|
|
3440 accurate, but can be slow for long files. Vim caches previously parsed text,
|
|
|
3441 so that it's only slow when parsing the text for the first time. However,
|
|
|
3442 when making changes some part of the next needs to be parsed again (worst
|
|
|
3443 case: to the end of the file).
|
|
|
3444
|
|
|
3445 Using "fromstart" is equivalent to using "minlines" with a very large number.
|
|
|
3446
|
|
|
3447
|
|
|
3448 Second syncing method: *:syn-sync-second* *:syn-sync-ccomment*
|
|
|
3449
|
|
|
3450 For the second method, only the "ccomment" argument needs to be given.
|
|
|
3451 Example: >
|
|
|
3452 :syntax sync ccomment
|
|
|
3453
|
|
|
3454 When Vim finds that the line where displaying starts is inside a C-style
|
|
|
3455 comment, the last region syntax item with the group-name "Comment" will be
|
|
|
3456 used. This requires that there is a region with the group-name "Comment"!
|
|
|
3457 An alternate group name can be specified, for example: >
|
|
|
3458 :syntax sync ccomment javaComment
|
|
|
3459 This means that the last item specified with "syn region javaComment" will be
|
|
|
3460 used for the detected C comment region. This only works properly if that
|
|
|
3461 region does have a start pattern "\/*" and an end pattern "*\/".
|
|
|
3462
|
|
|
3463 The "maxlines" argument can be used to restrict the search to a number of
|
|
|
3464 lines. The "minlines" argument can be used to at least start a number of
|
|
|
3465 lines back (e.g., for when there is some construct that only takes a few
|
|
|
3466 lines, but it hard to sync on).
|
|
|
3467
|
|
|
3468 Note: Syncing on a C comment doesn't work properly when strings are used
|
|
|
3469 that cross a line and contain a "*/". Since letting strings cross a line
|
|
|
3470 is a bad programming habit (many compilers give a warning message), and the
|
|
|
3471 chance of a "*/" appearing inside a comment is very small, this restriction
|
|
|
3472 is hardly ever noticed.
|
|
|
3473
|
|
|
3474
|
|
|
3475 Third syncing method: *:syn-sync-third*
|
|
|
3476
|
|
|
3477 For the third method, only the "minlines={N}" argument needs to be given.
|
|
|
3478 Vim will subtract {N} from the line number and start parsing there. This
|
|
|
3479 means {N} extra lines need to be parsed, which makes this method a bit slower.
|
|
|
3480 Example: >
|
|
|
3481 :syntax sync minlines=50
|
|
|
3482
|
|
|
3483 "lines" is equivalent to "minlines" (used by older versions).
|
|
|
3484
|
|
|
3485
|
|
|
3486 Fourth syncing method: *:syn-sync-fourth*
|
|
|
3487
|
|
|
3488 The idea is to synchronize on the end of a few specific regions, called a
|
|
|
3489 sync pattern. Only regions can cross lines, so when we find the end of some
|
|
|
3490 region, we might be able to know in which syntax item we are. The search
|
|
|
3491 starts in the line just above the one where redrawing starts. From there
|
|
|
3492 the search continues backwards in the file.
|
|
|
3493
|
|
|
3494 This works just like the non-syncing syntax items. You can use contained
|
|
|
3495 matches, nextgroup, etc. But there are a few differences:
|
|
|
3496 - Keywords cannot be used.
|
|
|
3497 - The syntax items with the "sync" keyword form a completely separated group
|
|
|
3498 of syntax items. You can't mix syncing groups and non-syncing groups.
|
|
|
3499 - The matching works backwards in the buffer (line by line), instead of
|
|
|
3500 forwards.
|
|
|
3501 - A line continuation pattern can be given. It is used to decide which group
|
|
|
3502 of lines need to be searched like they were one line. This means that the
|
|
|
3503 search for a match with the specified items starts in the first of the
|
|
|
3504 consecutive that contain the continuation pattern.
|
|
|
3505 - When using "nextgroup" or "contains", this only works within one line (or
|
|
|
3506 group of continued lines).
|
|
|
3507 - When using a region, it must start and end in the same line (or group of
|
|
|
3508 continued lines). Otherwise the end is assumed to be at the end of the
|
|
|
3509 line (or group of continued lines).
|
|
|
3510 - When a match with a sync pattern is found, the rest of the line (or group of
|
|
|
3511 continued lines) is searched for another match. The last match is used.
|
|
|
3512 This is used when a line can contain both the start end the end of a region
|
|
|
3513 (e.g., in a C-comment like /* this */, the last "*/" is used).
|
|
|
3514
|
|
|
3515 There are two ways how a match with a sync pattern can be used:
|
|
|
3516 1. Parsing for highlighting starts where redrawing starts (and where the
|
|
|
3517 search for the sync pattern started). The syntax group that is expected
|
|
|
3518 to be valid there must be specified. This works well when the regions
|
|
|
3519 that cross lines cannot contain other regions.
|
|
|
3520 2. Parsing for highlighting continues just after the match. The syntax group
|
|
|
3521 that is expected to be present just after the match must be specified.
|
|
|
3522 This can be used when the previous method doesn't work well. It's much
|
|
|
3523 slower, because more text needs to be parsed.
|
|
|
3524 Both types of sync patterns can be used at the same time.
|
|
|
3525
|
|
|
3526 Besides the sync patterns, other matches and regions can be specified, to
|
|
|
3527 avoid finding unwanted matches.
|
|
|
3528
|
|
|
3529 [The reason that the sync patterns are given separately, is that mostly the
|
|
|
3530 search for the sync point can be much simpler than figuring out the
|
|
|
3531 highlighting. The reduced number of patterns means it will go (much)
|
|
|
3532 faster.]
|
|
|
3533
|
|
|
3534 *syn-sync-grouphere* *E393* *E394*
|
|
|
3535 :syntax sync match {sync-group-name} grouphere {group-name} "pattern" ..
|
|
|
3536
|
|
|
3537 Define a match that is used for syncing. {group-name} is the
|
|
|
3538 name of a syntax group that follows just after the match. Parsing
|
|
|
3539 of the text for highlighting starts just after the match. A region
|
|
|
3540 must exist for this {group-name}. The first one defined will be used.
|
|
|
3541 "NONE" can be used for when there is no syntax group after the match.
|
|
|
3542
|
|
|
3543 *syn-sync-groupthere*
|
|
|
3544 :syntax sync match {sync-group-name} groupthere {group-name} "pattern" ..
|
|
|
3545
|
|
|
3546 Like "grouphere", but {group-name} is the name of a syntax group that
|
|
|
3547 is to be used at the start of the line where searching for the sync
|
|
|
3548 point started. The text between the match and the start of the sync
|
|
|
3549 pattern searching is assumed not to change the syntax highlighting.
|
|
|
3550 For example, in C you could search backwards for "/*" and "*/". If
|
|
|
3551 "/*" is found first, you know that you are inside a comment, so the
|
|
|
3552 "groupthere" is "cComment". If "*/" is found first, you know that you
|
|
|
3553 are not in a comment, so the "groupthere" is "NONE". (in practice
|
|
|
3554 it's a bit more complicated, because the "/*" and "*/" could appear
|
|
|
3555 inside a string. That's left as an exercise to the reader...).
|
|
|
3556
|
|
|
3557 :syntax sync match ..
|
|
|
3558 :syntax sync region ..
|
|
|
3559
|
|
|
3560 Without a "groupthere" argument. Define a region or match that is
|
|
|
3561 skipped while searching for a sync point.
|
|
|
3562
|
|
169
|
3563 *syn-sync-linecont*
|
|
7
|
3564 :syntax sync linecont {pattern}
|
|
|
3565
|
|
|
3566 When {pattern} matches in a line, it is considered to continue in
|
|
|
3567 the next line. This means that the search for a sync point will
|
|
|
3568 consider the lines to be concatenated.
|
|
|
3569
|
|
|
3570 If the "maxlines={N}" argument is given too, the number of lines that are
|
|
|
3571 searched for a match is restricted to N. This is useful if you have very
|
|
|
3572 few things to sync on and a slow machine. Example: >
|
|
|
3573 :syntax sync maxlines=100
|
|
|
3574
|
|
|
3575 You can clear all sync settings with: >
|
|
|
3576 :syntax sync clear
|
|
|
3577
|
|
|
3578 You can clear specific sync patterns with: >
|
|
|
3579 :syntax sync clear {sync-group-name} ..
|
|
|
3580
|
|
|
3581 ==============================================================================
|
|
|
3582 11. Listing syntax items *:syntax* *:sy* *:syn* *:syn-list*
|
|
|
3583
|
|
534
|
3584 This command lists all the syntax items: >
|
|
7
|
3585
|
|
|
3586 :sy[ntax] [list]
|
|
|
3587
|
|
|
3588 To show the syntax items for one syntax group: >
|
|
|
3589
|
|
|
3590 :sy[ntax] list {group-name}
|
|
|
3591
|
|
|
3592 To list the syntax groups in one cluster: *E392* >
|
|
|
3593
|
|
|
3594 :sy[ntax] list @{cluster-name}
|
|
|
3595
|
|
|
3596 See above for other arguments for the ":syntax" command.
|
|
|
3597
|
|
|
3598 Note that the ":syntax" command can be abbreviated to ":sy", although ":syn"
|
|
|
3599 is mostly used, because it looks better.
|
|
|
3600
|
|
|
3601 ==============================================================================
|
|
|
3602 12. Highlight command *:highlight* *:hi* *E28* *E411* *E415*
|
|
|
3603
|
|
|
3604 There are three types of highlight groups:
|
|
|
3605 - The ones used for specific languages. For these the name starts with the
|
|
|
3606 name of the language. Many of these don't have any attributes, but are
|
|
|
3607 linked to a group of the second type.
|
|
|
3608 - The ones used for all syntax languages.
|
|
|
3609 - The ones used for the 'highlight' option.
|
|
|
3610 *hitest.vim*
|
|
|
3611 You can see all the groups currently active with this command: >
|
|
|
3612 :so $VIMRUNTIME/syntax/hitest.vim
|
|
|
3613 This will open a new window containing all highlight group names, displayed
|
|
|
3614 in their own color.
|
|
|
3615
|
|
|
3616 *:colo* *:colorscheme* *E185*
|
|
|
3617 :colo[rscheme] {name} Load color scheme {name}. This searches 'runtimepath'
|
|
|
3618 for the file "colors/{name}.vim. The first one that
|
|
|
3619 is found is loaded.
|
|
|
3620 To see the name of the currently active color scheme
|
|
|
3621 (if there is one): >
|
|
|
3622 :echo g:colors_name
|
|
|
3623 < Doesn't work recursively, thus you can't use
|
|
|
3624 ":colorscheme" in a color scheme script.
|
|
12
|
3625 After the color scheme has been loaded the
|
|
|
3626 |ColorScheme| autocommand event is triggered.
|
|
22
|
3627 For info about writing a colorscheme file: >
|
|
|
3628 :edit $VIMRUNTIME/colors/README.txt
|
|
7
|
3629
|
|
|
3630 :hi[ghlight] List all the current highlight groups that have
|
|
|
3631 attributes set.
|
|
|
3632
|
|
|
3633 :hi[ghlight] {group-name}
|
|
|
3634 List one highlight group.
|
|
|
3635
|
|
|
3636 :hi[ghlight] clear Reset all highlighting to the defaults. Removes all
|
|
|
3637 highlighting for groups added by the user!
|
|
|
3638 Uses the current value of 'background' to decide which
|
|
|
3639 default colors to use.
|
|
|
3640
|
|
|
3641 :hi[ghlight] clear {group-name}
|
|
|
3642 :hi[ghlight] {group-name} NONE
|
|
|
3643 Disable the highlighting for one highlight group. It
|
|
|
3644 is _not_ set back to the default colors.
|
|
|
3645
|
|
|
3646 :hi[ghlight] [default] {group-name} {key}={arg} ..
|
|
|
3647 Add a highlight group, or change the highlighting for
|
|
|
3648 an existing group.
|
|
|
3649 See |highlight-args| for the {key}={arg} arguments.
|
|
|
3650 See |:highlight-default| for the optional [default]
|
|
|
3651 argument.
|
|
|
3652
|
|
|
3653 Normally a highlight group is added once when starting up. This sets the
|
|
|
3654 default values for the highlighting. After that, you can use additional
|
|
|
3655 highlight commands to change the arguments that you want to set to non-default
|
|
|
3656 values. The value "NONE" can be used to switch the value off or go back to
|
|
|
3657 the default value.
|
|
|
3658
|
|
|
3659 A simple way to change colors is with the |:colorscheme| command. This loads
|
|
|
3660 a file with ":highlight" commands such as this: >
|
|
|
3661
|
|
|
3662 :hi Comment gui=bold
|
|
|
3663
|
|
|
3664 Note that all settings that are not included remain the same, only the
|
|
|
3665 specified field is used, and settings are merged with previous ones. So, the
|
|
|
3666 result is like this single command has been used: >
|
|
|
3667 :hi Comment term=bold ctermfg=Cyan guifg=#80a0ff gui=bold
|
|
|
3668 <
|
|
481
|
3669 *:highlight-verbose*
|
|
448
|
3670 When listing a highlight group and 'verbose' is non-zero, the listing will
|
|
|
3671 also tell where it was last set. Example: >
|
|
|
3672 :verbose hi Comment
|
|
|
3673 < Comment xxx term=bold ctermfg=4 guifg=Blue ~
|
|
|
3674 Last set from /home/mool/vim/vim7/runtime/syntax/syncolor.vim ~
|
|
|
3675
|
|
484
|
3676 When ":hi clear" is used then the script where this command is used will be
|
|
|
3677 mentioned for the default values. See |:verbose-cmd| for more information.
|
|
448
|
3678
|
|
7
|
3679 *highlight-args* *E416* *E417* *E423*
|
|
|
3680 There are three types of terminals for highlighting:
|
|
|
3681 term a normal terminal (vt100, xterm)
|
|
|
3682 cterm a color terminal (MS-DOS console, color-xterm, these have the "Co"
|
|
|
3683 termcap entry)
|
|
|
3684 gui the GUI
|
|
|
3685
|
|
|
3686 For each type the highlighting can be given. This makes it possible to use
|
|
|
3687 the same syntax file on all terminals, and use the optimal highlighting.
|
|
|
3688
|
|
|
3689 1. highlight arguments for normal terminals
|
|
|
3690
|
|
301
|
3691 *bold* *underline* *undercurl*
|
|
|
3692 *inverse* *italic* *standout*
|
|
7
|
3693 term={attr-list} *attr-list* *highlight-term* *E418*
|
|
|
3694 attr-list is a comma separated list (without spaces) of the
|
|
|
3695 following items (in any order):
|
|
|
3696 bold
|
|
|
3697 underline
|
|
217
|
3698 undercurl not always available
|
|
7
|
3699 reverse
|
|
|
3700 inverse same as reverse
|
|
|
3701 italic
|
|
|
3702 standout
|
|
|
3703 NONE no attributes used (used to reset it)
|
|
|
3704
|
|
|
3705 Note that "bold" can be used here and by using a bold font. They
|
|
|
3706 have the same effect.
|
|
217
|
3707 "undercurl" is a curly underline. When "undercurl" is not possible
|
|
|
3708 then "underline" is used. In general "undercurl" is only available in
|
|
|
3709 the GUI.
|
|
7
|
3710
|
|
|
3711 start={term-list} *highlight-start* *E422*
|
|
|
3712 stop={term-list} *term-list* *highlight-stop*
|
|
|
3713 These lists of terminal codes can be used to get
|
|
|
3714 non-standard attributes on a terminal.
|
|
|
3715
|
|
|
3716 The escape sequence specified with the "start" argument
|
|
|
3717 is written before the characters in the highlighted
|
|
|
3718 area. It can be anything that you want to send to the
|
|
|
3719 terminal to highlight this area. The escape sequence
|
|
|
3720 specified with the "stop" argument is written after the
|
|
|
3721 highlighted area. This should undo the "start" argument.
|
|
|
3722 Otherwise the screen will look messed up.
|
|
|
3723
|
|
|
3724 The {term-list} can have two forms:
|
|
|
3725
|
|
|
3726 1. A string with escape sequences.
|
|
|
3727 This is any string of characters, except that it can't start with
|
|
|
3728 "t_" and blanks are not allowed. The <> notation is recognized
|
|
|
3729 here, so you can use things like "<Esc>" and "<Space>". Example:
|
|
|
3730 start=<Esc>[27h;<Esc>[<Space>r;
|
|
|
3731
|
|
|
3732 2. A list of terminal codes.
|
|
|
3733 Each terminal code has the form "t_xx", where "xx" is the name of
|
|
|
3734 the termcap entry. The codes have to be separated with commas.
|
|
|
3735 White space is not allowed. Example:
|
|
|
3736 start=t_C1,t_BL
|
|
|
3737 The terminal codes must exist for this to work.
|
|
|
3738
|
|
|
3739
|
|
|
3740 2. highlight arguments for color terminals
|
|
|
3741
|
|
|
3742 cterm={attr-list} *highlight-cterm*
|
|
|
3743 See above for the description of {attr-list} |attr-list|.
|
|
|
3744 The "cterm" argument is likely to be different from "term", when
|
|
|
3745 colors are used. For example, in a normal terminal comments could
|
|
|
3746 be underlined, in a color terminal they can be made Blue.
|
|
|
3747 Note: Many terminals (e.g., DOS console) can't mix these attributes
|
|
|
3748 with coloring. Use only one of "cterm=" OR "ctermfg=" OR "ctermbg=".
|
|
|
3749
|
|
|
3750 ctermfg={color-nr} *highlight-ctermfg* *E421*
|
|
|
3751 ctermbg={color-nr} *highlight-ctermbg*
|
|
|
3752 The {color-nr} argument is a color number. Its range is zero to
|
|
|
3753 (not including) the number given by the termcap entry "Co".
|
|
|
3754 The actual color with this number depends on the type of terminal
|
|
|
3755 and its settings. Sometimes the color also depends on the settings of
|
|
|
3756 "cterm". For example, on some systems "cterm=bold ctermfg=3" gives
|
|
|
3757 another color, on others you just get color 3.
|
|
|
3758
|
|
|
3759 For an xterm this depends on your resources, and is a bit
|
|
|
3760 unpredictable. See your xterm documentation for the defaults. The
|
|
|
3761 colors for a color-xterm can be changed from the .Xdefaults file.
|
|
|
3762 Unfortunately this means that it's not possible to get the same colors
|
|
|
3763 for each user. See |xterm-color| for info about color xterms.
|
|
|
3764
|
|
|
3765 The MSDOS standard colors are fixed (in a console window), so these
|
|
|
3766 have been used for the names. But the meaning of color names in X11
|
|
|
3767 are fixed, so these color settings have been used, to make the
|
|
|
3768 highlighting settings portable (complicated, isn't it?). The
|
|
|
3769 following names are recognized, with the color number used:
|
|
|
3770
|
|
|
3771 *cterm-colors*
|
|
|
3772 NR-16 NR-8 COLOR NAME ~
|
|
|
3773 0 0 Black
|
|
|
3774 1 4 DarkBlue
|
|
|
3775 2 2 DarkGreen
|
|
|
3776 3 6 DarkCyan
|
|
|
3777 4 1 DarkRed
|
|
|
3778 5 5 DarkMagenta
|
|
|
3779 6 3 Brown, DarkYellow
|
|
|
3780 7 7 LightGray, LightGrey, Gray, Grey
|
|
|
3781 8 0* DarkGray, DarkGrey
|
|
|
3782 9 4* Blue, LightBlue
|
|
|
3783 10 2* Green, LightGreen
|
|
|
3784 11 6* Cyan, LightCyan
|
|
|
3785 12 1* Red, LightRed
|
|
|
3786 13 5* Magenta, LightMagenta
|
|
|
3787 14 3* Yellow, LightYellow
|
|
|
3788 15 7* White
|
|
|
3789
|
|
|
3790 The number under "NR-16" is used for 16-color terminals ('t_Co'
|
|
|
3791 greater than or equal to 16). The number under "NR-8" is used for
|
|
|
3792 8-color terminals ('t_Co' less than 16). The '*' indicates that the
|
|
|
3793 bold attribute is set for ctermfg. In many 8-color terminals (e.g.,
|
|
|
3794 "linux"), this causes the bright colors to appear. This doesn't work
|
|
|
3795 for background colors! Without the '*' the bold attribute is removed.
|
|
|
3796 If you want to set the bold attribute in a different way, put a
|
|
|
3797 "cterm=" argument AFTER the "ctermfg=" or "ctermbg=" argument. Or use
|
|
|
3798 a number instead of a color name.
|
|
|
3799
|
|
|
3800 The case of the color names is ignored.
|
|
|
3801 Note that for 16 color ansi style terminals (including xterms), the
|
|
237
|
3802 numbers in the NR-8 column is used. Here '*' means 'add 8' so that Blue
|
|
7
|
3803 is 12, DarkGray is 8 etc.
|
|
|
3804
|
|
|
3805 Note that for some color terminals these names may result in the wrong
|
|
|
3806 colors!
|
|
|
3807
|
|
|
3808 *:hi-normal-cterm*
|
|
|
3809 When setting the "ctermfg" or "ctermbg" colors for the Normal group,
|
|
|
3810 these will become the colors used for the non-highlighted text.
|
|
|
3811 Example: >
|
|
|
3812 :highlight Normal ctermfg=grey ctermbg=darkblue
|
|
|
3813 < When setting the "ctermbg" color for the Normal group, the
|
|
|
3814 'background' option will be adjusted automatically. This causes the
|
|
|
3815 highlight groups that depend on 'background' to change! This means
|
|
|
3816 you should set the colors for Normal first, before setting other
|
|
|
3817 colors.
|
|
|
3818 When a colorscheme is being used, changing 'background' causes it to
|
|
|
3819 be reloaded, which may reset all colors (including Normal). First
|
|
|
3820 delete the "colors_name" variable when you don't want this.
|
|
|
3821
|
|
|
3822 When you have set "ctermfg" or "ctermbg" for the Normal group, Vim
|
|
|
3823 needs to reset the color when exiting. This is done with the "op"
|
|
|
3824 termcap entry |t_op|. If this doesn't work correctly, try setting the
|
|
|
3825 't_op' option in your .vimrc.
|
|
|
3826 *E419* *E420*
|
|
|
3827 When Vim knows the normal foreground and background colors, "fg" and
|
|
|
3828 "bg" can be used as color names. This only works after setting the
|
|
|
3829 colors for the Normal group and for the MS-DOS console. Example, for
|
|
|
3830 reverse video: >
|
|
|
3831 :highlight Visual ctermfg=bg ctermbg=fg
|
|
|
3832 < Note that the colors are used that are valid at the moment this
|
|
|
3833 command are given. If the Normal group colors are changed later, the
|
|
|
3834 "fg" and "bg" colors will not be adjusted.
|
|
|
3835
|
|
|
3836
|
|
|
3837 3. highlight arguments for the GUI
|
|
|
3838
|
|
|
3839 gui={attr-list} *highlight-gui*
|
|
|
3840 These give the attributes to use in the GUI mode.
|
|
|
3841 See |attr-list| for a description.
|
|
|
3842 Note that "bold" can be used here and by using a bold font. They
|
|
|
3843 have the same effect.
|
|
|
3844 Note that the attributes are ignored for the "Normal" group.
|
|
|
3845
|
|
|
3846 font={font-name} *highlight-font*
|
|
|
3847 font-name is the name of a font, as it is used on the system Vim
|
|
|
3848 runs on. For X11 this is a complicated name, for example: >
|
|
|
3849 font=-misc-fixed-bold-r-normal--14-130-75-75-c-70-iso8859-1
|
|
|
3850 <
|
|
|
3851 The font-name "NONE" can be used to revert to the default font.
|
|
|
3852 When setting the font for the "Normal" group, this becomes the default
|
|
|
3853 font (until the 'guifont' option is changed; the last one set is
|
|
|
3854 used).
|
|
|
3855 The following only works with Motif and Athena, not with other GUIs:
|
|
|
3856 When setting the font for the "Menu" group, the menus will be changed.
|
|
|
3857 When setting the font for the "Tooltip" group, the tooltips will be
|
|
|
3858 changed.
|
|
|
3859 All fonts used, except for Menu and Tooltip, should be of the same
|
|
|
3860 character size as the default font! Otherwise redrawing problems will
|
|
|
3861 occur.
|
|
|
3862
|
|
|
3863 guifg={color-name} *highlight-guifg*
|
|
|
3864 guibg={color-name} *highlight-guibg*
|
|
217
|
3865 guisp={color-name} *highlight-guisp*
|
|
|
3866 These give the foreground (guifg), background (guibg) and special
|
|
|
3867 (guisp) color to use in the GUI. "guisp" is used for underline and
|
|
|
3868 undercurl. There are a few special names:
|
|
7
|
3869 NONE no color (transparent)
|
|
|
3870 bg use normal background color
|
|
|
3871 background use normal background color
|
|
|
3872 fg use normal foreground color
|
|
|
3873 foreground use normal foreground color
|
|
|
3874 To use a color name with an embedded space or other special character,
|
|
|
3875 put it in single quotes. The single quote cannot be used then.
|
|
|
3876 Example: >
|
|
|
3877 :hi comment guifg='salmon pink'
|
|
|
3878 <
|
|
|
3879 *gui-colors*
|
|
|
3880 Suggested color names (these are available on most systems):
|
|
|
3881 Red LightRed DarkRed
|
|
|
3882 Green LightGreen DarkGreen SeaGreen
|
|
|
3883 Blue LightBlue DarkBlue SlateBlue
|
|
|
3884 Cyan LightCyan DarkCyan
|
|
|
3885 Magenta LightMagenta DarkMagenta
|
|
|
3886 Yellow LightYellow Brown DarkYellow
|
|
|
3887 Gray LightGray DarkGray
|
|
|
3888 Black White
|
|
|
3889 Orange Purple Violet
|
|
|
3890
|
|
|
3891 In the Win32 GUI version, additional system colors are available. See
|
|
|
3892 |win32-colors|.
|
|
|
3893
|
|
|
3894 You can also specify a color by its Red, Green and Blue values.
|
|
|
3895 The format is "#rrggbb", where
|
|
|
3896 "rr" is the Red value
|
|
217
|
3897 "gg" is the Green value
|
|
7
|
3898 "bb" is the Blue value
|
|
|
3899 All values are hexadecimal, range from "00" to "ff". Examples: >
|
|
|
3900 :highlight Comment guifg=#11f0c3 guibg=#ff00ff
|
|
|
3901 <
|
|
|
3902 *highlight-groups* *highlight-default*
|
|
|
3903 These are the default highlighting groups. These groups are used by the
|
|
|
3904 'highlight' option default. Note that the highlighting depends on the value
|
|
|
3905 of 'background'. You can see the current settings with the ":highlight"
|
|
|
3906 command.
|
|
|
3907 *hl-Cursor*
|
|
|
3908 Cursor the character under the cursor
|
|
|
3909 *hl-CursorIM*
|
|
|
3910 CursorIM like Cursor, but used when in IME mode |CursorIM|
|
|
|
3911 *hl-Directory*
|
|
|
3912 Directory directory names (and other special names in listings)
|
|
|
3913 *hl-DiffAdd*
|
|
|
3914 DiffAdd diff mode: Added line |diff.txt|
|
|
|
3915 *hl-DiffChange*
|
|
|
3916 DiffChange diff mode: Changed line |diff.txt|
|
|
|
3917 *hl-DiffDelete*
|
|
|
3918 DiffDelete diff mode: Deleted line |diff.txt|
|
|
|
3919 *hl-DiffText*
|
|
|
3920 DiffText diff mode: Changed text within a changed line |diff.txt|
|
|
|
3921 *hl-ErrorMsg*
|
|
|
3922 ErrorMsg error messages on the command line
|
|
|
3923 *hl-VertSplit*
|
|
|
3924 VertSplit the column separating vertically split windows
|
|
|
3925 *hl-Folded*
|
|
|
3926 Folded line used for closed folds
|
|
|
3927 *hl-FoldColumn*
|
|
|
3928 FoldColumn 'foldcolumn'
|
|
|
3929 *hl-SignColumn*
|
|
|
3930 SignColumn column where |signs| are displayed
|
|
|
3931 *hl-IncSearch*
|
|
|
3932 IncSearch 'incsearch' highlighting; also used for the text replaced with
|
|
|
3933 ":s///c"
|
|
|
3934 *hl-LineNr*
|
|
|
3935 LineNr line number for ":number" and ":#" commands, and when 'number'
|
|
|
3936 option is set.
|
|
|
3937 *hl-ModeMsg*
|
|
|
3938 ModeMsg 'showmode' message (e.g., "-- INSERT --")
|
|
|
3939 *hl-MoreMsg*
|
|
|
3940 MoreMsg |more-prompt|
|
|
|
3941 *hl-NonText*
|
|
|
3942 NonText '~' and '@' at the end of the window, characters from
|
|
|
3943 'showbreak' and other characters that do not really exist in
|
|
|
3944 the text (e.g., ">" displayed when a double-wide character
|
|
|
3945 doesn't fit at the end of the line).
|
|
|
3946 *hl-Normal*
|
|
|
3947 Normal normal text
|
|
540
|
3948 *hl-Pmenu*
|
|
|
3949 Pmenu Popup menu: normal item.
|
|
|
3950 *hl-PmenuSel*
|
|
|
3951 PmenuSel Popup menu: selected item.
|
|
|
3952 *hl-PmenuSbar*
|
|
|
3953 PmenuSbar Popup menu: scrollbar.
|
|
|
3954 *hl-PmenuThumb*
|
|
|
3955 PmenuThumb Popup menu: Thumb of the scrollbar.
|
|
7
|
3956 *hl-Question*
|
|
|
3957 Question |hit-enter| prompt and yes/no questions
|
|
|
3958 *hl-Search*
|
|
|
3959 Search Last search pattern highlighting (see 'hlsearch').
|
|
|
3960 Also used for highlighting the current line in the quickfix
|
|
|
3961 window and similar items that need to stand out.
|
|
|
3962 *hl-SpecialKey*
|
|
|
3963 SpecialKey Meta and special keys listed with ":map", also for text used
|
|
|
3964 to show unprintable characters in the text, 'listchars'.
|
|
|
3965 Generally: text that is displayed differently from what it
|
|
|
3966 really is.
|
|
221
|
3967 *hl-SpellBad*
|
|
|
3968 SpellBad Word that is not recognized by the spellchecker. |spell|
|
|
|
3969 This will be combined with the highlighting used otherwise.
|
|
391
|
3970 *hl-SpellCap*
|
|
|
3971 SpellCap Word that should start with a capital. |spell|
|
|
|
3972 This will be combined with the highlighting used otherwise.
|
|
221
|
3973 *hl-SpellLocal*
|
|
|
3974 SpellLocal Word that is recognized by the spellchecker as one that is
|
|
|
3975 used in another region. |spell|
|
|
|
3976 This will be combined with the highlighting used otherwise.
|
|
|
3977 *hl-SpellRare*
|
|
|
3978 SpellRare Word that is recognized by the spellchecker as one that is
|
|
|
3979 hardly ever used. |spell|
|
|
|
3980 This will be combined with the highlighting used otherwise.
|
|
7
|
3981 *hl-StatusLine*
|
|
|
3982 StatusLine status line of current window
|
|
|
3983 *hl-StatusLineNC*
|
|
|
3984 StatusLineNC status lines of not-current windows
|
|
|
3985 Note: if this is equal to "StatusLine" Vim will use "^^^" in
|
|
|
3986 the status line of the current window.
|
|
|
3987 *hl-Title*
|
|
|
3988 Title titles for output from ":set all", ":autocmd" etc.
|
|
|
3989 *hl-Visual*
|
|
|
3990 Visual Visual mode selection
|
|
|
3991 *hl-VisualNOS*
|
|
|
3992 VisualNOS Visual mode selection when vim is "Not Owning the Selection".
|
|
|
3993 Only X11 Gui's |gui-x11| and |xterm-clipboard| supports this.
|
|
|
3994 *hl-WarningMsg*
|
|
|
3995 WarningMsg warning messages
|
|
|
3996 *hl-WildMenu*
|
|
|
3997 WildMenu current match in 'wildmenu' completion
|
|
|
3998
|
|
523
|
3999 *hl-User1* *hl-User1..9* *hl-User9*
|
|
7
|
4000 The 'statusline' syntax allows the use of 9 different highlights in the
|
|
237
|
4001 statusline and ruler (via 'rulerformat'). The names are User1 to User9.
|
|
7
|
4002
|
|
|
4003 For the GUI you can use these groups to set the colors for the menu,
|
|
|
4004 scrollbars and tooltips. They don't have defaults. This doesn't work for the
|
|
|
4005 Win32 GUI. Only three highlight arguments have any effect here: font, guibg,
|
|
|
4006 and guifg.
|
|
|
4007
|
|
|
4008 *hl-Menu*
|
|
|
4009 Menu Current font, background and foreground colors of the menus.
|
|
|
4010 Also used for the toolbar.
|
|
|
4011 Applicable highlight arguments: font, guibg, guifg.
|
|
|
4012
|
|
|
4013 NOTE: For Motif and Athena the font argument actually
|
|
|
4014 specifies a fontset at all times, no matter if 'guifontset' is
|
|
|
4015 empty, and as such it is tied to the current |:language| when
|
|
|
4016 set.
|
|
|
4017
|
|
|
4018 *hl-Scrollbar*
|
|
|
4019 Scrollbar Current background and foreground of the main window's
|
|
|
4020 scrollbars.
|
|
|
4021 Applicable highlight arguments: guibg, guifg.
|
|
|
4022
|
|
|
4023 *hl-Tooltip*
|
|
|
4024 Tooltip Current font, background and foreground of the tooltips.
|
|
|
4025 Applicable highlight arguments: font, guibg, guifg.
|
|
|
4026
|
|
|
4027 NOTE: For Motif and Athena the font argument actually
|
|
|
4028 specifies a fontset at all times, no matter if 'guifontset' is
|
|
|
4029 empty, and as such it is tied to the current |:language| when
|
|
|
4030 set.
|
|
|
4031
|
|
|
4032 ==============================================================================
|
|
|
4033 13. Linking groups *:hi-link* *:highlight-link* *E412* *E413*
|
|
|
4034
|
|
|
4035 When you want to use the same highlighting for several syntax groups, you
|
|
|
4036 can do this more easily by linking the groups into one common highlight
|
|
|
4037 group, and give the color attributes only for that group.
|
|
|
4038
|
|
|
4039 To set a link:
|
|
|
4040
|
|
|
4041 :hi[ghlight][!] [default] link {from-group} {to-group}
|
|
|
4042
|
|
|
4043 To remove a link:
|
|
|
4044
|
|
|
4045 :hi[ghlight][!] [default] link {from-group} NONE
|
|
|
4046
|
|
|
4047 Notes: *E414*
|
|
|
4048 - If the {from-group} and/or {to-group} doesn't exist, it is created. You
|
|
|
4049 don't get an error message for a non-existing group.
|
|
|
4050 - As soon as you use a ":highlight" command for a linked group, the link is
|
|
|
4051 removed.
|
|
|
4052 - If there are already highlight settings for the {from-group}, the link is
|
|
|
4053 not made, unless the '!' is given. For a ":highlight link" command in a
|
|
|
4054 sourced file, you don't get an error message. This can be used to skip
|
|
|
4055 links for groups that already have settings.
|
|
|
4056
|
|
|
4057 *:hi-default* *:highlight-default*
|
|
|
4058 The [default] argument is used for setting the default highlighting for a
|
|
|
4059 group. If highlighting has already been specified for the group the command
|
|
|
4060 will be ignored. Also when there is an existing link.
|
|
|
4061
|
|
|
4062 Using [default] is especially useful to overrule the highlighting of a
|
|
|
4063 specific syntax file. For example, the C syntax file contains: >
|
|
|
4064 :highlight default link cComment Comment
|
|
|
4065 If you like Question highlighting for C comments, put this in your vimrc file: >
|
|
|
4066 :highlight link cComment Question
|
|
|
4067 Without the "default" in the C syntax file, the highlighting would be
|
|
|
4068 overruled when the syntax file is loaded.
|
|
|
4069
|
|
|
4070 ==============================================================================
|
|
|
4071 14. Cleaning up *:syn-clear* *E391*
|
|
|
4072
|
|
|
4073 If you want to clear the syntax stuff for the current buffer, you can use this
|
|
|
4074 command: >
|
|
|
4075 :syntax clear
|
|
|
4076
|
|
|
4077 This command should be used when you want to switch off syntax highlighting,
|
|
|
4078 or when you want to switch to using another syntax. It's normally not needed
|
|
|
4079 in a syntax file itself, because syntax is cleared by the autocommands that
|
|
|
4080 load the syntax file.
|
|
|
4081 The command also deletes the "b:current_syntax" variable, since no syntax is
|
|
|
4082 loaded after this command.
|
|
|
4083
|
|
|
4084 If you want to disable syntax highlighting for all buffers, you need to remove
|
|
|
4085 the autocommands that load the syntax files: >
|
|
|
4086 :syntax off
|
|
|
4087
|
|
|
4088 What this command actually does, is executing the command >
|
|
|
4089 :source $VIMRUNTIME/syntax/nosyntax.vim
|
|
|
4090 See the "nosyntax.vim" file for details. Note that for this to work
|
|
|
4091 $VIMRUNTIME must be valid. See |$VIMRUNTIME|.
|
|
|
4092
|
|
|
4093 To clean up specific syntax groups for the current buffer: >
|
|
|
4094 :syntax clear {group-name} ..
|
|
|
4095 This removes all patterns and keywords for {group-name}.
|
|
|
4096
|
|
|
4097 To clean up specific syntax group lists for the current buffer: >
|
|
|
4098 :syntax clear @{grouplist-name} ..
|
|
|
4099 This sets {grouplist-name}'s contents to an empty list.
|
|
|
4100
|
|
|
4101 *:syntax-reset* *:syn-reset*
|
|
|
4102 If you have changed the colors and messed them up, use this command to get the
|
|
|
4103 defaults back: >
|
|
|
4104
|
|
|
4105 :syntax reset
|
|
|
4106
|
|
|
4107 This doesn't change the colors for the 'highlight' option.
|
|
|
4108
|
|
|
4109 Note that the syntax colors that you set in your vimrc file will also be reset
|
|
|
4110 back to their Vim default.
|
|
|
4111 Note that if you are using a color scheme, the colors defined by the color
|
|
|
4112 scheme for syntax highlighting will be lost.
|
|
|
4113
|
|
|
4114 What this actually does is: >
|
|
|
4115
|
|
|
4116 let g:syntax_cmd = "reset"
|
|
|
4117 runtime! syntax/syncolor.vim
|
|
|
4118
|
|
|
4119 Note that this uses the 'runtimepath' option.
|
|
|
4120
|
|
|
4121 *syncolor*
|
|
|
4122 If you want to use different colors for syntax highlighting, you can add a Vim
|
|
|
4123 script file to set these colors. Put this file in a directory in
|
|
|
4124 'runtimepath' which comes after $VIMRUNTIME, so that your settings overrule
|
|
|
4125 the default colors. This way these colors will be used after the ":syntax
|
|
|
4126 reset" command.
|
|
|
4127
|
|
|
4128 For Unix you can use the file ~/.vim/after/syntax/syncolor.vim. Example: >
|
|
|
4129
|
|
|
4130 if &background == "light"
|
|
|
4131 highlight comment ctermfg=darkgreen guifg=darkgreen
|
|
|
4132 else
|
|
|
4133 highlight comment ctermfg=green guifg=green
|
|
|
4134 endif
|
|
|
4135
|
|
24
|
4136 *E679*
|
|
|
4137 Do make sure this syncolor.vim script does not use a "syntax on", set the
|
|
|
4138 'background' option or uses a "colorscheme" command, because it results in an
|
|
|
4139 endless loop.
|
|
|
4140
|
|
7
|
4141 Note that when a color scheme is used, there might be some confusion whether
|
|
|
4142 your defined colors are to be used or the colors from the scheme. This
|
|
|
4143 depends on the color scheme file. See |:colorscheme|.
|
|
|
4144
|
|
|
4145 *syntax_cmd*
|
|
|
4146 The "syntax_cmd" variable is set to one of these values when the
|
|
|
4147 syntax/syncolor.vim files are loaded:
|
|
|
4148 "on" ":syntax on" command. Highlight colors are overruled but
|
|
|
4149 links are kept
|
|
|
4150 "enable" ":syntax enable" command. Only define colors for groups that
|
|
|
4151 don't have highlighting yet. Use ":syntax default".
|
|
|
4152 "reset" ":syntax reset" command or loading a color scheme. Define all
|
|
|
4153 the colors.
|
|
|
4154 "skip" Don't define colors. Used to skip the default settings when a
|
|
|
4155 syncolor.vim file earlier in 'runtimepath' has already set
|
|
|
4156 them.
|
|
|
4157
|
|
|
4158 ==============================================================================
|
|
|
4159 15. Highlighting tags *tag-highlight*
|
|
|
4160
|
|
|
4161 If you want to highlight all the tags in your file, you can use the following
|
|
|
4162 mappings.
|
|
|
4163
|
|
|
4164 <F11> -- Generate tags.vim file, and highlight tags.
|
|
|
4165 <F12> -- Just highlight tags based on existing tags.vim file.
|
|
|
4166 >
|
|
|
4167 :map <F11> :sp tags<CR>:%s/^\([^ :]*:\)\=\([^ ]*\).*/syntax keyword Tag \2/<CR>:wq! tags.vim<CR>/^<CR><F12>
|
|
|
4168 :map <F12> :so tags.vim<CR>
|
|
|
4169
|
|
|
4170 WARNING: The longer the tags file, the slower this will be, and the more
|
|
|
4171 memory Vim will consume.
|
|
|
4172
|
|
|
4173 Only highlighting typedefs, unions and structs can be done too. For this you
|
|
|
4174 must use Exuberant ctags (found at http://ctags.sf.net).
|
|
|
4175
|
|
|
4176 Put these lines in your Makefile:
|
|
|
4177
|
|
|
4178 # Make a highlight file for types. Requires Exuberant ctags and awk
|
|
|
4179 types: types.vim
|
|
|
4180 types.vim: *.[ch]
|
|
|
4181 ctags -i=gstuS -o- *.[ch] |\
|
|
|
4182 awk 'BEGIN{printf("syntax keyword Type\t")}\
|
|
|
4183 {printf("%s ", $$1)}END{print ""}' > $@
|
|
|
4184
|
|
|
4185 And put these lines in your .vimrc: >
|
|
|
4186
|
|
|
4187 " load the types.vim highlighting file, if it exists
|
|
|
4188 autocmd BufRead,BufNewFile *.[ch] let fname = expand('<afile>:p:h') . '/types.vim'
|
|
|
4189 autocmd BufRead,BufNewFile *.[ch] if filereadable(fname)
|
|
|
4190 autocmd BufRead,BufNewFile *.[ch] exe 'so ' . fname
|
|
|
4191 autocmd BufRead,BufNewFile *.[ch] endif
|
|
|
4192
|
|
|
4193 ==============================================================================
|
|
|
4194 16. Color xterms *xterm-color* *color-xterm*
|
|
|
4195
|
|
|
4196 Most color xterms have only eight colors. If you don't get colors with the
|
|
|
4197 default setup, it should work with these lines in your .vimrc: >
|
|
|
4198 :if &term =~ "xterm"
|
|
|
4199 : if has("terminfo")
|
|
|
4200 : set t_Co=8
|
|
|
4201 : set t_Sf=<Esc>[3%p1%dm
|
|
|
4202 : set t_Sb=<Esc>[4%p1%dm
|
|
|
4203 : else
|
|
|
4204 : set t_Co=8
|
|
|
4205 : set t_Sf=<Esc>[3%dm
|
|
|
4206 : set t_Sb=<Esc>[4%dm
|
|
|
4207 : endif
|
|
|
4208 :endif
|
|
|
4209 < [<Esc> is a real escape, type CTRL-V <Esc>]
|
|
|
4210
|
|
|
4211 You might want to change the first "if" to match the name of your terminal,
|
|
|
4212 e.g. "dtterm" instead of "xterm".
|
|
|
4213
|
|
|
4214 Note: Do these settings BEFORE doing ":syntax on". Otherwise the colors may
|
|
|
4215 be wrong.
|
|
|
4216 *xiterm* *rxvt*
|
|
|
4217 The above settings have been mentioned to work for xiterm and rxvt too.
|
|
|
4218 But for using 16 colors in an rxvt these should work with terminfo: >
|
|
|
4219 :set t_AB=<Esc>[%?%p1%{8}%<%t25;%p1%{40}%+%e5;%p1%{32}%+%;%dm
|
|
|
4220 :set t_AF=<Esc>[%?%p1%{8}%<%t22;%p1%{30}%+%e1;%p1%{22}%+%;%dm
|
|
|
4221 <
|
|
|
4222 *colortest.vim*
|
|
|
4223 To test your color setup, a file has been included in the Vim distribution.
|
|
|
4224 To use it, execute these commands: >
|
|
|
4225 :e $VIMRUNTIME/syntax/colortest.vim
|
|
|
4226 :so %
|
|
|
4227
|
|
237
|
4228 Some versions of xterm (and other terminals, like the Linux console) can
|
|
7
|
4229 output lighter foreground colors, even though the number of colors is defined
|
|
|
4230 at 8. Therefore Vim sets the "cterm=bold" attribute for light foreground
|
|
|
4231 colors, when 't_Co' is 8.
|
|
|
4232
|
|
|
4233 *xfree-xterm*
|
|
|
4234 To get 16 colors or more, get the newest xterm version (which should be
|
|
237
|
4235 included with XFree86 3.3 and later). You can also find the latest version
|
|
7
|
4236 at: >
|
|
|
4237 http://invisible-island.net/xterm/xterm.html
|
|
|
4238 Here is a good way to configure it. This uses 88 colors and enables the
|
|
|
4239 termcap-query feature, which allows Vim to ask the xterm how many colors it
|
|
|
4240 supports. >
|
|
|
4241 ./configure --disable-bold-color --enable-88-color --enable-tcap-query
|
|
|
4242 If you only get 8 colors, check the xterm compilation settings.
|
|
|
4243 (Also see |UTF8-xterm| for using this xterm with UTF-8 character encoding).
|
|
|
4244
|
|
|
4245 This xterm should work with these lines in your .vimrc (for 16 colors): >
|
|
|
4246 :if has("terminfo")
|
|
|
4247 : set t_Co=16
|
|
|
4248 : set t_AB=<Esc>[%?%p1%{8}%<%t%p1%{40}%+%e%p1%{92}%+%;%dm
|
|
|
4249 : set t_AF=<Esc>[%?%p1%{8}%<%t%p1%{30}%+%e%p1%{82}%+%;%dm
|
|
|
4250 :else
|
|
|
4251 : set t_Co=16
|
|
|
4252 : set t_Sf=<Esc>[3%dm
|
|
|
4253 : set t_Sb=<Esc>[4%dm
|
|
|
4254 :endif
|
|
|
4255 < [<Esc> is a real escape, type CTRL-V <Esc>]
|
|
|
4256
|
|
|
4257 Without |+terminfo|, Vim will recognize these settings, and automatically
|
|
|
4258 translate cterm colors of 8 and above to "<Esc>[9%dm" and "<Esc>[10%dm".
|
|
|
4259 Colors above 16 are also translated automatically.
|
|
|
4260
|
|
|
4261 For 256 colors this has been reported to work: >
|
|
|
4262
|
|
|
4263 :set t_AB=<Esc>[48;5;%dm
|
|
|
4264 :set t_AF=<Esc>[38;5;%dm
|
|
|
4265
|
|
|
4266 Or just set the TERM environment variable to "xterm-color" or "xterm-16color"
|
|
|
4267 and try if that works.
|
|
|
4268
|
|
|
4269 You probably want to use these X resources (in your ~/.Xdefaults file):
|
|
|
4270 XTerm*color0: #000000
|
|
|
4271 XTerm*color1: #c00000
|
|
|
4272 XTerm*color2: #008000
|
|
|
4273 XTerm*color3: #808000
|
|
|
4274 XTerm*color4: #0000c0
|
|
|
4275 XTerm*color5: #c000c0
|
|
|
4276 XTerm*color6: #008080
|
|
|
4277 XTerm*color7: #c0c0c0
|
|
|
4278 XTerm*color8: #808080
|
|
|
4279 XTerm*color9: #ff6060
|
|
|
4280 XTerm*color10: #00ff00
|
|
|
4281 XTerm*color11: #ffff00
|
|
|
4282 XTerm*color12: #8080ff
|
|
|
4283 XTerm*color13: #ff40ff
|
|
|
4284 XTerm*color14: #00ffff
|
|
|
4285 XTerm*color15: #ffffff
|
|
|
4286 Xterm*cursorColor: Black
|
|
|
4287
|
|
|
4288 [Note: The cursorColor is required to work around a bug, which changes the
|
|
|
4289 cursor color to the color of the last drawn text. This has been fixed by a
|
|
|
4290 newer version of xterm, but not everybody is it using yet.]
|
|
|
4291
|
|
|
4292 To get these right away, reload the .Xdefaults file to the X Option database
|
|
|
4293 Manager (you only need to do this when you just changed the .Xdefaults file): >
|
|
|
4294 xrdb -merge ~/.Xdefaults
|
|
|
4295 <
|
|
|
4296 *xterm-blink* *xterm-blinking-cursor*
|
|
|
4297 To make the cursor blink in an xterm, see tools/blink.c. Or use Thomas
|
|
|
4298 Dickey's xterm above patchlevel 107 (see above for where to get it), with
|
|
|
4299 these resources:
|
|
|
4300 XTerm*cursorBlink: on
|
|
|
4301 XTerm*cursorOnTime: 400
|
|
|
4302 XTerm*cursorOffTime: 250
|
|
|
4303 XTerm*cursorColor: White
|
|
|
4304
|
|
|
4305 *hpterm-color*
|
|
|
4306 These settings work (more or less) for a hpterm, which only supports 8
|
|
|
4307 foreground colors: >
|
|
|
4308 :if has("terminfo")
|
|
|
4309 : set t_Co=8
|
|
|
4310 : set t_Sf=<Esc>[&v%p1%dS
|
|
|
4311 : set t_Sb=<Esc>[&v7S
|
|
|
4312 :else
|
|
|
4313 : set t_Co=8
|
|
|
4314 : set t_Sf=<Esc>[&v%dS
|
|
|
4315 : set t_Sb=<Esc>[&v7S
|
|
|
4316 :endif
|
|
|
4317 < [<Esc> is a real escape, type CTRL-V <Esc>]
|
|
|
4318
|
|
|
4319 *Eterm* *enlightened-terminal*
|
|
|
4320 These settings have been reported to work for the Enlightened terminal
|
|
|
4321 emulator, or Eterm. They might work for all xterm-like terminals that use the
|
|
|
4322 bold attribute to get bright colors. Add an ":if" like above when needed. >
|
|
|
4323 :set t_Co=16
|
|
|
4324 :set t_AF=^[[%?%p1%{8}%<%t3%p1%d%e%p1%{22}%+%d;1%;m
|
|
|
4325 :set t_AB=^[[%?%p1%{8}%<%t4%p1%d%e%p1%{32}%+%d;1%;m
|
|
|
4326 <
|
|
|
4327 *TTpro-telnet*
|
|
|
4328 These settings should work for TTpro telnet. Tera Term Pro is a freeware /
|
|
|
4329 open-source program for MS-Windows. >
|
|
|
4330 set t_Co=16
|
|
|
4331 set t_AB=^[[%?%p1%{8}%<%t%p1%{40}%+%e%p1%{32}%+5;%;%dm
|
|
|
4332 set t_AF=^[[%?%p1%{8}%<%t%p1%{30}%+%e%p1%{22}%+1;%;%dm
|
|
|
4333 Also make sure TTpro's Setup / Window / Full Color is enabled, and make sure
|
|
|
4334 that Setup / Font / Enable Bold is NOT enabled.
|
|
|
4335 (info provided by John Love-Jensen <eljay@Adobe.COM>)
|
|
|
4336
|
|
|
4337 vim:tw=78:sw=4:ts=8:ft=help:norl:
|
