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