blob: 5d67ba62290fec3a136ca591c33bef731f134733 [file] [log] [blame]
Aliaksei Budavei8556e232024-08-27 22:32:13 +02001*syntax.txt* For Vim version 9.1. Last change: 2024 Aug 26
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Syntax highlighting *syntax* *syntax-highlighting* *coloring*
8
9Syntax highlighting enables Vim to show parts of the text in another font or
10color. Those parts can be specific keywords or text matching a pattern. Vim
11doesn't parse the whole file (to keep it fast), so the highlighting has its
12limitations. Lexical highlighting might be a better name, but since everybody
13calls it syntax highlighting we'll stick with that.
14
15Vim supports syntax highlighting on all terminals. But since most ordinary
16terminals have very limited highlighting possibilities, it works best in the
17GUI version, gvim.
18
19In the User Manual:
20|usr_06.txt| introduces syntax highlighting.
21|usr_44.txt| introduces writing a syntax file.
22
231. Quick start |:syn-qstart|
242. Syntax files |:syn-files|
253. Syntax loading procedure |syntax-loading|
Bram Moolenaar9d87a372018-12-18 21:41:50 +0100264. Converting to HTML |2html.vim|
275. Syntax file remarks |:syn-file-remarks|
286. Defining a syntax |:syn-define|
297. :syntax arguments |:syn-arguments|
308. Syntax patterns |:syn-pattern|
319. Syntax clusters |:syn-cluster|
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003210. Including syntax files |:syn-include|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003311. Synchronizing |:syn-sync|
3412. Listing syntax items |:syntax|
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01003513. Colorschemes |color-schemes|
3614. Highlight command |:highlight|
3715. Linking groups |:highlight-link|
3816. Cleaning up |:syn-clear|
3917. Highlighting tags |tag-highlight|
4018. Window-local syntax |:ownsyntax|
4119. Color xterms |xterm-color|
4220. When syntax is slow |:syntime|
Bram Moolenaar071d4272004-06-13 20:20:40 +000043
44{Vi does not have any of these commands}
45
46Syntax highlighting is not available when the |+syntax| feature has been
47disabled at compile time.
48
49==============================================================================
501. Quick start *:syn-qstart*
51
52 *:syn-enable* *:syntax-enable*
53This command switches on syntax highlighting: >
54
55 :syntax enable
56
57What this command actually does is to execute the command >
58 :source $VIMRUNTIME/syntax/syntax.vim
59
60If the VIM environment variable is not set, Vim will try to find
61the path in another way (see |$VIMRUNTIME|). Usually this works just
62fine. If it doesn't, try setting the VIM environment variable to the
63directory where the Vim stuff is located. For example, if your syntax files
Bram Moolenaar8024f932020-01-14 19:29:13 +010064are in the "/usr/vim/vim82/syntax" directory, set $VIMRUNTIME to
65"/usr/vim/vim82". You must do this in the shell, before starting Vim.
Bram Moolenaar01164a62017-11-02 22:58:42 +010066This command also sources the |menu.vim| script when the GUI is running or
67will start soon. See |'go-M'| about avoiding that.
Bram Moolenaar071d4272004-06-13 20:20:40 +000068
69 *:syn-on* *:syntax-on*
Bram Moolenaar4072ba52020-12-23 13:56:35 +010070The `:syntax enable` command will keep most of your current color settings.
71This allows using `:highlight` commands to set your preferred colors before or
Bram Moolenaar071d4272004-06-13 20:20:40 +000072after using this command. If you want Vim to overrule your settings with the
73defaults, use: >
74 :syntax on
75<
76 *:hi-normal* *:highlight-normal*
77If you are running in the GUI, you can get white text on a black background
78with: >
79 :highlight Normal guibg=Black guifg=White
80For a color terminal see |:hi-normal-cterm|.
81For setting up your own colors syntax highlighting see |syncolor|.
82
Bram Moolenaar5666fcd2019-12-26 14:35:26 +010083NOTE: The syntax files on MS-Windows have lines that end in <CR><NL>.
Bram Moolenaar071d4272004-06-13 20:20:40 +000084The files for Unix end in <NL>. This means you should use the right type of
Bram Moolenaar5666fcd2019-12-26 14:35:26 +010085file for your system. Although on MS-Windows the right format is
Bram Moolenaar071d4272004-06-13 20:20:40 +000086automatically selected if the 'fileformats' option is not empty.
87
88NOTE: When using reverse video ("gvim -fg white -bg black"), the default value
89of 'background' will not be set until the GUI window is opened, which is after
Bram Moolenaar910f66f2006-04-05 20:41:53 +000090reading the |gvimrc|. This will cause the wrong default highlighting to be
Bram Moolenaar071d4272004-06-13 20:20:40 +000091used. To set the default value of 'background' before switching on
Bram Moolenaar910f66f2006-04-05 20:41:53 +000092highlighting, include the ":gui" command in the |gvimrc|: >
Bram Moolenaar071d4272004-06-13 20:20:40 +000093
94 :gui " open window and set default for 'background'
95 :syntax on " start highlighting, use 'background' to set colors
96
Bram Moolenaar910f66f2006-04-05 20:41:53 +000097NOTE: Using ":gui" in the |gvimrc| means that "gvim -f" won't start in the
Bram Moolenaar071d4272004-06-13 20:20:40 +000098foreground! Use ":gui -f" then.
99
Bram Moolenaar09092152010-08-08 16:38:42 +0200100 *g:syntax_on*
101You can toggle the syntax on/off with this command: >
102 :if exists("g:syntax_on") | syntax off | else | syntax enable | endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103
104To put this into a mapping, you can use: >
Bram Moolenaar09092152010-08-08 16:38:42 +0200105 :map <F7> :if exists("g:syntax_on") <Bar>
Bram Moolenaar071d4272004-06-13 20:20:40 +0000106 \ syntax off <Bar>
107 \ else <Bar>
108 \ syntax enable <Bar>
109 \ endif <CR>
110[using the |<>| notation, type this literally]
111
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000112Details:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000113The ":syntax" commands are implemented by sourcing a file. To see exactly how
114this works, look in the file:
115 command file ~
116 :syntax enable $VIMRUNTIME/syntax/syntax.vim
117 :syntax on $VIMRUNTIME/syntax/syntax.vim
118 :syntax manual $VIMRUNTIME/syntax/manual.vim
119 :syntax off $VIMRUNTIME/syntax/nosyntax.vim
120Also see |syntax-loading|.
121
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100122NOTE: If displaying long lines is slow and switching off syntax highlighting
123makes it fast, consider setting the 'synmaxcol' option to a lower value.
124
Bram Moolenaar071d4272004-06-13 20:20:40 +0000125==============================================================================
1262. Syntax files *:syn-files*
127
128The syntax and highlighting commands for one language are normally stored in
129a syntax file. The name convention is: "{name}.vim". Where {name} is the
130name of the language, or an abbreviation (to fit the name in 8.3 characters,
131a requirement in case the file is used on a DOS filesystem).
132Examples:
133 c.vim perl.vim java.vim html.vim
134 cpp.vim sh.vim csh.vim
135
136The syntax file can contain any Ex commands, just like a vimrc file. But
137the idea is that only commands for a specific language are included. When a
138language is a superset of another language, it may include the other one,
139for example, the cpp.vim file could include the c.vim file: >
140 :so $VIMRUNTIME/syntax/c.vim
141
142The .vim files are normally loaded with an autocommand. For example: >
143 :au Syntax c runtime! syntax/c.vim
144 :au Syntax cpp runtime! syntax/cpp.vim
145These commands are normally in the file $VIMRUNTIME/syntax/synload.vim.
146
147
148MAKING YOUR OWN SYNTAX FILES *mysyntaxfile*
149
150When you create your own syntax files, and you want to have Vim use these
151automatically with ":syntax enable", do this:
152
1531. Create your user runtime directory. You would normally use the first item
154 of the 'runtimepath' option. Example for Unix: >
155 mkdir ~/.vim
156
1572. Create a directory in there called "syntax". For Unix: >
158 mkdir ~/.vim/syntax
159
1603. Write the Vim syntax file. Or download one from the internet. Then write
161 it in your syntax directory. For example, for the "mine" syntax: >
162 :w ~/.vim/syntax/mine.vim
163
164Now you can start using your syntax file manually: >
165 :set syntax=mine
166You don't have to exit Vim to use this.
167
168If you also want Vim to detect the type of file, see |new-filetype|.
169
170If you are setting up a system with many users and you don't want each user
171to add the same syntax file, you can use another directory from 'runtimepath'.
172
173
174ADDING TO AN EXISTING SYNTAX FILE *mysyntaxfile-add*
175
176If you are mostly satisfied with an existing syntax file, but would like to
177add a few items or change the highlighting, follow these steps:
178
1791. Create your user directory from 'runtimepath', see above.
180
1812. Create a directory in there called "after/syntax". For Unix: >
182 mkdir ~/.vim/after
183 mkdir ~/.vim/after/syntax
184
1853. Write a Vim script that contains the commands you want to use. For
186 example, to change the colors for the C syntax: >
187 highlight cComment ctermfg=Green guifg=Green
188
1894. Write that file in the "after/syntax" directory. Use the name of the
190 syntax, with ".vim" added. For our C syntax: >
191 :w ~/.vim/after/syntax/c.vim
192
193That's it. The next time you edit a C file the Comment color will be
194different. You don't even have to restart Vim.
195
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000196If you have multiple files, you can use the filetype as the directory name.
197All the "*.vim" files in this directory will be used, for example:
198 ~/.vim/after/syntax/c/one.vim
199 ~/.vim/after/syntax/c/two.vim
200
Bram Moolenaar071d4272004-06-13 20:20:40 +0000201
202REPLACING AN EXISTING SYNTAX FILE *mysyntaxfile-replace*
203
204If you don't like a distributed syntax file, or you have downloaded a new
205version, follow the same steps as for |mysyntaxfile| above. Just make sure
206that you write the syntax file in a directory that is early in 'runtimepath'.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +0200207Vim will only load the first syntax file found, assuming that it sets
208b:current_syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000209
210
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100211NAMING CONVENTIONS *group-name* *{group-name}* *E669* *W18*
212
213A syntax group name is to be used for syntax items that match the same kind of
214thing. These are then linked to a highlight group that specifies the color.
215A syntax group name doesn't specify any color or attributes itself.
216
Gregory Andersd4376dc2023-08-20 19:14:03 +0200217The name for a highlight or syntax group must consist of ASCII letters,
218digits, underscores, dots, or hyphens. As a regexp: "[a-zA-Z0-9_.-]*".
219However, Vim does not give an error when using other characters. The maximum
220length of a group name is about 200 bytes. *E1249*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000221
Bram Moolenaareab6dff2020-03-01 19:06:45 +0100222To be able to allow each user to pick their favorite set of colors, there must
Bram Moolenaar071d4272004-06-13 20:20:40 +0000223be preferred names for highlight groups that are common for many languages.
224These are the suggested group names (if syntax highlighting works properly
225you can see the actual color, except for "Ignore"):
226
227 *Comment any comment
228
229 *Constant any constant
230 String a string constant: "this is a string"
231 Character a character constant: 'c', '\n'
232 Number a number constant: 234, 0xff
233 Boolean a boolean constant: TRUE, false
234 Float a floating point constant: 2.3e10
235
236 *Identifier any variable name
237 Function function name (also: methods for classes)
238
239 *Statement any statement
240 Conditional if, then, else, endif, switch, etc.
241 Repeat for, do, while, etc.
242 Label case, default, etc.
243 Operator "sizeof", "+", "*", etc.
244 Keyword any other keyword
245 Exception try, catch, throw
246
247 *PreProc generic Preprocessor
248 Include preprocessor #include
249 Define preprocessor #define
250 Macro same as Define
251 PreCondit preprocessor #if, #else, #endif, etc.
252
253 *Type int, long, char, etc.
254 StorageClass static, register, volatile, etc.
255 Structure struct, union, enum, etc.
256 Typedef A typedef
257
258 *Special any special symbol
259 SpecialChar special character in a constant
260 Tag you can use CTRL-] on this
261 Delimiter character that needs attention
262 SpecialComment special things inside a comment
263 Debug debugging statements
264
265 *Underlined text that stands out, HTML links
266
Bram Moolenaar4f99eae2010-07-24 15:56:43 +0200267 *Ignore left blank, hidden |hl-Ignore|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268
269 *Error any erroneous construct
270
271 *Todo anything that needs extra attention; mostly the
272 keywords TODO FIXME and XXX
273
Romain Lafourcade124371c2024-01-07 15:08:31 +0100274 *Added added line in a diff
275 *Changed changed line in a diff
276 *Removed removed line in a diff
277
Bram Moolenaar071d4272004-06-13 20:20:40 +0000278The names marked with * are the preferred groups; the others are minor groups.
279For the preferred groups, the "syntax.vim" file contains default highlighting.
280The minor groups are linked to the preferred groups, so they get the same
281highlighting. You can override these defaults by using ":highlight" commands
282after sourcing the "syntax.vim" file.
283
284Note that highlight group names are not case sensitive. "String" and "string"
285can be used for the same group.
286
287The following names are reserved and cannot be used as a group name:
288 NONE ALL ALLBUT contains contained
289
Bram Moolenaar4f99eae2010-07-24 15:56:43 +0200290 *hl-Ignore*
291When using the Ignore group, you may also consider using the conceal
292mechanism. See |conceal|.
293
Bram Moolenaar071d4272004-06-13 20:20:40 +0000294==============================================================================
2953. Syntax loading procedure *syntax-loading*
296
297This explains the details that happen when the command ":syntax enable" is
298issued. When Vim initializes itself, it finds out where the runtime files are
299located. This is used here as the variable |$VIMRUNTIME|.
300
301":syntax enable" and ":syntax on" do the following:
302
303 Source $VIMRUNTIME/syntax/syntax.vim
304 |
305 +- Clear out any old syntax by sourcing $VIMRUNTIME/syntax/nosyntax.vim
306 |
307 +- Source first syntax/synload.vim in 'runtimepath'
308 | |
309 | +- Setup the colors for syntax highlighting. If a color scheme is
310 | | defined it is loaded again with ":colors {name}". Otherwise
311 | | ":runtime! syntax/syncolor.vim" is used. ":syntax on" overrules
312 | | existing colors, ":syntax enable" only sets groups that weren't
313 | | set yet.
314 | |
315 | +- Set up syntax autocmds to load the appropriate syntax file when
316 | | the 'syntax' option is set. *synload-1*
317 | |
318 | +- Source the user's optional file, from the |mysyntaxfile| variable.
319 | This is for backwards compatibility with Vim 5.x only. *synload-2*
320 |
321 +- Do ":filetype on", which does ":runtime! filetype.vim". It loads any
322 | filetype.vim files found. It should always Source
323 | $VIMRUNTIME/filetype.vim, which does the following.
324 | |
325 | +- Install autocmds based on suffix to set the 'filetype' option
326 | | This is where the connection between file name and file type is
327 | | made for known file types. *synload-3*
328 | |
329 | +- Source the user's optional file, from the *myfiletypefile*
330 | | variable. This is for backwards compatibility with Vim 5.x only.
331 | | *synload-4*
332 | |
333 | +- Install one autocommand which sources scripts.vim when no file
334 | | type was detected yet. *synload-5*
335 | |
336 | +- Source $VIMRUNTIME/menu.vim, to setup the Syntax menu. |menu.vim|
337 |
338 +- Install a FileType autocommand to set the 'syntax' option when a file
339 | type has been detected. *synload-6*
340 |
341 +- Execute syntax autocommands to start syntax highlighting for each
342 already loaded buffer.
343
344
345Upon loading a file, Vim finds the relevant syntax file as follows:
346
347 Loading the file triggers the BufReadPost autocommands.
348 |
349 +- If there is a match with one of the autocommands from |synload-3|
350 | (known file types) or |synload-4| (user's file types), the 'filetype'
351 | option is set to the file type.
352 |
353 +- The autocommand at |synload-5| is triggered. If the file type was not
354 | found yet, then scripts.vim is searched for in 'runtimepath'. This
355 | should always load $VIMRUNTIME/scripts.vim, which does the following.
356 | |
357 | +- Source the user's optional file, from the *myscriptsfile*
358 | | variable. This is for backwards compatibility with Vim 5.x only.
359 | |
360 | +- If the file type is still unknown, check the contents of the file,
361 | again with checks like "getline(1) =~ pattern" as to whether the
362 | file type can be recognized, and set 'filetype'.
363 |
364 +- When the file type was determined and 'filetype' was set, this
365 | triggers the FileType autocommand |synload-6| above. It sets
366 | 'syntax' to the determined file type.
367 |
368 +- When the 'syntax' option was set above, this triggers an autocommand
369 | from |synload-1| (and |synload-2|). This find the main syntax file in
370 | 'runtimepath', with this command:
371 | runtime! syntax/<name>.vim
372 |
373 +- Any other user installed FileType or Syntax autocommands are
374 triggered. This can be used to change the highlighting for a specific
375 syntax.
376
377==============================================================================
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003784. Conversion to HTML *2html.vim* *convert-to-HTML*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000379
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003802html is not a syntax file itself, but a script that converts the current
Bram Moolenaar31c31672013-06-26 13:28:14 +0200381window into HTML. Vim opens a new window in which it builds the HTML file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000382
Bram Moolenaar31c31672013-06-26 13:28:14 +0200383After you save the resulting file, you can view it with any browser. The
384colors should be exactly the same as you see them in Vim. With
385|g:html_line_ids| you can jump to specific lines by adding (for example) #L123
386or #123 to the end of the URL in your browser's address bar. And with
Bram Moolenaar543b7ef2013-06-01 14:50:56 +0200387|g:html_dynamic_folds| enabled, you can show or hide the text that is folded
388in Vim.
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200389
Bram Moolenaar071d4272004-06-13 20:20:40 +0000390You are not supposed to set the 'filetype' or 'syntax' option to "2html"!
391Source the script to convert the current file: >
392
393 :runtime! syntax/2html.vim
394<
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200395Many variables affect the output of 2html.vim; see below. Any of the on/off
396options listed below can be enabled or disabled by setting them explicitly to
397the desired value, or restored to their default by removing the variable using
398|:unlet|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000399
400Remarks:
Bram Moolenaar076e8b22010-08-05 21:54:00 +0200401- Some truly ancient browsers may not show the background colors.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000402- From most browsers you can also print the file (in color)!
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200403- The latest TOhtml may actually work with older versions of Vim, but some
Bram Moolenaar166af9b2010-11-16 20:34:40 +0100404 features such as conceal support will not function, and the colors may be
405 incorrect for an old Vim without GUI support compiled in.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000406
407Here is an example how to run the script over all .c and .h files from a
408Unix shell: >
409 for f in *.[ch]; do gvim -f +"syn on" +"run! syntax/2html.vim" +"wq" +"q" $f; done
410<
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200411 *g:html_start_line* *g:html_end_line*
412To restrict the conversion to a range of lines, use a range with the |:TOhtml|
413command below, or set "g:html_start_line" and "g:html_end_line" to the first
414and last line to be converted. Example, using the last set Visual area: >
415
416 :let g:html_start_line = line("'<")
417 :let g:html_end_line = line("'>")
418 :runtime! syntax/2html.vim
419<
420 *:TOhtml*
421:[range]TOhtml The ":TOhtml" command is defined in a standard plugin.
422 This command will source |2html.vim| for you. When a
Bram Moolenaar60cce2f2015-10-13 23:21:27 +0200423 range is given, this command sets |g:html_start_line|
424 and |g:html_end_line| to the start and end of the
425 range, respectively. Default range is the entire
426 buffer.
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200427
Bram Moolenaar60cce2f2015-10-13 23:21:27 +0200428 If the current window is part of a |diff|, unless
429 |g:html_diff_one_file| is set, :TOhtml will convert
430 all windows which are part of the diff in the current
431 tab and place them side-by-side in a <table> element
432 in the generated HTML. With |g:html_line_ids| you can
433 jump to lines in specific windows with (for example)
434 #W1L42 for line 42 in the first diffed window, or
435 #W3L87 for line 87 in the third.
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200436
437 Examples: >
438
439 :10,40TOhtml " convert lines 10-40 to html
440 :'<,'>TOhtml " convert current/last visual selection
441 :TOhtml " convert entire buffer
442<
443 *g:html_diff_one_file*
444Default: 0.
Bram Moolenaar31c31672013-06-26 13:28:14 +0200445When 0, and using |:TOhtml| all windows involved in a |diff| in the current tab
446page are converted to HTML and placed side-by-side in a <table> element. When
4471, only the current buffer is converted.
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200448Example: >
449
450 let g:html_diff_one_file = 1
451<
452 *g:html_whole_filler*
453Default: 0.
454When 0, if |g:html_diff_one_file| is 1, a sequence of more than 3 filler lines
455is displayed as three lines with the middle line mentioning the total number
456of inserted lines.
457When 1, always display all inserted lines as if |g:html_diff_one_file| were
458not set.
459>
460 :let g:html_whole_filler = 1
461<
462 *TOhtml-performance* *g:html_no_progress*
463Default: 0.
464When 0, display a progress bar in the statusline for each major step in the
4652html.vim conversion process.
466When 1, do not display the progress bar. This offers a minor speed improvement
467but you won't have any idea how much longer the conversion might take; for big
468files it can take a long time!
469Example: >
470
471 let g:html_no_progress = 1
472<
473You can obtain better performance improvements by also instructing Vim to not
474run interactively, so that too much time is not taken to redraw as the script
475moves through the buffer, switches windows, and the like: >
476
477 vim -E -s -c "let g:html_no_progress=1" -c "syntax on" -c "set ft=c" -c "runtime syntax/2html.vim" -cwqa myfile.c
478<
479Note that the -s flag prevents loading your .vimrc and any plugins, so you
480need to explicitly source/enable anything that will affect the HTML
481conversion. See |-E| and |-s-ex| for details. It is probably best to create a
482script to replace all the -c commands and use it with the -u flag instead of
483specifying each command separately.
484
Bram Moolenaar09c6f262019-11-17 15:55:14 +0100485 *hl-TOhtmlProgress* *TOhtml-progress-color*
486When displayed, the progress bar will show colored boxes along the statusline
487as the HTML conversion proceeds. By default, the background color as the
488current "DiffDelete" highlight group is used. If "DiffDelete" and "StatusLine"
489have the same background color, TOhtml will automatically adjust the color to
490differ. If you do not like the automatically selected colors, you can define
491your own highlight colors for the progress bar. Example: >
492
493 hi TOhtmlProgress guifg=#c0ffee ctermbg=7
494<
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200495 *g:html_number_lines*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +0100496Default: Current 'number' setting.
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200497When 0, buffer text is displayed in the generated HTML without line numbering.
498When 1, a column of line numbers is added to the generated HTML with the same
499highlighting as the line number column in Vim (|hl-LineNr|).
500Force line numbers even if 'number' is not set: >
501 :let g:html_number_lines = 1
502Force to omit the line numbers: >
503 :let g:html_number_lines = 0
504Go back to the default to use 'number' by deleting the variable: >
505 :unlet g:html_number_lines
506<
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +0100507 *g:html_line_ids*
Bram Moolenaar31c31672013-06-26 13:28:14 +0200508Default: 1 if |g:html_number_lines| is set, 0 otherwise.
509When 1, adds an HTML id attribute to each line number, or to an empty <span>
510inserted for that purpose if no line numbers are shown. This ID attribute
511takes the form of L123 for single-buffer HTML pages, or W2L123 for diff-view
512pages, and is used to jump to a specific line (in a specific window of a diff
513view). Javascript is inserted to open any closed dynamic folds
Bram Moolenaar34401cc2014-08-29 15:12:19 +0200514(|g:html_dynamic_folds|) containing the specified line before jumping. The
Bram Moolenaar31c31672013-06-26 13:28:14 +0200515javascript also allows omitting the window ID in the url, and the leading L.
516For example: >
517
518 page.html#L123 jumps to line 123 in a single-buffer file
519 page.html#123 does the same
520
521 diff.html#W1L42 jumps to line 42 in the first window in a diff
522 diff.html#42 does the same
523<
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200524 *g:html_use_css*
525Default: 1.
Bram Moolenaar09c6f262019-11-17 15:55:14 +0100526When 1, generate valid HTML 5 markup with CSS styling, supported in all modern
527browsers and many old browsers.
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200528When 0, generate <font> tags and similar outdated markup. This is not
529recommended but it may work better in really old browsers, email clients,
530forum posts, and similar situations where basic CSS support is unavailable.
531Example: >
532 :let g:html_use_css = 0
533<
534 *g:html_ignore_conceal*
535Default: 0.
536When 0, concealed text is removed from the HTML and replaced with a character
537from |:syn-cchar| or 'listchars' as appropriate, depending on the current
538value of 'conceallevel'.
539When 1, include all text from the buffer in the generated HTML, even if it is
540|conceal|ed.
541
542Either of the following commands will ensure that all text in the buffer is
543included in the generated HTML (unless it is folded): >
544 :let g:html_ignore_conceal = 1
545 :setl conceallevel=0
546<
547 *g:html_ignore_folding*
548Default: 0.
549When 0, text in a closed fold is replaced by the text shown for the fold in
550Vim (|fold-foldtext|). See |g:html_dynamic_folds| if you also want to allow
551the user to expand the fold as in Vim to see the text inside.
552When 1, include all text from the buffer in the generated HTML; whether the
553text is in a fold has no impact at all. |g:html_dynamic_folds| has no effect.
554
555Either of these commands will ensure that all text in the buffer is included
556in the generated HTML (unless it is concealed): >
557 zR
558 :let g:html_ignore_folding = 1
559<
560 *g:html_dynamic_folds*
561Default: 0.
562When 0, text in a closed fold is not included at all in the generated HTML.
563When 1, generate javascript to open a fold and show the text within, just like
564in Vim.
565
566Setting this variable to 1 causes 2html.vim to always use CSS for styling,
567regardless of what |g:html_use_css| is set to.
568
569This variable is ignored when |g:html_ignore_folding| is set.
570>
571 :let g:html_dynamic_folds = 1
572<
573 *g:html_no_foldcolumn*
574Default: 0.
575When 0, if |g:html_dynamic_folds| is 1, generate a column of text similar to
576Vim's foldcolumn (|fold-foldcolumn|) the user can click on to toggle folds
577open or closed. The minimum width of the generated text column is the current
578'foldcolumn' setting.
579When 1, do not generate this column; instead, hovering the mouse cursor over
580folded text will open the fold as if |g:html_hover_unfold| were set.
581>
582 :let g:html_no_foldcolumn = 1
583<
584 *TOhtml-uncopyable-text* *g:html_prevent_copy*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +0100585Default: Empty string.
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200586This option prevents certain regions of the generated HTML from being copied,
587when you select all text in document rendered in a browser and copy it. Useful
588for allowing users to copy-paste only the source text even if a fold column or
589line numbers are shown in the generated content. Specify regions to be
590affected in this way as follows:
591 f: fold column
592 n: line numbers (also within fold text)
593 t: fold text
594 d: diff filler
595
596Example, to make the fold column and line numbers uncopyable: >
597 :let g:html_prevent_copy = "fn"
598<
Bram Moolenaar09c6f262019-11-17 15:55:14 +0100599The method used to prevent copying in the generated page depends on the value
600of |g:html_use_input_for_pc|.
601
602 *g:html_use_input_for_pc*
fritzophrenic86cfb392023-09-08 12:20:01 -0500603Default: "none"
Bram Moolenaar09c6f262019-11-17 15:55:14 +0100604If |g:html_prevent_copy| is non-empty, then:
605
606When "all", read-only <input> elements are used in place of normal text for
607uncopyable regions. In some browsers, especially older browsers, after
608selecting an entire page and copying the selection, the <input> tags are not
609pasted with the page text. If |g:html_no_invalid| is 0, the <input> tags have
610invalid type; this works in more browsers, but the page will not validate.
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +0100611Note: This method does NOT work in recent versions of Chrome and equivalent
Bram Moolenaar09c6f262019-11-17 15:55:14 +0100612browsers; the <input> tags get pasted with the text.
613
614When "fallback" (default value), the same <input> elements are generated for
615older browsers, but newer browsers (detected by CSS feature query) hide the
616<input> elements and instead use generated content in an ::before pseudoelement
617to display the uncopyable text. This method should work with the largest
618number of browsers, both old and new.
619
620When "none", the <input> elements are not generated at all. Only the
621generated-content method is used. This means that old browsers, notably
622Internet Explorer, will either copy the text intended not to be copyable, or
623the non-copyable text may not appear at all. However, this is the most
624standards-based method, and there will be much less markup.
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200625
626 *g:html_no_invalid*
627Default: 0.
Bram Moolenaar09c6f262019-11-17 15:55:14 +0100628When 0, if |g:html_prevent_copy| is non-empty and |g:html_use_input_for_pc| is
629not "none", an invalid attribute is intentionally inserted into the <input>
630element for the uncopyable areas. This prevents pasting the <input> elements
631in some applications. Specifically, some versions of Microsoft Word will not
632paste the <input> elements if they contain this invalid attribute. When 1, no
633invalid markup is inserted, and the generated page should validate. However,
634<input> elements may be pasted into some applications and can be difficult to
635remove afterward.
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200636
637 *g:html_hover_unfold*
638Default: 0.
639When 0, the only way to open a fold generated by 2html.vim with
640|g:html_dynamic_folds| set, is to click on the generated fold column.
641When 1, use CSS 2.0 to allow the user to open a fold by moving the mouse
642cursor over the displayed fold text. This is useful to allow users with
643disabled javascript to view the folded text.
644
645Note that old browsers (notably Internet Explorer 6) will not support this
646feature. Browser-specific markup for IE6 is included to fall back to the
647normal CSS1 styling so that the folds show up correctly for this browser, but
648they will not be openable without a foldcolumn.
649>
650 :let g:html_hover_unfold = 1
651<
Bram Moolenaar31c31672013-06-26 13:28:14 +0200652 *g:html_id_expr*
653Default: ""
654Dynamic folding and jumping to line IDs rely on unique IDs within the document
655to work. If generated HTML is copied into a larger document, these IDs are no
656longer guaranteed to be unique. Set g:html_id_expr to an expression Vim can
657evaluate to get a unique string to append to each ID used in a given document,
658so that the full IDs will be unique even when combined with other content in a
659larger HTML document. Example, to append _ and the buffer number to each ID: >
660
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000661 :let g:html_id_expr = '"_" .. bufnr("%")'
Bram Moolenaar31c31672013-06-26 13:28:14 +0200662<
663To append a string "_mystring" to the end of each ID: >
664
665 :let g:html_id_expr = '"_mystring"'
666<
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +0100667Note: When converting a diff view to HTML, the expression will only be
Bram Moolenaar31c31672013-06-26 13:28:14 +0200668evaluated for the first window in the diff, and the result used for all the
669windows.
670
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200671 *TOhtml-wrap-text* *g:html_pre_wrap*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +0100672Default: Current 'wrap' setting.
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200673When 0, if |g:html_no_pre| is 0 or unset, the text in the generated HTML does
674not wrap at the edge of the browser window.
675When 1, if |g:html_use_css| is 1, the CSS 2.0 "white-space:pre-wrap" value is
676used, causing the text to wrap at whitespace at the edge of the browser
677window.
678Explicitly enable text wrapping: >
679 :let g:html_pre_wrap = 1
680Explicitly disable wrapping: >
681 :let g:html_pre_wrap = 0
682Go back to default, determine wrapping from 'wrap' setting: >
683 :unlet g:html_pre_wrap
684<
685 *g:html_no_pre*
686Default: 0.
687When 0, buffer text in the generated HTML is surrounded by <pre>...</pre>
688tags. Series of whitespace is shown as in Vim without special markup, and tab
689characters can be included literally (see |g:html_expand_tabs|).
690When 1 (not recommended), the <pre> tags are omitted, and a plain <div> is
691used instead. Whitespace is replaced by a series of &nbsp; character
692references, and <br> is used to end each line. This is another way to allow
693text in the generated HTML is wrap (see |g:html_pre_wrap|) which also works in
694old browsers, but may cause noticeable differences between Vim's display and
695the rendered page generated by 2html.vim.
696>
697 :let g:html_no_pre = 1
698<
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +0100699 *g:html_no_doc*
700Default: 0.
701When 1 it doesn't generate a full HTML document with a DOCTYPE, <head>,
702<body>, etc. If |g:html_use_css| is enabled (the default) you'll have to
703define the CSS manually. The |g:html_dynamic_folds| and |g:html_line_ids|
704settings (off by default) also insert some JavaScript.
705
706
707 *g:html_no_links*
708Default: 0.
709Don't generate <a> tags for text that looks like an URL.
710
711 *g:html_no_modeline*
712Default: 0.
713Don't generate a modeline disabling folding.
714
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200715 *g:html_expand_tabs*
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +0100716Default: 0 if 'tabstop' is 8, 'expandtab' is 0, 'vartabstop' is not in use,
717 and no fold column or line numbers occur in the generated HTML;
718 1 otherwise.
719When 1, <Tab> characters in the buffer text are replaced with an appropriate
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200720number of space characters, or &nbsp; references if |g:html_no_pre| is 1.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +0100721When 0, if |g:html_no_pre| is 0 or unset, <Tab> characters in the buffer text
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200722are included as-is in the generated HTML. This is useful for when you want to
723allow copy and paste from a browser without losing the actual whitespace in
724the source document. Note that this can easily break text alignment and
725indentation in the HTML, unless set by default.
726
727Force |2html.vim| to keep <Tab> characters: >
728 :let g:html_expand_tabs = 0
729<
730Force tabs to be expanded: >
731 :let g:html_expand_tabs = 1
732<
733 *TOhtml-encoding-detect* *TOhtml-encoding*
734It is highly recommended to set your desired encoding with
735|g:html_use_encoding| for any content which will be placed on a web server.
736
737If you do not specify an encoding, |2html.vim| uses the preferred IANA name
738for the current value of 'fileencoding' if set, or 'encoding' if not.
739'encoding' is always used for certain 'buftype' values. 'fileencoding' will be
740set to match the chosen document encoding.
741
742Automatic detection works for the encodings mentioned specifically by name in
743|encoding-names|, but TOhtml will only automatically use those encodings with
744wide browser support. However, you can override this to support specific
745encodings that may not be automatically detected by default (see options
746below). See http://www.iana.org/assignments/character-sets for the IANA names.
747
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +0100748Note: By default all Unicode encodings are converted to UTF-8 with no BOM in
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200749the generated HTML, as recommended by W3C:
750
751 http://www.w3.org/International/questions/qa-choosing-encodings
752 http://www.w3.org/International/questions/qa-byte-order-mark
753
754 *g:html_use_encoding*
755Default: none, uses IANA name for current 'fileencoding' as above.
756To overrule all automatic charset detection, set g:html_use_encoding to the
757name of the charset to be used. It is recommended to set this variable to
758something widely supported, like UTF-8, for anything you will be hosting on a
759webserver: >
760 :let g:html_use_encoding = "UTF-8"
761You can also use this option to omit the line that specifies the charset
762entirely, by setting g:html_use_encoding to an empty string (NOT recommended): >
763 :let g:html_use_encoding = ""
764To go back to the automatic mechanism, delete the |g:html_use_encoding|
765variable: >
766 :unlet g:html_use_encoding
767<
768 *g:html_encoding_override*
769Default: none, autoload/tohtml.vim contains default conversions for encodings
770 mentioned by name at |encoding-names|.
771This option allows |2html.vim| to detect the correct 'fileencoding' when you
772specify an encoding with |g:html_use_encoding| which is not in the default
773list of conversions.
774
775This is a dictionary of charset-encoding pairs that will replace existing
776pairs automatically detected by TOhtml, or supplement with new pairs.
777
778Detect the HTML charset "windows-1252" as the encoding "8bit-cp1252": >
779 :let g:html_encoding_override = {'windows-1252': '8bit-cp1252'}
780<
781 *g:html_charset_override*
782Default: none, autoload/tohtml.vim contains default conversions for encodings
783 mentioned by name at |encoding-names| and which have wide
784 browser support.
785This option allows |2html.vim| to detect the HTML charset for any
786'fileencoding' or 'encoding' which is not detected automatically. You can also
787use it to override specific existing encoding-charset pairs. For example,
788TOhtml will by default use UTF-8 for all Unicode/UCS encodings. To use UTF-16
789and UTF-32 instead, use: >
790 :let g:html_charset_override = {'ucs-4': 'UTF-32', 'utf-16': 'UTF-16'}
791
792Note that documents encoded in either UTF-32 or UTF-16 have known
793compatibility problems with some major browsers.
794
Bram Moolenaar60cce2f2015-10-13 23:21:27 +0200795 *g:html_font*
796Default: "monospace"
797You can specify the font or fonts used in the converted document using
798g:html_font. If this option is set to a string, then the value will be
799surrounded with single quotes. If this option is set to a list then each list
800item is surrounded by single quotes and the list is joined with commas. Either
801way, "monospace" is added as the fallback generic family name and the entire
802result used as the font family (using CSS) or font face (if not using CSS).
803Examples: >
804
805 " font-family: 'Consolas', monospace;
806 :let g:html_font = "Consolas"
807
808 " font-family: 'DejaVu Sans Mono', 'Consolas', monospace;
809 :let g:html_font = ["DejaVu Sans Mono", "Consolas"]
810<
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200811 *convert-to-XML* *convert-to-XHTML* *g:html_use_xhtml*
812Default: 0.
813When 0, generate standard HTML 4.01 (strict when possible).
814When 1, generate XHTML 1.0 instead (XML compliant HTML).
815>
816 :let g:html_use_xhtml = 1
817<
Bram Moolenaar9d87a372018-12-18 21:41:50 +0100818==============================================================================
8195. Syntax file remarks *:syn-file-remarks*
820
821 *b:current_syntax-variable*
822Vim stores the name of the syntax that has been loaded in the
823"b:current_syntax" variable. You can use this if you want to load other
824settings, depending on which syntax is active. Example: >
825 :au BufReadPost * if b:current_syntax == "csh"
826 :au BufReadPost * do-some-things
827 :au BufReadPost * endif
828
829
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830
Bram Moolenaarda2303d2005-08-30 21:55:26 +0000831ABEL *abel.vim* *ft-abel-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000832
833ABEL highlighting provides some user-defined options. To enable them, assign
834any value to the respective variable. Example: >
835 :let abel_obsolete_ok=1
836To disable them use ":unlet". Example: >
837 :unlet abel_obsolete_ok
838
839Variable Highlight ~
840abel_obsolete_ok obsolete keywords are statements, not errors
841abel_cpp_comments_illegal do not interpret '//' as inline comment leader
842
843
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000844ADA
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000846See |ft-ada-syntax|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000847
848
Bram Moolenaarda2303d2005-08-30 21:55:26 +0000849ANT *ant.vim* *ft-ant-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850
851The ant syntax file provides syntax highlighting for javascript and python
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000852by default. Syntax highlighting for other script languages can be installed
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853by the function AntSyntaxScript(), which takes the tag name as first argument
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000854and the script syntax file name as second argument. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855
856 :call AntSyntaxScript('perl', 'perl.vim')
857
858will install syntax perl highlighting for the following ant code >
859
860 <script language = 'perl'><![CDATA[
861 # everything inside is highlighted as perl
862 ]]></script>
863
864See |mysyntaxfile-add| for installing script languages permanently.
865
866
Bram Moolenaarda2303d2005-08-30 21:55:26 +0000867APACHE *apache.vim* *ft-apache-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000868
Bram Moolenaar01164a62017-11-02 22:58:42 +0100869The apache syntax file provides syntax highlighting for Apache HTTP server
870version 2.2.3.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872
873 *asm.vim* *asmh8300.vim* *nasm.vim* *masm.vim* *asm68k*
Bram Moolenaarda2303d2005-08-30 21:55:26 +0000874ASSEMBLY *ft-asm-syntax* *ft-asmh8300-syntax* *ft-nasm-syntax*
875 *ft-masm-syntax* *ft-asm68k-syntax* *fasm.vim*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000876
877Files matching "*.i" could be Progress or Assembly. If the automatic detection
878doesn't work for you, or you don't edit Progress at all, use this in your
879startup vimrc: >
880 :let filetype_i = "asm"
881Replace "asm" with the type of assembly you use.
882
883There are many types of assembly languages that all use the same file name
884extensions. Therefore you will have to select the type yourself, or add a
885line in the assembly file that Vim will recognize. Currently these syntax
886files are included:
887 asm GNU assembly (the default)
888 asm68k Motorola 680x0 assembly
889 asmh8300 Hitachi H-8300 version of GNU assembly
890 ia64 Intel Itanium 64
891 fasm Flat assembly (http://flatassembler.net)
892 masm Microsoft assembly (probably works for any 80x86)
893 nasm Netwide assembly
894 tasm Turbo Assembly (with opcodes 80x86 up to Pentium, and
895 MMX)
896 pic PIC assembly (currently for PIC16F84)
897
898The most flexible is to add a line in your assembly file containing: >
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100899 asmsyntax=nasm
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900Replace "nasm" with the name of the real assembly syntax. This line must be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100901one of the first five lines in the file. No non-white text must be
Bram Moolenaar30b65812012-07-12 22:01:11 +0200902immediately before or after this text. Note that specifying asmsyntax=foo is
903equivalent to setting ft=foo in a |modeline|, and that in case of a conflict
904between the two settings the one from the modeline will take precedence (in
905particular, if you have ft=asm in the modeline, you will get the GNU syntax
906highlighting regardless of what is specified as asmsyntax).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000907
908The syntax type can always be overruled for a specific buffer by setting the
909b:asmsyntax variable: >
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000910 :let b:asmsyntax = "nasm"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000911
912If b:asmsyntax is not set, either automatically or by hand, then the value of
913the global variable asmsyntax is used. This can be seen as a default assembly
914language: >
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000915 :let asmsyntax = "nasm"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916
917As a last resort, if nothing is defined, the "asm" syntax is used.
918
919
920Netwide assembler (nasm.vim) optional highlighting ~
921
922To enable a feature: >
923 :let {variable}=1|set syntax=nasm
924To disable a feature: >
925 :unlet {variable} |set syntax=nasm
926
927Variable Highlight ~
928nasm_loose_syntax unofficial parser allowed syntax not as Error
929 (parser dependent; not recommended)
930nasm_ctx_outside_macro contexts outside macro not as Error
931nasm_no_warn potentially risky syntax not as ToDo
932
Philip Hd3ff1292024-04-21 15:44:10 +0200933ASTRO *astro.vim* *ft-astro-syntax*
934
935Configuration
936
937The following variables control certain syntax highlighting features.
h-east9c4389a2024-06-09 16:32:19 +0200938You can add them to your .vimrc.
939
Ken Takatab4e648a2024-06-11 19:45:32 +0200940To enable TypeScript and TSX for ".astro" files (default "disable"): >
Philip Hd3ff1292024-04-21 15:44:10 +0200941 let g:astro_typescript = "enable"
942<
Ken Takatab4e648a2024-06-11 19:45:32 +0200943To enable Stylus for ".astro" files (default "disable"): >
Philip Hd3ff1292024-04-21 15:44:10 +0200944 let g:astro_stylus = "enable"
945<
Philip Hd3ff1292024-04-21 15:44:10 +0200946NOTE: You need to install an external plugin to support stylus in astro files.
947
Bram Moolenaar071d4272004-06-13 20:20:40 +0000948
h-east53753f62024-05-05 18:42:31 +0200949ASPPERL *ft-aspperl-syntax*
950ASPVBS *ft-aspvbs-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000951
952*.asp and *.asa files could be either Perl or Visual Basic script. Since it's
953hard to detect this you can set two global variables to tell Vim what you are
954using. For Perl script use: >
955 :let g:filetype_asa = "aspperl"
956 :let g:filetype_asp = "aspperl"
957For Visual Basic use: >
958 :let g:filetype_asa = "aspvbs"
959 :let g:filetype_asp = "aspvbs"
960
AvidSeeker3088ef02024-07-16 21:39:07 +0200961ASYMPTOTE *asy.vim* *ft-asy-syntax*
962
963By default, only basic Asymptote keywords are highlighted. To highlight
964extended geometry keywords: >
965
966 :let g:asy_syn_plain = 1
967
968and for highlighting keywords related to 3D constructions: >
969
970 :let g:asy_syn_three = 1
971
972By default, Asymptote-defined colors (e.g: lightblue) are highlighted. To
973highlight TeX-defined colors (e.g: BlueViolet) use: >
974
975 :let g:asy_syn_texcolors = 1
976
977or for Xorg colors (e.g: AliceBlue): >
978
979 :let g:asy_syn_x11colors = 1
Bram Moolenaar071d4272004-06-13 20:20:40 +0000980
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000981BAAN *baan.vim* *baan-syntax*
Bram Moolenaarf193fff2006-04-27 00:02:13 +0000982
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +0200983The baan.vim gives syntax support for BaanC of release BaanIV up to SSA ERP LN
Bram Moolenaarf193fff2006-04-27 00:02:13 +0000984for both 3 GL and 4 GL programming. Large number of standard defines/constants
985are supported.
986
987Some special violation of coding standards will be signalled when one specify
988in ones |.vimrc|: >
989 let baan_code_stds=1
990
991*baan-folding*
992
993Syntax folding can be enabled at various levels through the variables
994mentioned below (Set those in your |.vimrc|). The more complex folding on
995source blocks and SQL can be CPU intensive.
996
997To allow any folding and enable folding at function level use: >
998 let baan_fold=1
999Folding can be enabled at source block level as if, while, for ,... The
1000indentation preceding the begin/end keywords has to match (spaces are not
1001considered equal to a tab). >
1002 let baan_fold_block=1
1003Folding can be enabled for embedded SQL blocks as SELECT, SELECTDO,
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001004SELECTEMPTY, ... The indentation preceding the begin/end keywords has to
Bram Moolenaarf193fff2006-04-27 00:02:13 +00001005match (spaces are not considered equal to a tab). >
1006 let baan_fold_sql=1
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001007Note: Block folding can result in many small folds. It is suggested to |:set|
Bram Moolenaarf193fff2006-04-27 00:02:13 +00001008the options 'foldminlines' and 'foldnestmax' in |.vimrc| or use |:setlocal| in
1009.../after/syntax/baan.vim (see |after-directory|). Eg: >
1010 set foldminlines=5
1011 set foldnestmax=6
1012
1013
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001014BASIC *basic.vim* *vb.vim* *ft-basic-syntax* *ft-vb-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001016Both Visual Basic and "normal" BASIC use the extension ".bas". To detect
Bram Moolenaar071d4272004-06-13 20:20:40 +00001017which one should be used, Vim checks for the string "VB_Name" in the first
1018five lines of the file. If it is not found, filetype will be "basic",
1019otherwise "vb". Files with the ".frm" extension will always be seen as Visual
1020Basic.
1021
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001022If the automatic detection doesn't work for you or you only edit, for
1023example, FreeBASIC files, use this in your startup vimrc: >
1024 :let filetype_bas = "freebasic"
1025
Bram Moolenaar071d4272004-06-13 20:20:40 +00001026
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001027C *c.vim* *ft-c-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001028
1029A few things in C highlighting are optional. To enable them assign any value
Bram Moolenaar91359012019-11-30 17:57:03 +01001030(including zero) to the respective variable. Example: >
Bram Moolenaar8c8de832008-06-24 22:58:06 +00001031 :let c_comment_strings = 1
Bram Moolenaar91359012019-11-30 17:57:03 +01001032 :let c_no_bracket_error = 0
1033To disable them use `:unlet`. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001034 :unlet c_comment_strings
Bram Moolenaar91359012019-11-30 17:57:03 +01001035Setting the value to zero doesn't work!
Bram Moolenaar071d4272004-06-13 20:20:40 +00001036
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001037An alternative is to switch to the C++ highlighting: >
1038 :set filetype=cpp
1039
Bram Moolenaar071d4272004-06-13 20:20:40 +00001040Variable Highlight ~
Bram Moolenaar03413f42016-04-12 21:07:15 +02001041*c_gnu* GNU gcc specific items
1042*c_comment_strings* strings and numbers inside a comment
Christian Brabandt06300802023-12-21 16:57:09 +01001043*c_space_errors* trailing white space and spaces before a <Tab>
1044*c_no_trail_space_error* ... but no trailing spaces
Bram Moolenaar03413f42016-04-12 21:07:15 +02001045*c_no_tab_space_error* ... but no spaces before a <Tab>
1046*c_no_bracket_error* don't highlight {}; inside [] as errors
1047*c_no_curly_error* don't highlight {}; inside [] and () as errors;
Christian Brabandt06300802023-12-21 16:57:09 +01001048 ...except { and } in first column
1049 Default is to highlight them, otherwise you
1050 can't spot a missing ")".
Bram Moolenaar91359012019-11-30 17:57:03 +01001051*c_curly_error* highlight a missing } by finding all pairs; this
1052 forces syncing from the start of the file, can be slow
Bram Moolenaar03413f42016-04-12 21:07:15 +02001053*c_no_ansi* don't do standard ANSI types and constants
Christian Brabandt06300802023-12-21 16:57:09 +01001054*c_ansi_typedefs* ... but do standard ANSI types
Bram Moolenaar03413f42016-04-12 21:07:15 +02001055*c_ansi_constants* ... but do standard ANSI constants
1056*c_no_utf* don't highlight \u and \U in strings
Christian Brabandt06300802023-12-21 16:57:09 +01001057*c_syntax_for_h* for *.h files use C syntax instead of C++ and use objc
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02001058 syntax instead of objcpp
Bram Moolenaar03413f42016-04-12 21:07:15 +02001059*c_no_if0* don't highlight "#if 0" blocks as comments
1060*c_no_cformat* don't highlight %-formats in strings
1061*c_no_c99* don't highlight C99 standard items
1062*c_no_c11* don't highlight C11 standard items
1063*c_no_bsd* don't highlight BSD specific types
Luca Saccarolaca0e9822023-12-24 18:57:02 +01001064*c_functions* highlight function calls and definitions
1065*c_function_pointers* highlight function pointers definitions
Bram Moolenaar071d4272004-06-13 20:20:40 +00001066
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001067When 'foldmethod' is set to "syntax" then /* */ comments and { } blocks will
1068become a fold. If you don't want comments to become a fold use: >
1069 :let c_no_comment_fold = 1
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00001070"#if 0" blocks are also folded, unless: >
1071 :let c_no_if0_fold = 1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001072
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073If you notice highlighting errors while scrolling backwards, which are fixed
1074when redrawing with CTRL-L, try setting the "c_minlines" internal variable
1075to a larger number: >
1076 :let c_minlines = 100
1077This will make the syntax synchronization start 100 lines before the first
1078displayed line. The default value is 50 (15 when c_no_if0 is set). The
1079disadvantage of using a larger number is that redrawing can become slow.
1080
1081When using the "#if 0" / "#endif" comment highlighting, notice that this only
1082works when the "#if 0" is within "c_minlines" from the top of the window. If
1083you have a long "#if 0" construct it will not be highlighted correctly.
1084
1085To match extra items in comments, use the cCommentGroup cluster.
1086Example: >
1087 :au Syntax c call MyCadd()
1088 :function MyCadd()
1089 : syn keyword cMyItem contained Ni
1090 : syn cluster cCommentGroup add=cMyItem
1091 : hi link cMyItem Title
1092 :endfun
1093
1094ANSI constants will be highlighted with the "cConstant" group. This includes
1095"NULL", "SIG_IGN" and others. But not "TRUE", for example, because this is
1096not in the ANSI standard. If you find this confusing, remove the cConstant
1097highlighting: >
1098 :hi link cConstant NONE
1099
1100If you see '{' and '}' highlighted as an error where they are OK, reset the
1101highlighting for cErrInParen and cErrInBracket.
1102
1103If you want to use folding in your C files, you can add these lines in a file
Bram Moolenaar06b5d512010-05-22 15:37:44 +02001104in the "after" directory in 'runtimepath'. For Unix this would be
Bram Moolenaar071d4272004-06-13 20:20:40 +00001105~/.vim/after/syntax/c.vim. >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106 syn sync fromstart
1107 set foldmethod=syntax
1108
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001109CH *ch.vim* *ft-ch-syntax*
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001110
1111C/C++ interpreter. Ch has similar syntax highlighting to C and builds upon
1112the C syntax file. See |c.vim| for all the settings that are available for C.
1113
1114By setting a variable you can tell Vim to use Ch syntax for *.h files, instead
1115of C or C++: >
1116 :let ch_syntax_for_h = 1
1117
Bram Moolenaar071d4272004-06-13 20:20:40 +00001118
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001119CHILL *chill.vim* *ft-chill-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001120
1121Chill syntax highlighting is similar to C. See |c.vim| for all the settings
1122that are available. Additionally there is:
1123
Bram Moolenaar071d4272004-06-13 20:20:40 +00001124chill_space_errors like c_space_errors
1125chill_comment_string like c_comment_strings
1126chill_minlines like c_minlines
1127
1128
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001129CHANGELOG *changelog.vim* *ft-changelog-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001130
1131ChangeLog supports highlighting spaces at the start of a line.
1132If you do not like this, add following line to your .vimrc: >
1133 let g:changelog_spacing_errors = 0
1134This works the next time you edit a changelog file. You can also use
1135"b:changelog_spacing_errors" to set this per buffer (before loading the syntax
1136file).
1137
1138You can change the highlighting used, e.g., to flag the spaces as an error: >
1139 :hi link ChangelogError Error
1140Or to avoid the highlighting: >
1141 :hi link ChangelogError NONE
1142This works immediately.
1143
1144
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01001145CLOJURE *ft-clojure-syntax*
1146
Bram Moolenaar113cb512021-11-07 20:27:04 +00001147 *g:clojure_syntax_keywords*
1148
1149Syntax highlighting of public vars in "clojure.core" is provided by default,
1150but additional symbols can be highlighted by adding them to the
1151|g:clojure_syntax_keywords| variable. The value should be a |Dictionary| of
1152syntax group names, each containing a |List| of identifiers.
Bram Moolenaar6f1d9a02016-07-24 14:12:38 +02001153>
1154 let g:clojure_syntax_keywords = {
Bram Moolenaar113cb512021-11-07 20:27:04 +00001155 \ 'clojureMacro': ["defproject", "defcustom"],
1156 \ 'clojureFunc': ["string/join", "string/replace"]
Bram Moolenaar6f1d9a02016-07-24 14:12:38 +02001157 \ }
1158<
1159Refer to the Clojure syntax script for valid syntax group names.
1160
Bram Moolenaar113cb512021-11-07 20:27:04 +00001161There is also *b:clojure_syntax_keywords* which is a buffer-local variant of
1162this variable intended for use by plugin authors to highlight symbols
1163dynamically.
Bram Moolenaar6f1d9a02016-07-24 14:12:38 +02001164
Bram Moolenaar113cb512021-11-07 20:27:04 +00001165By setting the *b:clojure_syntax_without_core_keywords* variable, vars from
1166"clojure.core" will not be highlighted by default. This is useful for
1167namespaces that have set `(:refer-clojure :only [])`
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01001168
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01001169
Bram Moolenaar113cb512021-11-07 20:27:04 +00001170 *g:clojure_fold*
1171
1172Setting |g:clojure_fold| to `1` will enable the folding of Clojure code. Any
1173list, vector or map that extends over more than one line can be folded using
1174the standard Vim |fold-commands|.
1175
1176
1177 *g:clojure_discard_macro*
1178
1179Set this variable to `1` to enable basic highlighting of Clojure's "discard
1180reader macro".
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01001181>
Bram Moolenaar113cb512021-11-07 20:27:04 +00001182 #_(defn foo [x]
1183 (println x))
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01001184<
Bram Moolenaar113cb512021-11-07 20:27:04 +00001185Note that this option will not correctly highlight stacked discard macros
1186(e.g. `#_#_`).
1187
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01001188
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001189COBOL *cobol.vim* *ft-cobol-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001190
1191COBOL highlighting has different needs for legacy code than it does for fresh
1192development. This is due to differences in what is being done (maintenance
1193versus development) and other factors. To enable legacy code highlighting,
1194add this line to your .vimrc: >
1195 :let cobol_legacy_code = 1
1196To disable it again, use this: >
1197 :unlet cobol_legacy_code
1198
1199
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001200COLD FUSION *coldfusion.vim* *ft-coldfusion-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001201
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001202The ColdFusion has its own version of HTML comments. To turn on ColdFusion
Bram Moolenaar071d4272004-06-13 20:20:40 +00001203comment highlighting, add the following line to your startup file: >
1204
1205 :let html_wrong_comments = 1
1206
1207The ColdFusion syntax file is based on the HTML syntax file.
1208
1209
Bram Moolenaar34700a62013-03-07 13:20:54 +01001210CPP *cpp.vim* *ft-cpp-syntax*
1211
Bram Moolenaar89a9c152021-08-29 21:55:35 +02001212Most things are the same as |ft-c-syntax|.
Bram Moolenaar34700a62013-03-07 13:20:54 +01001213
1214Variable Highlight ~
Bram Moolenaara0f849e2015-10-30 14:37:44 +01001215cpp_no_cpp11 don't highlight C++11 standard items
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01001216cpp_no_cpp14 don't highlight C++14 standard items
Bram Moolenaar89a9c152021-08-29 21:55:35 +02001217cpp_no_cpp17 don't highlight C++17 standard items
1218cpp_no_cpp20 don't highlight C++20 standard items
Bram Moolenaar34700a62013-03-07 13:20:54 +01001219
1220
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001221CSH *csh.vim* *ft-csh-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001222
1223This covers the shell named "csh". Note that on some systems tcsh is actually
1224used.
1225
1226Detecting whether a file is csh or tcsh is notoriously hard. Some systems
1227symlink /bin/csh to /bin/tcsh, making it almost impossible to distinguish
1228between csh and tcsh. In case VIM guesses wrong you can set the
Bram Moolenaar97293012011-07-18 19:40:27 +02001229"filetype_csh" variable. For using csh: *g:filetype_csh*
1230>
1231 :let g:filetype_csh = "csh"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001232
1233For using tcsh: >
1234
Bram Moolenaar97293012011-07-18 19:40:27 +02001235 :let g:filetype_csh = "tcsh"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001236
1237Any script with a tcsh extension or a standard tcsh filename (.tcshrc,
1238tcsh.tcshrc, tcsh.login) will have filetype tcsh. All other tcsh/csh scripts
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001239will be classified as tcsh, UNLESS the "filetype_csh" variable exists. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001240"filetype_csh" variable exists, the filetype will be set to the value of the
1241variable.
1242
Christian Brabandtb9bbf1f2024-07-07 19:24:36 +02001243CSV *ft-csv-syntax*
1244
zeertzjqd1c36982024-07-08 21:02:14 +02001245If you change the delimiter of a CSV file, its syntax highlighting will no
1246longer match the changed file content. You will need to unlet the following
1247variable: >
Christian Brabandtb9bbf1f2024-07-07 19:24:36 +02001248
1249 :unlet b:csv_delimiter
1250
1251And afterwards save and reload the file: >
1252
1253 :w
1254 :e
1255
zeertzjqd1c36982024-07-08 21:02:14 +02001256Now the syntax engine should determine the newly changed CSV delimiter.
Christian Brabandtb9bbf1f2024-07-07 19:24:36 +02001257
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001259CYNLIB *cynlib.vim* *ft-cynlib-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001260
1261Cynlib files are C++ files that use the Cynlib class library to enable
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001262hardware modelling and simulation using C++. Typically Cynlib files have a .cc
Bram Moolenaar071d4272004-06-13 20:20:40 +00001263or a .cpp extension, which makes it very difficult to distinguish them from a
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001264normal C++ file. Thus, to enable Cynlib highlighting for .cc files, add this
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265line to your .vimrc file: >
1266
1267 :let cynlib_cyntax_for_cc=1
1268
1269Similarly for cpp files (this extension is only usually used in Windows) >
1270
1271 :let cynlib_cyntax_for_cpp=1
1272
1273To disable these again, use this: >
1274
1275 :unlet cynlib_cyntax_for_cc
1276 :unlet cynlib_cyntax_for_cpp
1277<
1278
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001279CWEB *cweb.vim* *ft-cweb-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280
1281Files matching "*.w" could be Progress or cweb. If the automatic detection
1282doesn't work for you, or you don't edit Progress at all, use this in your
1283startup vimrc: >
1284 :let filetype_w = "cweb"
1285
1286
Bram Moolenaar96f45c02019-10-26 19:53:45 +02001287DART *dart.vim* *ft-dart-syntax*
1288
1289Dart is an object-oriented, typed, class defined, garbage collected language
1290used for developing mobile, desktop, web, and back-end applications. Dart uses
1291a C-like syntax derived from C, Java, and JavaScript, with features adopted
1292from Smalltalk, Python, Ruby, and others.
1293
1294More information about the language and its development environment at the
1295official Dart language website at https://dart.dev
1296
1297dart.vim syntax detects and highlights Dart statements, reserved words,
1298type declarations, storage classes, conditionals, loops, interpolated values,
1299and comments. There is no support idioms from Flutter or any other Dart
1300framework.
1301
1302Changes, fixes? Submit an issue or pull request via:
1303
1304https://github.com/pr3d4t0r/dart-vim-syntax/
1305
1306
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001307DESKTOP *desktop.vim* *ft-desktop-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308
1309Primary goal of this syntax file is to highlight .desktop and .directory files
Bram Moolenaara17d4c12010-05-30 18:30:36 +02001310according to freedesktop.org standard:
Bram Moolenaar65e0d772020-06-14 17:29:55 +02001311https://specifications.freedesktop.org/desktop-entry-spec/latest/
1312To highlight nonstandard extensions that does not begin with X-, set >
1313 let g:desktop_enable_nonstd = 1
1314Note that this may cause wrong highlight.
1315To highlight KDE-reserved features, set >
1316 let g:desktop_enable_kde = 1
1317g:desktop_enable_kde follows g:desktop_enable_nonstd if not supplied
Bram Moolenaar071d4272004-06-13 20:20:40 +00001318
1319
Romain Lafourcade124371c2024-01-07 15:08:31 +01001320DIFF *diff.vim*
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001321
1322The diff highlighting normally finds translated headers. This can be slow if
1323there are very long lines in the file. To disable translations: >
1324
1325 :let diff_translations = 0
1326
Bram Moolenaar0122c402015-02-03 19:13:34 +01001327Also see |diff-slow|.
1328
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001329DIRCOLORS *dircolors.vim* *ft-dircolors-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001330
1331The dircolors utility highlighting definition has one option. It exists to
1332provide compatibility with the Slackware GNU/Linux distributions version of
1333the command. It adds a few keywords that are generally ignored by most
1334versions. On Slackware systems, however, the utility accepts the keywords and
1335uses them for processing. To enable the Slackware keywords add the following
1336line to your startup file: >
1337 let dircolors_is_slackware = 1
1338
1339
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001340DOCBOOK *docbk.vim* *ft-docbk-syntax* *docbook*
Bram Moolenaar81af9252010-12-10 20:35:50 +01001341DOCBOOK XML *docbkxml.vim* *ft-docbkxml-syntax*
1342DOCBOOK SGML *docbksgml.vim* *ft-docbksgml-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001343
1344There are two types of DocBook files: SGML and XML. To specify what type you
1345are using the "b:docbk_type" variable should be set. Vim does this for you
1346automatically if it can recognize the type. When Vim can't guess it the type
1347defaults to XML.
1348You can set the type manually: >
1349 :let docbk_type = "sgml"
1350or: >
1351 :let docbk_type = "xml"
1352You need to do this before loading the syntax file, which is complicated.
1353Simpler is setting the filetype to "docbkxml" or "docbksgml": >
1354 :set filetype=docbksgml
1355or: >
1356 :set filetype=docbkxml
1357
Bram Moolenaar2df58b42012-11-28 18:21:11 +01001358You can specify the DocBook version: >
1359 :let docbk_ver = 3
1360When not set 4 is used.
1361
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001363DOSBATCH *dosbatch.vim* *ft-dosbatch-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001364
Bram Moolenaar938ae282023-02-20 20:44:55 +00001365Select the set of Windows Command interpreter extensions that should be
1366supported with the variable dosbatch_cmdextversion. For versions of Windows
1367NT (before Windows 2000) this should have the value of 1. For Windows 2000
1368and later it should be 2.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001369Select the version you want with the following line: >
1370
Bram Moolenaar8299df92004-07-10 09:47:34 +00001371 :let dosbatch_cmdextversion = 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00001372
1373If this variable is not defined it defaults to a value of 2 to support
Bram Moolenaar938ae282023-02-20 20:44:55 +00001374Windows 2000 and later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001375
Bram Moolenaar938ae282023-02-20 20:44:55 +00001376The original MS-DOS supports an idiom of using a double colon (::) as an
1377alternative way to enter a comment line. This idiom can be used with the
1378current Windows Command Interpreter, but it can lead to problems when used
1379inside ( ... ) command blocks. You can find a discussion about this on
1380Stack Overflow -
1381
1382https://stackoverflow.com/questions/12407800/which-comment-style-should-i-use-in-batch-files
1383
Christian Brabandtf7f33e32024-02-06 10:56:26 +01001384To allow the use of the :: idiom for comments in command blocks with the
1385Windows Command Interpreter set the dosbatch_colons_comment variable to
1386anything: >
Bram Moolenaar938ae282023-02-20 20:44:55 +00001387
1388 :let dosbatch_colons_comment = 1
1389
Christian Brabandtf7f33e32024-02-06 10:56:26 +01001390If this variable is set then a :: comment that is the last line in a command
1391block will be highlighted as an error.
1392
Bram Moolenaar938ae282023-02-20 20:44:55 +00001393There is an option that covers whether *.btm files should be detected as type
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001394"dosbatch" (MS-DOS batch files) or type "btm" (4DOS batch files). The latter
1395is used by default. You may select the former with the following line: >
Bram Moolenaar8299df92004-07-10 09:47:34 +00001396
1397 :let g:dosbatch_syntax_for_btm = 1
1398
1399If this variable is undefined or zero, btm syntax is selected.
1400
1401
Bram Moolenaar8cacf352006-04-15 20:27:24 +00001402DOXYGEN *doxygen.vim* *doxygen-syntax*
1403
1404Doxygen generates code documentation using a special documentation format
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001405(similar to Javadoc). This syntax script adds doxygen highlighting to c, cpp,
1406idl and php files, and should also work with java.
Bram Moolenaar8cacf352006-04-15 20:27:24 +00001407
Bram Moolenaar25394022007-05-10 19:06:20 +00001408There are a few of ways to turn on doxygen formatting. It can be done
1409explicitly or in a modeline by appending '.doxygen' to the syntax of the file.
1410Example: >
Bram Moolenaar8cacf352006-04-15 20:27:24 +00001411 :set syntax=c.doxygen
1412or >
1413 // vim:syntax=c.doxygen
1414
Bram Moolenaar5dc62522012-02-13 00:05:22 +01001415It can also be done automatically for C, C++, C#, IDL and PHP files by setting
1416the global or buffer-local variable load_doxygen_syntax. This is done by
1417adding the following to your .vimrc. >
Bram Moolenaar8cacf352006-04-15 20:27:24 +00001418 :let g:load_doxygen_syntax=1
1419
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01001420There are a couple of variables that have an effect on syntax highlighting,
1421and are to do with non-standard highlighting options.
Bram Moolenaar8cacf352006-04-15 20:27:24 +00001422
1423Variable Default Effect ~
1424g:doxygen_enhanced_color
1425g:doxygen_enhanced_colour 0 Use non-standard highlighting for
1426 doxygen comments.
1427
1428doxygen_my_rendering 0 Disable rendering of HTML bold, italic
1429 and html_my_rendering underline.
1430
1431doxygen_javadoc_autobrief 1 Set to 0 to disable javadoc autobrief
1432 colour highlighting.
1433
1434doxygen_end_punctuation '[.]' Set to regexp match for the ending
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001435 punctuation of brief
Bram Moolenaar8cacf352006-04-15 20:27:24 +00001436
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02001437There are also some highlight groups worth mentioning as they can be useful in
Bram Moolenaar8cacf352006-04-15 20:27:24 +00001438configuration.
1439
1440Highlight Effect ~
1441doxygenErrorComment The colour of an end-comment when missing
1442 punctuation in a code, verbatim or dot section
1443doxygenLinkError The colour of an end-comment when missing the
1444 \endlink from a \link section.
1445
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001447DTD *dtd.vim* *ft-dtd-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001449The DTD syntax highlighting is case sensitive by default. To disable
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450case-sensitive highlighting, add the following line to your startup file: >
1451
1452 :let dtd_ignore_case=1
1453
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001454The DTD syntax file will highlight unknown tags as errors. If
Bram Moolenaar071d4272004-06-13 20:20:40 +00001455this is annoying, it can be turned off by setting: >
1456
1457 :let dtd_no_tag_errors=1
1458
1459before sourcing the dtd.vim syntax file.
1460Parameter entity names are highlighted in the definition using the
1461'Type' highlighting group and 'Comment' for punctuation and '%'.
1462Parameter entity instances are highlighted using the 'Constant'
1463highlighting group and the 'Type' highlighting group for the
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001464delimiters % and ;. This can be turned off by setting: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465
1466 :let dtd_no_param_entities=1
1467
1468The DTD syntax file is also included by xml.vim to highlight included dtd's.
1469
1470
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001471EIFFEL *eiffel.vim* *ft-eiffel-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001472
1473While Eiffel is not case-sensitive, its style guidelines are, and the
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001474syntax highlighting file encourages their use. This also allows to
1475highlight class names differently. If you want to disable case-sensitive
Bram Moolenaar071d4272004-06-13 20:20:40 +00001476highlighting, add the following line to your startup file: >
1477
1478 :let eiffel_ignore_case=1
1479
1480Case still matters for class names and TODO marks in comments.
1481
1482Conversely, for even stricter checks, add one of the following lines: >
1483
1484 :let eiffel_strict=1
1485 :let eiffel_pedantic=1
1486
1487Setting eiffel_strict will only catch improper capitalization for the
1488five predefined words "Current", "Void", "Result", "Precursor", and
1489"NONE", to warn against their accidental use as feature or class names.
1490
1491Setting eiffel_pedantic will enforce adherence to the Eiffel style
1492guidelines fairly rigorously (like arbitrary mixes of upper- and
1493lowercase letters as well as outdated ways to capitalize keywords).
1494
1495If you want to use the lower-case version of "Current", "Void",
1496"Result", and "Precursor", you can use >
1497
1498 :let eiffel_lower_case_predef=1
1499
1500instead of completely turning case-sensitive highlighting off.
1501
1502Support for ISE's proposed new creation syntax that is already
1503experimentally handled by some compilers can be enabled by: >
1504
1505 :let eiffel_ise=1
1506
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001507Finally, some vendors support hexadecimal constants. To handle them, add >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508
1509 :let eiffel_hex_constants=1
1510
1511to your startup file.
1512
1513
Bram Moolenaar08589172014-03-08 18:38:28 +01001514EUPHORIA *euphoria3.vim* *euphoria4.vim* *ft-euphoria-syntax*
1515
Bram Moolenaar7ff78462020-07-10 22:00:53 +02001516Two syntax highlighting files exist for Euphoria. One for Euphoria
Bram Moolenaar664f3cf2019-12-07 16:03:51 +01001517version 3.1.1, which is the default syntax highlighting file, and one for
Bram Moolenaar08589172014-03-08 18:38:28 +01001518Euphoria version 4.0.5 or later.
1519
Christian Brabandt1c5728e2024-05-11 11:12:40 +02001520Euphoria version 3.1.1 (http://www.rapideuphoria.com/ link seems dead) is
1521still necessary for developing applications for the DOS platform, which
1522Euphoria version 4 (http://www.openeuphoria.org/) does not support.
Bram Moolenaar08589172014-03-08 18:38:28 +01001523
Bram Moolenaar664f3cf2019-12-07 16:03:51 +01001524The following file extensions are auto-detected as Euphoria file type:
1525
Bram Moolenaar08589172014-03-08 18:38:28 +01001526 *.e, *.eu, *.ew, *.ex, *.exu, *.exw
1527 *.E, *.EU, *.EW, *.EX, *.EXU, *.EXW
1528
Bram Moolenaar664f3cf2019-12-07 16:03:51 +01001529To select syntax highlighting file for Euphoria, as well as for
Bram Moolenaar08589172014-03-08 18:38:28 +01001530auto-detecting the *.e and *.E file extensions as Euphoria file type,
1531add the following line to your startup file: >
1532
Bram Moolenaar90df4b92021-07-07 20:26:08 +02001533 :let g:filetype_euphoria = "euphoria3"
Bram Moolenaar08589172014-03-08 18:38:28 +01001534
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02001535< or >
Bram Moolenaar08589172014-03-08 18:38:28 +01001536
Bram Moolenaar90df4b92021-07-07 20:26:08 +02001537 :let g:filetype_euphoria = "euphoria4"
1538
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001539Elixir and Euphoria share the *.ex file extension. If the filetype is
Bram Moolenaar90df4b92021-07-07 20:26:08 +02001540specifically set as Euphoria with the g:filetype_euphoria variable, or the
1541file is determined to be Euphoria based on keywords in the file, then the
1542filetype will be set as Euphoria. Otherwise, the filetype will default to
1543Elixir.
Bram Moolenaar08589172014-03-08 18:38:28 +01001544
1545
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001546ERLANG *erlang.vim* *ft-erlang-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001547
Bram Moolenaarad3b3662013-05-17 18:14:19 +02001548Erlang is a functional programming language developed by Ericsson. Files with
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02001549the following extensions are recognized as Erlang files: erl, hrl, yaws.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001550
Bram Moolenaarad3b3662013-05-17 18:14:19 +02001551The BIFs (built-in functions) are highlighted by default. To disable this,
1552put the following line in your vimrc: >
1553
1554 :let g:erlang_highlight_bifs = 0
1555
1556To enable highlighting some special atoms, put this in your vimrc: >
1557
1558 :let g:erlang_highlight_special_atoms = 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559
1560
Bram Moolenaar90df4b92021-07-07 20:26:08 +02001561ELIXIR *elixir.vim* *ft-elixir-syntax*
1562
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01001563Elixir is a dynamic, functional language for building scalable and
1564maintainable applications.
Bram Moolenaar90df4b92021-07-07 20:26:08 +02001565
1566The following file extensions are auto-detected as Elixir file types:
1567
1568 *.ex, *.exs, *.eex, *.leex, *.lock
1569
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001570Elixir and Euphoria share the *.ex file extension. If the filetype is
Bram Moolenaar90df4b92021-07-07 20:26:08 +02001571specifically set as Euphoria with the g:filetype_euphoria variable, or the
1572file is determined to be Euphoria based on keywords in the file, then the
1573filetype will be set as Euphoria. Otherwise, the filetype will default to
1574Elixir.
1575
1576
Bram Moolenaard68071d2006-05-02 22:08:30 +00001577FLEXWIKI *flexwiki.vim* *ft-flexwiki-syntax*
1578
Christian Brabandt1c5728e2024-05-11 11:12:40 +02001579FlexWiki is an ASP.NET-based wiki package which used to be available at
1580http://www.flexwiki.com
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01001581NOTE: This site currently doesn't work, on Wikipedia is mentioned that
Bram Moolenaar446beb42011-05-10 17:18:44 +02001582development stopped in 2009.
Bram Moolenaard68071d2006-05-02 22:08:30 +00001583
1584Syntax highlighting is available for the most common elements of FlexWiki
1585syntax. The associated ftplugin script sets some buffer-local options to make
1586editing FlexWiki pages more convenient. FlexWiki considers a newline as the
1587start of a new paragraph, so the ftplugin sets 'tw'=0 (unlimited line length),
1588'wrap' (wrap long lines instead of using horizontal scrolling), 'linebreak'
1589(to wrap at a character in 'breakat' instead of at the last char on screen),
1590and so on. It also includes some keymaps that are disabled by default.
1591
1592If you want to enable the keymaps that make "j" and "k" and the cursor keys
1593move up and down by display lines, add this to your .vimrc: >
1594 :let flexwiki_maps = 1
1595
1596
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001597FORM *form.vim* *ft-form-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001598
1599The coloring scheme for syntax elements in the FORM file uses the default
1600modes Conditional, Number, Statement, Comment, PreProc, Type, and String,
Bram Moolenaardd2a0d82007-05-12 15:07:00 +00001601following the language specifications in 'Symbolic Manipulation with FORM' by
Bram Moolenaar071d4272004-06-13 20:20:40 +00001602J.A.M. Vermaseren, CAN, Netherlands, 1991.
1603
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01001604If you want to include your own changes to the default colors, you have to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001605redefine the following syntax groups:
1606
1607 - formConditional
1608 - formNumber
1609 - formStatement
1610 - formHeaderStatement
1611 - formComment
1612 - formPreProc
1613 - formDirective
1614 - formType
1615 - formString
1616
1617Note that the form.vim syntax file implements FORM preprocessor commands and
1618directives per default in the same syntax group.
1619
1620A predefined enhanced color mode for FORM is available to distinguish between
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001621header statements and statements in the body of a FORM program. To activate
Bram Moolenaar071d4272004-06-13 20:20:40 +00001622this mode define the following variable in your vimrc file >
1623
1624 :let form_enhanced_color=1
1625
1626The enhanced mode also takes advantage of additional color features for a dark
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001627gvim display. Here, statements are colored LightYellow instead of Yellow, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00001628conditionals are LightBlue for better distinction.
1629
Bram Moolenaara2baa732022-02-04 16:09:54 +00001630Both Visual Basic and FORM use the extension ".frm". To detect which one
1631should be used, Vim checks for the string "VB_Name" in the first five lines of
1632the file. If it is found, filetype will be "vb", otherwise "form".
1633
1634If the automatic detection doesn't work for you or you only edit, for
1635example, FORM files, use this in your startup vimrc: >
1636 :let filetype_frm = "form"
1637
Bram Moolenaar071d4272004-06-13 20:20:40 +00001638
Bram Moolenaar3d14c0f2021-11-27 17:22:07 +00001639FORTH *forth.vim* *ft-forth-syntax*
1640
Doug Kearns19a3bc32023-08-20 20:51:12 +02001641Files matching "*.f" could be Fortran or Forth and those matching "*.fs" could
1642be F# or Forth. If the automatic detection doesn't work for you, or you don't
1643edit F# or Fortran at all, use this in your startup vimrc: >
1644 :let filetype_f = "forth"
Bram Moolenaar3d14c0f2021-11-27 17:22:07 +00001645 :let filetype_fs = "forth"
1646
1647
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001648FORTRAN *fortran.vim* *ft-fortran-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001649
1650Default highlighting and dialect ~
Ajit-Thakkare1ddc2d2024-01-24 15:08:34 -04001651Vim highlights according to Fortran 2023 (the most recent standard). This
1652choice should be appropriate for most users most of the time because Fortran
16532023 is almost a superset of previous versions (Fortran 2018, 2008, 2003, 95,
165490, 77, and 66). A few legacy constructs deleted or declared obsolescent,
1655respectively, in recent Fortran standards are highlighted as errors and todo
Ajit-Thakkar71cbe8e2023-12-18 08:53:21 +01001656items.
Ajit-Thakkar68630842023-12-05 23:07:27 +01001657
1658The syntax script no longer supports Fortran dialects. The variable
1659fortran_dialect is now silently ignored. Since computers are much faster now,
1660the variable fortran_more_precise is no longer needed and is silently ignored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001661
1662Fortran source code form ~
Bram Moolenaar6be7f872012-01-20 21:08:56 +01001663Fortran code can be in either fixed or free source form. Note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001664syntax highlighting will not be correct if the form is incorrectly set.
1665
Ajit-Thakkar71cbe8e2023-12-18 08:53:21 +01001666When you create a new Fortran file, the syntax script assumes fixed source
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001667form. If you always use free source form, then >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668 :let fortran_free_source=1
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01001669in your .vimrc prior to the :syntax on command. If you always use fixed
1670source form, then >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001671 :let fortran_fixed_source=1
1672in your .vimrc prior to the :syntax on command.
1673
Bram Moolenaar256972a2015-12-29 19:10:25 +01001674If the form of the source code depends, in a non-standard way, upon the file
1675extension, then it is most convenient to set fortran_free_source in a ftplugin
1676file. For more information on ftplugin files, see |ftplugin|. Note that this
1677will work only if the "filetype plugin indent on" command precedes the "syntax
1678on" command in your .vimrc file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679
Ajit-Thakkar71cbe8e2023-12-18 08:53:21 +01001680When you edit an existing Fortran file, the syntax script will assume free
Bram Moolenaar071d4272004-06-13 20:20:40 +00001681source form if the fortran_free_source variable has been set, and assumes
Ajit-Thakkar71cbe8e2023-12-18 08:53:21 +01001682fixed source form if the fortran_fixed_source variable has been set. Suppose
1683neither of these variables have been set. In that case, the syntax script attempts to
Bram Moolenaar256972a2015-12-29 19:10:25 +01001684determine which source form has been used by examining the file extension
1685using conventions common to the ifort, gfortran, Cray, NAG, and PathScale
1686compilers (.f, .for, .f77 for fixed-source, .f90, .f95, .f03, .f08 for
Ajit-Thakkar68630842023-12-05 23:07:27 +01001687free-source). No default is used for the .fpp and .ftn file extensions because
1688different compilers treat them differently. If none of this works, then the
1689script examines the first five columns of the first 500 lines of your file. If
1690no signs of free source form are detected, then the file is assumed to be in
1691fixed source form. The algorithm should work in the vast majority of cases.
1692In some cases, such as a file that begins with 500 or more full-line comments,
1693the script may incorrectly decide that the code is in fixed form. If that
1694happens, just add a non-comment statement beginning anywhere in the first five
1695columns of the first twenty-five lines, save (:w), and then reload (:e!) the
1696file.
1697
1698Vendor extensions ~
1699Fixed-form Fortran requires a maximum line length of 72 characters but the
1700script allows a maximum line length of 80 characters as do all compilers
1701created in the last three decades. An even longer line length of 132
1702characters is allowed if you set the variable fortran_extended_line_length
1703with a command such as >
zeertzjq61e984e2023-12-09 15:18:33 +08001704 :let fortran_extended_line_length=1
Ajit-Thakkar68630842023-12-05 23:07:27 +01001705placed prior to the :syntax on command.
1706
1707If you want additional highlighting of the CUDA Fortran extensions, you should
1708set the variable fortran_CUDA with a command such as >
1709 :let fortran_CUDA=1
1710placed prior to the :syntax on command.
1711
1712To activate recognition of some common, non-standard, vendor-supplied
1713intrinsics, you should set the variable fortran_vendor_intrinsics with a
1714command such as >
1715 :let fortran_vendor_intrinsics=1
1716placed prior to the :syntax on command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717
Ajit-Thakkar71cbe8e2023-12-18 08:53:21 +01001718Tabs in Fortran files ~
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001719Tabs are not recognized by the Fortran standards. Tabs are not a good idea in
Ajit-Thakkar71cbe8e2023-12-18 08:53:21 +01001720fixed format Fortran source code which requires fixed column boundaries.
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001721Therefore, tabs are marked as errors. Nevertheless, some programmers like
Ajit-Thakkar71cbe8e2023-12-18 08:53:21 +01001722using tabs. If your Fortran files contain tabs, then you should set the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723variable fortran_have_tabs in your .vimrc with a command such as >
1724 :let fortran_have_tabs=1
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001725placed prior to the :syntax on command. Unfortunately, the use of tabs will
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726mean that the syntax file will not be able to detect incorrect margins.
1727
Ajit-Thakkar71cbe8e2023-12-18 08:53:21 +01001728Syntax folding of Fortran files ~
Ajit-Thakkard94ca962024-01-03 14:58:21 -04001729Vim will fold your file using foldmethod=syntax, if you set the variable
1730fortran_fold in your .vimrc with a command such as >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731 :let fortran_fold=1
1732to instruct the syntax script to define fold regions for program units, that
1733is main programs starting with a program statement, subroutines, function
Ajit-Thakkard94ca962024-01-03 14:58:21 -04001734subprograms, modules, submodules, blocks of comment lines, and block data
1735units. Block, interface, associate, critical, type definition, and change team
1736constructs will also be folded. If you also set the variable
1737fortran_fold_conditionals with a command such as >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001738 :let fortran_fold_conditionals=1
Ajit-Thakkard96f25b2023-12-29 11:29:43 -04001739then fold regions will also be defined for do loops, if blocks, select case,
Ajit-Thakkard94ca962024-01-03 14:58:21 -04001740select type, and select rank constructs. Note that defining fold regions can
1741be slow for large files.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001742
Bram Moolenaar6be7f872012-01-20 21:08:56 +01001743The syntax/fortran.vim script contains embedded comments that tell you how to
1744comment and/or uncomment some lines to (a) activate recognition of some
1745non-standard, vendor-supplied intrinsics and (b) to prevent features deleted
1746or declared obsolescent in the 2008 standard from being highlighted as todo
Bram Moolenaar56b45b92013-06-24 22:22:18 +02001747items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001748
1749Limitations ~
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001750Parenthesis checking does not catch too few closing parentheses. Hollerith
1751strings are not recognized. Some keywords may be highlighted incorrectly
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752because Fortran90 has no reserved words.
1753
Ajit-Thakkar71cbe8e2023-12-18 08:53:21 +01001754For further information related to Fortran, see |ft-fortran-indent| and
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001755|ft-fortran-plugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001756
Bram Moolenaar0d878b92022-07-01 18:45:04 +01001757FREEBASIC *freebasic.vim* *ft-freebasic-syntax*
1758
1759FreeBASIC files will be highlighted differently for each of the four available
1760dialects, "fb", "qb", "fblite" and "deprecated". See |ft-freebasic-plugin|
1761for how to select the correct dialect.
1762
1763Highlighting is further configurable via the following variables.
1764
1765Variable Highlight ~
1766*freebasic_no_comment_fold* disable multiline comment folding
1767*freebasic_operators* non-alpha operators
1768*freebasic_space_errors* trailing white space and spaces before a <Tab>
1769*freebasic_type_suffixes* QuickBASIC style type suffixes
1770
1771
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001773FVWM CONFIGURATION FILES *fvwm.vim* *ft-fvwm-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774
1775In order for Vim to recognize Fvwm configuration files that do not match
1776the patterns *fvwmrc* or *fvwm2rc* , you must put additional patterns
1777appropriate to your system in your myfiletypes.vim file. For these
1778patterns, you must set the variable "b:fvwm_version" to the major version
1779number of Fvwm, and the 'filetype' option to fvwm.
1780
1781For example, to make Vim identify all files in /etc/X11/fvwm2/
1782as Fvwm2 configuration files, add the following: >
1783
1784 :au! BufNewFile,BufRead /etc/X11/fvwm2/* let b:fvwm_version = 2 |
1785 \ set filetype=fvwm
1786
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001787GSP *gsp.vim* *ft-gsp-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788
1789The default coloring style for GSP pages is defined by |html.vim|, and
1790the coloring for java code (within java tags or inline between backticks)
1791is defined by |java.vim|. The following HTML groups defined in |html.vim|
1792are redefined to incorporate and highlight inline java code:
1793
1794 htmlString
1795 htmlValue
1796 htmlEndTag
1797 htmlTag
1798 htmlTagN
1799
1800Highlighting should look fine most of the places where you'd see inline
1801java code, but in some special cases it may not. To add another HTML
1802group where you will have inline java code where it does not highlight
1803correctly, just copy the line you want from |html.vim| and add gspJava
1804to the contains clause.
1805
1806The backticks for inline java are highlighted according to the htmlError
1807group to make them easier to see.
1808
1809
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001810GROFF *groff.vim* *ft-groff-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001811
1812The groff syntax file is a wrapper for |nroff.vim|, see the notes
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001813under that heading for examples of use and configuration. The purpose
Bram Moolenaar071d4272004-06-13 20:20:40 +00001814of this wrapper is to set up groff syntax extensions by setting the
1815filetype from a |modeline| or in a personal filetype definitions file
1816(see |filetype.txt|).
1817
1818
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001819HASKELL *haskell.vim* *lhaskell.vim* *ft-haskell-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820
1821The Haskell syntax files support plain Haskell code as well as literate
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001822Haskell code, the latter in both Bird style and TeX style. The Haskell
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823syntax highlighting will also highlight C preprocessor directives.
1824
1825If you want to highlight delimiter characters (useful if you have a
1826light-coloured background), add to your .vimrc: >
1827 :let hs_highlight_delimiters = 1
1828To treat True and False as keywords as opposed to ordinary identifiers,
1829add: >
1830 :let hs_highlight_boolean = 1
1831To also treat the names of primitive types as keywords: >
1832 :let hs_highlight_types = 1
1833And to treat the names of even more relatively common types as keywords: >
1834 :let hs_highlight_more_types = 1
1835If you want to highlight the names of debugging functions, put in
1836your .vimrc: >
1837 :let hs_highlight_debug = 1
1838
1839The Haskell syntax highlighting also highlights C preprocessor
1840directives, and flags lines that start with # but are not valid
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001841directives as erroneous. This interferes with Haskell's syntax for
1842operators, as they may start with #. If you want to highlight those
Bram Moolenaar071d4272004-06-13 20:20:40 +00001843as operators as opposed to errors, put in your .vimrc: >
1844 :let hs_allow_hash_operator = 1
1845
1846The syntax highlighting for literate Haskell code will try to
1847automatically guess whether your literate Haskell code contains
1848TeX markup or not, and correspondingly highlight TeX constructs
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001849or nothing at all. You can override this globally by putting
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850in your .vimrc >
1851 :let lhs_markup = none
1852for no highlighting at all, or >
1853 :let lhs_markup = tex
1854to force the highlighting to always try to highlight TeX markup.
1855For more flexibility, you may also use buffer local versions of
1856this variable, so e.g. >
1857 :let b:lhs_markup = tex
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001858will force TeX highlighting for a particular buffer. It has to be
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859set before turning syntax highlighting on for the buffer or
1860loading a file.
1861
1862
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001863HTML *html.vim* *ft-html-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001864
1865The coloring scheme for tags in the HTML file works as follows.
1866
1867The <> of opening tags are colored differently than the </> of a closing tag.
1868This is on purpose! For opening tags the 'Function' color is used, while for
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +01001869closing tags the 'Identifier' color is used (See syntax.vim to check how those
1870are defined for you)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871
1872Known tag names are colored the same way as statements in C. Unknown tag
1873names are colored with the same color as the <> or </> respectively which
1874makes it easy to spot errors
1875
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001876Note that the same is true for argument (or attribute) names. Known attribute
Bram Moolenaar071d4272004-06-13 20:20:40 +00001877names are colored differently than unknown ones.
1878
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001879Some HTML tags are used to change the rendering of text. The following tags
Bram Moolenaar071d4272004-06-13 20:20:40 +00001880are recognized by the html.vim syntax coloring file and change the way normal
1881text is shown: <B> <I> <U> <EM> <STRONG> (<EM> is used as an alias for <I>,
1882while <STRONG> as an alias for <B>), <H1> - <H6>, <HEAD>, <TITLE> and <A>, but
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001883only if used as a link (that is, it must include a href as in
Bram Moolenaar25394022007-05-10 19:06:20 +00001884<A href="somefile.html">).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001885
1886If you want to change how such text is rendered, you must redefine the
1887following syntax groups:
1888
1889 - htmlBold
1890 - htmlBoldUnderline
1891 - htmlBoldUnderlineItalic
1892 - htmlUnderline
1893 - htmlUnderlineItalic
1894 - htmlItalic
1895 - htmlTitle for titles
1896 - htmlH1 - htmlH6 for headings
1897
1898To make this redefinition work you must redefine them all with the exception
1899of the last two (htmlTitle and htmlH[1-6], which are optional) and define the
1900following variable in your vimrc (this is due to the order in which the files
1901are read during initialization) >
1902 :let html_my_rendering=1
1903
1904If you'd like to see an example download mysyntax.vim at
1905http://www.fleiner.com/vim/download.html
1906
1907You can also disable this rendering by adding the following line to your
1908vimrc file: >
1909 :let html_no_rendering=1
1910
Christian Brabandtdf9f67e2024-07-30 20:19:15 +02001911By default Vim synchronises the syntax to 250 lines before the first displayed
1912line. This can be configured using: >
1913 :let html_minlines = 500
1914<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001915HTML comments are rather special (see an HTML reference document for the
1916details), and the syntax coloring scheme will highlight all errors.
1917However, if you prefer to use the wrong style (starts with <!-- and
Bram Moolenaar8bb1c3e2014-07-04 16:43:17 +02001918ends with -->) you can define >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919 :let html_wrong_comments=1
1920
1921JavaScript and Visual Basic embedded inside HTML documents are highlighted as
1922'Special' with statements, comments, strings and so on colored as in standard
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01001923programming languages. Note that only JavaScript and Visual Basic are
1924currently supported, no other scripting language has been added yet.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001925
1926Embedded and inlined cascading style sheets (CSS) are highlighted too.
1927
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001928There are several html preprocessor languages out there. html.vim has been
1929written such that it should be trivial to include it. To do so add the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930following two lines to the syntax coloring file for that language
1931(the example comes from the asp.vim file):
Bram Moolenaar30e9b3c2019-09-07 16:24:12 +02001932>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933 runtime! syntax/html.vim
1934 syn cluster htmlPreproc add=asp
1935
1936Now you just need to make sure that you add all regions that contain
1937the preprocessor language to the cluster htmlPreproc.
1938
Bram Moolenaard13166e2022-11-18 21:49:57 +00001939 *html-folding*
1940The HTML syntax file provides syntax |folding| (see |:syn-fold|) between start
1941and end tags. This can be turned on by >
1942
1943 :let g:html_syntax_folding = 1
1944 :set foldmethod=syntax
1945
1946Note: Syntax folding might slow down syntax highlighting significantly,
1947especially for large files.
1948
Bram Moolenaar071d4272004-06-13 20:20:40 +00001949
h-east9c4389a2024-06-09 16:32:19 +02001950HTML/OS (BY AESTIVA) *htmlos.vim* *ft-htmlos-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001951
1952The coloring scheme for HTML/OS works as follows:
1953
1954Functions and variable names are the same color by default, because VIM
1955doesn't specify different colors for Functions and Identifiers. To change
1956this (which is recommended if you want function names to be recognizable in a
1957different color) you need to add the following line to either your ~/.vimrc: >
1958 :hi Function term=underline cterm=bold ctermfg=LightGray
1959
1960Of course, the ctermfg can be a different color if you choose.
1961
1962Another issues that HTML/OS runs into is that there is no special filetype to
1963signify that it is a file with HTML/OS coding. You can change this by opening
1964a file and turning on HTML/OS syntax by doing the following: >
1965 :set syntax=htmlos
1966
1967Lastly, it should be noted that the opening and closing characters to begin a
1968block of HTML/OS code can either be << or [[ and >> or ]], respectively.
1969
1970
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001971IA64 *ia64.vim* *intel-itanium* *ft-ia64-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001972
1973Highlighting for the Intel Itanium 64 assembly language. See |asm.vim| for
1974how to recognize this filetype.
1975
1976To have *.inc files be recognized as IA64, add this to your .vimrc file: >
1977 :let g:filetype_inc = "ia64"
1978
1979
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001980INFORM *inform.vim* *ft-inform-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001981
1982Inform highlighting includes symbols provided by the Inform Library, as
1983most programs make extensive use of it. If do not wish Library symbols
1984to be highlighted add this to your vim startup: >
1985 :let inform_highlight_simple=1
1986
1987By default it is assumed that Inform programs are Z-machine targeted,
1988and highlights Z-machine assembly language symbols appropriately. If
1989you intend your program to be targeted to a Glulx/Glk environment you
1990need to add this to your startup sequence: >
1991 :let inform_highlight_glulx=1
1992
1993This will highlight Glulx opcodes instead, and also adds glk() to the
1994set of highlighted system functions.
1995
1996The Inform compiler will flag certain obsolete keywords as errors when
1997it encounters them. These keywords are normally highlighted as errors
1998by Vim. To prevent such error highlighting, you must add this to your
1999startup sequence: >
2000 :let inform_suppress_obsolete=1
2001
2002By default, the language features highlighted conform to Compiler
2003version 6.30 and Library version 6.11. If you are using an older
2004Inform development environment, you may with to add this to your
2005startup sequence: >
2006 :let inform_highlight_old=1
2007
Bram Moolenaar9e54a0e2006-04-14 20:42:25 +00002008IDL *idl.vim* *idl-syntax*
2009
2010IDL (Interface Definition Language) files are used to define RPC calls. In
2011Microsoft land, this is also used for defining COM interfaces and calls.
2012
2013IDL's structure is simple enough to permit a full grammar based approach to
2014rather than using a few heuristics. The result is large and somewhat
Bram Moolenaar25394022007-05-10 19:06:20 +00002015repetitive but seems to work.
Bram Moolenaar9e54a0e2006-04-14 20:42:25 +00002016
2017There are some Microsoft extensions to idl files that are here. Some of them
2018are disabled by defining idl_no_ms_extensions.
2019
2020The more complex of the extensions are disabled by defining idl_no_extensions.
2021
2022Variable Effect ~
2023
2024idl_no_ms_extensions Disable some of the Microsoft specific
2025 extensions
2026idl_no_extensions Disable complex extensions
2027idlsyntax_showerror Show IDL errors (can be rather intrusive, but
2028 quite helpful)
2029idlsyntax_showerror_soft Use softer colours by default for errors
2030
Bram Moolenaar071d4272004-06-13 20:20:40 +00002031
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002032JAVA *java.vim* *ft-java-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033
Aliaksei Budavei3749dff2024-07-31 22:13:25 +02002034The java.vim syntax highlighting file offers several options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002035
Aliaksei Budavei3749dff2024-07-31 22:13:25 +02002036In Java 1.0.2, it was never possible to have braces inside parens, so this was
2037flagged as an error. Since Java 1.1, this is possible (with anonymous
2038classes); and, therefore, is no longer marked as an error. If you prefer the
2039old way, put the following line into your Vim startup file: >
2040 :let g:java_mark_braces_in_parens_as_errors = 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041
Aliaksei Budavei3749dff2024-07-31 22:13:25 +02002042All (exported) public types declared in `java.lang` are always automatically
2043imported and available as simple names. To highlight them, use: >
2044 :let g:java_highlight_java_lang_ids = 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045
Aliaksei Budavei3749dff2024-07-31 22:13:25 +02002046You can also highlight types of most standard Java packages if you download
2047the javaid.vim script at http://www.fleiner.com/vim/download.html. If you
2048prefer to only highlight types of a certain package, say `java.io`, use the
2049following: >
2050 :let g:java_highlight_java_io = 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051Check the javaid.vim file for a list of all the packages that are supported.
2052
Aliaksei Budaveie73e5b82024-07-24 20:15:15 +02002053Headers of indented function declarations can be highlighted (along with parts
2054of lambda expressions and method reference expressions), but it depends on how
2055you write Java code. Two formats are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056
Aliaksei Budaveie73e5b82024-07-24 20:15:15 +020020571) If you write function declarations that are consistently indented by either
Aliaksei Budavei3749dff2024-07-31 22:13:25 +02002058a tab, or a space . . . or eight space character(s), you may want to set one
2059of >
2060 :let g:java_highlight_functions = "indent"
2061 :let g:java_highlight_functions = "indent1"
2062 :let g:java_highlight_functions = "indent2"
2063 :let g:java_highlight_functions = "indent3"
2064 :let g:java_highlight_functions = "indent4"
2065 :let g:java_highlight_functions = "indent5"
2066 :let g:java_highlight_functions = "indent6"
2067 :let g:java_highlight_functions = "indent7"
2068 :let g:java_highlight_functions = "indent8"
Aliaksei Budaveic4d0c8c2024-04-29 21:24:35 +03002069Note that in terms of 'shiftwidth', this is the leftmost step of indentation.
Aliaksei Budaveie73e5b82024-07-24 20:15:15 +02002070
20712) However, if you follow the Java guidelines about how functions and types
2072are supposed to be named (with respect to upper- and lowercase) and there is
2073any amount of indentation, you may want to set >
Aliaksei Budavei3749dff2024-07-31 22:13:25 +02002074 :let g:java_highlight_functions = "style"
Aliaksei Budaveie73e5b82024-07-24 20:15:15 +02002075
Aliaksei Budavei3749dff2024-07-31 22:13:25 +02002076In addition, you can combine any value of "g:java_highlight_functions" with >
2077 :let g:java_highlight_signature = 1
Aliaksei Budavei01a4fb12024-06-23 10:03:33 +02002078to have the name of a function with its parameter list parens distinctly
2079highlighted from its type parameters, return type, and formal parameters; and
2080to have the parameter list parens of a lambda expression with its arrow
2081distinctly highlighted from its formal parameters or identifiers.
2082
Aliaksei Budaveibeb02ed2024-06-20 21:00:53 +02002083If neither setting does work for you, but you would still want headers of
2084function declarations to be highlighted, modify the current syntax definitions
2085or compose new ones.
2086
2087Higher-order function types can be hard to parse by eye, so uniformly toning
2088down some of their components may be of value. Provided that such type names
2089conform to the Java naming guidelines, you may arrange it with >
Aliaksei Budavei3749dff2024-07-31 22:13:25 +02002090 :let g:java_highlight_generics = 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00002091
Aliaksei Budavei3749dff2024-07-31 22:13:25 +02002092In Java 1.1, the functions `System.out.println()` and `System.err.println()`
2093should only be used for debugging. Consider adding the following definition
2094in your startup file: >
2095 :let g:java_highlight_debug = 1
2096to have the bulk of those statements colored as
2097 *Debug debugging statements,
2098and to make some of their own items further grouped and linked:
2099 *Special as DebugSpecial,
2100 *String as DebugString,
2101 *Boolean as DebugBoolean,
2102 *Type as DebugType,
2103which are used for special characters appearing in strings, strings proper,
2104boolean literals, and special instance references (`super`, `this`, `null`),
2105respectively.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002106
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002107Javadoc is a program that takes special comments out of Java program files and
2108creates HTML pages. The standard configuration will highlight this HTML code
Aliaksei Budavei3749dff2024-07-31 22:13:25 +02002109similarly to HTML files (see |html.vim|). You can even add JavaScript and CSS
2110inside this code (see below). The HTML rendering diverges as follows:
2111 1. The first sentence (all characters up to the first period `.`, which is
2112 followed by a whitespace character or a line terminator, or up to the
2113 first block tag, e.g. `@param`, `@return`) is colored as
2114 *SpecialComment special comments.
2115 2. The text is colored as
2116 *Comment comments.
2117 3. HTML comments are colored as
2118 *Special special symbols.
2119 4. The standard Javadoc tags (`@code`, `@see`, etc.) are colored as
2120 *Special special symbols
2121 and some of their arguments are colored as
2122 *Function function names.
2123To turn this feature off, add the following line to your startup file: >
2124 :let g:java_ignore_javadoc = 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00002125
Aliaksei Budavei3749dff2024-07-31 22:13:25 +02002126If you use the special Javadoc comment highlighting described above, you can
2127also turn on special highlighting for JavaScript, Visual Basic scripts, and
2128embedded CSS (stylesheets). This only makes sense if any of these languages
2129actually appear in Javadoc comments. The variables to use are >
2130 :let g:java_javascript = 1
2131 :let g:java_css = 1
2132 :let g:java_vb = 1
2133Note that these three variables are maintained in the HTML syntax file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002134
Aliaksei Budavei30a8ad62024-07-31 22:16:08 +02002135Numbers and strings can be recognized in non-Javadoc comments with >
2136 :let g:java_comment_strings = 1
2137
Aliaksei Budavei2750b832024-08-22 21:09:32 +02002138When 'foldmethod' is set to "syntax", blocks of code and multi-line comments
2139will be folded. No text is usually written in the first line of a multi-line
2140comment, making folded contents of Javadoc comments less informative with the
2141default 'foldtext' value; you may opt for showing the contents of a second
2142line for any comments written in this way, and showing the contents of a first
2143line otherwise, with >
2144 :let g:java_foldtext_show_first_or_second_line = 1
2145
Aliaksei Budavei30a8ad62024-07-31 22:16:08 +02002146Trailing whitespace characters or a run of space characters before a tab
2147character can be marked as an error with >
2148 :let g:java_space_errors = 1
2149but either kind of an error can be suppressed by also defining one of >
2150 :let g:java_no_trail_space_error = 1
2151 :let g:java_no_tab_space_error = 1
2152
Aliaksei Budavei3749dff2024-07-31 22:13:25 +02002153In order to highlight nested parens with different colors, define colors for
2154`javaParen`, `javaParen1`, and `javaParen2`. For example, >
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155 :hi link javaParen Comment
2156or >
2157 :hi javaParen ctermfg=blue guifg=#0000ff
2158
2159If you notice highlighting errors while scrolling backwards, which are fixed
Aliaksei Budavei3749dff2024-07-31 22:13:25 +02002160when redrawing with CTRL-L, try setting the "g:java_minlines" variable to
2161a larger number: >
2162 :let g:java_minlines = 50
Bram Moolenaar071d4272004-06-13 20:20:40 +00002163This will make the syntax synchronization start 50 lines before the first
2164displayed line. The default value is 10. The disadvantage of using a larger
2165number is that redrawing can become slow.
2166
Aliaksei Budavei8556e232024-08-27 22:32:13 +02002167Significant changes to the Java platform are gradually introduced in the form
2168of JDK Enhancement Proposals (JEPs) that can be implemented for a release and
2169offered as its preview features. It may take several JEPs and a few release
2170cycles for such a feature to become either integrated into the platform or
2171withdrawn from this effort. To cater for early adopters, there is optional
2172support in Vim for syntax related preview features that are implemented. You
2173can request it by specifying a list of preview feature numbers as follows: >
2174 :let g:java_syntax_previews = [430]
2175
2176The supported JEP numbers are to be drawn from this table:
2177 `430`: String Templates [JDK 21]
2178
2179Note that as soon as the particular preview feature will have been integrated
2180into the Java platform, its entry will be removed from the table and related
2181optionality will be discontinued.
2182
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183
JJCUBERdc831db2024-08-13 23:42:36 +02002184JSON *json.vim* *ft-json-syntax* *g:vim_json_conceal*
2185 *g:vim_json_warnings*
Bram Moolenaar589edb32019-09-20 14:38:13 +02002186
2187The json syntax file provides syntax highlighting with conceal support by
2188default. To disable concealment: >
2189 let g:vim_json_conceal = 0
2190
2191To disable syntax highlighting of errors: >
2192 let g:vim_json_warnings = 0
2193
2194
Vito79952b92024-04-26 22:36:20 +02002195JQ *jq.vim* *jq_quote_highlight* *ft-jq-syntax*
2196
2197To disable numbers having their own color add the following to your vimrc: >
2198 hi link jqNumber Normal
2199
2200If you want quotes to have different highlighting than strings >
2201 let g:jq_quote_highlight = 1
2202
2203
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002204LACE *lace.vim* *ft-lace-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002205
2206Lace (Language for Assembly of Classes in Eiffel) is case insensitive, but the
2207style guide lines are not. If you prefer case insensitive highlighting, just
2208define the vim variable 'lace_case_insensitive' in your startup file: >
2209 :let lace_case_insensitive=1
2210
2211
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002212LEX *lex.vim* *ft-lex-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002213
2214Lex uses brute-force synchronizing as the "^%%$" section delimiter
2215gives no clue as to what section follows. Consequently, the value for >
2216 :syn sync minlines=300
2217may be changed by the user if s/he is experiencing synchronization
2218difficulties (such as may happen with large lex files).
2219
2220
Bram Moolenaar6fc45b52010-07-25 17:42:45 +02002221LIFELINES *lifelines.vim* *ft-lifelines-syntax*
2222
2223To highlight deprecated functions as errors, add in your .vimrc: >
2224
2225 :let g:lifelines_deprecated = 1
2226<
2227
Bram Moolenaara5fac542005-10-12 20:58:49 +00002228LISP *lisp.vim* *ft-lisp-syntax*
2229
2230The lisp syntax highlighting provides two options: >
2231
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01002232 g:lisp_instring : If it exists, then "(...)" strings are highlighted
Bram Moolenaara5fac542005-10-12 20:58:49 +00002233 as if the contents of the string were lisp.
2234 Useful for AutoLisp.
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01002235 g:lisp_rainbow : If it exists and is nonzero, then differing levels
Bram Moolenaara5fac542005-10-12 20:58:49 +00002236 of parenthesization will receive different
2237 highlighting.
2238<
2239The g:lisp_rainbow option provides 10 levels of individual colorization for
2240the parentheses and backquoted parentheses. Because of the quantity of
2241colorization levels, unlike non-rainbow highlighting, the rainbow mode
2242specifies its highlighting using ctermfg and guifg, thereby bypassing the
Bram Moolenaar723dd942019-04-04 13:11:03 +02002243usual color scheme control using standard highlighting groups. The actual
Bram Moolenaara5fac542005-10-12 20:58:49 +00002244highlighting used depends on the dark/bright setting (see |'bg'|).
2245
2246
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002247LITE *lite.vim* *ft-lite-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002248
2249There are two options for the lite syntax highlighting.
2250
2251If you like SQL syntax highlighting inside Strings, use this: >
2252
2253 :let lite_sql_query = 1
2254
2255For syncing, minlines defaults to 100. If you prefer another value, you can
2256set "lite_minlines" to the value you desire. Example: >
2257
2258 :let lite_minlines = 200
2259
2260
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002261LPC *lpc.vim* *ft-lpc-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002262
Bram Moolenaard2f3a8b2018-06-19 14:35:59 +02002263LPC stands for a simple, memory-efficient language: Lars Pensjö C. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264file name of LPC is usually *.c. Recognizing these files as LPC would bother
2265users writing only C programs. If you want to use LPC syntax in Vim, you
2266should set a variable in your .vimrc file: >
2267
2268 :let lpc_syntax_for_c = 1
2269
2270If it doesn't work properly for some particular C or LPC files, use a
Christian Brabandt596ad662023-08-16 00:11:09 +02002271modeline. For a LPC file: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00002272
2273 // vim:set ft=lpc:
2274
Christian Brabandt596ad662023-08-16 00:11:09 +02002275For a C file that is recognized as LPC: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00002276
2277 // vim:set ft=c:
2278
2279If you don't want to set the variable, use the modeline in EVERY LPC file.
2280
2281There are several implementations for LPC, we intend to support most widely
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002282used ones. Here the default LPC syntax is for MudOS series, for MudOS v22
Bram Moolenaar071d4272004-06-13 20:20:40 +00002283and before, you should turn off the sensible modifiers, and this will also
Bram Moolenaar7e38ea22014-04-05 22:55:53 +02002284assert the new efuns after v22 to be invalid, don't set this variable when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285you are using the latest version of MudOS: >
2286
2287 :let lpc_pre_v22 = 1
2288
2289For LpMud 3.2 series of LPC: >
2290
2291 :let lpc_compat_32 = 1
2292
2293For LPC4 series of LPC: >
2294
2295 :let lpc_use_lpc4_syntax = 1
2296
2297For uLPC series of LPC:
2298uLPC has been developed to Pike, so you should use Pike syntax
2299instead, and the name of your source file should be *.pike
2300
2301
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002302LUA *lua.vim* *ft-lua-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002303
Bram Moolenaar5dc62522012-02-13 00:05:22 +01002304The Lua syntax file can be used for versions 4.0, 5.0, 5.1 and 5.2 (5.2 is
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00002305the default). You can select one of these versions using the global variables
2306lua_version and lua_subversion. For example, to activate Lua
Christian Brabandt596ad662023-08-16 00:11:09 +020023075.1 syntax highlighting, set the variables like this: >
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00002308
2309 :let lua_version = 5
2310 :let lua_subversion = 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00002311
2312
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002313MAIL *mail.vim* *ft-mail.vim*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002314
2315Vim highlights all the standard elements of an email (headers, signatures,
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002316quoted text and URLs / email addresses). In keeping with standard conventions,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002317signatures begin in a line containing only "--" followed optionally by
2318whitespaces and end with a newline.
2319
2320Vim treats lines beginning with ']', '}', '|', '>' or a word followed by '>'
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002321as quoted text. However Vim highlights headers and signatures in quoted text
Bram Moolenaar071d4272004-06-13 20:20:40 +00002322only if the text is quoted with '>' (optionally followed by one space).
2323
2324By default mail.vim synchronises syntax to 100 lines before the first
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002325displayed line. If you have a slow machine, and generally deal with emails
Bram Moolenaar071d4272004-06-13 20:20:40 +00002326with short headers, you can change this to a smaller value: >
2327
Ken Takataeb4b9032024-07-25 21:07:13 +02002328 :let mail_minlines = 30
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329
2330
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002331MAKE *make.vim* *ft-make-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002332
2333In makefiles, commands are usually highlighted to make it easy for you to spot
2334errors. However, this may be too much coloring for you. You can turn this
2335feature off by using: >
2336
2337 :let make_no_commands = 1
2338
Ken Takataeb4b9032024-07-25 21:07:13 +02002339Comments are also highlighted by default. You can turn this off by using: >
2340
2341 :let make_no_comments = 1
2342
2343Microsoft Makefile handles variable expansion and comments differently
2344(backslashes are not used for escape). If you see any wrong highlights
2345because of this, you can try this: >
2346
2347 :let make_microsoft = 1
2348
Bram Moolenaar071d4272004-06-13 20:20:40 +00002349
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002350MAPLE *maple.vim* *ft-maple-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002351
2352Maple V, by Waterloo Maple Inc, supports symbolic algebra. The language
2353supports many packages of functions which are selectively loaded by the user.
2354The standard set of packages' functions as supplied in Maple V release 4 may be
2355highlighted at the user's discretion. Users may place in their .vimrc file: >
2356
2357 :let mvpkg_all= 1
2358
2359to get all package functions highlighted, or users may select any subset by
2360choosing a variable/package from the table below and setting that variable to
23611, also in their .vimrc file (prior to sourcing
2362$VIMRUNTIME/syntax/syntax.vim).
2363
2364 Table of Maple V Package Function Selectors >
2365 mv_DEtools mv_genfunc mv_networks mv_process
2366 mv_Galois mv_geometry mv_numapprox mv_simplex
2367 mv_GaussInt mv_grobner mv_numtheory mv_stats
2368 mv_LREtools mv_group mv_orthopoly mv_student
2369 mv_combinat mv_inttrans mv_padic mv_sumtools
2370 mv_combstruct mv_liesymm mv_plots mv_tensor
2371 mv_difforms mv_linalg mv_plottools mv_totorder
2372 mv_finance mv_logic mv_powseries
2373
2374
JJCUBERdc831db2024-08-13 23:42:36 +02002375MARKDOWN *ft-markdown-syntax* *g:markdown_minlines*
2376 *g:markdown_fenced_languages* *g:markdown_syntax_conceal*
Bram Moolenaarce001a32022-04-27 15:25:03 +01002377
2378If you have long regions there might be wrong highlighting. At the cost of
2379slowing down displaying, you can have the engine look further back to sync on
Christian Brabandt675cbfb2024-03-10 19:32:55 +01002380the start of a region, for example 500 lines (default is 50): >
Bram Moolenaarce001a32022-04-27 15:25:03 +01002381
2382 :let g:markdown_minlines = 500
2383
Christian Brabandt675cbfb2024-03-10 19:32:55 +01002384If you want to enable fenced code block syntax highlighting in your markdown
2385documents you can enable like this: >
2386
2387 :let g:markdown_fenced_languages = ['html', 'python', 'bash=sh']
2388
2389To disable markdown syntax concealing add the following to your vimrc: >
2390
2391 :let g:markdown_syntax_conceal = 0
2392
Bram Moolenaarce001a32022-04-27 15:25:03 +01002393
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002394MATHEMATICA *mma.vim* *ft-mma-syntax* *ft-mathematica-syntax*
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002395
2396Empty *.m files will automatically be presumed to be Matlab files unless you
2397have the following in your .vimrc: >
2398
2399 let filetype_m = "mma"
2400
AvidSeekerb5844102024-07-16 21:10:50 +02002401MEDIAWIKI *ft-mediawiki-syntax*
2402
Stanislav Asunkindd36d6c2024-08-14 14:43:30 +02002403By default, syntax highlighting includes basic HTML tags like style and
AvidSeekerb5844102024-07-16 21:10:50 +02002404headers |html.vim|. For strict Mediawiki syntax highlighting: >
2405
2406 let g:html_no_rendering = 1
2407
2408If HTML highlighting is desired, terminal-based text formatting such as bold
2409and italic is possible by: >
2410
2411 let g:html_style_rendering = 1
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002412
Doug Kearns68a89472024-01-05 17:59:04 +01002413MODULA2 *modula2.vim* *ft-modula2-syntax*
2414
2415Vim will recognise comments with dialect tags to automatically select a given
2416dialect.
2417
2418The syntax for a dialect tag comment is: >
2419
2420 taggedComment :=
2421 '(*!' dialectTag '*)'
2422 ;
2423
2424 dialectTag :=
2425 m2pim | m2iso | m2r10
2426 ;
2427
2428 reserved words
2429 m2pim = 'm2pim', m2iso = 'm2iso', m2r10 = 'm2r10'
2430
2431A dialect tag comment is recognised by Vim if it occurs within the first 200
2432lines of the source file. Only the very first such comment is recognised, any
2433additional dialect tag comments are ignored.
2434
2435Example: >
2436
2437 DEFINITION MODULE FooLib; (*!m2pim*)
2438 ...
2439
2440Variable g:modula2_default_dialect sets the default Modula-2 dialect when the
2441dialect cannot be determined from the contents of the Modula-2 file: if
2442defined and set to 'm2pim', the default dialect is PIM.
2443
2444Example: >
2445
2446 let g:modula2_default_dialect = 'm2pim'
2447
2448
2449Highlighting is further configurable for each dialect via the following
2450variables.
2451
2452Variable Highlight ~
2453*modula2_iso_allow_lowline* allow low line in identifiers
2454*modula2_iso_disallow_octals* disallow octal integer literals
2455*modula2_iso_disallow_synonyms* disallow "@", "&" and "~" synonyms
2456
2457*modula2_pim_allow_lowline* allow low line in identifiers
2458*modula2_pim_disallow_octals* disallow octal integer literals
2459*modula2_pim_disallow_synonyms* disallow "&" and "~" synonyms
2460
2461*modula2_r10_allow_lowline* allow low line in identifiers
2462
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002463MOO *moo.vim* *ft-moo-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002464
2465If you use C-style comments inside expressions and find it mangles your
2466highlighting, you may want to use extended (slow!) matches for C-style
2467comments: >
2468
2469 :let moo_extended_cstyle_comments = 1
2470
2471To disable highlighting of pronoun substitution patterns inside strings: >
2472
2473 :let moo_no_pronoun_sub = 1
2474
2475To disable highlighting of the regular expression operator '%|', and matching
2476'%(' and '%)' inside strings: >
2477
2478 :let moo_no_regexp = 1
2479
2480Unmatched double quotes can be recognized and highlighted as errors: >
2481
2482 :let moo_unmatched_quotes = 1
2483
2484To highlight builtin properties (.name, .location, .programmer etc.): >
2485
2486 :let moo_builtin_properties = 1
2487
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002488Unknown builtin functions can be recognized and highlighted as errors. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00002489use this option, add your own extensions to the mooKnownBuiltinFunction group.
2490To enable this option: >
2491
2492 :let moo_unknown_builtin_functions = 1
2493
2494An example of adding sprintf() to the list of known builtin functions: >
2495
2496 :syn keyword mooKnownBuiltinFunction sprintf contained
2497
2498
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002499MSQL *msql.vim* *ft-msql-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002500
2501There are two options for the msql syntax highlighting.
2502
2503If you like SQL syntax highlighting inside Strings, use this: >
2504
2505 :let msql_sql_query = 1
2506
2507For syncing, minlines defaults to 100. If you prefer another value, you can
2508set "msql_minlines" to the value you desire. Example: >
2509
2510 :let msql_minlines = 200
2511
2512
Bram Moolenaarc572da52017-08-27 16:52:01 +02002513N1QL *n1ql.vim* *ft-n1ql-syntax*
2514
2515N1QL is a SQL-like declarative language for manipulating JSON documents in
2516Couchbase Server databases.
2517
2518Vim syntax highlights N1QL statements, keywords, operators, types, comments,
2519and special values. Vim ignores syntactical elements specific to SQL or its
2520many dialects, like COLUMN or CHAR, that don't exist in N1QL.
2521
2522
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002523NCF *ncf.vim* *ft-ncf-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524
2525There is one option for NCF syntax highlighting.
2526
2527If you want to have unrecognized (by ncf.vim) statements highlighted as
2528errors, use this: >
2529
2530 :let ncf_highlight_unknowns = 1
2531
2532If you don't want to highlight these errors, leave it unset.
2533
2534
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002535NROFF *nroff.vim* *ft-nroff-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002536
2537The nroff syntax file works with AT&T n/troff out of the box. You need to
2538activate the GNU groff extra features included in the syntax file before you
2539can use them.
2540
2541For example, Linux and BSD distributions use groff as their default text
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002542processing package. In order to activate the extra syntax highlighting
Bram Moolenaardad44732021-03-31 20:07:33 +02002543features for groff, arrange for files to be recognized as groff (see
2544|ft-groff-syntax|) or add the following option to your start-up files: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00002545
Bram Moolenaardad44732021-03-31 20:07:33 +02002546 :let nroff_is_groff = 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00002547
2548Groff is different from the old AT&T n/troff that you may still find in
2549Solaris. Groff macro and request names can be longer than 2 characters and
2550there are extensions to the language primitives. For example, in AT&T troff
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002551you access the year as a 2-digit number with the request \(yr. In groff you
Bram Moolenaar071d4272004-06-13 20:20:40 +00002552can use the same request, recognized for compatibility, or you can use groff's
2553native syntax, \[yr]. Furthermore, you can use a 4-digit year directly:
2554\[year]. Macro requests can be longer than 2 characters, for example, GNU mm
2555accepts the requests ".VERBON" and ".VERBOFF" for creating verbatim
2556environments.
2557
2558In order to obtain the best formatted output g/troff can give you, you should
2559follow a few simple rules about spacing and punctuation.
2560
25611. Do not leave empty spaces at the end of lines.
2562
25632. Leave one space and one space only after an end-of-sentence period,
2564 exclamation mark, etc.
2565
25663. For reasons stated below, it is best to follow all period marks with a
2567 carriage return.
2568
2569The reason behind these unusual tips is that g/n/troff have a line breaking
2570algorithm that can be easily upset if you don't follow the rules given above.
2571
2572Unlike TeX, troff fills text line-by-line, not paragraph-by-paragraph and,
2573furthermore, it does not have a concept of glue or stretch, all horizontal and
2574vertical space input will be output as is.
2575
2576Therefore, you should be careful about not using more space between sentences
2577than you intend to have in your final document. For this reason, the common
2578practice is to insert a carriage return immediately after all punctuation
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002579marks. If you want to have "even" text in your final processed output, you
Bram Moolenaarbf884932013-04-05 22:26:15 +02002580need to maintain regular spacing in the input text. To mark both trailing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581spaces and two or more spaces after a punctuation as an error, use: >
2582
2583 :let nroff_space_errors = 1
2584
2585Another technique to detect extra spacing and other errors that will interfere
2586with the correct typesetting of your file, is to define an eye-catching
2587highlighting definition for the syntax groups "nroffDefinition" and
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002588"nroffDefSpecial" in your configuration files. For example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00002589
2590 hi def nroffDefinition term=italic cterm=italic gui=reverse
2591 hi def nroffDefSpecial term=italic,bold cterm=italic,bold
2592 \ gui=reverse,bold
2593
2594If you want to navigate preprocessor entries in your source file as easily as
2595with section markers, you can activate the following option in your .vimrc
2596file: >
2597
2598 let b:preprocs_as_sections = 1
2599
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00002600As well, the syntax file adds an extra paragraph marker for the extended
Bram Moolenaar071d4272004-06-13 20:20:40 +00002601paragraph macro (.XP) in the ms package.
2602
2603Finally, there is a |groff.vim| syntax file that can be used for enabling
2604groff syntax highlighting either on a file basis or globally by default.
2605
2606
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002607OCAML *ocaml.vim* *ft-ocaml-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002608
2609The OCaml syntax file handles files having the following prefixes: .ml,
2610.mli, .mll and .mly. By setting the following variable >
2611
2612 :let ocaml_revised = 1
2613
2614you can switch from standard OCaml-syntax to revised syntax as supported
2615by the camlp4 preprocessor. Setting the variable >
2616
2617 :let ocaml_noend_error = 1
2618
2619prevents highlighting of "end" as error, which is useful when sources
2620contain very long structures that Vim does not synchronize anymore.
2621
Wu, Zhenyu7005b7e2024-04-08 20:53:19 +02002622PANDOC *ft-pandoc-syntax*
2623
2624By default, markdown files will be detected as filetype "markdown".
2625Alternatively, you may want them to be detected as filetype "pandoc" instead.
Christian Brabandt2606e772024-07-04 11:23:51 +02002626To do so, set the *g:filetype_md* var: >
Wu, Zhenyu7005b7e2024-04-08 20:53:19 +02002627
Christian Brabandt2606e772024-07-04 11:23:51 +02002628 :let g:filetype_md = 'pandoc'
Wu, Zhenyu7005b7e2024-04-08 20:53:19 +02002629
2630The pandoc syntax plugin uses |conceal| for pretty highlighting. Default is 1 >
2631
2632 :let g:pandoc#syntax#conceal#use = 1
2633
2634To specify elements that should not be concealed, set the following variable: >
2635
2636 :let g:pandoc#syntax#conceal#blacklist = []
2637
2638This is a list of the rules wich can be used here:
2639
Shougo Matsushitabe2b03c2024-04-08 22:11:50 +02002640 - titleblock
Wu, Zhenyu7005b7e2024-04-08 20:53:19 +02002641 - image
2642 - block
2643 - subscript
2644 - superscript
2645 - strikeout
2646 - atx
2647 - codeblock_start
2648 - codeblock_delim
2649 - footnote
2650 - definition
2651 - list
2652 - newline
2653 - dashes
2654 - ellipses
2655 - quotes
2656 - inlinecode
2657 - inlinemath
2658
2659You can customize the way concealing works. For example, if you prefer to mark
2660footnotes with the `*` symbol: >
2661
2662 :let g:pandoc#syntax#conceal#cchar_overrides = {"footnote" : "*"}
2663
2664To conceal the urls in links, use: >
2665
2666 :let g:pandoc#syntax#conceal#urls = 1
2667
2668Prevent highlighting specific codeblock types so that they remain Normal.
2669Codeblock types include "definition" for codeblocks inside definition blocks
2670and "delimited" for delimited codeblocks. Default = [] >
2671
2672 :let g:pandoc#syntax#codeblocks#ignore = ['definition']
2673
2674Use embedded highlighting for delimited codeblocks where a language is
2675specified. Default = 1 >
2676
2677 :let g:pandoc#syntax#codeblocks#embeds#use = 1
2678
2679For specify what languages and using what syntax files to highlight embeds. This is a
2680list of language names. When the language pandoc and vim use don't match, you
2681can use the "PANDOC=VIM" syntax. For example: >
2682
2683 :let g:pandoc#syntax#codeblocks#embeds#langs = ["ruby", "bash=sh"]
2684
2685To use italics and strong in emphases. Default = 1 >
2686
Christian Brabandta0400192024-04-09 08:06:52 +02002687 :let g:pandoc#syntax#style#emphases = 1
Wu, Zhenyu7005b7e2024-04-08 20:53:19 +02002688
2689"0" will add "block" to g:pandoc#syntax#conceal#blacklist, because otherwise
2690you couldn't tell where the styles are applied.
2691
2692To add underline subscript, superscript and strikeout text styles. Default = 1 >
2693
2694 :let g:pandoc#syntax#style#underline_special = 1
2695
2696Detect and highlight definition lists. Disabling this can improve performance.
2697Default = 1 (i.e., enabled by default) >
2698
2699 :let g:pandoc#syntax#style#use_definition_lists = 1
2700
2701The pandoc syntax script also comes with the following commands: >
2702
2703 :PandocHighlight LANG
2704
2705Enables embedded highlighting for language LANG in codeblocks. Uses the
2706syntax for items in g:pandoc#syntax#codeblocks#embeds#langs. >
2707
2708 :PandocUnhighlight LANG
2709
2710Disables embedded highlighting for language LANG in codeblocks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002712PAPP *papp.vim* *ft-papp-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002713
Bram Moolenaarade0d392020-01-21 22:33:58 +01002714The PApp syntax file handles .papp files and, to a lesser extent, .pxml
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715and .pxsl files which are all a mixture of perl/xml/html/other using xml
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002716as the top-level file format. By default everything inside phtml or pxml
2717sections is treated as a string with embedded preprocessor commands. If
Bram Moolenaar071d4272004-06-13 20:20:40 +00002718you set the variable: >
2719
2720 :let papp_include_html=1
2721
Bram Moolenaar76db9e02022-11-09 21:21:04 +00002722in your startup file it will try to syntax-highlight html code inside phtml
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723sections, but this is relatively slow and much too colourful to be able to
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002724edit sensibly. ;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725
2726The newest version of the papp.vim syntax file can usually be found at
2727http://papp.plan9.de.
2728
2729
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002730PASCAL *pascal.vim* *ft-pascal-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731
Bram Moolenaar98a29d02021-01-18 19:55:44 +01002732Files matching "*.p" could be Progress or Pascal and those matching "*.pp"
2733could be Puppet or Pascal. If the automatic detection doesn't work for you,
2734or you only edit Pascal files, use this in your startup vimrc: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735
Bram Moolenaar98a29d02021-01-18 19:55:44 +01002736 :let filetype_p = "pascal"
2737 :let filetype_pp = "pascal"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002738
2739The Pascal syntax file has been extended to take into account some extensions
2740provided by Turbo Pascal, Free Pascal Compiler and GNU Pascal Compiler.
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002741Delphi keywords are also supported. By default, Turbo Pascal 7.0 features are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742enabled. If you prefer to stick with the standard Pascal keywords, add the
2743following line to your startup file: >
2744
2745 :let pascal_traditional=1
2746
2747To switch on Delphi specific constructions (such as one-line comments,
2748keywords, etc): >
2749
2750 :let pascal_delphi=1
2751
2752
2753The option pascal_symbol_operator controls whether symbol operators such as +,
2754*, .., etc. are displayed using the Operator color or not. To colorize symbol
2755operators, add the following line to your startup file: >
2756
2757 :let pascal_symbol_operator=1
2758
2759Some functions are highlighted by default. To switch it off: >
2760
2761 :let pascal_no_functions=1
2762
Bram Moolenaar996343d2010-07-04 22:20:21 +02002763Furthermore, there are specific variables for some compilers. Besides
Bram Moolenaar071d4272004-06-13 20:20:40 +00002764pascal_delphi, there are pascal_gpc and pascal_fpc. Default extensions try to
2765match Turbo Pascal. >
2766
2767 :let pascal_gpc=1
2768
2769or >
2770
2771 :let pascal_fpc=1
2772
2773To ensure that strings are defined on a single line, you can define the
2774pascal_one_line_string variable. >
2775
2776 :let pascal_one_line_string=1
2777
2778If you dislike <Tab> chars, you can set the pascal_no_tabs variable. Tabs
2779will be highlighted as Error. >
2780
2781 :let pascal_no_tabs=1
2782
2783
2784
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002785PERL *perl.vim* *ft-perl-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786
2787There are a number of possible options to the perl syntax highlighting.
2788
Bram Moolenaar56b45b92013-06-24 22:22:18 +02002789Inline POD highlighting is now turned on by default. If you don't wish
2790to have the added complexity of highlighting POD embedded within Perl
2791files, you may set the 'perl_include_pod' option to 0: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00002792
Bram Moolenaar56b45b92013-06-24 22:22:18 +02002793 :let perl_include_pod = 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002794
Bram Moolenaar822ff862014-06-12 21:46:14 +02002795To reduce the complexity of parsing (and increase performance) you can switch
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002796off two elements in the parsing of variable names and contents. >
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002798To handle package references in variable and function names not differently
2799from the rest of the name (like 'PkgName::' in '$PkgName::VarName'): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002801 :let perl_no_scope_in_variables = 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002803(In Vim 6.x it was the other way around: "perl_want_scope_in_variables"
2804enabled it.)
2805
2806If you do not want complex things like '@{${"foo"}}' to be parsed: >
2807
2808 :let perl_no_extended_vars = 1
2809
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00002810(In Vim 6.x it was the other way around: "perl_extended_vars" enabled it.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01002812The coloring strings can be changed. By default strings and qq friends will
2813be highlighted like the first line. If you set the variable
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814perl_string_as_statement, it will be highlighted as in the second line.
2815
2816 "hello world!"; qq|hello world|;
2817 ^^^^^^^^^^^^^^NN^^^^^^^^^^^^^^^N (unlet perl_string_as_statement)
2818 S^^^^^^^^^^^^SNNSSS^^^^^^^^^^^SN (let perl_string_as_statement)
2819
2820(^ = perlString, S = perlStatement, N = None at all)
2821
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002822The syncing has 3 options. The first two switch off some triggering of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002823synchronization and should only be needed in case it fails to work properly.
2824If while scrolling all of a sudden the whole screen changes color completely
RestorerZf7a38652024-04-22 20:55:32 +02002825then you should try and switch off one of those. Let the developer know if
2826you can figure out the line that causes the mistake.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827
2828One triggers on "^\s*sub\s*" and the other on "^[$@%]" more or less. >
2829
2830 :let perl_no_sync_on_sub
2831 :let perl_no_sync_on_global_var
2832
2833Below you can set the maximum distance VIM should look for starting points for
2834its attempts in syntax highlighting. >
2835
2836 :let perl_sync_dist = 100
2837
2838If you want to use folding with perl, set perl_fold: >
2839
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002840 :let perl_fold = 1
2841
2842If you want to fold blocks in if statements, etc. as well set the following: >
2843
2844 :let perl_fold_blocks = 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00002845
Bram Moolenaar56b45b92013-06-24 22:22:18 +02002846Subroutines are folded by default if 'perl_fold' is set. If you do not want
2847this, you can set 'perl_nofold_subs': >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002848
Bram Moolenaar56b45b92013-06-24 22:22:18 +02002849 :let perl_nofold_subs = 1
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002850
Bram Moolenaar56b45b92013-06-24 22:22:18 +02002851Anonymous subroutines are not folded by default; you may enable their folding
2852via 'perl_fold_anonymous_subs': >
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002853
Bram Moolenaar56b45b92013-06-24 22:22:18 +02002854 :let perl_fold_anonymous_subs = 1
2855
2856Packages are also folded by default if 'perl_fold' is set. To disable this
2857behavior, set 'perl_nofold_packages': >
2858
2859 :let perl_nofold_packages = 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00002860
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002861PHP3 and PHP4 *php.vim* *php3.vim* *ft-php-syntax* *ft-php3-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01002863[Note: Previously this was called "php3", but since it now also supports php4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864it has been renamed to "php"]
2865
2866There are the following options for the php syntax highlighting.
2867
2868If you like SQL syntax highlighting inside Strings: >
2869
2870 let php_sql_query = 1
2871
2872For highlighting the Baselib methods: >
2873
2874 let php_baselib = 1
2875
2876Enable HTML syntax highlighting inside strings: >
2877
2878 let php_htmlInStrings = 1
2879
2880Using the old colorstyle: >
2881
2882 let php_oldStyle = 1
2883
2884Enable highlighting ASP-style short tags: >
2885
2886 let php_asp_tags = 1
2887
2888Disable short tags: >
2889
2890 let php_noShortTags = 1
2891
2892For highlighting parent error ] or ): >
2893
2894 let php_parent_error_close = 1
2895
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02002896For skipping a php end tag, if there exists an open ( or [ without a closing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897one: >
2898
2899 let php_parent_error_open = 1
2900
2901Enable folding for classes and functions: >
2902
2903 let php_folding = 1
2904
2905Selecting syncing method: >
2906
2907 let php_sync_method = x
2908
2909x = -1 to sync by search (default),
2910x > 0 to sync at least x lines backwards,
2911x = 0 to sync from start.
2912
2913
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00002914PLAINTEX *plaintex.vim* *ft-plaintex-syntax*
2915
2916TeX is a typesetting language, and plaintex is the file type for the "plain"
2917variant of TeX. If you never want your *.tex files recognized as plain TeX,
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002918see |ft-tex-plugin|.
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00002919
2920This syntax file has the option >
2921
2922 let g:plaintex_delimiters = 1
2923
2924if you want to highlight brackets "[]" and braces "{}".
2925
2926
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002927PPWIZARD *ppwiz.vim* *ft-ppwiz-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928
2929PPWizard is a preprocessor for HTML and OS/2 INF files
2930
2931This syntax file has the options:
2932
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01002933- ppwiz_highlight_defs : Determines highlighting mode for PPWizard's
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002934 definitions. Possible values are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002935
2936 ppwiz_highlight_defs = 1 : PPWizard #define statements retain the
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01002937 colors of their contents (e.g. PPWizard macros and variables).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002938
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01002939 ppwiz_highlight_defs = 2 : Preprocessor #define and #evaluate
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940 statements are shown in a single color with the exception of line
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01002941 continuation symbols.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002942
2943 The default setting for ppwiz_highlight_defs is 1.
2944
2945- ppwiz_with_html : If the value is 1 (the default), highlight literal
2946 HTML code; if 0, treat HTML code like ordinary text.
2947
2948
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002949PHTML *phtml.vim* *ft-phtml-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950
2951There are two options for the phtml syntax highlighting.
2952
2953If you like SQL syntax highlighting inside Strings, use this: >
2954
2955 :let phtml_sql_query = 1
2956
2957For syncing, minlines defaults to 100. If you prefer another value, you can
2958set "phtml_minlines" to the value you desire. Example: >
2959
2960 :let phtml_minlines = 200
2961
2962
Bram Moolenaarda2303d2005-08-30 21:55:26 +00002963POSTSCRIPT *postscr.vim* *ft-postscr-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964
2965There are several options when it comes to highlighting PostScript.
2966
2967First which version of the PostScript language to highlight. There are
2968currently three defined language versions, or levels. Level 1 is the original
2969and base version, and includes all extensions prior to the release of level 2.
2970Level 2 is the most common version around, and includes its own set of
2971extensions prior to the release of level 3. Level 3 is currently the highest
2972level supported. You select which level of the PostScript language you want
2973highlighted by defining the postscr_level variable as follows: >
2974
2975 :let postscr_level=2
2976
2977If this variable is not defined it defaults to 2 (level 2) since this is
2978the most prevalent version currently.
2979
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01002980Note: Not all PS interpreters will support all language features for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981particular language level. In particular the %!PS-Adobe-3.0 at the start of
2982PS files does NOT mean the PostScript present is level 3 PostScript!
2983
2984If you are working with Display PostScript, you can include highlighting of
2985Display PS language features by defining the postscr_display variable as
2986follows: >
2987
2988 :let postscr_display=1
2989
2990If you are working with Ghostscript, you can include highlighting of
2991Ghostscript specific language features by defining the variable
2992postscr_ghostscript as follows: >
2993
2994 :let postscr_ghostscript=1
2995
2996PostScript is a large language, with many predefined elements. While it
2997useful to have all these elements highlighted, on slower machines this can
2998cause Vim to slow down. In an attempt to be machine friendly font names and
2999character encodings are not highlighted by default. Unless you are working
3000explicitly with either of these this should be ok. If you want them to be
3001highlighted you should set one or both of the following variables: >
3002
3003 :let postscr_fonts=1
3004 :let postscr_encodings=1
3005
3006There is a stylistic option to the highlighting of and, or, and not. In
3007PostScript the function of these operators depends on the types of their
3008operands - if the operands are booleans then they are the logical operators,
3009if they are integers then they are binary operators. As binary and logical
3010operators can be highlighted differently they have to be highlighted one way
3011or the other. By default they are treated as logical operators. They can be
3012highlighted as binary operators by defining the variable
3013postscr_andornot_binary as follows: >
3014
3015 :let postscr_andornot_binary=1
3016<
3017
Bram Moolenaarda2303d2005-08-30 21:55:26 +00003018 *ptcap.vim* *ft-printcap-syntax*
3019PRINTCAP + TERMCAP *ft-ptcap-syntax* *ft-termcap-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020
3021This syntax file applies to the printcap and termcap databases.
3022
3023In order for Vim to recognize printcap/termcap files that do not match
3024the patterns *printcap*, or *termcap*, you must put additional patterns
3025appropriate to your system in your |myfiletypefile| file. For these
3026patterns, you must set the variable "b:ptcap_type" to either "print" or
3027"term", and then the 'filetype' option to ptcap.
3028
3029For example, to make Vim identify all files in /etc/termcaps/ as termcap
3030files, add the following: >
3031
3032 :au BufNewFile,BufRead /etc/termcaps/* let b:ptcap_type = "term" |
3033 \ set filetype=ptcap
3034
3035If you notice highlighting errors while scrolling backwards, which
3036are fixed when redrawing with CTRL-L, try setting the "ptcap_minlines"
3037internal variable to a larger number: >
3038
3039 :let ptcap_minlines = 50
3040
3041(The default is 20 lines.)
3042
3043
Bram Moolenaarda2303d2005-08-30 21:55:26 +00003044PROGRESS *progress.vim* *ft-progress-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045
3046Files matching "*.w" could be Progress or cweb. If the automatic detection
3047doesn't work for you, or you don't edit cweb at all, use this in your
3048startup vimrc: >
3049 :let filetype_w = "progress"
3050The same happens for "*.i", which could be assembly, and "*.p", which could be
3051Pascal. Use this if you don't use assembly and Pascal: >
3052 :let filetype_i = "progress"
3053 :let filetype_p = "progress"
3054
3055
Bram Moolenaarda2303d2005-08-30 21:55:26 +00003056PYTHON *python.vim* *ft-python-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057
Bram Moolenaar34700a62013-03-07 13:20:54 +01003058There are six options to control Python syntax highlighting.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003059
3060For highlighted numbers: >
Bram Moolenaar34700a62013-03-07 13:20:54 +01003061 :let python_no_number_highlight = 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062
3063For highlighted builtin functions: >
Bram Moolenaar34700a62013-03-07 13:20:54 +01003064 :let python_no_builtin_highlight = 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00003065
3066For highlighted standard exceptions: >
Bram Moolenaar34700a62013-03-07 13:20:54 +01003067 :let python_no_exception_highlight = 1
3068
3069For highlighted doctests and code inside: >
3070 :let python_no_doctest_highlight = 1
3071or >
3072 :let python_no_doctest_code_highlight = 1
Bram Moolenaardd60c362023-02-27 15:49:53 +00003073The first option implies the second one.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074
Bram Moolenaar4a748032010-09-30 21:47:56 +02003075For highlighted trailing whitespace and mix of spaces and tabs: >
Bram Moolenaar34700a62013-03-07 13:20:54 +01003076 :let python_space_error_highlight = 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077
h_east59858792023-10-25 22:47:05 +09003078If you want all possible Python highlighting: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003079 :let python_highlight_all = 1
Bram Moolenaardd60c362023-02-27 15:49:53 +00003080This has the same effect as setting python_space_error_highlight and
3081unsetting all the other ones.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082
Bram Moolenaardd60c362023-02-27 15:49:53 +00003083If you use Python 2 or straddling code (Python 2 and 3 compatible),
3084you can enforce the use of an older syntax file with support for
Bram Moolenaar71badf92023-04-22 22:40:14 +01003085Python 2 and up to Python 3.5. >
3086 :let python_use_python2_syntax = 1
Bram Moolenaardd60c362023-02-27 15:49:53 +00003087This option will exclude all modern Python 3.6 or higher features.
3088
3089Note: Only existence of these options matters, not their value.
3090 You can replace 1 above with anything.
3091
Bram Moolenaar34700a62013-03-07 13:20:54 +01003092
Bram Moolenaarda2303d2005-08-30 21:55:26 +00003093QUAKE *quake.vim* *ft-quake-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094
Bram Moolenaarade0d392020-01-21 22:33:58 +01003095The Quake syntax definition should work for most FPS (First Person Shooter)
3096based on one of the Quake engines. However, the command names vary a bit
3097between the three games (Quake, Quake 2, and Quake 3 Arena) so the syntax
3098definition checks for the existence of three global variables to allow users
3099to specify what commands are legal in their files. The three variables can
3100be set for the following effects:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101
3102set to highlight commands only available in Quake: >
3103 :let quake_is_quake1 = 1
3104
3105set to highlight commands only available in Quake 2: >
3106 :let quake_is_quake2 = 1
3107
3108set to highlight commands only available in Quake 3 Arena: >
3109 :let quake_is_quake3 = 1
3110
3111Any combination of these three variables is legal, but might highlight more
3112commands than are actually available to you by the game.
3113
3114
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02003115R *r.vim* *ft-r-syntax*
3116
3117The parsing of R code for syntax highlight starts 40 lines backwards, but you
3118can set a different value in your |vimrc|. Example: >
3119 let r_syntax_minlines = 60
3120
3121You can also turn off syntax highlighting of ROxygen: >
3122 let r_syntax_hl_roxygen = 0
3123
3124enable folding of code delimited by parentheses, square brackets and curly
3125braces: >
3126 let r_syntax_folding = 1
3127
3128and highlight as functions all keywords followed by an opening parenthesis: >
3129 let r_syntax_fun_pattern = 1
3130
3131
3132R MARKDOWN *rmd.vim* *ft-rmd-syntax*
3133
3134To disable syntax highlight of YAML header, add to your |vimrc|: >
3135 let rmd_syn_hl_yaml = 0
3136
3137To disable syntax highlighting of citation keys: >
3138 let rmd_syn_hl_citations = 0
3139
3140To highlight R code in knitr chunk headers: >
3141 let rmd_syn_hl_chunk = 1
3142
3143By default, chunks of R code will be highlighted following the rules of R
Jakson Alves de Aquino9042bd82023-12-25 09:22:27 +00003144language. Moreover, whenever the buffer is saved, Vim scans the buffer and
3145highlights other languages if they are present in new chunks. LaTeX code also
3146is automatically recognized and highlighted when the buffer is saved. This
3147behavior can be controlled with the variables `rmd_dynamic_fenced_languages`,
3148and `rmd_include_latex` whose valid values are: >
3149 let rmd_dynamic_fenced_languages = 0 " No autodetection of languages
3150 let rmd_dynamic_fenced_languages = 1 " Autodetection of languages
3151 let rmd_include_latex = 0 " Don't highlight LaTeX code
3152 let rmd_include_latex = 1 " Autodetect LaTeX code
3153 let rmd_include_latex = 2 " Always include LaTeX highlighting
3154
3155If the value of `rmd_dynamic_fenced_languages` is 0, you still can set the
3156list of languages whose chunks of code should be properly highlighted, as in
3157the example: >
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02003158 let rmd_fenced_languages = ['r', 'python']
3159
3160
3161R RESTRUCTURED TEXT *rrst.vim* *ft-rrst-syntax*
3162
3163To highlight R code in knitr chunk headers, add to your |vimrc|: >
3164 let rrst_syn_hl_chunk = 1
3165
3166
Pierrick Guillaume280e5b12024-05-31 12:00:49 +02003167RASI *rasi.vim* *ft-rasi-syntax*
3168
3169Rasi stands for Rofi Advanced Style Information. It is used by the program
Christian Brabandtf3dd6f62024-05-31 12:26:12 +02003170rofi to style the rendering of the search window. The language is heavily
Pierrick Guillaume280e5b12024-05-31 12:00:49 +02003171inspired by CSS stylesheet. Files with the following extensions are recognized
3172as rasi files: .rasi.
3173
Bram Moolenaarda2303d2005-08-30 21:55:26 +00003174READLINE *readline.vim* *ft-readline-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175
3176The readline library is primarily used by the BASH shell, which adds quite a
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00003177few commands and options to the ones already available. To highlight these
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178items as well you can add the following to your |vimrc| or just type it in the
3179command line before loading a file with the readline syntax: >
3180 let readline_has_bash = 1
3181
3182This will add highlighting for the commands that BASH (version 2.05a and
3183later, and part earlier) adds.
3184
3185
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01003186REGO *rego.vim* *ft-rego-syntax*
3187
3188Rego is a query language developed by Styra. It is mostly used as a policy
3189language for kubernetes, but can be applied to almost anything. Files with
3190the following extensions are recognized as rego files: .rego.
3191
3192
Bram Moolenaar97d62492012-11-15 21:28:22 +01003193RESTRUCTURED TEXT *rst.vim* *ft-rst-syntax*
3194
Bram Moolenaar4c05fa02019-01-01 15:32:17 +01003195Syntax highlighting is enabled for code blocks within the document for a
3196select number of file types. See $VIMRUNTIME/syntax/rst.vim for the default
3197syntax list.
3198
3199To set a user-defined list of code block syntax highlighting: >
Bram Moolenaar97d62492012-11-15 21:28:22 +01003200 let rst_syntax_code_list = ['vim', 'lisp', ...]
Bram Moolenaar4c05fa02019-01-01 15:32:17 +01003201
3202To assign multiple code block types to a single syntax, define
3203`rst_syntax_code_list` as a mapping: >
3204 let rst_syntax_code_list = {
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01003205 \ 'cpp': ['cpp', 'c++'],
3206 \ 'bash': ['bash', 'sh'],
Bram Moolenaar4c05fa02019-01-01 15:32:17 +01003207 ...
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01003208 \ }
Bram Moolenaar4c05fa02019-01-01 15:32:17 +01003209
3210To use color highlighting for emphasis text: >
3211 let rst_use_emphasis_colors = 1
3212
3213To enable folding of sections: >
3214 let rst_fold_enabled = 1
3215
3216Note that folding can cause performance issues on some platforms.
3217
Bram Moolenaar97d62492012-11-15 21:28:22 +01003218
Bram Moolenaarda2303d2005-08-30 21:55:26 +00003219REXX *rexx.vim* *ft-rexx-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220
3221If you notice highlighting errors while scrolling backwards, which are fixed
3222when redrawing with CTRL-L, try setting the "rexx_minlines" internal variable
3223to a larger number: >
3224 :let rexx_minlines = 50
3225This will make the syntax synchronization start 50 lines before the first
3226displayed line. The default value is 10. The disadvantage of using a larger
3227number is that redrawing can become slow.
3228
Bram Moolenaar97293012011-07-18 19:40:27 +02003229Vim tries to guess what type a ".r" file is. If it can't be detected (from
3230comment lines), the default is "r". To make the default rexx add this line to
3231your .vimrc: *g:filetype_r*
3232>
3233 :let g:filetype_r = "r"
3234
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235
Bram Moolenaarda2303d2005-08-30 21:55:26 +00003236RUBY *ruby.vim* *ft-ruby-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003237
Bram Moolenaar7e1479b2016-09-11 15:07:27 +02003238 Ruby: Operator highlighting |ruby_operators|
3239 Ruby: Whitespace errors |ruby_space_errors|
3240 Ruby: Folding |ruby_fold| |ruby_foldable_groups|
3241 Ruby: Reducing expensive operations |ruby_no_expensive| |ruby_minlines|
3242 Ruby: Spellchecking strings |ruby_spellcheck_strings|
3243
3244 *ruby_operators*
3245 Ruby: Operator highlighting ~
3246
3247Operators can be highlighted by defining "ruby_operators": >
3248
3249 :let ruby_operators = 1
3250<
3251 *ruby_space_errors*
3252 Ruby: Whitespace errors ~
3253
3254Whitespace errors can be highlighted by defining "ruby_space_errors": >
3255
3256 :let ruby_space_errors = 1
3257<
3258This will highlight trailing whitespace and tabs preceded by a space character
3259as errors. This can be refined by defining "ruby_no_trail_space_error" and
3260"ruby_no_tab_space_error" which will ignore trailing whitespace and tabs after
3261spaces respectively.
3262
3263 *ruby_fold* *ruby_foldable_groups*
3264 Ruby: Folding ~
3265
3266Folding can be enabled by defining "ruby_fold": >
3267
3268 :let ruby_fold = 1
3269<
3270This will set the value of 'foldmethod' to "syntax" locally to the current
3271buffer or window, which will enable syntax-based folding when editing Ruby
3272filetypes.
3273
Bram Moolenaar7e1479b2016-09-11 15:07:27 +02003274Default folding is rather detailed, i.e., small syntax units like "if", "do",
3275"%w[]" may create corresponding fold levels.
3276
3277You can set "ruby_foldable_groups" to restrict which groups are foldable: >
3278
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003279 :let ruby_foldable_groups = 'if case %'
Bram Moolenaar7e1479b2016-09-11 15:07:27 +02003280<
3281The value is a space-separated list of keywords:
3282
3283 keyword meaning ~
3284 -------- ------------------------------------- ~
3285 ALL Most block syntax (default)
3286 NONE Nothing
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003287 if "if" or "unless" block
Bram Moolenaar7e1479b2016-09-11 15:07:27 +02003288 def "def" block
3289 class "class" block
3290 module "module" block
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003291 do "do" block
Bram Moolenaar7e1479b2016-09-11 15:07:27 +02003292 begin "begin" block
3293 case "case" block
3294 for "for", "while", "until" loops
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003295 { Curly bracket block or hash literal
3296 [ Array literal
3297 % Literal with "%" notation, e.g.: %w(STRING), %!STRING!
3298 / Regexp
Bram Moolenaar7e1479b2016-09-11 15:07:27 +02003299 string String and shell command output (surrounded by ', ", `)
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003300 : Symbol
3301 # Multiline comment
3302 << Here documents
Bram Moolenaar7e1479b2016-09-11 15:07:27 +02003303 __END__ Source code after "__END__" directive
3304
3305 *ruby_no_expensive*
3306 Ruby: Reducing expensive operations ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307
3308By default, the "end" keyword is colorized according to the opening statement
Bram Moolenaar943d2b52005-12-02 00:50:49 +00003309of the block it closes. While useful, this feature can be expensive; if you
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310experience slow redrawing (or you are on a terminal with poor color support)
3311you may want to turn it off by defining the "ruby_no_expensive" variable: >
Bram Moolenaar943d2b52005-12-02 00:50:49 +00003312
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 :let ruby_no_expensive = 1
Bram Moolenaar25394022007-05-10 19:06:20 +00003314<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003315In this case the same color will be used for all control keywords.
3316
Bram Moolenaar7e1479b2016-09-11 15:07:27 +02003317 *ruby_minlines*
3318
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319If you do want this feature enabled, but notice highlighting errors while
3320scrolling backwards, which are fixed when redrawing with CTRL-L, try setting
3321the "ruby_minlines" variable to a value larger than 50: >
Bram Moolenaar943d2b52005-12-02 00:50:49 +00003322
Bram Moolenaar071d4272004-06-13 20:20:40 +00003323 :let ruby_minlines = 100
Bram Moolenaar25394022007-05-10 19:06:20 +00003324<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325Ideally, this value should be a number of lines large enough to embrace your
3326largest class or module.
3327
Bram Moolenaar7e1479b2016-09-11 15:07:27 +02003328 *ruby_spellcheck_strings*
3329 Ruby: Spellchecking strings ~
Bram Moolenaar943d2b52005-12-02 00:50:49 +00003330
Bram Moolenaar7e1479b2016-09-11 15:07:27 +02003331Ruby syntax will perform spellchecking of strings if you define
3332"ruby_spellcheck_strings": >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003333
Bram Moolenaar7e1479b2016-09-11 15:07:27 +02003334 :let ruby_spellcheck_strings = 1
Bram Moolenaar25394022007-05-10 19:06:20 +00003335<
Bram Moolenaarc81e5e72007-05-05 18:24:42 +00003336
Bram Moolenaarda2303d2005-08-30 21:55:26 +00003337SCHEME *scheme.vim* *ft-scheme-syntax*
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003338
Bram Moolenaar72540672018-02-09 22:00:53 +01003339By default only R7RS keywords are highlighted and properly indented.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003340
Bram Moolenaar72540672018-02-09 22:00:53 +01003341scheme.vim also supports extensions of the CHICKEN Scheme->C compiler.
3342Define b:is_chicken or g:is_chicken, if you need them.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003343
3344
Bram Moolenaarda2303d2005-08-30 21:55:26 +00003345SDL *sdl.vim* *ft-sdl-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003346
3347The SDL highlighting probably misses a few keywords, but SDL has so many
3348of them it's almost impossibly to cope.
3349
3350The new standard, SDL-2000, specifies that all identifiers are
3351case-sensitive (which was not so before), and that all keywords can be
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00003352used either completely lowercase or completely uppercase. To have the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353highlighting reflect this, you can set the following variable: >
3354 :let sdl_2000=1
3355
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00003356This also sets many new keywords. If you want to disable the old
Bram Moolenaar071d4272004-06-13 20:20:40 +00003357keywords, which is probably a good idea, use: >
3358 :let SDL_no_96=1
3359
3360
3361The indentation is probably also incomplete, but right now I am very
3362satisfied with it for my own projects.
3363
3364
Bram Moolenaarda2303d2005-08-30 21:55:26 +00003365SED *sed.vim* *ft-sed-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366
3367To make tabs stand out from regular blanks (accomplished by using Todo
Bram Moolenaar3c053a12022-10-16 13:11:12 +01003368highlighting on the tabs), define "g:sed_highlight_tabs" by putting >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369
Bram Moolenaar3c053a12022-10-16 13:11:12 +01003370 :let g:sed_highlight_tabs = 1
3371<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003372in the vimrc file. (This special highlighting only applies for tabs
3373inside search patterns, replacement texts, addresses or text included
3374by an Append/Change/Insert command.) If you enable this option, it is
3375also a good idea to set the tab width to one character; by doing that,
3376you can easily count the number of tabs in a string.
3377
Bram Moolenaar3c053a12022-10-16 13:11:12 +01003378GNU sed allows comments after text on the same line. BSD sed only allows
3379comments where "#" is the first character of the line. To enforce BSD-style
3380comments, i.e. mark end-of-line comments as errors, use: >
3381
3382 :let g:sed_dialect = "bsd"
3383<
3384Note that there are other differences between GNU sed and BSD sed which are
3385not (yet) affected by this setting.
3386
Bram Moolenaar071d4272004-06-13 20:20:40 +00003387Bugs:
3388
3389 The transform command (y) is treated exactly like the substitute
3390 command. This means that, as far as this syntax file is concerned,
3391 transform accepts the same flags as substitute, which is wrong.
3392 (Transform accepts no flags.) I tolerate this bug because the
3393 involved commands need very complex treatment (95 patterns, one for
3394 each plausible pattern delimiter).
3395
3396
Bram Moolenaarda2303d2005-08-30 21:55:26 +00003397SGML *sgml.vim* *ft-sgml-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398
3399The coloring scheme for tags in the SGML file works as follows.
3400
3401The <> of opening tags are colored differently than the </> of a closing tag.
3402This is on purpose! For opening tags the 'Function' color is used, while for
3403closing tags the 'Type' color is used (See syntax.vim to check how those are
3404defined for you)
3405
3406Known tag names are colored the same way as statements in C. Unknown tag
3407names are not colored which makes it easy to spot errors.
3408
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00003409Note that the same is true for argument (or attribute) names. Known attribute
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410names are colored differently than unknown ones.
3411
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00003412Some SGML tags are used to change the rendering of text. The following tags
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413are recognized by the sgml.vim syntax coloring file and change the way normal
3414text is shown: <varname> <emphasis> <command> <function> <literal>
3415<replaceable> <ulink> and <link>.
3416
3417If you want to change how such text is rendered, you must redefine the
3418following syntax groups:
3419
3420 - sgmlBold
3421 - sgmlBoldItalic
3422 - sgmlUnderline
3423 - sgmlItalic
3424 - sgmlLink for links
3425
3426To make this redefinition work you must redefine them all and define the
3427following variable in your vimrc (this is due to the order in which the files
3428are read during initialization) >
3429 let sgml_my_rendering=1
3430
3431You can also disable this rendering by adding the following line to your
3432vimrc file: >
3433 let sgml_no_rendering=1
3434
3435(Adapted from the html.vim help text by Claudio Fleiner <claudio@fleiner.com>)
3436
3437
Bram Moolenaar4466ad62020-11-21 13:16:30 +01003438 *ft-posix-syntax* *ft-dash-syntax*
Bram Moolenaardc083282016-10-11 08:57:33 +02003439SH *sh.vim* *ft-sh-syntax* *ft-bash-syntax* *ft-ksh-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440
Bram Moolenaardc083282016-10-11 08:57:33 +02003441This covers syntax highlighting for the older Unix (Bourne) sh, and newer
3442shells such as bash, dash, posix, and the Korn shells.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003443
3444Vim attempts to determine which shell type is in use by specifying that
Bram Moolenaar91f84f62018-07-29 15:07:52 +02003445various filenames are of specific types, e.g.: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003446
3447 ksh : .kshrc* *.ksh
3448 bash: .bashrc* bashrc bash.bashrc .bash_profile* *.bash
3449<
Bram Moolenaar91f84f62018-07-29 15:07:52 +02003450See $VIMRUNTIME/filetype.vim for the full list of patterns. If none of these
3451cases pertain, then the first line of the file is examined (ex. looking for
3452/bin/sh /bin/ksh /bin/bash). If the first line specifies a shelltype, then
3453that shelltype is used. However some files (ex. .profile) are known to be
3454shell files but the type is not apparent. Furthermore, on many systems sh is
3455symbolically linked to "bash" (Linux, Windows+cygwin) or "ksh" (Posix).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456
Bram Moolenaardc083282016-10-11 08:57:33 +02003457One may specify a global default by instantiating one of the following
Bram Moolenaar071d4272004-06-13 20:20:40 +00003458variables in your <.vimrc>:
3459
Bram Moolenaardc083282016-10-11 08:57:33 +02003460 ksh: >
Bram Moolenaar7fc904b2006-04-13 20:37:35 +00003461 let g:is_kornshell = 1
Bram Moolenaarade0d392020-01-21 22:33:58 +01003462< posix: (using this is nearly the same as setting g:is_kornshell to 1) >
Bram Moolenaar7fc904b2006-04-13 20:37:35 +00003463 let g:is_posix = 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464< bash: >
Bram Moolenaar7fc904b2006-04-13 20:37:35 +00003465 let g:is_bash = 1
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003466< sh: (default) Bourne shell >
Bram Moolenaar7fc904b2006-04-13 20:37:35 +00003467 let g:is_sh = 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468
Bram Moolenaardc083282016-10-11 08:57:33 +02003469< (dash users should use posix)
3470
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003471If there's no "#! ..." line, and the user hasn't availed himself/herself of a
3472default sh.vim syntax setting as just shown, then syntax/sh.vim will assume
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003473the Bourne shell syntax. No need to quote RFCs or market penetration
3474statistics in error reports, please -- just select the default version of the
Bram Moolenaardc083282016-10-11 08:57:33 +02003475sh your system uses and install the associated "let..." in your <.vimrc>.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003476
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003477The syntax/sh.vim file provides several levels of syntax-based folding: >
3478
3479 let g:sh_fold_enabled= 0 (default, no syntax folding)
3480 let g:sh_fold_enabled= 1 (enable function folding)
3481 let g:sh_fold_enabled= 2 (enable heredoc folding)
3482 let g:sh_fold_enabled= 4 (enable if/do/for folding)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003483>
Bram Moolenaardc083282016-10-11 08:57:33 +02003484then various syntax items (ie. HereDocuments and function bodies) become
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003485syntax-foldable (see |:syn-fold|). You also may add these together
3486to get multiple types of folding: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003487
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003488 let g:sh_fold_enabled= 3 (enables function and heredoc folding)
3489
3490If you notice highlighting errors while scrolling backwards which are fixed
3491when one redraws with CTRL-L, try setting the "sh_minlines" internal variable
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492to a larger number. Example: >
3493
3494 let sh_minlines = 500
3495
3496This will make syntax synchronization start 500 lines before the first
3497displayed line. The default value is 200. The disadvantage of using a larger
3498number is that redrawing can become slow.
3499
3500If you don't have much to synchronize on, displaying can be very slow. To
3501reduce this, the "sh_maxlines" internal variable can be set. Example: >
3502
3503 let sh_maxlines = 100
3504<
3505The default is to use the twice sh_minlines. Set it to a smaller number to
3506speed up displaying. The disadvantage is that highlight errors may appear.
3507
Bram Moolenaar3df01732017-02-17 22:47:16 +01003508syntax/sh.vim tries to flag certain problems as errors; usually things like
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01003509unmatched "]", "done", "fi", etc. If you find the error handling problematic
Bram Moolenaar3df01732017-02-17 22:47:16 +01003510for your purposes, you may suppress such error highlighting by putting
3511the following line in your .vimrc: >
3512
3513 let g:sh_no_error= 1
3514<
Bram Moolenaardc083282016-10-11 08:57:33 +02003515
Bram Moolenaard960d762011-09-21 19:22:10 +02003516 *sh-embed* *sh-awk*
3517 Sh: EMBEDDING LANGUAGES~
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518
Bram Moolenaard960d762011-09-21 19:22:10 +02003519You may wish to embed languages into sh. I'll give an example courtesy of
3520Lorance Stinson on how to do this with awk as an example. Put the following
3521file into $HOME/.vim/after/syntax/sh/awkembed.vim: >
3522
Bram Moolenaardae8d212016-02-27 22:40:16 +01003523 " AWK Embedding:
Bram Moolenaard960d762011-09-21 19:22:10 +02003524 " ==============
3525 " Shamelessly ripped from aspperl.vim by Aaron Hope.
3526 if exists("b:current_syntax")
3527 unlet b:current_syntax
3528 endif
3529 syn include @AWKScript syntax/awk.vim
3530 syn region AWKScriptCode matchgroup=AWKCommand start=+[=\\]\@<!'+ skip=+\\'+ end=+'+ contains=@AWKScript contained
3531 syn region AWKScriptEmbedded matchgroup=AWKCommand start=+\<awk\>+ skip=+\\$+ end=+[=\\]\@<!'+me=e-1 contains=@shIdList,@shExprList2 nextgroup=AWKScriptCode
3532 syn cluster shCommandSubList add=AWKScriptEmbedded
3533 hi def link AWKCommand Type
3534<
3535This code will then let the awk code in the single quotes: >
3536 awk '...awk code here...'
3537be highlighted using the awk highlighting syntax. Clearly this may be
3538extended to other languages.
3539
3540
3541SPEEDUP *spup.vim* *ft-spup-syntax*
3542(AspenTech plant simulator)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543
3544The Speedup syntax file has some options:
3545
3546- strict_subsections : If this variable is defined, only keywords for
3547 sections and subsections will be highlighted as statements but not
3548 other keywords (like WITHIN in the OPERATION section).
3549
3550- highlight_types : Definition of this variable causes stream types
3551 like temperature or pressure to be highlighted as Type, not as a
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00003552 plain Identifier. Included are the types that are usually found in
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 the DECLARE section; if you defined own types, you have to include
3554 them in the syntax file.
3555
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01003556- oneline_comments : This value ranges from 1 to 3 and determines the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557 highlighting of # style comments.
3558
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01003559 oneline_comments = 1 : Allow normal Speedup code after an even
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 number of #s.
3561
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01003562 oneline_comments = 2 : Show code starting with the second # as
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00003563 error. This is the default setting.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01003565 oneline_comments = 3 : Show the whole line as error if it contains
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566 more than one #.
3567
3568Since especially OPERATION sections tend to become very large due to
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00003569PRESETting variables, syncing may be critical. If your computer is
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570fast enough, you can increase minlines and/or maxlines near the end of
3571the syntax file.
3572
3573
Bram Moolenaarda2303d2005-08-30 21:55:26 +00003574SQL *sql.vim* *ft-sql-syntax*
3575 *sqlinformix.vim* *ft-sqlinformix-syntax*
Bram Moolenaar1056d982006-03-09 22:37:52 +00003576 *sqlanywhere.vim* *ft-sqlanywhere-syntax*
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003577
Bram Moolenaar1056d982006-03-09 22:37:52 +00003578While there is an ANSI standard for SQL, most database engines add their own
3579custom extensions. Vim currently supports the Oracle and Informix dialects of
3580SQL. Vim assumes "*.sql" files are Oracle SQL by default.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003581
Bram Moolenaar1056d982006-03-09 22:37:52 +00003582Vim currently has SQL support for a variety of different vendors via syntax
3583scripts. You can change Vim's default from Oracle to any of the current SQL
3584supported types. You can also easily alter the SQL dialect being used on a
3585buffer by buffer basis.
3586
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003587For more detailed instructions see |ft_sql.txt|.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003588
3589
Bram Moolenaar47003982021-12-05 21:54:04 +00003590SQUIRREL *squirrel.vim* *ft-squirrel-syntax*
3591
3592Squirrel is a high level imperative, object-oriented programming language,
3593designed to be a light-weight scripting language that fits in the size, memory
3594bandwidth, and real-time requirements of applications like video games. Files
3595with the following extensions are recognized as squirrel files: .nut.
3596
3597
Bram Moolenaarda2303d2005-08-30 21:55:26 +00003598TCSH *tcsh.vim* *ft-tcsh-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599
3600This covers the shell named "tcsh". It is a superset of csh. See |csh.vim|
3601for how the filetype is detected.
3602
3603Tcsh does not allow \" in strings unless the "backslash_quote" shell variable
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01003604is set. If you want VIM to assume that no backslash quote constructs exist
3605add this line to your .vimrc: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003606
3607 :let tcsh_backslash_quote = 0
3608
3609If you notice highlighting errors while scrolling backwards, which are fixed
3610when redrawing with CTRL-L, try setting the "tcsh_minlines" internal variable
3611to a larger number: >
3612
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003613 :let tcsh_minlines = 1000
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003615This will make the syntax synchronization start 1000 lines before the first
3616displayed line. If you set "tcsh_minlines" to "fromstart", then
3617synchronization is done from the start of the file. The default value for
3618tcsh_minlines is 100. The disadvantage of using a larger number is that
3619redrawing can become slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003620
3621
Bram Moolenaar56b45b92013-06-24 22:22:18 +02003622TEX *tex.vim* *ft-tex-syntax* *latex-syntax*
Bram Moolenaar1b884a02020-12-10 21:11:27 +01003623 *syntax-tex* *syntax-latex*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624
Bram Moolenaar56b45b92013-06-24 22:22:18 +02003625 Tex Contents~
3626 Tex: Want Syntax Folding? |tex-folding|
3627 Tex: No Spell Checking Wanted |g:tex_nospell|
3628 Tex: Don't Want Spell Checking In Comments? |tex-nospell|
3629 Tex: Want Spell Checking in Verbatim Zones? |tex-verb|
3630 Tex: Run-on Comments or MathZones |tex-runon|
3631 Tex: Slow Syntax Highlighting? |tex-slow|
3632 Tex: Want To Highlight More Commands? |tex-morecommands|
3633 Tex: Excessive Error Highlighting? |tex-error|
3634 Tex: Need a new Math Group? |tex-math|
3635 Tex: Starting a New Style? |tex-style|
3636 Tex: Taking Advantage of Conceal Mode |tex-conceal|
3637 Tex: Selective Conceal Mode |g:tex_conceal|
3638 Tex: Controlling iskeyword |g:tex_isk|
Bram Moolenaar6e932462014-09-09 18:48:09 +02003639 Tex: Fine Subscript and Superscript Control |tex-supersub|
Bram Moolenaar1b884a02020-12-10 21:11:27 +01003640 Tex: Match Check Control |tex-matchcheck|
Bram Moolenaar56b45b92013-06-24 22:22:18 +02003641
3642 *tex-folding* *g:tex_fold_enabled*
Bram Moolenaar7fc0c062010-08-10 21:43:35 +02003643 Tex: Want Syntax Folding? ~
Bram Moolenaar488c6512005-08-11 20:09:58 +00003644
3645As of version 28 of <syntax/tex.vim>, syntax-based folding of parts, chapters,
3646sections, subsections, etc are supported. Put >
3647 let g:tex_fold_enabled=1
3648in your <.vimrc>, and :set fdm=syntax. I suggest doing the latter via a
3649modeline at the end of your LaTeX file: >
3650 % vim: fdm=syntax
Bram Moolenaard960d762011-09-21 19:22:10 +02003651If your system becomes too slow, then you might wish to look into >
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02003652 https://vimhelp.org/vim_faq.txt.html#faq-29.7
Bram Moolenaar488c6512005-08-11 20:09:58 +00003653<
Bram Moolenaar56b45b92013-06-24 22:22:18 +02003654 *g:tex_nospell*
3655 Tex: No Spell Checking Wanted~
3656
3657If you don't want spell checking anywhere in your LaTeX document, put >
3658 let g:tex_nospell=1
3659into your .vimrc. If you merely wish to suppress spell checking inside
3660comments only, see |g:tex_comment_nospell|.
3661
3662 *tex-nospell* *g:tex_comment_nospell*
Bram Moolenaar7fc0c062010-08-10 21:43:35 +02003663 Tex: Don't Want Spell Checking In Comments? ~
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003664
3665Some folks like to include things like source code in comments and so would
3666prefer that spell checking be disabled in comments in LaTeX files. To do
3667this, put the following in your <.vimrc>: >
3668 let g:tex_comment_nospell= 1
Bram Moolenaar56b45b92013-06-24 22:22:18 +02003669If you want to suppress spell checking everywhere inside your LaTeX document,
3670see |g:tex_nospell|.
3671
3672 *tex-verb* *g:tex_verbspell*
Bram Moolenaar7fc0c062010-08-10 21:43:35 +02003673 Tex: Want Spell Checking in Verbatim Zones?~
Bram Moolenaar74cbdf02010-08-04 23:03:17 +02003674
3675Often verbatim regions are used for things like source code; seldom does
3676one want source code spell-checked. However, for those of you who do
3677want your verbatim zones spell-checked, put the following in your <.vimrc>: >
3678 let g:tex_verbspell= 1
Bram Moolenaar7fc0c062010-08-10 21:43:35 +02003679<
Bram Moolenaar56b45b92013-06-24 22:22:18 +02003680 *tex-runon* *tex-stopzone*
Bram Moolenaar7fc0c062010-08-10 21:43:35 +02003681 Tex: Run-on Comments or MathZones ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682
Bram Moolenaar488c6512005-08-11 20:09:58 +00003683The <syntax/tex.vim> highlighting supports TeX, LaTeX, and some AmsTeX. The
3684highlighting supports three primary zones/regions: normal, texZone, and
3685texMathZone. Although considerable effort has been made to have these zones
3686terminate properly, zones delineated by $..$ and $$..$$ cannot be synchronized
3687as there's no difference between start and end patterns. Consequently, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003688special "TeX comment" has been provided >
3689 %stopzone
3690which will forcibly terminate the highlighting of either a texZone or a
3691texMathZone.
3692
Bram Moolenaar56b45b92013-06-24 22:22:18 +02003693 *tex-slow* *tex-sync*
Bram Moolenaar7fc0c062010-08-10 21:43:35 +02003694 Tex: Slow Syntax Highlighting? ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00003695
3696If you have a slow computer, you may wish to reduce the values for >
3697 :syn sync maxlines=200
3698 :syn sync minlines=50
3699(especially the latter). If your computer is fast, you may wish to
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00003700increase them. This primarily affects synchronizing (i.e. just what group,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003701if any, is the text at the top of the screen supposed to be in?).
3702
Bram Moolenaard960d762011-09-21 19:22:10 +02003703Another cause of slow highlighting is due to syntax-driven folding; see
3704|tex-folding| for a way around this.
3705
Bram Moolenaar56b45b92013-06-24 22:22:18 +02003706 *g:tex_fast*
3707
3708Finally, if syntax highlighting is still too slow, you may set >
3709
3710 :let g:tex_fast= ""
3711
3712in your .vimrc. Used this way, the g:tex_fast variable causes the syntax
3713highlighting script to avoid defining any regions and associated
3714synchronization. The result will be much faster syntax highlighting; the
3715price: you will no longer have as much highlighting or any syntax-based
3716folding, and you will be missing syntax-based error checking.
3717
3718You may decide that some syntax is acceptable; you may use the following table
3719selectively to enable just some syntax highlighting: >
3720
3721 b : allow bold and italic syntax
3722 c : allow texComment syntax
3723 m : allow texMatcher syntax (ie. {...} and [...])
3724 M : allow texMath syntax
3725 p : allow parts, chapter, section, etc syntax
3726 r : allow texRefZone syntax (nocite, bibliography, label, pageref, eqref)
3727 s : allow superscript/subscript regions
3728 S : allow texStyle syntax
3729 v : allow verbatim syntax
3730 V : allow texNewEnv and texNewCmd syntax
3731<
3732As an example, let g:tex_fast= "M" will allow math-associated highlighting
3733but suppress all the other region-based syntax highlighting.
Bram Moolenaar6e932462014-09-09 18:48:09 +02003734(also see: |g:tex_conceal| and |tex-supersub|)
Bram Moolenaar56b45b92013-06-24 22:22:18 +02003735
3736 *tex-morecommands* *tex-package*
Bram Moolenaar7fc0c062010-08-10 21:43:35 +02003737 Tex: Want To Highlight More Commands? ~
Bram Moolenaarc81e5e72007-05-05 18:24:42 +00003738
3739LaTeX is a programmable language, and so there are thousands of packages full
3740of specialized LaTeX commands, syntax, and fonts. If you're using such a
3741package you'll often wish that the distributed syntax/tex.vim would support
3742it. However, clearly this is impractical. So please consider using the
3743techniques in |mysyntaxfile-add| to extend or modify the highlighting provided
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01003744by syntax/tex.vim. Please consider uploading any extensions that you write,
3745which typically would go in $HOME/after/syntax/tex/[pkgname].vim, to
3746http://vim.sf.net/.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +00003747
Bram Moolenaar93a1df22018-09-10 11:51:50 +02003748I've included some support for various popular packages on my website: >
3749
3750 http://www.drchip.org/astronaut/vim/index.html#LATEXPKGS
3751<
3752The syntax files there go into your .../after/syntax/tex/ directory.
3753
Bram Moolenaar56b45b92013-06-24 22:22:18 +02003754 *tex-error* *g:tex_no_error*
Bram Moolenaar7fc0c062010-08-10 21:43:35 +02003755 Tex: Excessive Error Highlighting? ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00003756
3757The <tex.vim> supports lexical error checking of various sorts. Thus,
3758although the error checking is ofttimes very useful, it can indicate
3759errors where none actually are. If this proves to be a problem for you,
3760you may put in your <.vimrc> the following statement: >
Bram Moolenaar56b45b92013-06-24 22:22:18 +02003761 let g:tex_no_error=1
Bram Moolenaar488c6512005-08-11 20:09:58 +00003762and all error checking by <syntax/tex.vim> will be suppressed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003764 *tex-math*
Bram Moolenaar7fc0c062010-08-10 21:43:35 +02003765 Tex: Need a new Math Group? ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766
3767If you want to include a new math group in your LaTeX, the following
3768code shows you an example as to how you might do so: >
Bram Moolenaar488c6512005-08-11 20:09:58 +00003769 call TexNewMathZone(sfx,mathzone,starform)
3770You'll want to provide the new math group with a unique suffix
3771(currently, A-L and V-Z are taken by <syntax/tex.vim> itself).
3772As an example, consider how eqnarray is set up by <syntax/tex.vim>: >
3773 call TexNewMathZone("D","eqnarray",1)
3774You'll need to change "mathzone" to the name of your new math group,
3775and then to the call to it in .vim/after/syntax/tex.vim.
3776The "starform" variable, if true, implies that your new math group
3777has a starred form (ie. eqnarray*).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003778
Bram Moolenaar56b45b92013-06-24 22:22:18 +02003779 *tex-style* *b:tex_stylish*
Bram Moolenaar7fc0c062010-08-10 21:43:35 +02003780 Tex: Starting a New Style? ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00003781
3782One may use "\makeatletter" in *.tex files, thereby making the use of "@" in
3783commands available. However, since the *.tex file doesn't have one of the
3784following suffices: sty cls clo dtx ltx, the syntax highlighting will flag
3785such use of @ as an error. To solve this: >
3786
3787 :let b:tex_stylish = 1
3788 :set ft=tex
3789
3790Putting "let g:tex_stylish=1" into your <.vimrc> will make <syntax/tex.vim>
3791always accept such use of @.
3792
Bram Moolenaar611df5b2010-07-26 22:51:56 +02003793 *tex-cchar* *tex-cole* *tex-conceal*
Bram Moolenaar7fc0c062010-08-10 21:43:35 +02003794 Tex: Taking Advantage of Conceal Mode~
Bram Moolenaar611df5b2010-07-26 22:51:56 +02003795
Bram Moolenaar477db062010-07-28 18:17:41 +02003796If you have |'conceallevel'| set to 2 and if your encoding is utf-8, then a
3797number of character sequences can be translated into appropriate utf-8 glyphs,
3798including various accented characters, Greek characters in MathZones, and
3799superscripts and subscripts in MathZones. Not all characters can be made into
3800superscripts or subscripts; the constraint is due to what utf-8 supports.
3801In fact, only a few characters are supported as subscripts.
3802
3803One way to use this is to have vertically split windows (see |CTRL-W_v|); one
3804with |'conceallevel'| at 0 and the other at 2; and both using |'scrollbind'|.
Bram Moolenaar611df5b2010-07-26 22:51:56 +02003805
Bram Moolenaar56b45b92013-06-24 22:22:18 +02003806 *g:tex_conceal*
Bram Moolenaar7fc0c062010-08-10 21:43:35 +02003807 Tex: Selective Conceal Mode~
3808
3809You may selectively use conceal mode by setting g:tex_conceal in your
Bram Moolenaar56b45b92013-06-24 22:22:18 +02003810<.vimrc>. By default, g:tex_conceal is set to "admgs" to enable concealment
3811for the following sets of characters: >
Bram Moolenaar7fc0c062010-08-10 21:43:35 +02003812
3813 a = accents/ligatures
Bram Moolenaard38b0552012-04-25 19:07:41 +02003814 b = bold and italic
Bram Moolenaar7fc0c062010-08-10 21:43:35 +02003815 d = delimiters
3816 m = math symbols
3817 g = Greek
3818 s = superscripts/subscripts
3819<
3820By leaving one or more of these out, the associated conceal-character
3821substitution will not be made.
3822
Bram Moolenaar56b45b92013-06-24 22:22:18 +02003823 *g:tex_isk* *g:tex_stylish*
3824 Tex: Controlling iskeyword~
3825
3826Normally, LaTeX keywords support 0-9, a-z, A-z, and 192-255 only. Latex
3827keywords don't support the underscore - except when in *.sty files. The
3828syntax highlighting script handles this with the following logic:
3829
3830 * If g:tex_stylish exists and is 1
3831 then the file will be treated as a "sty" file, so the "_"
3832 will be allowed as part of keywords
Bram Moolenaar3df01732017-02-17 22:47:16 +01003833 (regardless of g:tex_isk)
Bram Moolenaar56b45b92013-06-24 22:22:18 +02003834 * Else if the file's suffix is sty, cls, clo, dtx, or ltx,
3835 then the file will be treated as a "sty" file, so the "_"
3836 will be allowed as part of keywords
Bram Moolenaar3df01732017-02-17 22:47:16 +01003837 (regardless of g:tex_isk)
Bram Moolenaar56b45b92013-06-24 22:22:18 +02003838
3839 * If g:tex_isk exists, then it will be used for the local 'iskeyword'
3840 * Else the local 'iskeyword' will be set to 48-57,a-z,A-Z,192-255
3841
Bram Moolenaar6e932462014-09-09 18:48:09 +02003842 *tex-supersub* *g:tex_superscripts* *g:tex_subscripts*
3843 Tex: Fine Subscript and Superscript Control~
3844
3845 See |tex-conceal| for how to enable concealed character replacement.
3846
3847 See |g:tex_conceal| for selectively concealing accents, bold/italic,
3848 math, Greek, and superscripts/subscripts.
3849
3850 One may exert fine control over which superscripts and subscripts one
3851 wants syntax-based concealment for (see |:syn-cchar|). Since not all
3852 fonts support all characters, one may override the
3853 concealed-replacement lists; by default these lists are given by: >
3854
3855 let g:tex_superscripts= "[0-9a-zA-W.,:;+-<>/()=]"
3856 let g:tex_subscripts= "[0-9aehijklmnoprstuvx,+-/().]"
3857<
3858 For example, I use Luxi Mono Bold; it doesn't support subscript
3859 characters for "hklmnpst", so I put >
3860 let g:tex_subscripts= "[0-9aeijoruvx,+-/().]"
3861< in ~/.vim/ftplugin/tex/tex.vim in order to avoid having inscrutable
3862 utf-8 glyphs appear.
3863
Bram Moolenaar1b884a02020-12-10 21:11:27 +01003864 *tex-matchcheck* *g:tex_matchcheck*
3865 Tex: Match Check Control~
3866
3867 Sometimes one actually wants mismatched parentheses, square braces,
Bram Moolenaar2346a632021-06-13 19:02:49 +02003868 and or curly braces; for example, \text{(1,10]} is a range from but
3869 not including 1 to and including 10. This wish, of course, conflicts
Bram Moolenaar1b884a02020-12-10 21:11:27 +01003870 with the desire to provide delimiter mismatch detection. To
3871 accommodate these conflicting goals, syntax/tex.vim provides >
3872 g:tex_matchcheck = '[({[]'
3873< which is shown along with its default setting. So, if one doesn't
3874 want [] and () to be checked for mismatches, try using >
3875 let g:tex_matchcheck= '[{}]'
3876< If you don't want matching to occur inside bold and italicized
3877 regions, >
3878 let g:tex_excludematcher= 1
3879< will prevent the texMatcher group from being included in those regions.
Bram Moolenaar56b45b92013-06-24 22:22:18 +02003880
Bram Moolenaar22dbc772013-06-28 18:44:48 +02003881TF *tf.vim* *ft-tf-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882
Bram Moolenaar22dbc772013-06-28 18:44:48 +02003883There is one option for the tf syntax highlighting.
3884
3885For syncing, minlines defaults to 100. If you prefer another value, you can
3886set "tf_minlines" to the value you desire. Example: >
3887
3888 :let tf_minlines = your choice
3889<
rhysd5e457152024-05-24 18:59:10 +02003890TYPESCRIPT *typescript.vim* *ft-typescript-syntax*
3891 *typescriptreact.vim* *ft-typescriptreact-syntax*
3892
3893There is one option to control the TypeScript syntax highlighting.
3894
3895 *g:typescript_host_keyword*
3896When this variable is set to 1, host-specific APIs such as `addEventListener`
3897are highlighted. To disable set it to zero in your .vimrc: >
3898
3899 let g:typescript_host_keyword = 0
3900<
3901The default value is 1.
3902
Gregory Anders1cc4cae2024-07-15 20:00:48 +02003903TYPST *ft-typst-syntax*
3904
3905 *g:typst_embedded_languages*
3906Typst files can embed syntax highlighting for other languages by setting the
3907|g:typst_embedded_languages| variable. This variable is a list of language
3908names whose syntax definitions will be included in Typst files. Example: >
3909
3910 let g:typst_embedded_languages = ['python', 'r']
3911
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003912VIM *vim.vim* *ft-vim-syntax*
3913 *g:vimsyn_minlines* *g:vimsyn_maxlines*
Bram Moolenaar996343d2010-07-04 22:20:21 +02003914There is a trade-off between more accurate syntax highlighting versus screen
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003915updating speed. To improve accuracy, you may wish to increase the
3916g:vimsyn_minlines variable. The g:vimsyn_maxlines variable may be used to
3917improve screen updating rates (see |:syn-sync| for more on this). >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003919 g:vimsyn_minlines : used to set synchronization minlines
3920 g:vimsyn_maxlines : used to set synchronization maxlines
3921<
3922 (g:vim_minlines and g:vim_maxlines are deprecated variants of
3923 these two options)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003925 *g:vimsyn_embed*
3926The g:vimsyn_embed option allows users to select what, if any, types of
3927embedded script highlighting they wish to have. >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003928
Bram Moolenaara0f849e2015-10-30 14:37:44 +01003929 g:vimsyn_embed == 0 : don't support any embedded scripts
dkearns959c3c82024-06-12 04:18:08 +10003930 g:vimsyn_embed =~ 'l' : support embedded Lua
3931 g:vimsyn_embed =~ 'm' : support embedded MzScheme
3932 g:vimsyn_embed =~ 'p' : support embedded Perl
3933 g:vimsyn_embed =~ 'P' : support embedded Python
3934 g:vimsyn_embed =~ 'r' : support embedded Ruby
3935 g:vimsyn_embed =~ 't' : support embedded Tcl
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003936<
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02003937By default, g:vimsyn_embed is a string supporting interpreters that your vim
Doug Kearns92f4e912024-06-05 19:45:43 +02003938itself supports. Concatenate the indicated characters to support multiple
dkearns959c3c82024-06-12 04:18:08 +10003939types of embedded interpreters (e.g., g:vimsyn_embed = "mp" supports embedded
3940mzscheme and embedded perl).
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003941 *g:vimsyn_folding*
Doug Kearns92f4e912024-06-05 19:45:43 +02003942Some folding is now supported with when 'foldmethod' is set to "syntax": >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003944 g:vimsyn_folding == 0 or doesn't exist: no syntax-based folding
3945 g:vimsyn_folding =~ 'a' : augroups
3946 g:vimsyn_folding =~ 'f' : fold functions
Doug Kearnsce064932024-04-13 18:24:01 +02003947 g:vimsyn_folding =~ 'h' : fold heredocs
3948 g:vimsyn_folding =~ 'H' : fold Vim9-script legacy headers
dkearns959c3c82024-06-12 04:18:08 +10003949 g:vimsyn_folding =~ 'l' : fold Lua script
3950 g:vimsyn_folding =~ 'm' : fold MzScheme script
3951 g:vimsyn_folding =~ 'p' : fold Perl script
3952 g:vimsyn_folding =~ 'P' : fold Python script
3953 g:vimsyn_folding =~ 'r' : fold Ruby script
3954 g:vimsyn_folding =~ 't' : fold Tcl script
Bram Moolenaar30b65812012-07-12 22:01:11 +02003955<
Doug Kearns92f4e912024-06-05 19:45:43 +02003956
3957By default, g:vimsyn_folding is unset. Concatenate the indicated characters
dkearns959c3c82024-06-12 04:18:08 +10003958to support folding of multiple syntax constructs (e.g.,
3959g:vimsyn_folding = "fh" will enable folding of both functions and heredocs).
Doug Kearns92f4e912024-06-05 19:45:43 +02003960
dkearns959c3c82024-06-12 04:18:08 +10003961 *g:vimsyn_comment_strings*
3962By default, strings are highlighted inside comments. This may be disabled by
3963setting g:vimsyn_comment_strings to false.
3964
3965 *g:vimsyn_noerror*
Bram Moolenaarb544f3c2017-02-23 19:03:28 +01003966Not all error highlighting that syntax/vim.vim does may be correct; Vim script
3967is a difficult language to highlight correctly. A way to suppress error
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003968highlighting is to put the following line in your |vimrc|: >
Bram Moolenaar437df8f2006-04-27 21:47:44 +00003969
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003970 let g:vimsyn_noerror = 1
3971<
Bram Moolenaar437df8f2006-04-27 21:47:44 +00003972
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973
Bram Moolenaar86b48162022-12-06 18:20:10 +00003974WDL *wdl.vim* *wdl-syntax*
3975
3976The Workflow Description Language is a way to specify data processing workflows
3977with a human-readable and writeable syntax. This is used a lot in
3978bioinformatics. More info on the spec can be found here:
3979https://github.com/openwdl/wdl
3980
3981
Bram Moolenaarda2303d2005-08-30 21:55:26 +00003982XF86CONFIG *xf86conf.vim* *ft-xf86conf-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003983
3984The syntax of XF86Config file differs in XFree86 v3.x and v4.x. Both
3985variants are supported. Automatic detection is used, but is far from perfect.
3986You may need to specify the version manually. Set the variable
3987xf86conf_xfree86_version to 3 or 4 according to your XFree86 version in
3988your .vimrc. Example: >
3989 :let xf86conf_xfree86_version=3
3990When using a mix of versions, set the b:xf86conf_xfree86_version variable.
3991
3992Note that spaces and underscores in option names are not supported. Use
3993"SyncOnGreen" instead of "__s yn con gr_e_e_n" if you want the option name
3994highlighted.
3995
3996
Bram Moolenaarda2303d2005-08-30 21:55:26 +00003997XML *xml.vim* *ft-xml-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003998
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00003999Xml namespaces are highlighted by default. This can be inhibited by
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000setting a global variable: >
4001
4002 :let g:xml_namespace_transparent=1
4003<
4004 *xml-folding*
4005The xml syntax file provides syntax |folding| (see |:syn-fold|) between
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00004006start and end tags. This can be turned on by >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007
4008 :let g:xml_syntax_folding = 1
4009 :set foldmethod=syntax
4010
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01004011Note: Syntax folding might slow down syntax highlighting significantly,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012especially for large files.
4013
4014
Bram Moolenaarda2303d2005-08-30 21:55:26 +00004015X Pixmaps (XPM) *xpm.vim* *ft-xpm-syntax*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004016
4017xpm.vim creates its syntax items dynamically based upon the contents of the
4018XPM file. Thus if you make changes e.g. in the color specification strings,
4019you have to source it again e.g. with ":set syn=xpm".
4020
4021To copy a pixel with one of the colors, yank a "pixel" with "yl" and insert it
4022somewhere else with "P".
4023
4024Do you want to draw with the mouse? Try the following: >
4025 :function! GetPixel()
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004026 : let c = getline(".")[col(".") - 1]
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027 : echo c
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004028 : exe "noremap <LeftMouse> <LeftMouse>r" .. c
4029 : exe "noremap <LeftDrag> <LeftMouse>r" .. c
Bram Moolenaar071d4272004-06-13 20:20:40 +00004030 :endfunction
4031 :noremap <RightMouse> <LeftMouse>:call GetPixel()<CR>
4032 :set guicursor=n:hor20 " to see the color beneath the cursor
4033This turns the right button into a pipette and the left button into a pen.
4034It will work with XPM files that have one character per pixel only and you
4035must not click outside of the pixel strings, but feel free to improve it.
4036
4037It will look much better with a font in a quadratic cell size, e.g. for X: >
4038 :set guifont=-*-clean-medium-r-*-*-8-*-*-*-*-80-*
4039
Bram Moolenaar5a5f4592015-04-13 12:43:06 +02004040
4041YAML *yaml.vim* *ft-yaml-syntax*
4042
4043 *g:yaml_schema* *b:yaml_schema*
Bram Moolenaar664f3cf2019-12-07 16:03:51 +01004044A YAML schema is a combination of a set of tags and a mechanism for resolving
4045non-specific tags. For user this means that YAML parser may, depending on
4046plain scalar contents, treat plain scalar (which can actually be only string
4047and nothing else) as a value of the other type: null, boolean, floating-point,
4048integer. `g:yaml_schema` option determines according to which schema values
Bram Moolenaar5a5f4592015-04-13 12:43:06 +02004049will be highlighted specially. Supported schemas are
4050
4051Schema Description ~
4052failsafe No additional highlighting.
4053json Supports JSON-style numbers, booleans and null.
4054core Supports more number, boolean and null styles.
Bram Moolenaar664f3cf2019-12-07 16:03:51 +01004055pyyaml In addition to core schema supports highlighting timestamps,
4056 but there are some differences in what is recognized as
4057 numbers and many additional boolean values not present in core
Bram Moolenaar5a5f4592015-04-13 12:43:06 +02004058 schema.
4059
4060Default schema is `core`.
4061
Bram Moolenaar664f3cf2019-12-07 16:03:51 +01004062Note that schemas are not actually limited to plain scalars, but this is the
4063only difference between schemas defined in YAML specification and the only
Bram Moolenaar5a5f4592015-04-13 12:43:06 +02004064difference defined in the syntax file.
4065
Bram Moolenaarf3913272016-02-25 00:00:01 +01004066
4067ZSH *zsh.vim* *ft-zsh-syntax*
4068
4069The syntax script for zsh allows for syntax-based folding: >
4070
4071 :let g:zsh_fold_enable = 1
4072
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073==============================================================================
Bram Moolenaar9d87a372018-12-18 21:41:50 +010040746. Defining a syntax *:syn-define* *E410*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075
4076Vim understands three types of syntax items:
4077
Bram Moolenaarce0842a2005-07-18 21:58:11 +000040781. Keyword
Bram Moolenaar71badf92023-04-22 22:40:14 +01004079 It can only contain keyword characters, according to the characters
4080 specified with |:syn-iskeyword| or the 'iskeyword' option. It cannot
4081 contain other syntax items. It will only match with a complete word (there
4082 are no keyword characters before or after the match). The keyword "if"
4083 would match in "if(a=b)", but not in "ifdef x", because "(" is not a
4084 keyword character and "d" is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004085
Bram Moolenaarce0842a2005-07-18 21:58:11 +000040862. Match
Bram Moolenaar071d4272004-06-13 20:20:40 +00004087 This is a match with a single regexp pattern.
4088
Bram Moolenaarce0842a2005-07-18 21:58:11 +000040893. Region
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 This starts at a match of the "start" regexp pattern and ends with a match
4091 with the "end" regexp pattern. Any other text can appear in between. A
4092 "skip" regexp pattern can be used to avoid matching the "end" pattern.
4093
4094Several syntax ITEMs can be put into one syntax GROUP. For a syntax group
4095you can give highlighting attributes. For example, you could have an item
4096to define a "/* .. */" comment and another one that defines a "// .." comment,
4097and put them both in the "Comment" group. You can then specify that a
4098"Comment" will be in bold font and have a blue color. You are free to make
4099one highlight group for one syntax item, or put all items into one group.
4100This depends on how you want to specify your highlighting attributes. Putting
4101each item in its own group results in having to specify the highlighting
4102for a lot of groups.
4103
4104Note that a syntax group and a highlight group are similar. For a highlight
4105group you will have given highlight attributes. These attributes will be used
4106for the syntax group with the same name.
4107
4108In case more than one item matches at the same position, the one that was
4109defined LAST wins. Thus you can override previously defined syntax items by
4110using an item that matches the same text. But a keyword always goes before a
4111match or region. And a keyword with matching case always goes before a
4112keyword with ignoring case.
4113
4114
4115PRIORITY *:syn-priority*
4116
4117When several syntax items may match, these rules are used:
4118
41191. When multiple Match or Region items start in the same position, the item
4120 defined last has priority.
41212. A Keyword has priority over Match and Region items.
41223. An item that starts in an earlier position has priority over items that
4123 start in later positions.
4124
4125
4126DEFINING CASE *:syn-case* *E390*
4127
Bram Moolenaarce0842a2005-07-18 21:58:11 +00004128:sy[ntax] case [match | ignore]
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 This defines if the following ":syntax" commands will work with
4130 matching case, when using "match", or with ignoring case, when using
4131 "ignore". Note that any items before this are not affected, and all
4132 items until the next ":syntax case" command are affected.
4133
Bram Moolenaar690afe12017-01-28 18:34:47 +01004134:sy[ntax] case
Bram Moolenaar9da17d72022-02-09 21:50:44 +00004135 Show either "syntax case match" or "syntax case ignore".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136
Bram Moolenaare35a52a2020-05-31 19:48:53 +02004137
4138DEFINING FOLDLEVEL *:syn-foldlevel*
4139
Bram Moolenaar9da17d72022-02-09 21:50:44 +00004140:sy[ntax] foldlevel start
4141:sy[ntax] foldlevel minimum
Bram Moolenaare35a52a2020-05-31 19:48:53 +02004142 This defines how the foldlevel of a line is computed when using
4143 foldmethod=syntax (see |fold-syntax| and |:syn-fold|):
4144
4145 start: Use level of item containing start of line.
4146 minimum: Use lowest local-minimum level of items on line.
4147
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02004148 The default is "start". Use "minimum" to search a line horizontally
Bram Moolenaare35a52a2020-05-31 19:48:53 +02004149 for the lowest level contained on the line that is followed by a
4150 higher level. This produces more natural folds when syntax items
4151 may close and open horizontally within a line.
4152
4153:sy[ntax] foldlevel
Bram Moolenaar9da17d72022-02-09 21:50:44 +00004154 Show the current foldlevel method, either "syntax foldlevel start" or
4155 "syntax foldlevel minimum".
Bram Moolenaare35a52a2020-05-31 19:48:53 +02004156
4157 {not meaningful when Vim was compiled without |+folding| feature}
4158
Bram Moolenaarce0842a2005-07-18 21:58:11 +00004159SPELL CHECKING *:syn-spell*
4160
Bram Moolenaar9da17d72022-02-09 21:50:44 +00004161:sy[ntax] spell toplevel
4162:sy[ntax] spell notoplevel
4163:sy[ntax] spell default
Bram Moolenaarce0842a2005-07-18 21:58:11 +00004164 This defines where spell checking is to be done for text that is not
4165 in a syntax item:
4166
4167 toplevel: Text is spell checked.
4168 notoplevel: Text is not spell checked.
4169 default: When there is a @Spell cluster no spell checking.
4170
4171 For text in syntax items use the @Spell and @NoSpell clusters
4172 |spell-syntax|. When there is no @Spell and no @NoSpell cluster then
4173 spell checking is done for "default" and "toplevel".
4174
4175 To activate spell checking the 'spell' option must be set.
4176
Bram Moolenaar690afe12017-01-28 18:34:47 +01004177:sy[ntax] spell
Bram Moolenaar9da17d72022-02-09 21:50:44 +00004178 Show the current syntax spell checking method, either "syntax spell
4179 toplevel", "syntax spell notoplevel" or "syntax spell default".
Bram Moolenaar690afe12017-01-28 18:34:47 +01004180
4181
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004182SYNTAX ISKEYWORD SETTING *:syn-iskeyword*
4183
4184:sy[ntax] iskeyword [clear | {option}]
4185 This defines the keyword characters. It's like the 'iskeyword' option
4186 for but only applies to syntax highlighting.
4187
4188 clear: Syntax specific iskeyword setting is disabled and the
4189 buffer-local 'iskeyword' setting is used.
Bram Moolenaar938ae282023-02-20 20:44:55 +00004190 {option} Set the syntax 'iskeyword' option to a new value.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004191
4192 Example: >
4193 :syntax iskeyword @,48-57,192-255,$,_
4194<
4195 This would set the syntax specific iskeyword option to include all
4196 alphabetic characters, plus the numeric characters, all accented
4197 characters and also includes the "_" and the "$".
4198
4199 If no argument is given, the current value will be output.
4200
4201 Setting this option influences what |/\k| matches in syntax patterns
Bram Moolenaar298b4402016-01-28 22:38:53 +01004202 and also determines where |:syn-keyword| will be checked for a new
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004203 match.
4204
Bram Moolenaard0796902016-09-16 20:02:31 +02004205 It is recommended when writing syntax files, to use this command to
4206 set the correct value for the specific syntax language and not change
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004207 the 'iskeyword' option.
Bram Moolenaarce0842a2005-07-18 21:58:11 +00004208
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209DEFINING KEYWORDS *:syn-keyword*
4210
4211:sy[ntax] keyword {group-name} [{options}] {keyword} .. [{options}]
4212
4213 This defines a number of keywords.
4214
4215 {group-name} Is a syntax group name such as "Comment".
4216 [{options}] See |:syn-arguments| below.
4217 {keyword} .. Is a list of keywords which are part of this group.
4218
4219 Example: >
4220 :syntax keyword Type int long char
4221<
4222 The {options} can be given anywhere in the line. They will apply to
4223 all keywords given, also for options that come after a keyword.
4224 These examples do exactly the same: >
4225 :syntax keyword Type contained int long char
4226 :syntax keyword Type int long contained char
4227 :syntax keyword Type int long char contained
Bram Moolenaar88774fd2015-08-25 19:52:04 +02004228< *E789* *E890*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229 When you have a keyword with an optional tail, like Ex commands in
4230 Vim, you can put the optional characters inside [], to define all the
4231 variations at once: >
4232 :syntax keyword vimCommand ab[breviate] n[ext]
4233<
4234 Don't forget that a keyword can only be recognized if all the
4235 characters are included in the 'iskeyword' option. If one character
4236 isn't, the keyword will never be recognized.
4237 Multi-byte characters can also be used. These do not have to be in
4238 'iskeyword'.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004239 See |:syn-iskeyword| for defining syntax specific iskeyword settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004240
4241 A keyword always has higher priority than a match or region, the
4242 keyword is used if more than one item matches. Keywords do not nest
4243 and a keyword can't contain anything else.
4244
4245 Note that when you have a keyword that is the same as an option (even
4246 one that isn't allowed here), you can not use it. Use a match
4247 instead.
4248
4249 The maximum length of a keyword is 80 characters.
4250
4251 The same keyword can be defined multiple times, when its containment
4252 differs. For example, you can define the keyword once not contained
4253 and use one highlight group, and once contained, and use a different
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00004254 highlight group. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004255 :syn keyword vimCommand tag
4256 :syn keyword vimSetting contained tag
4257< When finding "tag" outside of any syntax item, the "vimCommand"
4258 highlight group is used. When finding "tag" in a syntax item that
4259 contains "vimSetting", the "vimSetting" group is used.
4260
4261
4262DEFINING MATCHES *:syn-match*
4263
Bram Moolenaar2ec618c2016-10-01 14:47:05 +02004264:sy[ntax] match {group-name} [{options}]
4265 [excludenl]
4266 [keepend]
4267 {pattern}
4268 [{options}]
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269
4270 This defines one match.
4271
4272 {group-name} A syntax group name such as "Comment".
4273 [{options}] See |:syn-arguments| below.
4274 [excludenl] Don't make a pattern with the end-of-line "$"
4275 extend a containing match or region. Must be
4276 given before the pattern. |:syn-excludenl|
Bram Moolenaar2ec618c2016-10-01 14:47:05 +02004277 keepend Don't allow contained matches to go past a
4278 match with the end pattern. See
4279 |:syn-keepend|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004280 {pattern} The search pattern that defines the match.
4281 See |:syn-pattern| below.
4282 Note that the pattern may match more than one
4283 line, which makes the match depend on where
4284 Vim starts searching for the pattern. You
4285 need to make sure syncing takes care of this.
4286
4287 Example (match a character constant): >
4288 :syntax match Character /'.'/hs=s+1,he=e-1
4289<
4290
4291DEFINING REGIONS *:syn-region* *:syn-start* *:syn-skip* *:syn-end*
4292 *E398* *E399*
4293:sy[ntax] region {group-name} [{options}]
4294 [matchgroup={group-name}]
4295 [keepend]
4296 [extend]
4297 [excludenl]
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02004298 start={start-pattern} ..
4299 [skip={skip-pattern}]
4300 end={end-pattern} ..
Bram Moolenaar071d4272004-06-13 20:20:40 +00004301 [{options}]
4302
4303 This defines one region. It may span several lines.
4304
4305 {group-name} A syntax group name such as "Comment".
4306 [{options}] See |:syn-arguments| below.
4307 [matchgroup={group-name}] The syntax group to use for the following
4308 start or end pattern matches only. Not used
4309 for the text in between the matched start and
4310 end patterns. Use NONE to reset to not using
4311 a different group for the start or end match.
4312 See |:syn-matchgroup|.
4313 keepend Don't allow contained matches to go past a
4314 match with the end pattern. See
4315 |:syn-keepend|.
4316 extend Override a "keepend" for an item this region
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00004317 is contained in. See |:syn-extend|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 excludenl Don't make a pattern with the end-of-line "$"
4319 extend a containing match or item. Only
4320 useful for end patterns. Must be given before
4321 the patterns it applies to. |:syn-excludenl|
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02004322 start={start-pattern} The search pattern that defines the start of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004323 the region. See |:syn-pattern| below.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02004324 skip={skip-pattern} The search pattern that defines text inside
Bram Moolenaar071d4272004-06-13 20:20:40 +00004325 the region where not to look for the end
4326 pattern. See |:syn-pattern| below.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02004327 end={end-pattern} The search pattern that defines the end of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004328 the region. See |:syn-pattern| below.
4329
4330 Example: >
4331 :syntax region String start=+"+ skip=+\\"+ end=+"+
4332<
4333 The start/skip/end patterns and the options can be given in any order.
4334 There can be zero or one skip pattern. There must be one or more
4335 start and end patterns. This means that you can omit the skip
4336 pattern, but you must give at least one start and one end pattern. It
4337 is allowed to have white space before and after the equal sign
4338 (although it mostly looks better without white space).
4339
4340 When more than one start pattern is given, a match with one of these
4341 is sufficient. This means there is an OR relation between the start
4342 patterns. The last one that matches is used. The same is true for
4343 the end patterns.
4344
4345 The search for the end pattern starts right after the start pattern.
4346 Offsets are not used for this. This implies that the match for the
4347 end pattern will never overlap with the start pattern.
4348
4349 The skip and end pattern can match across line breaks, but since the
4350 search for the pattern can start in any line it often does not do what
4351 you want. The skip pattern doesn't avoid a match of an end pattern in
4352 the next line. Use single-line patterns to avoid trouble.
4353
4354 Note: The decision to start a region is only based on a matching start
4355 pattern. There is no check for a matching end pattern. This does NOT
4356 work: >
4357 :syn region First start="(" end=":"
4358 :syn region Second start="(" end=";"
4359< The Second always matches before the First (last defined pattern has
4360 higher priority). The Second region then continues until the next
4361 ';', no matter if there is a ':' before it. Using a match does work: >
4362 :syn match First "(\_.\{-}:"
4363 :syn match Second "(\_.\{-};"
4364< This pattern matches any character or line break with "\_." and
4365 repeats that with "\{-}" (repeat as few as possible).
4366
4367 *:syn-keepend*
4368 By default, a contained match can obscure a match for the end pattern.
4369 This is useful for nesting. For example, a region that starts with
4370 "{" and ends with "}", can contain another region. An encountered "}"
4371 will then end the contained region, but not the outer region:
4372 { starts outer "{}" region
4373 { starts contained "{}" region
4374 } ends contained "{}" region
4375 } ends outer "{} region
4376 If you don't want this, the "keepend" argument will make the matching
4377 of an end pattern of the outer region also end any contained item.
4378 This makes it impossible to nest the same region, but allows for
4379 contained items to highlight parts of the end pattern, without causing
4380 that to skip the match with the end pattern. Example: >
4381 :syn match vimComment +"[^"]\+$+
4382 :syn region vimCommand start="set" end="$" contains=vimComment keepend
4383< The "keepend" makes the vimCommand always end at the end of the line,
4384 even though the contained vimComment includes a match with the <EOL>.
4385
4386 When "keepend" is not used, a match with an end pattern is retried
4387 after each contained match. When "keepend" is included, the first
4388 encountered match with an end pattern is used, truncating any
4389 contained matches.
4390 *:syn-extend*
4391 The "keepend" behavior can be changed by using the "extend" argument.
4392 When an item with "extend" is contained in an item that uses
4393 "keepend", the "keepend" is ignored and the containing region will be
4394 extended.
4395 This can be used to have some contained items extend a region while
4396 others don't. Example: >
4397
4398 :syn region htmlRef start=+<a>+ end=+</a>+ keepend contains=htmlItem,htmlScript
4399 :syn match htmlItem +<[^>]*>+ contained
4400 :syn region htmlScript start=+<script+ end=+</script[^>]*>+ contained extend
4401
4402< Here the htmlItem item does not make the htmlRef item continue
4403 further, it is only used to highlight the <> items. The htmlScript
4404 item does extend the htmlRef item.
4405
4406 Another example: >
4407 :syn region xmlFold start="<a>" end="</a>" fold transparent keepend extend
4408< This defines a region with "keepend", so that its end cannot be
4409 changed by contained items, like when the "</a>" is matched to
4410 highlight it differently. But when the xmlFold region is nested (it
4411 includes itself), the "extend" applies, so that the "</a>" of a nested
4412 region only ends that region, and not the one it is contained in.
4413
4414 *:syn-excludenl*
4415 When a pattern for a match or end pattern of a region includes a '$'
4416 to match the end-of-line, it will make a region item that it is
4417 contained in continue on the next line. For example, a match with
4418 "\\$" (backslash at the end of the line) can make a region continue
4419 that would normally stop at the end of the line. This is the default
4420 behavior. If this is not wanted, there are two ways to avoid it:
4421 1. Use "keepend" for the containing item. This will keep all
4422 contained matches from extending the match or region. It can be
4423 used when all contained items must not extend the containing item.
4424 2. Use "excludenl" in the contained item. This will keep that match
4425 from extending the containing match or region. It can be used if
4426 only some contained items must not extend the containing item.
4427 "excludenl" must be given before the pattern it applies to.
4428
4429 *:syn-matchgroup*
4430 "matchgroup" can be used to highlight the start and/or end pattern
4431 differently than the body of the region. Example: >
4432 :syntax region String matchgroup=Quote start=+"+ skip=+\\"+ end=+"+
4433< This will highlight the quotes with the "Quote" group, and the text in
4434 between with the "String" group.
4435 The "matchgroup" is used for all start and end patterns that follow,
4436 until the next "matchgroup". Use "matchgroup=NONE" to go back to not
4437 using a matchgroup.
4438
4439 In a start or end pattern that is highlighted with "matchgroup" the
4440 contained items of the region are not used. This can be used to avoid
4441 that a contained item matches in the start or end pattern match. When
4442 using "transparent", this does not apply to a start or end pattern
4443 match that is highlighted with "matchgroup".
4444
4445 Here is an example, which highlights three levels of parentheses in
4446 different colors: >
4447 :sy region par1 matchgroup=par1 start=/(/ end=/)/ contains=par2
4448 :sy region par2 matchgroup=par2 start=/(/ end=/)/ contains=par3 contained
4449 :sy region par3 matchgroup=par3 start=/(/ end=/)/ contains=par1 contained
4450 :hi par1 ctermfg=red guifg=red
4451 :hi par2 ctermfg=blue guifg=blue
4452 :hi par3 ctermfg=darkgreen guifg=darkgreen
Bram Moolenaaradc21822011-04-01 18:03:16 +02004453<
4454 *E849*
4455The maximum number of syntax groups is 19999.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456
4457==============================================================================
Bram Moolenaar9d87a372018-12-18 21:41:50 +010044587. :syntax arguments *:syn-arguments*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004459
4460The :syntax commands that define syntax items take a number of arguments.
4461The common ones are explained here. The arguments may be given in any order
4462and may be mixed with patterns.
4463
4464Not all commands accept all arguments. This table shows which arguments
4465can not be used for all commands:
Bram Moolenaar09092152010-08-08 16:38:42 +02004466 *E395*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004467 contains oneline fold display extend concealends~
4468:syntax keyword - - - - - -
4469:syntax match yes - yes yes yes -
4470:syntax region yes yes yes yes yes yes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471
4472These arguments can be used for all three commands:
Bram Moolenaar860cae12010-06-05 23:22:07 +02004473 conceal
4474 cchar
Bram Moolenaar071d4272004-06-13 20:20:40 +00004475 contained
4476 containedin
4477 nextgroup
4478 transparent
4479 skipwhite
4480 skipnl
4481 skipempty
4482
Bram Moolenaar860cae12010-06-05 23:22:07 +02004483conceal *conceal* *:syn-conceal*
4484
4485When the "conceal" argument is given, the item is marked as concealable.
Bram Moolenaar370df582010-06-22 05:16:38 +02004486Whether or not it is actually concealed depends on the value of the
Bram Moolenaarf5963f72010-07-23 22:10:27 +02004487'conceallevel' option. The 'concealcursor' option is used to decide whether
4488concealable items in the current line are displayed unconcealed to be able to
4489edit the line.
Christian Brabandtfe1e2b52024-04-26 18:42:59 +02004490
4491Another way to conceal text is with |matchadd()|, but internally this works a
4492bit differently |syntax-vs-match|.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004493
4494concealends *:syn-concealends*
4495
4496When the "concealends" argument is given, the start and end matches of
4497the region, but not the contents of the region, are marked as concealable.
4498Whether or not they are actually concealed depends on the setting on the
4499'conceallevel' option. The ends of a region can only be concealed separately
Christian Brabandtfe1e2b52024-04-26 18:42:59 +02004500in this way when they have their own highlighting via "matchgroup". The
4501|synconcealed()| function can be used to retrieve information about conealed
4502items.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004503
4504cchar *:syn-cchar*
Bram Moolenaard58e9292011-02-09 17:07:58 +01004505 *E844*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004506The "cchar" argument defines the character shown in place of the item
4507when it is concealed (setting "cchar" only makes sense when the conceal
4508argument is given.) If "cchar" is not set then the default conceal
Bram Moolenaard58e9292011-02-09 17:07:58 +01004509character defined in the 'listchars' option is used. The character cannot be
4510a control character such as Tab. Example: >
Bram Moolenaar860cae12010-06-05 23:22:07 +02004511 :syntax match Entity "&amp;" conceal cchar=&
Bram Moolenaar9028b102010-07-11 16:58:51 +02004512See |hl-Conceal| for highlighting.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513
4514contained *:syn-contained*
4515
4516When the "contained" argument is given, this item will not be recognized at
4517the top level, but only when it is mentioned in the "contains" field of
4518another match. Example: >
4519 :syntax keyword Todo TODO contained
4520 :syntax match Comment "//.*" contains=Todo
4521
4522
4523display *:syn-display*
4524
4525If the "display" argument is given, this item will be skipped when the
4526detected highlighting will not be displayed. This will speed up highlighting,
4527by skipping this item when only finding the syntax state for the text that is
4528to be displayed.
4529
4530Generally, you can use "display" for match and region items that meet these
4531conditions:
4532- The item does not continue past the end of a line. Example for C: A region
4533 for a "/*" comment can't contain "display", because it continues on the next
4534 line.
4535- The item does not contain items that continue past the end of the line or
4536 make it continue on the next line.
4537- The item does not change the size of any item it is contained in. Example
4538 for C: A match with "\\$" in a preprocessor match can't have "display",
4539 because it may make that preprocessor match shorter.
4540- The item does not allow other items to match that didn't match otherwise,
4541 and that item may extend the match too far. Example for C: A match for a
4542 "//" comment can't use "display", because a "/*" inside that comment would
4543 match then and start a comment which extends past the end of the line.
4544
4545Examples, for the C language, where "display" can be used:
4546- match with a number
4547- match with a label
4548
4549
4550transparent *:syn-transparent*
4551
4552If the "transparent" argument is given, this item will not be highlighted
4553itself, but will take the highlighting of the item it is contained in. This
4554is useful for syntax items that don't need any highlighting but are used
4555only to skip over a part of the text.
4556
4557The "contains=" argument is also inherited from the item it is contained in,
4558unless a "contains" argument is given for the transparent item itself. To
4559avoid that unwanted items are contained, use "contains=NONE". Example, which
4560highlights words in strings, but makes an exception for "vim": >
4561 :syn match myString /'[^']*'/ contains=myWord,myVim
4562 :syn match myWord /\<[a-z]*\>/ contained
4563 :syn match myVim /\<vim\>/ transparent contained contains=NONE
4564 :hi link myString String
4565 :hi link myWord Comment
4566Since the "myVim" match comes after "myWord" it is the preferred match (last
4567match in the same position overrules an earlier one). The "transparent"
4568argument makes the "myVim" match use the same highlighting as "myString". But
4569it does not contain anything. If the "contains=NONE" argument would be left
4570out, then "myVim" would use the contains argument from myString and allow
Bram Moolenaar2346a632021-06-13 19:02:49 +02004571"myWord" to be contained, which will be highlighted as a Comment. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572happens because a contained match doesn't match inside itself in the same
4573position, thus the "myVim" match doesn't overrule the "myWord" match here.
4574
4575When you look at the colored text, it is like looking at layers of contained
4576items. The contained item is on top of the item it is contained in, thus you
4577see the contained item. When a contained item is transparent, you can look
4578through, thus you see the item it is contained in. In a picture:
4579
4580 look from here
4581
4582 | | | | | |
4583 V V V V V V
4584
4585 xxxx yyy more contained items
4586 .................... contained item (transparent)
4587 ============================= first item
4588
4589The 'x', 'y' and '=' represent a highlighted syntax item. The '.' represent a
4590transparent group.
4591
4592What you see is:
4593
4594 =======xxxx=======yyy========
4595
4596Thus you look through the transparent "....".
4597
4598
4599oneline *:syn-oneline*
4600
4601The "oneline" argument indicates that the region does not cross a line
4602boundary. It must match completely in the current line. However, when the
4603region has a contained item that does cross a line boundary, it continues on
4604the next line anyway. A contained item can be used to recognize a line
4605continuation pattern. But the "end" pattern must still match in the first
4606line, otherwise the region doesn't even start.
4607
4608When the start pattern includes a "\n" to match an end-of-line, the end
4609pattern must be found in the same line as where the start pattern ends. The
4610end pattern may also include an end-of-line. Thus the "oneline" argument
4611means that the end of the start pattern and the start of the end pattern must
4612be within one line. This can't be changed by a skip pattern that matches a
4613line break.
4614
4615
4616fold *:syn-fold*
4617
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004618The "fold" argument makes the fold level increase by one for this item.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619Example: >
4620 :syn region myFold start="{" end="}" transparent fold
4621 :syn sync fromstart
4622 :set foldmethod=syntax
4623This will make each {} block form one fold.
4624
4625The fold will start on the line where the item starts, and end where the item
4626ends. If the start and end are within the same line, there is no fold.
4627The 'foldnestmax' option limits the nesting of syntax folds.
Bram Moolenaare35a52a2020-05-31 19:48:53 +02004628See |:syn-foldlevel| to control how the foldlevel of a line is computed
4629from its syntax items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630{not available when Vim was compiled without |+folding| feature}
4631
4632
4633 *:syn-contains* *E405* *E406* *E407* *E408* *E409*
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004634contains={group-name},..
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635
4636The "contains" argument is followed by a list of syntax group names. These
4637groups will be allowed to begin inside the item (they may extend past the
4638containing group's end). This allows for recursive nesting of matches and
4639regions. If there is no "contains" argument, no groups will be contained in
4640this item. The group names do not need to be defined before they can be used
4641here.
4642
4643contains=ALL
4644 If the only item in the contains list is "ALL", then all
4645 groups will be accepted inside the item.
4646
4647contains=ALLBUT,{group-name},..
4648 If the first item in the contains list is "ALLBUT", then all
4649 groups will be accepted inside the item, except the ones that
4650 are listed. Example: >
4651 :syntax region Block start="{" end="}" ... contains=ALLBUT,Function
4652
4653contains=TOP
4654 If the first item in the contains list is "TOP", then all
4655 groups will be accepted that don't have the "contained"
4656 argument.
4657contains=TOP,{group-name},..
4658 Like "TOP", but excluding the groups that are listed.
4659
4660contains=CONTAINED
4661 If the first item in the contains list is "CONTAINED", then
4662 all groups will be accepted that have the "contained"
4663 argument.
4664contains=CONTAINED,{group-name},..
4665 Like "CONTAINED", but excluding the groups that are
4666 listed.
4667
4668
4669The {group-name} in the "contains" list can be a pattern. All group names
4670that match the pattern will be included (or excluded, if "ALLBUT" is used).
4671The pattern cannot contain white space or a ','. Example: >
4672 ... contains=Comment.*,Keyw[0-3]
4673The matching will be done at moment the syntax command is executed. Groups
4674that are defined later will not be matched. Also, if the current syntax
4675command defines a new group, it is not matched. Be careful: When putting
4676syntax commands in a file you can't rely on groups NOT being defined, because
4677the file may have been sourced before, and ":syn clear" doesn't remove the
4678group names.
4679
4680The contained groups will also match in the start and end patterns of a
4681region. If this is not wanted, the "matchgroup" argument can be used
4682|:syn-matchgroup|. The "ms=" and "me=" offsets can be used to change the
4683region where contained items do match. Note that this may also limit the
4684area that is highlighted
4685
4686
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004687containedin={group-name}... *:syn-containedin*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688
4689The "containedin" argument is followed by a list of syntax group names. The
4690item will be allowed to begin inside these groups. This works as if the
4691containing item has a "contains=" argument that includes this item.
4692
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004693The {group-name}... can be used just like for "contains", as explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004694
4695This is useful when adding a syntax item afterwards. An item can be told to
4696be included inside an already existing item, without changing the definition
4697of that item. For example, to highlight a word in a C comment after loading
4698the C syntax: >
4699 :syn keyword myword HELP containedin=cComment contained
4700Note that "contained" is also used, to avoid that the item matches at the top
4701level.
4702
4703Matches for "containedin" are added to the other places where the item can
4704appear. A "contains" argument may also be added as usual. Don't forget that
4705keywords never contain another item, thus adding them to "containedin" won't
4706work.
4707
4708
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004709nextgroup={group-name},.. *:syn-nextgroup*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004710
4711The "nextgroup" argument is followed by a list of syntax group names,
4712separated by commas (just like with "contains", so you can also use patterns).
4713
4714If the "nextgroup" argument is given, the mentioned syntax groups will be
4715tried for a match, after the match or region ends. If none of the groups have
4716a match, highlighting continues normally. If there is a match, this group
4717will be used, even when it is not mentioned in the "contains" field of the
4718current group. This is like giving the mentioned group priority over all
4719other groups. Example: >
4720 :syntax match ccFoobar "Foo.\{-}Bar" contains=ccFoo
4721 :syntax match ccFoo "Foo" contained nextgroup=ccFiller
4722 :syntax region ccFiller start="." matchgroup=ccBar end="Bar" contained
4723
4724This will highlight "Foo" and "Bar" differently, and only when there is a
4725"Bar" after "Foo". In the text line below, "f" shows where ccFoo is used for
4726highlighting, and "bbb" where ccBar is used. >
4727
4728 Foo asdfasd Bar asdf Foo asdf Bar asdf
4729 fff bbb fff bbb
4730
4731Note the use of ".\{-}" to skip as little as possible until the next Bar.
4732when ".*" would be used, the "asdf" in between "Bar" and "Foo" would be
4733highlighted according to the "ccFoobar" group, because the ccFooBar match
4734would include the first "Foo" and the last "Bar" in the line (see |pattern|).
4735
4736
4737skipwhite *:syn-skipwhite*
4738skipnl *:syn-skipnl*
4739skipempty *:syn-skipempty*
4740
4741These arguments are only used in combination with "nextgroup". They can be
4742used to allow the next group to match after skipping some text:
Bram Moolenaardd2a0d82007-05-12 15:07:00 +00004743 skipwhite skip over space and tab characters
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744 skipnl skip over the end of a line
4745 skipempty skip over empty lines (implies a "skipnl")
4746
4747When "skipwhite" is present, the white space is only skipped if there is no
4748next group that matches the white space.
4749
4750When "skipnl" is present, the match with nextgroup may be found in the next
4751line. This only happens when the current item ends at the end of the current
4752line! When "skipnl" is not present, the nextgroup will only be found after
4753the current item in the same line.
4754
4755When skipping text while looking for a next group, the matches for other
4756groups are ignored. Only when no next group matches, other items are tried
4757for a match again. This means that matching a next group and skipping white
4758space and <EOL>s has a higher priority than other items.
4759
4760Example: >
4761 :syn match ifstart "\<if.*" nextgroup=ifline skipwhite skipempty
4762 :syn match ifline "[^ \t].*" nextgroup=ifline skipwhite skipempty contained
4763 :syn match ifline "endif" contained
4764Note that the "[^ \t].*" match matches all non-white text. Thus it would also
4765match "endif". Therefore the "endif" match is put last, so that it takes
4766precedence.
4767Note that this example doesn't work for nested "if"s. You need to add
4768"contains" arguments to make that work (omitted for simplicity of the
4769example).
4770
Bram Moolenaar860cae12010-06-05 23:22:07 +02004771IMPLICIT CONCEAL *:syn-conceal-implicit*
4772
4773:sy[ntax] conceal [on|off]
4774 This defines if the following ":syntax" commands will define keywords,
4775 matches or regions with the "conceal" flag set. After ":syn conceal
4776 on", all subsequent ":syn keyword", ":syn match" or ":syn region"
4777 defined will have the "conceal" flag set implicitly. ":syn conceal
4778 off" returns to the normal state where the "conceal" flag must be
4779 given explicitly.
4780
Bram Moolenaar690afe12017-01-28 18:34:47 +01004781:sy[ntax] conceal
Bram Moolenaar9da17d72022-02-09 21:50:44 +00004782 Show either "syntax conceal on" or "syntax conceal off".
Bram Moolenaar690afe12017-01-28 18:34:47 +01004783
Bram Moolenaar071d4272004-06-13 20:20:40 +00004784==============================================================================
Bram Moolenaar9d87a372018-12-18 21:41:50 +010047858. Syntax patterns *:syn-pattern* *E401* *E402*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004786
4787In the syntax commands, a pattern must be surrounded by two identical
4788characters. This is like it works for the ":s" command. The most common to
4789use is the double quote. But if the pattern contains a double quote, you can
4790use another character that is not used in the pattern. Examples: >
4791 :syntax region Comment start="/\*" end="\*/"
4792 :syntax region String start=+"+ end=+"+ skip=+\\"+
4793
4794See |pattern| for the explanation of what a pattern is. Syntax patterns are
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004795always interpreted like the 'magic' option is set, no matter what the actual
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796value of 'magic' is. And the patterns are interpreted like the 'l' flag is
4797not included in 'cpoptions'. This was done to make syntax files portable and
4798independent of 'compatible' and 'magic' settings.
4799
4800Try to avoid patterns that can match an empty string, such as "[a-z]*".
4801This slows down the highlighting a lot, because it matches everywhere.
4802
4803 *:syn-pattern-offset*
4804The pattern can be followed by a character offset. This can be used to
4805change the highlighted part, and to change the text area included in the
4806match or region (which only matters when trying to match other items). Both
4807are relative to the matched pattern. The character offset for a skip
4808pattern can be used to tell where to continue looking for an end pattern.
4809
4810The offset takes the form of "{what}={offset}"
4811The {what} can be one of seven strings:
4812
4813ms Match Start offset for the start of the matched text
4814me Match End offset for the end of the matched text
4815hs Highlight Start offset for where the highlighting starts
4816he Highlight End offset for where the highlighting ends
4817rs Region Start offset for where the body of a region starts
4818re Region End offset for where the body of a region ends
4819lc Leading Context offset past "leading context" of pattern
4820
4821The {offset} can be:
4822
4823s start of the matched pattern
4824s+{nr} start of the matched pattern plus {nr} chars to the right
4825s-{nr} start of the matched pattern plus {nr} chars to the left
4826e end of the matched pattern
4827e+{nr} end of the matched pattern plus {nr} chars to the right
4828e-{nr} end of the matched pattern plus {nr} chars to the left
Bram Moolenaarac7bd632013-03-19 11:35:58 +01004829{nr} (for "lc" only): start matching {nr} chars right of the start
Bram Moolenaar071d4272004-06-13 20:20:40 +00004830
4831Examples: "ms=s+1", "hs=e-2", "lc=3".
4832
4833Although all offsets are accepted after any pattern, they are not always
4834meaningful. This table shows which offsets are actually used:
4835
4836 ms me hs he rs re lc ~
4837match item yes yes yes yes - - yes
4838region item start yes - yes - yes - yes
4839region item skip - yes - - - - yes
4840region item end - yes - yes - yes yes
4841
4842Offsets can be concatenated, with a ',' in between. Example: >
4843 :syn match String /"[^"]*"/hs=s+1,he=e-1
4844<
4845 some "string" text
4846 ^^^^^^ highlighted
4847
4848Notes:
4849- There must be no white space between the pattern and the character
4850 offset(s).
4851- The highlighted area will never be outside of the matched text.
4852- A negative offset for an end pattern may not always work, because the end
4853 pattern may be detected when the highlighting should already have stopped.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004854- Before Vim 7.2 the offsets were counted in bytes instead of characters.
Bram Moolenaar207f0092020-08-30 17:20:20 +02004855 This didn't work well for multibyte characters, so it was changed with the
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004856 Vim 7.2 release.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004857- The start of a match cannot be in a line other than where the pattern
4858 matched. This doesn't work: "a\nb"ms=e. You can make the highlighting
4859 start in another line, this does work: "a\nb"hs=e.
4860
4861Example (match a comment but don't highlight the /* and */): >
4862 :syntax region Comment start="/\*"hs=e+1 end="\*/"he=s-1
4863<
4864 /* this is a comment */
4865 ^^^^^^^^^^^^^^^^^^^ highlighted
4866
4867A more complicated Example: >
4868 :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
4869<
4870 abcfoostringbarabc
4871 mmmmmmmmmmm match
Bram Moolenaar4770d092006-01-12 23:22:24 +00004872 sssrrreee highlight start/region/end ("Foo", "Exa" and "Bar")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004873
4874Leading context *:syn-lc* *:syn-leading* *:syn-context*
4875
4876Note: This is an obsolete feature, only included for backwards compatibility
4877with previous Vim versions. It's now recommended to use the |/\@<=| construct
Bram Moolenaar1588bc82022-03-08 21:35:07 +00004878in the pattern. You can also often use |/\zs|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004879
4880The "lc" offset specifies leading context -- a part of the pattern that must
4881be present, but is not considered part of the match. An offset of "lc=n" will
4882cause Vim to step back n columns before attempting the pattern match, allowing
4883characters which have already been matched in previous patterns to also be
4884used as leading context for this match. This can be used, for instance, to
4885specify that an "escaping" character must not precede the match: >
4886
4887 :syn match ZNoBackslash "[^\\]z"ms=s+1
4888 :syn match WNoBackslash "[^\\]w"lc=1
4889 :syn match Underline "_\+"
4890<
4891 ___zzzz ___wwww
4892 ^^^ ^^^ matches Underline
4893 ^ ^ matches ZNoBackslash
4894 ^^^^ matches WNoBackslash
4895
4896The "ms" offset is automatically set to the same value as the "lc" offset,
4897unless you set "ms" explicitly.
4898
4899
4900Multi-line patterns *:syn-multi-line*
4901
4902The patterns can include "\n" to match an end-of-line. Mostly this works as
4903expected, but there are a few exceptions.
4904
4905When using a start pattern with an offset, the start of the match is not
4906allowed to start in a following line. The highlighting can start in a
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004907following line though. Using the "\zs" item also requires that the start of
4908the match doesn't move to another line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004909
4910The skip pattern can include the "\n", but the search for an end pattern will
4911continue in the first character of the next line, also when that character is
4912matched by the skip pattern. This is because redrawing may start in any line
4913halfway a region and there is no check if the skip pattern started in a
4914previous line. For example, if the skip pattern is "a\nb" and an end pattern
4915is "b", the end pattern does match in the second line of this: >
4916 x x a
4917 b x x
4918Generally this means that the skip pattern should not match any characters
4919after the "\n".
4920
4921
4922External matches *:syn-ext-match*
4923
4924These extra regular expression items are available in region patterns:
4925
Bram Moolenaar203d04d2013-06-06 21:36:40 +02004926 */\z(* */\z(\)* *E50* *E52* *E879*
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004927 \z(\) Marks the sub-expression as "external", meaning that it can be
4928 accessed from another pattern match. Currently only usable in
4929 defining a syntax region start pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004930
4931 */\z1* */\z2* */\z3* */\z4* */\z5*
4932 \z1 ... \z9 */\z6* */\z7* */\z8* */\z9* *E66* *E67*
4933 Matches the same string that was matched by the corresponding
4934 sub-expression in a previous start pattern match.
4935
4936Sometimes the start and end patterns of a region need to share a common
4937sub-expression. A common example is the "here" document in Perl and many Unix
4938shells. This effect can be achieved with the "\z" special regular expression
4939items, which marks a sub-expression as "external", in the sense that it can be
4940referenced from outside the pattern in which it is defined. The here-document
4941example, for instance, can be done like this: >
4942 :syn region hereDoc start="<<\z(\I\i*\)" end="^\z1$"
4943
4944As can be seen here, the \z actually does double duty. In the start pattern,
4945it marks the "\(\I\i*\)" sub-expression as external; in the end pattern, it
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01004946changes the \z1 back-reference into an external reference referring to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947first external sub-expression in the start pattern. External references can
4948also be used in skip patterns: >
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00004949 :syn region foo start="start \z(\I\i*\)" skip="not end \z1" end="end \z1"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950
4951Note that normal and external sub-expressions are completely orthogonal and
4952indexed separately; for instance, if the pattern "\z(..\)\(..\)" is applied
4953to the string "aabb", then \1 will refer to "bb" and \z1 will refer to "aa".
4954Note also that external sub-expressions cannot be accessed as back-references
4955within the same pattern like normal sub-expressions. If you want to use one
4956sub-expression as both a normal and an external sub-expression, you can nest
4957the two, as in "\(\z(...\)\)".
4958
4959Note that only matches within a single line can be used. Multi-line matches
4960cannot be referred to.
4961
4962==============================================================================
Bram Moolenaar9d87a372018-12-18 21:41:50 +010049639. Syntax clusters *:syn-cluster* *E400*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964
4965:sy[ntax] cluster {cluster-name} [contains={group-name}..]
4966 [add={group-name}..]
4967 [remove={group-name}..]
4968
4969This command allows you to cluster a list of syntax groups together under a
4970single name.
4971
4972 contains={group-name}..
4973 The cluster is set to the specified list of groups.
4974 add={group-name}..
4975 The specified groups are added to the cluster.
4976 remove={group-name}..
4977 The specified groups are removed from the cluster.
4978
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004979A cluster so defined may be referred to in a contains=.., containedin=..,
4980nextgroup=.., add=.. or remove=.. list with a "@" prefix. You can also use
4981this notation to implicitly declare a cluster before specifying its contents.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004982
4983Example: >
4984 :syntax match Thing "# [^#]\+ #" contains=@ThingMembers
4985 :syntax cluster ThingMembers contains=ThingMember1,ThingMember2
4986
4987As the previous example suggests, modifications to a cluster are effectively
4988retroactive; the membership of the cluster is checked at the last minute, so
4989to speak: >
4990 :syntax keyword A aaa
4991 :syntax keyword B bbb
4992 :syntax cluster AandB contains=A
4993 :syntax match Stuff "( aaa bbb )" contains=@AandB
4994 :syntax cluster AandB add=B " now both keywords are matched in Stuff
4995
4996This also has implications for nested clusters: >
4997 :syntax keyword A aaa
4998 :syntax keyword B bbb
4999 :syntax cluster SmallGroup contains=B
5000 :syntax cluster BigGroup contains=A,@SmallGroup
5001 :syntax match Stuff "( aaa bbb )" contains=@BigGroup
5002 :syntax cluster BigGroup remove=B " no effect, since B isn't in BigGroup
5003 :syntax cluster SmallGroup remove=B " now bbb isn't matched within Stuff
Bram Moolenaaradc21822011-04-01 18:03:16 +02005004<
5005 *E848*
5006The maximum number of clusters is 9767.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005007
5008==============================================================================
Bram Moolenaar9d87a372018-12-18 21:41:50 +0100500910. Including syntax files *:syn-include* *E397*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005010
5011It is often useful for one language's syntax file to include a syntax file for
5012a related language. Depending on the exact relationship, this can be done in
5013two different ways:
5014
5015 - If top-level syntax items in the included syntax file are to be
5016 allowed at the top level in the including syntax, you can simply use
5017 the |:runtime| command: >
5018
5019 " In cpp.vim:
5020 :runtime! syntax/c.vim
5021 :unlet b:current_syntax
5022
5023< - If top-level syntax items in the included syntax file are to be
5024 contained within a region in the including syntax, you can use the
5025 ":syntax include" command:
5026
5027:sy[ntax] include [@{grouplist-name}] {file-name}
5028
5029 All syntax items declared in the included file will have the
5030 "contained" flag added. In addition, if a group list is specified,
5031 all top-level syntax items in the included file will be added to
5032 that list. >
5033
5034 " In perl.vim:
5035 :syntax include @Pod <sfile>:p:h/pod.vim
5036 :syntax region perlPOD start="^=head" end="^=cut" contains=@Pod
5037<
5038 When {file-name} is an absolute path (starts with "/", "c:", "$VAR"
5039 or "<sfile>") that file is sourced. When it is a relative path
5040 (e.g., "syntax/pod.vim") the file is searched for in 'runtimepath'.
5041 All matching files are loaded. Using a relative path is
5042 recommended, because it allows a user to replace the included file
Bram Moolenaareab6dff2020-03-01 19:06:45 +01005043 with their own version, without replacing the file that does the
5044 ":syn include".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005045
Bram Moolenaaradc21822011-04-01 18:03:16 +02005046 *E847*
5047The maximum number of includes is 999.
5048
Bram Moolenaar071d4272004-06-13 20:20:40 +00005049==============================================================================
Bram Moolenaar9d87a372018-12-18 21:41:50 +0100505011. Synchronizing *:syn-sync* *E403* *E404*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051
5052Vim wants to be able to start redrawing in any position in the document. To
5053make this possible it needs to know the syntax state at the position where
5054redrawing starts.
5055
5056:sy[ntax] sync [ccomment [group-name] | minlines={N} | ...]
5057
5058There are four ways to synchronize:
50591. Always parse from the start of the file.
5060 |:syn-sync-first|
50612. Based on C-style comments. Vim understands how C-comments work and can
5062 figure out if the current line starts inside or outside a comment.
5063 |:syn-sync-second|
50643. Jumping back a certain number of lines and start parsing there.
5065 |:syn-sync-third|
50664. Searching backwards in the text for a pattern to sync on.
5067 |:syn-sync-fourth|
5068
5069 *:syn-sync-maxlines* *:syn-sync-minlines*
5070For the last three methods, the line range where the parsing can start is
5071limited by "minlines" and "maxlines".
5072
5073If the "minlines={N}" argument is given, the parsing always starts at least
5074that many lines backwards. This can be used if the parsing may take a few
5075lines before it's correct, or when it's not possible to use syncing.
5076
5077If the "maxlines={N}" argument is given, the number of lines that are searched
5078for a comment or syncing pattern is restricted to N lines backwards (after
5079adding "minlines"). This is useful if you have few things to sync on and a
5080slow machine. Example: >
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01005081 :syntax sync maxlines=500 ccomment
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082<
5083 *:syn-sync-linebreaks*
5084When using a pattern that matches multiple lines, a change in one line may
5085cause a pattern to no longer match in a previous line. This means has to
5086start above where the change was made. How many lines can be specified with
5087the "linebreaks" argument. For example, when a pattern may include one line
5088break use this: >
5089 :syntax sync linebreaks=1
5090The result is that redrawing always starts at least one line before where a
5091change was made. The default value for "linebreaks" is zero. Usually the
5092value for "minlines" is bigger than "linebreaks".
5093
5094
5095First syncing method: *:syn-sync-first*
5096>
5097 :syntax sync fromstart
5098
5099The file will be parsed from the start. This makes syntax highlighting
5100accurate, but can be slow for long files. Vim caches previously parsed text,
5101so that it's only slow when parsing the text for the first time. However,
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005102when making changes some part of the text needs to be parsed again (worst
Bram Moolenaar071d4272004-06-13 20:20:40 +00005103case: to the end of the file).
5104
5105Using "fromstart" is equivalent to using "minlines" with a very large number.
5106
5107
5108Second syncing method: *:syn-sync-second* *:syn-sync-ccomment*
5109
5110For the second method, only the "ccomment" argument needs to be given.
5111Example: >
5112 :syntax sync ccomment
5113
5114When Vim finds that the line where displaying starts is inside a C-style
5115comment, the last region syntax item with the group-name "Comment" will be
5116used. This requires that there is a region with the group-name "Comment"!
5117An alternate group name can be specified, for example: >
5118 :syntax sync ccomment javaComment
5119This means that the last item specified with "syn region javaComment" will be
5120used for the detected C comment region. This only works properly if that
5121region does have a start pattern "\/*" and an end pattern "*\/".
5122
5123The "maxlines" argument can be used to restrict the search to a number of
5124lines. The "minlines" argument can be used to at least start a number of
5125lines back (e.g., for when there is some construct that only takes a few
5126lines, but it hard to sync on).
5127
5128Note: Syncing on a C comment doesn't work properly when strings are used
5129that cross a line and contain a "*/". Since letting strings cross a line
5130is a bad programming habit (many compilers give a warning message), and the
5131chance of a "*/" appearing inside a comment is very small, this restriction
5132is hardly ever noticed.
5133
5134
5135Third syncing method: *:syn-sync-third*
5136
5137For the third method, only the "minlines={N}" argument needs to be given.
5138Vim will subtract {N} from the line number and start parsing there. This
5139means {N} extra lines need to be parsed, which makes this method a bit slower.
5140Example: >
5141 :syntax sync minlines=50
5142
5143"lines" is equivalent to "minlines" (used by older versions).
5144
5145
5146Fourth syncing method: *:syn-sync-fourth*
5147
5148The idea is to synchronize on the end of a few specific regions, called a
5149sync pattern. Only regions can cross lines, so when we find the end of some
5150region, we might be able to know in which syntax item we are. The search
5151starts in the line just above the one where redrawing starts. From there
5152the search continues backwards in the file.
5153
5154This works just like the non-syncing syntax items. You can use contained
5155matches, nextgroup, etc. But there are a few differences:
5156- Keywords cannot be used.
5157- The syntax items with the "sync" keyword form a completely separated group
5158 of syntax items. You can't mix syncing groups and non-syncing groups.
5159- The matching works backwards in the buffer (line by line), instead of
5160 forwards.
5161- A line continuation pattern can be given. It is used to decide which group
5162 of lines need to be searched like they were one line. This means that the
5163 search for a match with the specified items starts in the first of the
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +01005164 consecutive lines that contain the continuation pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005165- When using "nextgroup" or "contains", this only works within one line (or
5166 group of continued lines).
5167- When using a region, it must start and end in the same line (or group of
5168 continued lines). Otherwise the end is assumed to be at the end of the
5169 line (or group of continued lines).
5170- When a match with a sync pattern is found, the rest of the line (or group of
5171 continued lines) is searched for another match. The last match is used.
Jon Parise947f7522024-08-03 17:40:58 +02005172 This is used when a line can contain both the start and the end of a region
Bram Moolenaar071d4272004-06-13 20:20:40 +00005173 (e.g., in a C-comment like /* this */, the last "*/" is used).
5174
5175There are two ways how a match with a sync pattern can be used:
51761. Parsing for highlighting starts where redrawing starts (and where the
5177 search for the sync pattern started). The syntax group that is expected
5178 to be valid there must be specified. This works well when the regions
5179 that cross lines cannot contain other regions.
51802. Parsing for highlighting continues just after the match. The syntax group
5181 that is expected to be present just after the match must be specified.
5182 This can be used when the previous method doesn't work well. It's much
5183 slower, because more text needs to be parsed.
5184Both types of sync patterns can be used at the same time.
5185
5186Besides the sync patterns, other matches and regions can be specified, to
5187avoid finding unwanted matches.
5188
5189[The reason that the sync patterns are given separately, is that mostly the
5190search for the sync point can be much simpler than figuring out the
5191highlighting. The reduced number of patterns means it will go (much)
5192faster.]
5193
5194 *syn-sync-grouphere* *E393* *E394*
5195 :syntax sync match {sync-group-name} grouphere {group-name} "pattern" ..
5196
5197 Define a match that is used for syncing. {group-name} is the
5198 name of a syntax group that follows just after the match. Parsing
5199 of the text for highlighting starts just after the match. A region
5200 must exist for this {group-name}. The first one defined will be used.
5201 "NONE" can be used for when there is no syntax group after the match.
5202
5203 *syn-sync-groupthere*
5204 :syntax sync match {sync-group-name} groupthere {group-name} "pattern" ..
5205
5206 Like "grouphere", but {group-name} is the name of a syntax group that
5207 is to be used at the start of the line where searching for the sync
5208 point started. The text between the match and the start of the sync
5209 pattern searching is assumed not to change the syntax highlighting.
5210 For example, in C you could search backwards for "/*" and "*/". If
5211 "/*" is found first, you know that you are inside a comment, so the
5212 "groupthere" is "cComment". If "*/" is found first, you know that you
5213 are not in a comment, so the "groupthere" is "NONE". (in practice
5214 it's a bit more complicated, because the "/*" and "*/" could appear
5215 inside a string. That's left as an exercise to the reader...).
5216
5217 :syntax sync match ..
5218 :syntax sync region ..
5219
5220 Without a "groupthere" argument. Define a region or match that is
5221 skipped while searching for a sync point.
5222
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005223 *syn-sync-linecont*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224 :syntax sync linecont {pattern}
5225
5226 When {pattern} matches in a line, it is considered to continue in
5227 the next line. This means that the search for a sync point will
5228 consider the lines to be concatenated.
5229
5230If the "maxlines={N}" argument is given too, the number of lines that are
5231searched for a match is restricted to N. This is useful if you have very
5232few things to sync on and a slow machine. Example: >
5233 :syntax sync maxlines=100
5234
5235You can clear all sync settings with: >
5236 :syntax sync clear
5237
5238You can clear specific sync patterns with: >
5239 :syntax sync clear {sync-group-name} ..
5240
5241==============================================================================
Bram Moolenaar9d87a372018-12-18 21:41:50 +0100524212. Listing syntax items *:syntax* *:sy* *:syn* *:syn-list*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005243
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005244This command lists all the syntax items: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245
5246 :sy[ntax] [list]
5247
5248To show the syntax items for one syntax group: >
5249
5250 :sy[ntax] list {group-name}
5251
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +02005252To list the syntax groups in one cluster: *E392* >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005253
5254 :sy[ntax] list @{cluster-name}
5255
5256See above for other arguments for the ":syntax" command.
5257
5258Note that the ":syntax" command can be abbreviated to ":sy", although ":syn"
5259is mostly used, because it looks better.
5260
5261==============================================================================
Bram Moolenaar2d8ed022022-05-21 13:08:16 +0100526213. Colorschemes *color-schemes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005263
Bram Moolenaarb7398fe2023-05-14 18:50:25 +01005264In the next section you can find information about individual highlight groups
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01005265and how to specify colors for them. Most likely you want to just select a set
5266of colors by using the `:colorscheme` command, for example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00005267
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01005268 colorscheme pablo
5269<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005270 *:colo* *:colorscheme* *E185*
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005271:colo[rscheme] Output the name of the currently active color scheme.
5272 This is basically the same as >
5273 :echo g:colors_name
5274< In case g:colors_name has not been defined :colo will
5275 output "default". When compiled without the |+eval|
5276 feature it will output "unknown".
5277
Bram Moolenaar071d4272004-06-13 20:20:40 +00005278:colo[rscheme] {name} Load color scheme {name}. This searches 'runtimepath'
Bram Moolenaarbc488a72013-07-05 21:01:22 +02005279 for the file "colors/{name}.vim". The first one that
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 is found is loaded.
Bram Moolenaare18c0b32016-03-20 21:08:34 +01005281 Also searches all plugins in 'packpath', first below
5282 "start" and then under "opt".
5283
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005284 Doesn't work recursively, thus you can't use
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 ":colorscheme" in a color scheme script.
Bram Moolenaarb4ada792016-10-30 21:55:26 +01005286
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01005287You have two options for customizing a color scheme. For changing the
5288appearance of specific colors, you can redefine a color name before loading
5289the scheme. The desert scheme uses the khaki color for the cursor. To use a
5290darker variation of the same color: >
Bram Moolenaar113cb512021-11-07 20:27:04 +00005291
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01005292 let v:colornames['khaki'] = '#bdb76b'
5293 colorscheme desert
Bram Moolenaar113cb512021-11-07 20:27:04 +00005294<
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01005295For further customization, such as changing |:highlight-link| associations,
5296use another name, e.g. "~/.vim/colors/mine.vim", and use `:runtime` to load
5297the original color scheme: >
5298 runtime colors/evening.vim
5299 hi Statement ctermfg=Blue guifg=Blue
Bram Moolenaarb4ada792016-10-30 21:55:26 +01005300
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01005301Before the color scheme will be loaded all default color list scripts
5302(`colors/lists/default.vim`) will be executed and then the |ColorSchemePre|
5303autocommand event is triggered. After the color scheme has been loaded the
5304|ColorScheme| autocommand event is triggered.
5305
Bram Moolenaare8008642022-08-19 17:15:35 +01005306 *colorscheme-override*
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01005307If a color scheme is almost right, you can add modifications on top of it by
5308using the |ColorScheme| autocommand. For example, to remove the background
5309color (can make it transparent in some terminals): >
5310 augroup my_colorschemes
5311 au!
5312 au Colorscheme pablo hi Normal ctermbg=NONE
5313 augroup END
5314
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01005315Change a couple more colors: >
5316 augroup my_colorschemes
5317 au!
5318 au Colorscheme pablo hi Normal ctermbg=NONE
Bram Moolenaar76db9e02022-11-09 21:21:04 +00005319 \ | highlight Special ctermfg=63
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01005320 \ | highlight Identifier ctermfg=44
5321 augroup END
5322
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01005323If you make a lot of changes it might be better to copy the distributed
5324colorscheme to your home directory and change it: >
5325 :!cp $VIMRUNTIME/colors/pablo.vim ~/.vim/colors
5326 :edit ~/.vim/colors/pablo.vim
5327
5328With Vim 9.0 the collection of color schemes was updated and made work in many
5329different terminals. One change was to often define the Normal highlight
5330group to make sure the colors work well. In case you prefer the old version,
5331you can find them here:
5332https://github.com/vim/colorschemes/blob/master/legacy_colors/
5333
5334For info about writing a color scheme file: >
5335 :edit $VIMRUNTIME/colors/README.txt
5336
5337
5338==============================================================================
533914. Highlight command *:highlight* *:hi* *E28* *E411* *E415*
5340
5341There are three types of highlight groups:
5342- The ones used for specific languages. For these the name starts with the
5343 name of the language. Many of these don't have any attributes, but are
5344 linked to a group of the second type.
5345- The ones used for all syntax languages.
5346- The ones used for the 'highlight' option.
5347 *hitest.vim*
5348You can see all the groups currently active with this command: >
5349 :so $VIMRUNTIME/syntax/hitest.vim
5350This will open a new window containing all highlight group names, displayed
5351in their own color.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005352
5353:hi[ghlight] List all the current highlight groups that have
5354 attributes set.
5355
5356:hi[ghlight] {group-name}
5357 List one highlight group.
5358
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005359 *highlight-clear* *:hi-clear*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005360:hi[ghlight] clear Reset all highlighting to the defaults. Removes all
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005361 highlighting for groups added by the user.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362 Uses the current value of 'background' to decide which
5363 default colors to use.
Bram Moolenaar213da552020-09-17 19:59:26 +02005364 If there was a default link, restore it. |:hi-link|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005365
5366:hi[ghlight] clear {group-name}
5367:hi[ghlight] {group-name} NONE
5368 Disable the highlighting for one highlight group. It
5369 is _not_ set back to the default colors.
5370
5371:hi[ghlight] [default] {group-name} {key}={arg} ..
5372 Add a highlight group, or change the highlighting for
Bram Moolenaar113cb512021-11-07 20:27:04 +00005373 an existing group. If a given color name is not
Bram Moolenaar519cc552021-11-16 19:18:26 +00005374 recognized, each `colors/lists/default.vim` found on
Bram Moolenaar113cb512021-11-07 20:27:04 +00005375 |'runtimepath'| will be loaded.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376 See |highlight-args| for the {key}={arg} arguments.
5377 See |:highlight-default| for the optional [default]
5378 argument.
5379
5380Normally a highlight group is added once when starting up. This sets the
5381default values for the highlighting. After that, you can use additional
5382highlight commands to change the arguments that you want to set to non-default
5383values. The value "NONE" can be used to switch the value off or go back to
5384the default value.
5385
5386A simple way to change colors is with the |:colorscheme| command. This loads
5387a file with ":highlight" commands such as this: >
5388
5389 :hi Comment gui=bold
5390
5391Note that all settings that are not included remain the same, only the
5392specified field is used, and settings are merged with previous ones. So, the
5393result is like this single command has been used: >
5394 :hi Comment term=bold ctermfg=Cyan guifg=#80a0ff gui=bold
5395<
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005396 *:highlight-verbose*
Bram Moolenaar661b1822005-07-28 22:36:45 +00005397When listing a highlight group and 'verbose' is non-zero, the listing will
5398also tell where it was last set. Example: >
5399 :verbose hi Comment
5400< Comment xxx term=bold ctermfg=4 guifg=Blue ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005401 Last set from /home/mool/vim/vim7/runtime/syntax/syncolor.vim ~
Bram Moolenaar661b1822005-07-28 22:36:45 +00005402
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005403When ":hi clear" is used then the script where this command is used will be
5404mentioned for the default values. See |:verbose-cmd| for more information.
Bram Moolenaar661b1822005-07-28 22:36:45 +00005405
Bram Moolenaar071d4272004-06-13 20:20:40 +00005406 *highlight-args* *E416* *E417* *E423*
5407There are three types of terminals for highlighting:
5408term a normal terminal (vt100, xterm)
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005409cterm a color terminal (MS-Windows console, color-xterm, these have the "Co"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410 termcap entry)
5411gui the GUI
5412
5413For each type the highlighting can be given. This makes it possible to use
5414the same syntax file on all terminals, and use the optimal highlighting.
5415
54161. highlight arguments for normal terminals
5417
Bram Moolenaar75c50c42005-06-04 22:06:24 +00005418 *bold* *underline* *undercurl*
Bram Moolenaar84f54632022-06-29 18:39:11 +01005419 *underdouble* *underdotted*
5420 *underdashed* *inverse* *italic*
5421 *standout* *nocombine* *strikethrough*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422term={attr-list} *attr-list* *highlight-term* *E418*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005423 attr-list is a comma-separated list (without spaces) of the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005424 following items (in any order):
5425 bold
5426 underline
Bram Moolenaar5409c052005-03-18 20:27:04 +00005427 undercurl not always available
Bram Moolenaar84f54632022-06-29 18:39:11 +01005428 underdouble not always available
5429 underdotted not always available
5430 underdashed not always available
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02005431 strikethrough not always available
Bram Moolenaar071d4272004-06-13 20:20:40 +00005432 reverse
5433 inverse same as reverse
5434 italic
5435 standout
Bram Moolenaar0cd2a942017-08-12 15:12:30 +02005436 nocombine override attributes instead of combining them
Bram Moolenaar071d4272004-06-13 20:20:40 +00005437 NONE no attributes used (used to reset it)
5438
5439 Note that "bold" can be used here and by using a bold font. They
5440 have the same effect.
Bram Moolenaar84f54632022-06-29 18:39:11 +01005441 *underline-codes*
Bram Moolenaar5409c052005-03-18 20:27:04 +00005442 "undercurl" is a curly underline. When "undercurl" is not possible
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02005443 then "underline" is used. In general "undercurl" and "strikethrough"
Bram Moolenaaracc22402020-06-07 21:07:18 +02005444 are only available in the GUI and some terminals. The color is set
5445 with |highlight-guisp| or |highlight-ctermul|. You can try these
5446 termcap entries to make undercurl work in a terminal: >
5447 let &t_Cs = "\e[4:3m"
5448 let &t_Ce = "\e[4:0m"
5449
Bram Moolenaar84f54632022-06-29 18:39:11 +01005450< "underdouble" is a double underline, "underdotted" is a dotted
5451 underline and "underdashed" is a dashed underline. These are only
5452 supported by some terminals. If your terminal supports them you may
5453 have to specify the codes like this: >
5454 let &t_Us = "\e[4:2m"
5455 let &t_ds = "\e[4:4m"
5456 let &t_Ds = "\e[4:5m"
5457< They are reset with |t_Ce|, the same as curly underline (undercurl).
5458 When t_Us, t_ds or t_Ds is not set then underline will be used as a
5459 fallback.
5460
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461
5462start={term-list} *highlight-start* *E422*
5463stop={term-list} *term-list* *highlight-stop*
5464 These lists of terminal codes can be used to get
5465 non-standard attributes on a terminal.
5466
5467 The escape sequence specified with the "start" argument
5468 is written before the characters in the highlighted
5469 area. It can be anything that you want to send to the
5470 terminal to highlight this area. The escape sequence
5471 specified with the "stop" argument is written after the
5472 highlighted area. This should undo the "start" argument.
5473 Otherwise the screen will look messed up.
5474
5475 The {term-list} can have two forms:
5476
5477 1. A string with escape sequences.
5478 This is any string of characters, except that it can't start with
5479 "t_" and blanks are not allowed. The <> notation is recognized
5480 here, so you can use things like "<Esc>" and "<Space>". Example:
5481 start=<Esc>[27h;<Esc>[<Space>r;
5482
5483 2. A list of terminal codes.
5484 Each terminal code has the form "t_xx", where "xx" is the name of
5485 the termcap entry. The codes have to be separated with commas.
5486 White space is not allowed. Example:
5487 start=t_C1,t_BL
5488 The terminal codes must exist for this to work.
5489
5490
54912. highlight arguments for color terminals
5492
5493cterm={attr-list} *highlight-cterm*
5494 See above for the description of {attr-list} |attr-list|.
5495 The "cterm" argument is likely to be different from "term", when
5496 colors are used. For example, in a normal terminal comments could
5497 be underlined, in a color terminal they can be made Blue.
Bram Moolenaar68e65602019-05-26 21:33:31 +02005498 Note: Some terminals (e.g., DOS console) can't mix these attributes
5499 with coloring. To be portable, use only one of "cterm=" OR "ctermfg="
5500 OR "ctermbg=".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005501
5502ctermfg={color-nr} *highlight-ctermfg* *E421*
5503ctermbg={color-nr} *highlight-ctermbg*
Bram Moolenaare023e882020-05-31 16:42:30 +02005504ctermul={color-nr} *highlight-ctermul*
5505 These give the foreground (ctermfg), background (ctermbg) and
5506 underline (ctermul) color to use in the terminal.
5507
Bram Moolenaar071d4272004-06-13 20:20:40 +00005508 The {color-nr} argument is a color number. Its range is zero to
5509 (not including) the number given by the termcap entry "Co".
5510 The actual color with this number depends on the type of terminal
5511 and its settings. Sometimes the color also depends on the settings of
5512 "cterm". For example, on some systems "cterm=bold ctermfg=3" gives
5513 another color, on others you just get color 3.
5514
5515 For an xterm this depends on your resources, and is a bit
5516 unpredictable. See your xterm documentation for the defaults. The
5517 colors for a color-xterm can be changed from the .Xdefaults file.
5518 Unfortunately this means that it's not possible to get the same colors
5519 for each user. See |xterm-color| for info about color xterms.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02005520 *tmux*
5521 When using tmux you may want to use this in the tmux config: >
5522 # tmux colors
Bram Moolenaar2346a632021-06-13 19:02:49 +02005523 set -s default-terminal "tmux-256color"
5524 set -as terminal-overrides ",*-256color:Tc"
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02005525< More info at:
5526 https://github.com/tmux/tmux/wiki/FAQ#how-do-i-use-a-256-colour-terminal
5527 https://github.com/tmux/tmux/wiki/FAQ#how-do-i-use-rgb-colour
Bram Moolenaar071d4272004-06-13 20:20:40 +00005528
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005529 The MS-Windows standard colors are fixed (in a console window), so
5530 these have been used for the names. But the meaning of color names in
5531 X11 are fixed, so these color settings have been used, to make the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 highlighting settings portable (complicated, isn't it?). The
5533 following names are recognized, with the color number used:
5534
5535 *cterm-colors*
5536 NR-16 NR-8 COLOR NAME ~
5537 0 0 Black
5538 1 4 DarkBlue
5539 2 2 DarkGreen
5540 3 6 DarkCyan
5541 4 1 DarkRed
5542 5 5 DarkMagenta
5543 6 3 Brown, DarkYellow
5544 7 7 LightGray, LightGrey, Gray, Grey
5545 8 0* DarkGray, DarkGrey
5546 9 4* Blue, LightBlue
5547 10 2* Green, LightGreen
5548 11 6* Cyan, LightCyan
5549 12 1* Red, LightRed
5550 13 5* Magenta, LightMagenta
5551 14 3* Yellow, LightYellow
5552 15 7* White
5553
5554 The number under "NR-16" is used for 16-color terminals ('t_Co'
5555 greater than or equal to 16). The number under "NR-8" is used for
5556 8-color terminals ('t_Co' less than 16). The '*' indicates that the
5557 bold attribute is set for ctermfg. In many 8-color terminals (e.g.,
5558 "linux"), this causes the bright colors to appear. This doesn't work
5559 for background colors! Without the '*' the bold attribute is removed.
5560 If you want to set the bold attribute in a different way, put a
5561 "cterm=" argument AFTER the "ctermfg=" or "ctermbg=" argument. Or use
5562 a number instead of a color name.
5563
Christian Brabandt0f4054f2024-02-05 10:30:01 +01005564 The case of the color names is ignored, however Vim will use lower
5565 case color names when reading from the |v:colornames| dictionary.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005566 Note that for 16 color ansi style terminals (including xterms), the
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005567 numbers in the NR-8 column is used. Here '*' means 'add 8' so that
5568 Blue is 12, DarkGray is 8 etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005569
5570 Note that for some color terminals these names may result in the wrong
5571 colors!
5572
Bram Moolenaar5837f1f2015-03-21 18:06:14 +01005573 You can also use "NONE" to remove the color.
5574
Bram Moolenaar071d4272004-06-13 20:20:40 +00005575 *:hi-normal-cterm*
5576 When setting the "ctermfg" or "ctermbg" colors for the Normal group,
5577 these will become the colors used for the non-highlighted text.
5578 Example: >
5579 :highlight Normal ctermfg=grey ctermbg=darkblue
5580< When setting the "ctermbg" color for the Normal group, the
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02005581 'background' option will be adjusted automatically, under the
5582 condition that the color is recognized and 'background' was not set
5583 explicitly. This causes the highlight groups that depend on
5584 'background' to change! This means you should set the colors for
5585 Normal first, before setting other colors.
Bram Moolenaar723dd942019-04-04 13:11:03 +02005586 When a color scheme is being used, changing 'background' causes it to
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587 be reloaded, which may reset all colors (including Normal). First
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005588 delete the "g:colors_name" variable when you don't want this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005589
5590 When you have set "ctermfg" or "ctermbg" for the Normal group, Vim
5591 needs to reset the color when exiting. This is done with the "op"
5592 termcap entry |t_op|. If this doesn't work correctly, try setting the
5593 't_op' option in your .vimrc.
Bram Moolenaare023e882020-05-31 16:42:30 +02005594 *E419* *E420* *E453*
5595 When Vim knows the normal foreground, background and underline colors,
5596 "fg", "bg" and "ul" can be used as color names. This only works after
5597 setting the colors for the Normal group and for the MS-Windows
5598 console. Example, for reverse video: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005599 :highlight Visual ctermfg=bg ctermbg=fg
5600< Note that the colors are used that are valid at the moment this
Bram Moolenaar75e15672020-06-28 13:10:22 +02005601 command is given. If the Normal group colors are changed later, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005602 "fg" and "bg" colors will not be adjusted.
5603
PMuncha606f3a2023-11-15 15:35:49 +01005604ctermfont={font-nr} *highlight-ctermfont*
5605 This gives the alternative font number to use in the terminal. The
5606 available fonts depend on the terminal, and if the terminal is not set
5607 up for alternative fonts this simply won't do anything. The range of
5608 {font-nr} is 0-10 where 0 resets the font to the default font, 1-9
5609 selects one of the 9 alternate fonts, and 10 selects the Fraktur font.
5610 For more information see your terminal's handling of SGR parameters
5611 10-20. |t_CF|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005612
56133. highlight arguments for the GUI
5614
5615gui={attr-list} *highlight-gui*
5616 These give the attributes to use in the GUI mode.
5617 See |attr-list| for a description.
5618 Note that "bold" can be used here and by using a bold font. They
5619 have the same effect.
5620 Note that the attributes are ignored for the "Normal" group.
5621
5622font={font-name} *highlight-font*
5623 font-name is the name of a font, as it is used on the system Vim
5624 runs on. For X11 this is a complicated name, for example: >
5625 font=-misc-fixed-bold-r-normal--14-130-75-75-c-70-iso8859-1
5626<
5627 The font-name "NONE" can be used to revert to the default font.
5628 When setting the font for the "Normal" group, this becomes the default
5629 font (until the 'guifont' option is changed; the last one set is
5630 used).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005631 The following only works with Motif, not with other GUIs:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005632 When setting the font for the "Menu" group, the menus will be changed.
5633 When setting the font for the "Tooltip" group, the tooltips will be
5634 changed.
5635 All fonts used, except for Menu and Tooltip, should be of the same
5636 character size as the default font! Otherwise redrawing problems will
5637 occur.
Bram Moolenaar82af8712016-06-04 20:20:29 +02005638 To use a font name with an embedded space or other special character,
5639 put it in single quotes. The single quote cannot be used then.
5640 Example: >
5641 :hi comment font='Monospace 10'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005642
5643guifg={color-name} *highlight-guifg*
5644guibg={color-name} *highlight-guibg*
Bram Moolenaar5409c052005-03-18 20:27:04 +00005645guisp={color-name} *highlight-guisp*
5646 These give the foreground (guifg), background (guibg) and special
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02005647 (guisp) color to use in the GUI. "guisp" is used for undercurl and
5648 strikethrough.
Bram Moolenaar7df351e2006-01-23 22:30:28 +00005649 There are a few special names:
Bram Moolenaar938ae282023-02-20 20:44:55 +00005650 NONE no color (transparent) *E1361*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005651 bg use normal background color
5652 background use normal background color
5653 fg use normal foreground color
5654 foreground use normal foreground color
5655 To use a color name with an embedded space or other special character,
5656 put it in single quotes. The single quote cannot be used then.
5657 Example: >
5658 :hi comment guifg='salmon pink'
5659<
5660 *gui-colors*
5661 Suggested color names (these are available on most systems):
5662 Red LightRed DarkRed
5663 Green LightGreen DarkGreen SeaGreen
5664 Blue LightBlue DarkBlue SlateBlue
5665 Cyan LightCyan DarkCyan
5666 Magenta LightMagenta DarkMagenta
5667 Yellow LightYellow Brown DarkYellow
5668 Gray LightGray DarkGray
5669 Black White
5670 Orange Purple Violet
5671
5672 In the Win32 GUI version, additional system colors are available. See
5673 |win32-colors|.
5674
5675 You can also specify a color by its Red, Green and Blue values.
5676 The format is "#rrggbb", where
5677 "rr" is the Red value
Bram Moolenaar071d4272004-06-13 20:20:40 +00005678 "gg" is the Green value
Bram Moolenaar5409c052005-03-18 20:27:04 +00005679 "bb" is the Blue value
Bram Moolenaar071d4272004-06-13 20:20:40 +00005680 All values are hexadecimal, range from "00" to "ff". Examples: >
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01005681 :highlight Comment guifg=#11f0c3 guibg=#ff00ff
Bram Moolenaar071d4272004-06-13 20:20:40 +00005682<
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01005683 If you are authoring a color scheme and use the same hexadecimal value
Christian Brabandt0f4054f2024-02-05 10:30:01 +01005684 repeatedly, you can define a (lower case) name for it in |v:colornames|.
5685 For example: >
Drew Vogele30d1022021-10-24 20:35:07 +01005686
5687 # provide a default value for this color but allow the user to
5688 # override it.
5689 :call extend(v:colornames, {'alt_turquoise': '#11f0c3'}, 'keep')
5690 :highlight Comment guifg=alt_turquoise guibg=magenta
5691<
5692 If you are using a color scheme that relies on named colors and you
5693 would like to adjust the precise appearance of those colors, you can
5694 do so by overriding the values in |v:colornames| prior to loading the
5695 scheme: >
5696
5697 let v:colornames['alt_turquoise'] = '#22f0d3'
5698 colorscheme alt
5699<
5700 If you want to develop a color list that can be relied on by others,
5701 it is best to prefix your color names. By convention these color lists
5702 are placed in the colors/lists directory. You can see an example in
5703 '$VIMRUNTIME/colors/lists/csscolors.vim'. This list would be sourced
5704 by a color scheme using: >
5705
5706 :runtime colors/lists/csscolors.vim
5707 :highlight Comment guifg=css_turquoise
5708<
5709
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710 *highlight-groups* *highlight-default*
5711These are the default highlighting groups. These groups are used by the
5712'highlight' option default. Note that the highlighting depends on the value
5713of 'background'. You can see the current settings with the ":highlight"
5714command.
Bram Moolenaard899e512022-05-07 21:54:03 +01005715When possible the name is highlighted in the used colors. If this makes it
5716unreadable use Visual selection.
5717
Bram Moolenaar1a384422010-07-14 19:53:30 +02005718 *hl-ColorColumn*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005719ColorColumn Used for the columns set with 'colorcolumn'.
Bram Moolenaar860cae12010-06-05 23:22:07 +02005720 *hl-Conceal*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005721Conceal Placeholder characters substituted for concealed
5722 text (see 'conceallevel').
Bram Moolenaardd60c362023-02-27 15:49:53 +00005723 *hl-Cursor* *hl-lCursor*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005724Cursor Character under the cursor.
5725lCursor Character under the cursor when |language-mapping|
5726 is used (see 'guicursor').
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727 *hl-CursorIM*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005728CursorIM Like Cursor, but used when in IME mode. |CursorIM|
Bram Moolenaar5316eee2006-03-12 22:11:10 +00005729 *hl-CursorColumn*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005730CursorColumn Screen column that the cursor is in when 'cursorcolumn' is set.
Bram Moolenaar5316eee2006-03-12 22:11:10 +00005731 *hl-CursorLine*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005732CursorLine Screen line that the cursor is in when 'cursorline' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005733 *hl-Directory*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005734Directory Directory names (and other special names in listings).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735 *hl-DiffAdd*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005736DiffAdd Diff mode: Added line. |diff.txt|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005737 *hl-DiffChange*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005738DiffChange Diff mode: Changed line. |diff.txt|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005739 *hl-DiffDelete*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005740DiffDelete Diff mode: Deleted line. |diff.txt|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005741 *hl-DiffText*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005742DiffText Diff mode: Changed text within a changed line. |diff.txt|
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005743 *hl-EndOfBuffer*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005744EndOfBuffer Filler lines (~) after the last line in the buffer.
Bram Moolenaar58b85342016-08-14 19:54:54 +02005745 By default, this is highlighted like |hl-NonText|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005746 *hl-ErrorMsg*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005747ErrorMsg Error messages on the command line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005748 *hl-VertSplit*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005749VertSplit Column separating vertically split windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005750 *hl-Folded*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005751Folded Line used for closed folds.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005752 *hl-FoldColumn*
5753FoldColumn 'foldcolumn'
5754 *hl-SignColumn*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005755SignColumn Column where |signs| are displayed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756 *hl-IncSearch*
5757IncSearch 'incsearch' highlighting; also used for the text replaced with
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005758 ":s///c".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759 *hl-LineNr*
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005760LineNr Line number for ":number" and ":#" commands, and when 'number'
Bram Moolenaar64486672010-05-16 15:46:46 +02005761 or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01005762 *hl-LineNrAbove*
5763LineNrAbove Line number for when the 'relativenumber'
5764 option is set, above the cursor line.
5765 *hl-LineNrBelow*
5766LineNrBelow Line number for when the 'relativenumber'
5767 option is set, below the cursor line.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005768 *hl-CursorLineNr*
Bram Moolenaar89a9c152021-08-29 21:55:35 +02005769CursorLineNr Like LineNr when 'cursorline' is set and 'cursorlineopt'
5770 contains "number" or is "both", for the cursor line.
Bram Moolenaare413ea02021-11-24 16:20:13 +00005771 *hl-CursorLineFold*
5772CursorLineFold Like FoldColumn when 'cursorline' is set for the cursor line.
Bram Moolenaar76db9e02022-11-09 21:21:04 +00005773 *hl-CursorLineSign*
5774CursorLineSign Like SignColumn when 'cursorline' is set for the cursor line.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005775 *hl-MatchParen*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005776MatchParen Character under the cursor or just before it, if it
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005777 is a paired bracket, and its match. |pi_paren.txt|
Bram Moolenaar9b03d3e2022-08-30 20:26:34 +01005778 *hl-MessageWindow*
Bram Moolenaard13166e2022-11-18 21:49:57 +00005779MessageWindow Messages popup window used by `:echowindow`. If not defined
5780 |hl-WarningMsg| is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005781 *hl-ModeMsg*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005782ModeMsg 'showmode' message (e.g., "-- INSERT --").
Shougo Matsushitabe2b03c2024-04-08 22:11:50 +02005783 *hl-MsgArea*
5784MsgArea Command-line area, also used for outputting messages, see also
5785 'cmdheight'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005786 *hl-MoreMsg*
5787MoreMsg |more-prompt|
5788 *hl-NonText*
Bram Moolenaarf269eab2022-10-03 18:04:35 +01005789NonText '@' at the end of the window, "<<<" at the start of the window
5790 for 'smoothscroll', characters from 'showbreak' and other
5791 characters that do not really exist in the text, such as the
5792 ">" displayed when a double-wide character doesn't fit at the
5793 end of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005794 *hl-Normal*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005795Normal Normal text.
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00005796 *hl-Pmenu*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005797Pmenu Popup menu: Normal item.
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00005798 *hl-PmenuSel*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005799PmenuSel Popup menu: Selected item.
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00005800 *hl-PmenuKind*
5801PmenuKind Popup menu: Normal item "kind".
5802 *hl-PmenuKindSel*
5803PmenuKindSel Popup menu: Selected item "kind".
5804 *hl-PmenuExtra*
5805PmenuExtra Popup menu: Normal item "extra text".
5806 *hl-PmenuExtraSel*
5807PmenuExtraSel Popup menu: Selected item "extra text".
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00005808 *hl-PmenuSbar*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005809PmenuSbar Popup menu: Scrollbar.
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00005810 *hl-PmenuThumb*
5811PmenuThumb Popup menu: Thumb of the scrollbar.
glepnir40c1c332024-06-11 19:37:04 +02005812 *hl-PmenuMatch*
h-east84ac2122024-06-17 18:12:30 +02005813PmenuMatch Popup menu: Matched text in normal item.
glepnir40c1c332024-06-11 19:37:04 +02005814 *hl-PmenuMatchSel*
h-east84ac2122024-06-17 18:12:30 +02005815PmenuMatchSel Popup menu: Matched text in selected item.
Bram Moolenaar9b03d3e2022-08-30 20:26:34 +01005816 *hl-PopupNotification*
5817PopupNotification
5818 Popup window created with |popup_notification()|. If not
5819 defined |hl-WarningMsg| is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005820 *hl-Question*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005821Question |hit-enter| prompt and yes/no questions.
Bram Moolenaar74675a62017-07-15 13:53:23 +02005822 *hl-QuickFixLine*
5823QuickFixLine Current |quickfix| item in the quickfix window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005824 *hl-Search*
5825Search Last search pattern highlighting (see 'hlsearch').
Bram Moolenaar74675a62017-07-15 13:53:23 +02005826 Also used for similar items that need to stand out.
LemonBoya4399382022-04-09 21:04:08 +01005827 *hl-CurSearch*
5828CurSearch Current match for the last search pattern (see 'hlsearch').
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005829 Note: This is correct after a search, but may get outdated if
5830 changes are made or the screen is redrawn.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005831 *hl-SpecialKey*
5832SpecialKey Meta and special keys listed with ":map", also for text used
5833 to show unprintable characters in the text, 'listchars'.
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005834 Generally: Text that is displayed differently from what it
Bram Moolenaar071d4272004-06-13 20:20:40 +00005835 really is.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005836 *hl-SpellBad*
5837SpellBad Word that is not recognized by the spellchecker. |spell|
5838 This will be combined with the highlighting used otherwise.
Bram Moolenaar53180ce2005-07-05 21:48:14 +00005839 *hl-SpellCap*
5840SpellCap Word that should start with a capital. |spell|
5841 This will be combined with the highlighting used otherwise.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005842 *hl-SpellLocal*
5843SpellLocal Word that is recognized by the spellchecker as one that is
5844 used in another region. |spell|
5845 This will be combined with the highlighting used otherwise.
5846 *hl-SpellRare*
5847SpellRare Word that is recognized by the spellchecker as one that is
5848 hardly ever used. |spell|
5849 This will be combined with the highlighting used otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005850 *hl-StatusLine*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005851StatusLine Status line of current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005852 *hl-StatusLineNC*
5853StatusLineNC status lines of not-current windows
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005854 Note: If this is equal to "StatusLine", Vim will use "^^^" in
Bram Moolenaar071d4272004-06-13 20:20:40 +00005855 the status line of the current window.
Bram Moolenaar40962ec2018-01-28 22:47:25 +01005856 *hl-StatusLineTerm*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005857StatusLineTerm Status line of current window, if it is a |terminal| window.
Bram Moolenaar40962ec2018-01-28 22:47:25 +01005858 *hl-StatusLineTermNC*
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01005859StatusLineTermNC Status lines of not-current windows that is a
5860 |terminal| window.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00005861 *hl-TabLine*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005862TabLine Tab pages line, not active tab page label.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00005863 *hl-TabLineFill*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005864TabLineFill Tab pages line, where there are no labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00005865 *hl-TabLineSel*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005866TabLineSel Tab pages line, active tab page label.
Bram Moolenaardf980db2017-12-24 13:22:00 +01005867 *hl-Terminal*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005868Terminal |terminal| window (see |terminal-size-color|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005869 *hl-Title*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005870Title Titles for output from ":set all", ":autocmd" etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005871 *hl-Visual*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005872Visual Visual mode selection.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005873 *hl-VisualNOS*
5874VisualNOS Visual mode selection when vim is "Not Owning the Selection".
5875 Only X11 Gui's |gui-x11| and |xterm-clipboard| supports this.
5876 *hl-WarningMsg*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005877WarningMsg Warning messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005878 *hl-WildMenu*
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01005879WildMenu Current match in 'wildmenu' completion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005880
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005881 *hl-User1* *hl-User1..9* *hl-User9*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005882The 'statusline' syntax allows the use of 9 different highlights in the
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00005883statusline and ruler (via 'rulerformat'). The names are User1 to User9.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005884
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005885For the GUI you can use the following groups to set the colors for the menu,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886scrollbars and tooltips. They don't have defaults. This doesn't work for the
5887Win32 GUI. Only three highlight arguments have any effect here: font, guibg,
5888and guifg.
5889
5890 *hl-Menu*
5891Menu Current font, background and foreground colors of the menus.
5892 Also used for the toolbar.
5893 Applicable highlight arguments: font, guibg, guifg.
5894
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005895 NOTE: For Motif the font argument actually
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896 specifies a fontset at all times, no matter if 'guifontset' is
5897 empty, and as such it is tied to the current |:language| when
5898 set.
5899
5900 *hl-Scrollbar*
5901Scrollbar Current background and foreground of the main window's
5902 scrollbars.
5903 Applicable highlight arguments: guibg, guifg.
5904
5905 *hl-Tooltip*
5906Tooltip Current font, background and foreground of the tooltips.
5907 Applicable highlight arguments: font, guibg, guifg.
5908
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005909 NOTE: For Motif the font argument actually
Bram Moolenaar071d4272004-06-13 20:20:40 +00005910 specifies a fontset at all times, no matter if 'guifontset' is
5911 empty, and as such it is tied to the current |:language| when
5912 set.
5913
5914==============================================================================
Bram Moolenaar2d8ed022022-05-21 13:08:16 +0100591515. Linking groups *:hi-link* *:highlight-link* *E412* *E413*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005916
5917When you want to use the same highlighting for several syntax groups, you
5918can do this more easily by linking the groups into one common highlight
5919group, and give the color attributes only for that group.
5920
5921To set a link:
5922
5923 :hi[ghlight][!] [default] link {from-group} {to-group}
5924
5925To remove a link:
5926
5927 :hi[ghlight][!] [default] link {from-group} NONE
5928
5929Notes: *E414*
5930- If the {from-group} and/or {to-group} doesn't exist, it is created. You
5931 don't get an error message for a non-existing group.
5932- As soon as you use a ":highlight" command for a linked group, the link is
5933 removed.
5934- If there are already highlight settings for the {from-group}, the link is
5935 not made, unless the '!' is given. For a ":highlight link" command in a
5936 sourced file, you don't get an error message. This can be used to skip
5937 links for groups that already have settings.
5938
5939 *:hi-default* *:highlight-default*
5940The [default] argument is used for setting the default highlighting for a
5941group. If highlighting has already been specified for the group the command
5942will be ignored. Also when there is an existing link.
5943
5944Using [default] is especially useful to overrule the highlighting of a
5945specific syntax file. For example, the C syntax file contains: >
5946 :highlight default link cComment Comment
5947If you like Question highlighting for C comments, put this in your vimrc file: >
5948 :highlight link cComment Question
5949Without the "default" in the C syntax file, the highlighting would be
5950overruled when the syntax file is loaded.
5951
Bram Moolenaar23515b42020-11-29 14:36:24 +01005952To have a link survive `:highlight clear`, which is useful if you have
5953highlighting for a specific filetype and you want to keep it when selecting
5954another color scheme, put a command like this in the
5955"after/syntax/{filetype}.vim" file: >
5956 highlight! default link cComment Question
5957
Bram Moolenaar071d4272004-06-13 20:20:40 +00005958==============================================================================
Bram Moolenaar2d8ed022022-05-21 13:08:16 +0100595916. Cleaning up *:syn-clear* *E391*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005960
5961If you want to clear the syntax stuff for the current buffer, you can use this
5962command: >
5963 :syntax clear
5964
5965This command should be used when you want to switch off syntax highlighting,
5966or when you want to switch to using another syntax. It's normally not needed
5967in a syntax file itself, because syntax is cleared by the autocommands that
5968load the syntax file.
5969The command also deletes the "b:current_syntax" variable, since no syntax is
5970loaded after this command.
5971
Bram Moolenaar61da1bf2019-06-06 12:14:49 +02005972To clean up specific syntax groups for the current buffer: >
5973 :syntax clear {group-name} ..
5974This removes all patterns and keywords for {group-name}.
5975
5976To clean up specific syntax group lists for the current buffer: >
5977 :syntax clear @{grouplist-name} ..
5978This sets {grouplist-name}'s contents to an empty list.
5979
5980 *:syntax-off* *:syn-off*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005981If you want to disable syntax highlighting for all buffers, you need to remove
5982the autocommands that load the syntax files: >
5983 :syntax off
5984
5985What this command actually does, is executing the command >
5986 :source $VIMRUNTIME/syntax/nosyntax.vim
5987See the "nosyntax.vim" file for details. Note that for this to work
5988$VIMRUNTIME must be valid. See |$VIMRUNTIME|.
5989
Bram Moolenaar071d4272004-06-13 20:20:40 +00005990 *:syntax-reset* *:syn-reset*
5991If you have changed the colors and messed them up, use this command to get the
5992defaults back: >
5993
5994 :syntax reset
5995
Bram Moolenaar03413f42016-04-12 21:07:15 +02005996It is a bit of a wrong name, since it does not reset any syntax items, it only
5997affects the highlighting.
5998
Bram Moolenaar071d4272004-06-13 20:20:40 +00005999This doesn't change the colors for the 'highlight' option.
6000
6001Note that the syntax colors that you set in your vimrc file will also be reset
6002back to their Vim default.
6003Note that if you are using a color scheme, the colors defined by the color
6004scheme for syntax highlighting will be lost.
6005
6006What this actually does is: >
6007
6008 let g:syntax_cmd = "reset"
6009 runtime! syntax/syncolor.vim
6010
6011Note that this uses the 'runtimepath' option.
6012
6013 *syncolor*
6014If you want to use different colors for syntax highlighting, you can add a Vim
6015script file to set these colors. Put this file in a directory in
6016'runtimepath' which comes after $VIMRUNTIME, so that your settings overrule
6017the default colors. This way these colors will be used after the ":syntax
6018reset" command.
6019
6020For Unix you can use the file ~/.vim/after/syntax/syncolor.vim. Example: >
6021
6022 if &background == "light"
6023 highlight comment ctermfg=darkgreen guifg=darkgreen
6024 else
6025 highlight comment ctermfg=green guifg=green
6026 endif
Bram Moolenaar88a42052021-11-21 21:13:36 +00006027<
Bram Moolenaarc0197e22004-09-13 20:26:32 +00006028 *E679*
6029Do make sure this syncolor.vim script does not use a "syntax on", set the
6030'background' option or uses a "colorscheme" command, because it results in an
6031endless loop.
6032
Bram Moolenaar071d4272004-06-13 20:20:40 +00006033Note that when a color scheme is used, there might be some confusion whether
6034your defined colors are to be used or the colors from the scheme. This
6035depends on the color scheme file. See |:colorscheme|.
6036
6037 *syntax_cmd*
6038The "syntax_cmd" variable is set to one of these values when the
6039syntax/syncolor.vim files are loaded:
Bram Moolenaar88a42052021-11-21 21:13:36 +00006040 "on" `:syntax on` command. Highlight colors are overruled but
Bram Moolenaar071d4272004-06-13 20:20:40 +00006041 links are kept
Bram Moolenaar88a42052021-11-21 21:13:36 +00006042 "enable" `:syntax enable` command. Only define colors for groups that
6043 don't have highlighting yet. Use `:highlight default` .
6044 "reset" `:syntax reset` command or loading a color scheme. Define all
Bram Moolenaar071d4272004-06-13 20:20:40 +00006045 the colors.
6046 "skip" Don't define colors. Used to skip the default settings when a
6047 syncolor.vim file earlier in 'runtimepath' has already set
6048 them.
6049
6050==============================================================================
Bram Moolenaar2d8ed022022-05-21 13:08:16 +0100605117. Highlighting tags *tag-highlight*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006052
6053If you want to highlight all the tags in your file, you can use the following
6054mappings.
6055
6056 <F11> -- Generate tags.vim file, and highlight tags.
6057 <F12> -- Just highlight tags based on existing tags.vim file.
6058>
6059 :map <F11> :sp tags<CR>:%s/^\([^ :]*:\)\=\([^ ]*\).*/syntax keyword Tag \2/<CR>:wq! tags.vim<CR>/^<CR><F12>
6060 :map <F12> :so tags.vim<CR>
6061
6062WARNING: The longer the tags file, the slower this will be, and the more
6063memory Vim will consume.
6064
6065Only highlighting typedefs, unions and structs can be done too. For this you
Bram Moolenaar47c532e2022-03-19 15:18:53 +00006066must use Universal Ctags (found at https://ctags.io) or Exuberant ctags (found
6067at http://ctags.sf.net).
Bram Moolenaar071d4272004-06-13 20:20:40 +00006068
6069Put these lines in your Makefile:
6070
Bram Moolenaar47c532e2022-03-19 15:18:53 +00006071# Make a highlight file for types. Requires Universal/Exuberant ctags and awk
Bram Moolenaar071d4272004-06-13 20:20:40 +00006072types: types.vim
6073types.vim: *.[ch]
Bram Moolenaarc81e5e72007-05-05 18:24:42 +00006074 ctags --c-kinds=gstu -o- *.[ch] |\
Bram Moolenaar071d4272004-06-13 20:20:40 +00006075 awk 'BEGIN{printf("syntax keyword Type\t")}\
6076 {printf("%s ", $$1)}END{print ""}' > $@
6077
6078And put these lines in your .vimrc: >
6079
6080 " load the types.vim highlighting file, if it exists
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006081 autocmd BufRead,BufNewFile *.[ch] let fname = expand('<afile>:p:h') .. '/types.vim'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006082 autocmd BufRead,BufNewFile *.[ch] if filereadable(fname)
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006083 autocmd BufRead,BufNewFile *.[ch] exe 'so ' .. fname
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 autocmd BufRead,BufNewFile *.[ch] endif
6085
6086==============================================================================
Bram Moolenaar2d8ed022022-05-21 13:08:16 +0100608718. Window-local syntax *:ownsyntax*
Bram Moolenaar860cae12010-06-05 23:22:07 +02006088
6089Normally all windows on a buffer share the same syntax settings. It is
6090possible, however, to set a particular window on a file to have its own
6091private syntax setting. A possible example would be to edit LaTeX source
6092with conventional highlighting in one window, while seeing the same source
6093highlighted differently (so as to hide control sequences and indicate bold,
6094italic etc regions) in another. The 'scrollbind' option is useful here.
6095
6096To set the current window to have the syntax "foo", separately from all other
6097windows on the buffer: >
6098 :ownsyntax foo
Bram Moolenaardebe25a2010-06-06 17:41:24 +02006099< *w:current_syntax*
6100This will set the "w:current_syntax" variable to "foo". The value of
6101"b:current_syntax" does not change. This is implemented by saving and
6102restoring "b:current_syntax", since the syntax files do set
6103"b:current_syntax". The value set by the syntax file is assigned to
6104"w:current_syntax".
Bram Moolenaared32d942014-12-06 23:33:00 +01006105Note: This resets the 'spell', 'spellcapcheck' and 'spellfile' options.
Bram Moolenaar860cae12010-06-05 23:22:07 +02006106
6107Once a window has its own syntax, syntax commands executed from other windows
Bram Moolenaar56b45b92013-06-24 22:22:18 +02006108on the same buffer (including :syntax clear) have no effect. Conversely,
Bram Moolenaarbf884932013-04-05 22:26:15 +02006109syntax commands executed from that window do not affect other windows on the
Bram Moolenaar860cae12010-06-05 23:22:07 +02006110same buffer.
6111
Bram Moolenaardebe25a2010-06-06 17:41:24 +02006112A window with its own syntax reverts to normal behavior when another buffer
6113is loaded into that window or the file is reloaded.
6114When splitting the window, the new window will use the original syntax.
Bram Moolenaar860cae12010-06-05 23:22:07 +02006115
6116==============================================================================
Bram Moolenaar2d8ed022022-05-21 13:08:16 +0100611719. Color xterms *xterm-color* *color-xterm*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006118
6119Most color xterms have only eight colors. If you don't get colors with the
6120default setup, it should work with these lines in your .vimrc: >
6121 :if &term =~ "xterm"
6122 : if has("terminfo")
6123 : set t_Co=8
6124 : set t_Sf=<Esc>[3%p1%dm
6125 : set t_Sb=<Esc>[4%p1%dm
6126 : else
6127 : set t_Co=8
6128 : set t_Sf=<Esc>[3%dm
6129 : set t_Sb=<Esc>[4%dm
6130 : endif
6131 :endif
6132< [<Esc> is a real escape, type CTRL-V <Esc>]
6133
6134You might want to change the first "if" to match the name of your terminal,
6135e.g. "dtterm" instead of "xterm".
6136
6137Note: Do these settings BEFORE doing ":syntax on". Otherwise the colors may
6138be wrong.
6139 *xiterm* *rxvt*
6140The above settings have been mentioned to work for xiterm and rxvt too.
6141But for using 16 colors in an rxvt these should work with terminfo: >
6142 :set t_AB=<Esc>[%?%p1%{8}%<%t25;%p1%{40}%+%e5;%p1%{32}%+%;%dm
6143 :set t_AF=<Esc>[%?%p1%{8}%<%t22;%p1%{30}%+%e1;%p1%{22}%+%;%dm
6144<
6145 *colortest.vim*
6146To test your color setup, a file has been included in the Vim distribution.
Bram Moolenaarf740b292006-02-16 22:11:02 +00006147To use it, execute this command: >
6148 :runtime syntax/colortest.vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00006150Some versions of xterm (and other terminals, like the Linux console) can
Bram Moolenaar071d4272004-06-13 20:20:40 +00006151output lighter foreground colors, even though the number of colors is defined
6152at 8. Therefore Vim sets the "cterm=bold" attribute for light foreground
6153colors, when 't_Co' is 8.
6154
6155 *xfree-xterm*
6156To get 16 colors or more, get the newest xterm version (which should be
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00006157included with XFree86 3.3 and later). You can also find the latest version
Bram Moolenaar071d4272004-06-13 20:20:40 +00006158at: >
6159 http://invisible-island.net/xterm/xterm.html
6160Here is a good way to configure it. This uses 88 colors and enables the
6161termcap-query feature, which allows Vim to ask the xterm how many colors it
6162supports. >
6163 ./configure --disable-bold-color --enable-88-color --enable-tcap-query
6164If you only get 8 colors, check the xterm compilation settings.
6165(Also see |UTF8-xterm| for using this xterm with UTF-8 character encoding).
6166
6167This xterm should work with these lines in your .vimrc (for 16 colors): >
6168 :if has("terminfo")
6169 : set t_Co=16
6170 : set t_AB=<Esc>[%?%p1%{8}%<%t%p1%{40}%+%e%p1%{92}%+%;%dm
6171 : set t_AF=<Esc>[%?%p1%{8}%<%t%p1%{30}%+%e%p1%{82}%+%;%dm
6172 :else
6173 : set t_Co=16
6174 : set t_Sf=<Esc>[3%dm
6175 : set t_Sb=<Esc>[4%dm
6176 :endif
6177< [<Esc> is a real escape, type CTRL-V <Esc>]
6178
6179Without |+terminfo|, Vim will recognize these settings, and automatically
6180translate cterm colors of 8 and above to "<Esc>[9%dm" and "<Esc>[10%dm".
6181Colors above 16 are also translated automatically.
6182
6183For 256 colors this has been reported to work: >
6184
6185 :set t_AB=<Esc>[48;5;%dm
6186 :set t_AF=<Esc>[38;5;%dm
6187
6188Or just set the TERM environment variable to "xterm-color" or "xterm-16color"
6189and try if that works.
6190
6191You probably want to use these X resources (in your ~/.Xdefaults file):
6192 XTerm*color0: #000000
6193 XTerm*color1: #c00000
6194 XTerm*color2: #008000
6195 XTerm*color3: #808000
6196 XTerm*color4: #0000c0
6197 XTerm*color5: #c000c0
6198 XTerm*color6: #008080
6199 XTerm*color7: #c0c0c0
6200 XTerm*color8: #808080
6201 XTerm*color9: #ff6060
6202 XTerm*color10: #00ff00
6203 XTerm*color11: #ffff00
6204 XTerm*color12: #8080ff
6205 XTerm*color13: #ff40ff
6206 XTerm*color14: #00ffff
6207 XTerm*color15: #ffffff
6208 Xterm*cursorColor: Black
6209
6210[Note: The cursorColor is required to work around a bug, which changes the
6211cursor color to the color of the last drawn text. This has been fixed by a
Bram Moolenaarc81e5e72007-05-05 18:24:42 +00006212newer version of xterm, but not everybody is using it yet.]
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213
6214To get these right away, reload the .Xdefaults file to the X Option database
6215Manager (you only need to do this when you just changed the .Xdefaults file): >
6216 xrdb -merge ~/.Xdefaults
6217<
6218 *xterm-blink* *xterm-blinking-cursor*
6219To make the cursor blink in an xterm, see tools/blink.c. Or use Thomas
6220Dickey's xterm above patchlevel 107 (see above for where to get it), with
6221these resources:
6222 XTerm*cursorBlink: on
6223 XTerm*cursorOnTime: 400
6224 XTerm*cursorOffTime: 250
6225 XTerm*cursorColor: White
6226
6227 *hpterm-color*
Bram Moolenaarc81e5e72007-05-05 18:24:42 +00006228These settings work (more or less) for an hpterm, which only supports 8
Bram Moolenaar071d4272004-06-13 20:20:40 +00006229foreground colors: >
6230 :if has("terminfo")
6231 : set t_Co=8
6232 : set t_Sf=<Esc>[&v%p1%dS
6233 : set t_Sb=<Esc>[&v7S
6234 :else
6235 : set t_Co=8
6236 : set t_Sf=<Esc>[&v%dS
6237 : set t_Sb=<Esc>[&v7S
6238 :endif
6239< [<Esc> is a real escape, type CTRL-V <Esc>]
6240
6241 *Eterm* *enlightened-terminal*
6242These settings have been reported to work for the Enlightened terminal
6243emulator, or Eterm. They might work for all xterm-like terminals that use the
6244bold attribute to get bright colors. Add an ":if" like above when needed. >
6245 :set t_Co=16
6246 :set t_AF=^[[%?%p1%{8}%<%t3%p1%d%e%p1%{22}%+%d;1%;m
6247 :set t_AB=^[[%?%p1%{8}%<%t4%p1%d%e%p1%{32}%+%d;1%;m
6248<
6249 *TTpro-telnet*
6250These settings should work for TTpro telnet. Tera Term Pro is a freeware /
6251open-source program for MS-Windows. >
6252 set t_Co=16
6253 set t_AB=^[[%?%p1%{8}%<%t%p1%{40}%+%e%p1%{32}%+5;%;%dm
6254 set t_AF=^[[%?%p1%{8}%<%t%p1%{30}%+%e%p1%{22}%+1;%;%dm
6255Also make sure TTpro's Setup / Window / Full Color is enabled, and make sure
6256that Setup / Font / Enable Bold is NOT enabled.
6257(info provided by John Love-Jensen <eljay@Adobe.COM>)
6258
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02006259
6260==============================================================================
Bram Moolenaar2d8ed022022-05-21 13:08:16 +0100626120. When syntax is slow *:syntime*
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02006262
6263This is aimed at authors of a syntax file.
6264
6265If your syntax causes redrawing to be slow, here are a few hints on making it
6266faster. To see slowness switch on some features that usually interfere, such
6267as 'relativenumber' and |folding|.
6268
Bram Moolenaar3f32a5f2022-05-12 20:34:15 +01006269Note: This is only available when compiled with the |+profile| feature.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006270You many need to build Vim with "huge" features.
6271
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02006272To find out what patterns are consuming most time, get an overview with this
6273sequence: >
6274 :syntime on
6275 [ redraw the text at least once with CTRL-L ]
6276 :syntime report
6277
6278This will display a list of syntax patterns that were used, sorted by the time
6279it took to match them against the text.
6280
6281:syntime on Start measuring syntax times. This will add some
6282 overhead to compute the time spent on syntax pattern
6283 matching.
6284
6285:syntime off Stop measuring syntax times.
6286
6287:syntime clear Set all the counters to zero, restart measuring.
6288
6289:syntime report Show the syntax items used since ":syntime on" in the
6290 current window. Use a wider display to see more of
6291 the output.
6292
6293 The list is sorted by total time. The columns are:
6294 TOTAL Total time in seconds spent on
6295 matching this pattern.
6296 COUNT Number of times the pattern was used.
6297 MATCH Number of times the pattern actually
6298 matched
6299 SLOWEST The longest time for one try.
6300 AVERAGE The average time for one try.
6301 NAME Name of the syntax item. Note that
6302 this is not unique.
6303 PATTERN The pattern being used.
6304
6305Pattern matching gets slow when it has to try many alternatives. Try to
6306include as much literal text as possible to reduce the number of ways a
6307pattern does NOT match.
6308
6309When using the "\@<=" and "\@<!" items, add a maximum size to avoid trying at
6310all positions in the current and previous line. For example, if the item is
6311literal text specify the size of that text (in bytes):
6312
Bram Moolenaar56b45b92013-06-24 22:22:18 +02006313"<\@<=span" Matches "span" in "<span". This tries matching with "<" in
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02006314 many places.
Bram Moolenaar56b45b92013-06-24 22:22:18 +02006315"<\@1<=span" Matches the same, but only tries one byte before "span".
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02006316
RestorerZf7a38652024-04-22 20:55:32 +02006317
Bram Moolenaar91f84f62018-07-29 15:07:52 +02006318 vim:tw=78:sw=4:ts=8:noet:ft=help:norl: