Movatterモバイル変換


[0]ホーム

URL:


Syntax

Nvim:help pages,generated fromsource using thetree-sitter-vimdoc parser.


Syntax highlightingsyntax-highlightingcoloring
Syntax highlighting enables Vim to show parts of the text in another font orcolor.Those parts can be specific keywords or text matching a pattern. Vimdoesn't parse the whole file (to keep it fast), so the highlighting has itslimitations. Lexical highlighting might be a better name, but since everybodycalls it syntax highlighting we'll stick with that.
Vim supports syntax highlighting on all terminals. But since most ordinaryterminals have very limited highlighting possibilities, it works best in theGUI version, gvim.
In the User Manual:usr_06.txt introduces syntax highlighting.usr_44.txt introduces writing a syntax file.

1. Quick start:syn-qstart

:syn-enable:syntax-enable:syn-on:syntax-onSyntax highlighting is enabled by default. If you need to enable it againafter it was disabled (see below), use:
:syntax enable
Alternatively:
:syntax on
What this command actually does is to execute the command
:source $VIMRUNTIME/syntax/syntax.vim
If the VIM environment variable is not set, Vim will try to findthe path in another way (see$VIMRUNTIME). Usually this works justfine. If it doesn't, try setting the VIM environment variable to thedirectory where the Vim stuff is located. For example, if your syntax filesare in the "/usr/vim/vim82/syntax" directory, set $VIMRUNTIME to"/usr/vim/vim82". You must do this in the shell, before starting Vim.This command also sources themenu.vim script when the GUI is running orwill start soon.
:hi-normal:highlight-normalIf you are running in the GUI, you can get white text on a black backgroundwith:
:highlight Normal guibg=Black guifg=White
For a color terminal see:hi-normal-cterm.
NOTE: The syntax files on MS-Windows have lines that end in<CR><NL>.The files for Unix end in<NL>. This means you should use the right type offile for your system. Although on MS-Windows the right format isautomatically selected if the'fileformats' option is not empty.
NOTE: When using reverse video ("gvim -fg white -bg black"), the default valueof'background' will not be set until the GUI window is opened, which is afterreading thegvimrc. This will cause the wrong default highlighting to beused. To set the default value of'background' before switching onhighlighting, include the ":gui" command in thegvimrc:
:gui" open window and set default for 'background':syntax on" start highlighting, use 'background' to set colors
NOTE: Using ":gui" in thegvimrc means that "gvim -f" won't start in theforeground! Use ":gui -f" then.
g:syntax_on
You can toggle the syntax on/off with this command:
:if exists("g:syntax_on") | syntax off | else | syntax enable | endif
To put this into a mapping, you can use:
:map <F7> :if exists("g:syntax_on") <Bar>     \   syntax off <Bar>     \ else <Bar>     \   syntax enable <Bar>     \ endif <CR>
[using the<> notation, type this literally]
Details:The ":syntax" commands are implemented by sourcing a file. To see exactly howthis works, look in the file:
commandfile
:syntax enable$VIMRUNTIME/syntax/syntax.vim :syntax on$VIMRUNTIME/syntax/syntax.vim :syntax manual$VIMRUNTIME/syntax/manual.vim :syntax off$VIMRUNTIME/syntax/nosyntax.vimAlso seesyntax-loading.
NOTE: If displaying long lines is slow and switching off syntax highlightingmakes it fast, consider setting the'synmaxcol' option to a lower value.

2. Syntax files:syn-files

The syntax and highlighting commands for one language are normally stored ina syntax file.The name convention is: "{name}.vim". Where{name} is thename of the language, or an abbreviation (to fit the name in 8.3 characters,a requirement in case the file is used on a DOS filesystem).Examples:c.vimperl.vimjava.vimhtml.vimcpp.vimsh.vimcsh.vim
The syntax file can contain any Ex commands, just like a vimrc file. Butthe idea is that only commands for a specific language are included. When alanguage is a superset of another language, it may include the other one,for example, the cpp.vim file could include the c.vim file:
:so $VIMRUNTIME/syntax/c.vim
The .vim files are normally loaded with an autocommand. For example:
:au Syntax c    runtime! syntax/c.vim:au Syntax cpp   runtime! syntax/cpp.vim
These commands are normally in the file $VIMRUNTIME/syntax/synload.vim.

MAKING YOUR OWN SYNTAX FILESmysyntaxfile

When you create your own syntax files, and you want to have Vim use theseautomatically with ":syntax enable", do this:
1. Create your user runtime directory.You would normally use the first item of the'runtimepath' option. Example for Unix:
mkdir ~/.config/nvim
2. Create a directory in there called "syntax". For Unix:
mkdir ~/.config/nvim/syntax
3. Write the Vim syntax file. Or download one from the internet. Then write it in your syntax directory. For example, for the "mine" syntax:
:w ~/.config/nvim/syntax/mine.vim
Now you can start using your syntax file manually:
:set syntax=mine
You don't have to exit Vim to use this.
If you also want Vim to detect the type of file, seenew-filetype.
If you are setting up a system with many users and you don't want each userto add the same syntax file, you can use another directory from'runtimepath'.

ADDING TO AN EXISTING SYNTAX FILEmysyntaxfile-add

If you are mostly satisfied with an existing syntax file, but would like toadd a few items or change the highlighting, follow these steps:
1. Create your user directory from'runtimepath', see above.
2. Create a directory in there called "after/syntax". For Unix:
mkdir -p ~/.config/nvim/after/syntax
3. Write a Vim script that contains the commands you want to use. For example, to change the colors for the C syntax:
highlight cComment ctermfg=Green guifg=Green
4. Write that file in the "after/syntax" directory. Use the name of the syntax, with ".vim" added. For our C syntax:
:w ~/.config/nvim/after/syntax/c.vim
That's it. The next time you edit a C file the Comment color will bedifferent. You don't even have to restart Vim.
If you have multiple files, you can use the filetype as the directory name.All the "*.vim" files in this directory will be used, for example:~/.config/nvim/after/syntax/c/one.vim~/.config/nvim/after/syntax/c/two.vim

REPLACING AN EXISTING SYNTAX FILEmysyntaxfile-replace

If you don't like a distributed syntax file, or you have downloaded a newversion, follow the same steps as formysyntaxfile above. Just make surethat you write the syntax file in a directory that is early in'runtimepath'.Vim will only load the first syntax file found, assuming that it setsb:current_syntax.

NAMING CONVENTIONSgroup-name{group-name}E669E5248

A syntax group name is to be used for syntax items that match the same kind ofthing. These are then linked to a highlight group that specifies the color.A syntax group name doesn't specify any color or attributes itself.
The name for a highlight or syntax group must consist of ASCII letters,digits, underscores, dots, hyphens, or@. As a regexp:[a-zA-Z0-9_.@-]*.The maximum length of a group name is about 200 bytes.E1249
To be able to allow each user to pick their favorite set of colors, there mustbe preferred names for highlight groups that are common for many languages.These are the suggested group names (if syntax highlighting works properlyyou can see the actual color, except for "Ignore"):
Commentany comment
Constantany constantStringa string constant: "this is a string"Charactera character constant: 'c', '\n'Numbera number constant: 234, 0xffBooleana boolean constant: TRUE, falseFloata floating point constant: 2.3e10
Identifierany variable nameFunctionfunction name (also: methods for classes)
Statementany statementConditionalif, then, else, endif, switch, etc.Repeatfor, do, while, etc.Labelcase, default, etc.Operator"sizeof", "+", "*", etc.Keywordany other keywordExceptiontry, catch, throw
PreProcgeneric PreprocessorIncludepreprocessor #includeDefinepreprocessor #defineMacrosame as DefinePreConditpreprocessor #if, #else, #endif, etc.
Typeint, long, char, etc.StorageClassstatic, register, volatile, etc.Structurestruct, union, enum, etc.Typedefa typedef
Specialany special symbolSpecialCharspecial character in a constantTagyou can useCTRL-] on thisDelimitercharacter that needs attentionSpecialCommentspecial things inside a commentDebugdebugging statements
Underlinedtext that stands out, HTML links
Ignoreleft blank, hiddenhl-Ignore
Errorany erroneous construct
Todoanything that needs extra attention; mostly thekeywords TODO FIXME and XXX
Addedadded line in a diffChangedchanged line in a diffRemovedremoved line in a diff
Note that highlight group names are not case sensitive. "String" and "string"can be used for the same group.
The following names are reserved and cannot be used as a group name:NONE ALL ALLBUT contains contained
hl-Ignore
When using the Ignore group, you may also consider using the concealmechanism. Seeconceal.

3. Syntax loading proceduresyntax-loading

This explains the details that happen when the command ":syntax enable" isissued. When Vim initializes itself, it finds out where the runtime files arelocated. This is used here as the variable$VIMRUNTIME.
":syntax enable" and ":syntax on" do the following:
Source $VIMRUNTIME/syntax/syntax.vim | +-Clear out any old syntax by sourcing $VIMRUNTIME/syntax/nosyntax.vim | +-Source first syntax/synload.vim in'runtimepath' || |+- Set up syntax autocmds to load the appropriate syntax file when || the'syntax' option is set.synload-1 || |+- Source the user's optional file, from themysyntaxfile variable. | This is for backwards compatibility with Vim 5.x only.synload-2 | +-Do ":filetype on", which does ":runtime! filetype.vim". It loads any |filetype.vim files found. It should always Source |$VIMRUNTIME/filetype.vim, which does the following. || |+- Install autocmds based on suffix to set the'filetype' option || This is where the connection between file name and file type is || made for known file types.synload-3 || |+- Source the user's optional file, from themyfiletypefile || variable. This is for backwards compatibility with Vim 5.x only. ||synload-4 || |+- Install one autocommand which sources scripts.vim when no file || type was detected yet.synload-5 || |+- Source $VIMRUNTIME/menu.vim, to setup the Syntax menu.menu.vim | +-Install a FileType autocommand to set the'syntax' option when a file |type has been detected.synload-6 | +-Execute syntax autocommands to start syntax highlighting for eachalready loaded buffer.
Upon loading a file, Vim finds the relevant syntax file as follows:
Loading the file triggers the BufReadPost autocommands. | +-If there is a match with one of the autocommands fromsynload-3 |(known file types) orsynload-4 (user's file types), the'filetype' |option is set to the file type. | +-The autocommand atsynload-5 is triggered. If the file type was not |found yet, then scripts.vim is searched for in'runtimepath'. This |should always load $VIMRUNTIME/scripts.vim, which does the following. || |+- Source the user's optional file, from themyscriptsfile || variable. This is for backwards compatibility with Vim 5.x only. || |+- If the file type is still unknown, check the contents of the file, | again with checks like "getline(1) =~ pattern" as to whether the | file type can be recognized, and set'filetype'. | +-When the file type was determined and'filetype' was set, this |triggers the FileType autocommandsynload-6 above. It sets |'syntax' to the determined file type. | +-When the'syntax' option was set above, this triggers an autocommand |fromsynload-1 (andsynload-2). This find the main syntax file in |'runtimepath', with this command: |runtime! syntax/<name>.vim | +-Any other user installed FileType or Syntax autocommands aretriggered. This can be used to change the highlighting for a specificsyntax.

4. Conversion to HTMLconvert-to-HTML2html.vim

The old to html converter has been replaced by a Lua version and thedocumentation has been moved to:TOhtml.

5. Syntax file remarks:syn-file-remarks

b:current_syntax-variable
Vim stores the name of the syntax that has been loaded in the"b:current_syntax" variable. You can use this if you want to load othersettings, depending on which syntax is active.Example:
:au BufReadPost * if b:current_syntax == "csh":au BufReadPost *   do-some-things:au BufReadPost * endif

ABELft-abel-syntax

ABEL highlighting provides some user-defined options. To enable them, assignany value to the respective variable. Example:
:let abel_obsolete_ok=1
To disable them use ":unlet". Example:
:unlet abel_obsolete_ok
VariableHighlight
abel_obsolete_okobsolete keywords are statements, not errorsabel_cpp_comments_illegaldo not interpret '//' as inline comment leader

ADA

Seeft-ada-syntax

ANTft-ant-syntax

The ant syntax file provides syntax highlighting for javascript and pythonby default. Syntax highlighting for other script languages can be installedby the function AntSyntaxScript(), which takes the tag name as first argumentand the script syntax file name as second argument. Example:
:call AntSyntaxScript('perl', 'perl.vim')
will install syntax perl highlighting for the following ant code
<script language = 'perl'><![CDATA[    # everything inside is highlighted as perl]]></script>
Seemysyntaxfile-add for installing script languages permanently.

APACHEft-apache-syntax

The apache syntax file provides syntax highlighting for Apache HTTP serverversion 2.2.3.

ASSEMBLYasm68kft-asm-syntaxft-asmh8300-syntaxft-nasm-syntax

ft-masm-syntaxft-asm68k-syntax
Files matching "*.i" could be Progress or Assembly. If the automaticdetection doesn't work for you, or you don't edit Progress at all, use this inyour startup vimrc:
:let filetype_i = "asm"
Replace "asm" with the type of assembly you use.
There are many types of assembly languages that all use the same file nameextensions. Therefore you will have to select the type yourself, or add aline in the assembly file that Vim will recognize. Currently these syntaxfiles are included:asmGNU assembly (usually have .s or .S extension and werealready built using C compiler such as GCC or CLANG)asm68kMotorola 680x0 assemblyasmh8300Hitachi H-8300 version of GNU assemblyia64Intel Itanium 64fasmFlat assembly (https://flatassembler.net)masmMicrosoft assembly (.masm files are compiled withMicrosoft's Macro Assembler. This is only supportedfor x86, x86_64, ARM and AARCH64 CPU families)nasmNetwide assemblytasmTurbo Assembly (with opcodes 80x86 up to Pentium, andMMX)picPIC assembly (currently for PIC16F84)
The most flexible is to add a line in your assembly file containing:
asmsyntax=nasm
Replace "nasm" with the name of the real assembly syntax. This line must beone of the first five lines in the file. No non-white text must beimmediately before or after this text. Note that specifying asmsyntax=foo isequivalent to setting ft=foo in amodeline, and that in case of a conflictbetween the two settings the one from the modeline will take precedence (inparticular, if you have ft=asm in the modeline, you will get the GNU syntaxhighlighting regardless of what is specified as asmsyntax).
The syntax type can always be overruled for a specific buffer by setting theb:asmsyntax variable:
:let b:asmsyntax = "nasm"
If b:asmsyntax is not set, either automatically or by hand, then the value ofthe global variable asmsyntax is used.This can be seen as a default assemblylanguage:
:let asmsyntax = "nasm"
As a last resort, if nothing is defined, the "asm" syntax is used.
Netwide assembler (nasm.vim) optional highlighting
To enable a feature:
:let   {variable}=1|set syntax=nasm
To disable a feature:
:unlet {variable}  |set syntax=nasm
VariableHighlight
nasm_loose_syntaxunofficial parser allowed syntax not as Error (parser dependent; not recommended)nasm_ctx_outside_macrocontexts outside macro not as Errornasm_no_warnpotentially risky syntax not as ToDo

ASTROft-astro-syntax

Configuration
The following variables control certain syntax highlighting features.You can add them to your .vimrc.
To enable TypeScript and TSX for ".astro" files (default "disable"):
let g:astro_typescript = "enable"
To enable Stylus for ".astro" files (default "disable"):
let g:astro_stylus = "enable"
NOTE: You need to install an external plugin to support stylus in astro files.

ASPPERLft-aspperl-syntax

ASPVBSft-aspvbs-syntax

*.asp and*.asa files could be either Perl or Visual Basic script. Since it'shard to detect this you can set two global variables to tell Vim what you areusing.For Perl script use:
:let g:filetype_asa = "aspperl":let g:filetype_asp = "aspperl"
For Visual Basic use:
:let g:filetype_asa = "aspvbs":let g:filetype_asp = "aspvbs"

ASYMPTOTEft-asy-syntax

By default, only basic Asymptote keywords are highlighted. To highlightextended geometry keywords:
:let g:asy_syn_plain = 1
and for highlighting keywords related to 3D constructions:
:let g:asy_syn_three = 1
By default, Asymptote-defined colors (e.g: lightblue) are highlighted. Tohighlight TeX-defined colors (e.g: BlueViolet) use:
:let g:asy_syn_texcolors = 1
or for Xorg colors (e.g: AliceBlue):
:let g:asy_syn_x11colors = 1

BAANbaan-syntax

The baan.vim gives syntax support for BaanC of release BaanIV up to SSA ERP LNfor both 3 GL and 4 GL programming. Large number of standarddefines/constants are supported.
Some special violation of coding standards will be signalled when one specifyin onesinit.vim:
let baan_code_stds=1
baan-folding
Syntax folding can be enabled at various levels through the variablesmentioned below (Set those in yourinit.vim). The more complex folding onsource blocks and SQL can be CPU intensive.
To allow any folding and enable folding at function level use:
let baan_fold=1
Folding can be enabled at source block level as if, while, for ,... Theindentation preceding the begin/end keywords has to match (spaces are notconsidered equal to a tab).
let baan_fold_block=1
Folding can be enabled for embedded SQL blocks as SELECT, SELECTDO,SELECTEMPTY, ... The indentation preceding the begin/end keywords has tomatch (spaces are not considered equal to a tab).
let baan_fold_sql=1
Note: Block folding can result in many small folds. It is suggested to:setthe options'foldminlines' and'foldnestmax' ininit.vim or use:setlocalin .../after/syntax/baan.vim (seeafter-directory). Eg:
set foldminlines=5set foldnestmax=6

BASICft-basic-syntaxft-vb-syntax

Both Visual Basic and "normal" BASIC use the extension ".bas".To detectwhich one should be used, Vim checks for the string "VB_Name" in the firstfive lines of the file. If it is not found, filetype will be "basic",otherwise "vb". Files with the ".frm" extension will always be seen as VisualBasic.
If the automatic detection doesn't work for you or you only edit, forexample, FreeBASIC files, use this in your startup vimrc:
:let filetype_bas = "freebasic"
Cft-c-syntax
A few things in C highlighting are optional. To enable them assign any value(including zero) to the respective variable. Example:
:let c_comment_strings = 1:let c_no_bracket_error = 0
To disable them use:unlet. Example:
:unlet c_comment_strings
Setting the value to zero doesn't work!
An alternative is to switch to the C++ highlighting:
:set filetype=cpp
VariableHighlight
c_gnu GNU gcc specific itemsc_comment_strings strings and numbers inside a commentc_space_errors trailing white space and spaces before a<Tab>c_no_trail_space_error ... but no trailing spacesc_no_tab_space_error ... but no spaces before a<Tab>c_no_bracket_error don't highlight {}; inside [] as errorsc_no_curly_error don't highlight {}; inside [] and () as errors; ...except { and } in first columnDefault is to highlight them, otherwise youcan't spot a missing ")".c_curly_error highlight a missing } by finding all pairs; thisforces syncing from the start of the file, can be slowc_no_ansi don't do standard ANSI types and constantsc_ansi_typedefs ... but do standard ANSI typesc_ansi_constants ... but do standard ANSI constantsc_no_utf don't highlight \u and \U in stringsc_syntax_for_h for*.h files use C syntax instead of C++ and use objcsyntax instead of objcppc_no_if0 don't highlight "#if 0" blocks as commentsc_no_cformat don't highlight %-formats in stringsc_no_c99 don't highlight C99 standard itemsc_no_c11 don't highlight C11 standard itemsc_no_c23 don't highlight C23 standard itemsc_no_bsd don't highlight BSD specific typesc_functions highlight function calls and definitionsc_function_pointers highlight function pointers definitions
When'foldmethod' is set to "syntax" then/* */ comments and { } blocks willbecome a fold. If you don't want comments to become a fold use:
:let c_no_comment_fold = 1
"#if 0" blocks are also folded, unless:
:let c_no_if0_fold = 1
If you notice highlighting errors while scrolling backwards, which are fixedwhen redrawing withCTRL-L, try setting the "c_minlines" internal variableto a larger number:
:let c_minlines = 100
This will make the syntax synchronization start 100 lines before the firstdisplayed line. The default value is 50 (15 when c_no_if0 is set). Thedisadvantage of using a larger number is that redrawing can become slow.
When using the "#if 0" / "#endif" comment highlighting, notice that this onlyworks when the "#if 0" is within "c_minlines" from the top of the window. Ifyou have a long "#if 0" construct it will not be highlighted correctly.
To match extra items in comments, use the cCommentGroup cluster.Example:
:au Syntax c call MyCadd():function MyCadd():  syn keyword cMyItem contained Ni:  syn cluster cCommentGroup add=cMyItem:  hi link cMyItem Title:endfun
ANSI constants will be highlighted with the "cConstant" group.This includes"NULL", "SIG_IGN" and others. But not "TRUE", for example, because this isnot in the ANSI standard. If you find this confusing, remove the cConstanthighlighting:
:hi link cConstant NONE
If you see '{' and '}' highlighted as an error where they are OK, reset thehighlighting for cErrInParen and cErrInBracket.
If you want to use folding in your C files, you can add these lines in a filein the "after" directory in'runtimepath'. For Unix this would be~/.config/nvim/after/syntax/c.vim.
syn sync fromstartset foldmethod=syntax

CANGJIEft-cangjie-syntax

This file provides syntax highlighting for the Cangjie programming language, anew-generation language oriented to full-scenario intelligence.
All highlighting is enabled by default. To disable highlighting for aspecific group, set the corresponding variable to 0 in yourvimrc.All options to disable highlighting are:
:let g:cangjie_comment_color = 0:let g:cangjie_identifier_color = 0:let g:cangjie_keyword_color = 0:let g:cangjie_macro_color = 0:let g:cangjie_number_color = 0:let g:cangjie_operator_color = 0:let g:cangjie_string_color = 0:let g:cangjie_type_color = 0

CHft-ch-syntax

C/C++ interpreter. Ch has similar syntax highlighting to C and builds uponthe C syntax file. Seeft-c-syntax for all the settings that are availablefor C.
By setting a variable you can tell Vim to use Ch syntax for*.h files, insteadof C or C++:
:let ch_syntax_for_h = 1

CHILLft-chill-syntax

Chill syntax highlighting is similar to C. Seeft-c-syntax for all thesettings that are available. Additionally there is:
chill_space_errorslike c_space_errorschill_comment_stringlike c_comment_stringschill_minlineslike c_minlines

CHANGELOGft-changelog-syntax

ChangeLog supports highlighting spaces at the start of a line.If you do not like this, add following line to your vimrc:
let g:changelog_spacing_errors = 0
This works the next time you edit a changelog file. You can also use"b:changelog_spacing_errors" to set this per buffer (before loading the syntaxfile).
You can change the highlighting used, e.g., to flag the spaces as an error:
:hi link ChangelogError Error
Or to avoid the highlighting:
:hi link ChangelogError NONE
This works immediately.

CLOJUREft-clojure-syntax

g:clojure_syntax_keywords
Syntax highlighting of public vars in "clojure.core" is provided by default,but additional symbols can be highlighted by adding them to theg:clojure_syntax_keywords variable. The value should be aDictionary ofsyntax group names, each containing aList of identifiers.
let g:clojure_syntax_keywords = {    \   'clojureMacro': ["defproject", "defcustom"],    \   'clojureFunc': ["string/join", "string/replace"]    \ }
Refer to the Clojure syntax script for valid syntax group names.
There is alsob:clojure_syntax_keywords which is a buffer-local variant ofthis variable intended for use by plugin authors to highlight symbolsdynamically.
By setting theb:clojure_syntax_without_core_keywords variable, vars from"clojure.core" will not be highlighted by default. This is useful fornamespaces that have set(:refer-clojure :only [])
g:clojure_fold
Settingg:clojure_fold to1 will enable the folding of Clojure code. Anylist, vector or map that extends over more than one line can be folded usingthe standard Vimfold-commands.
g:clojure_discard_macro
Set this variable to1 to enable basic highlighting of Clojure's "discardreader macro".
#_(defn foo [x]    (println x))
Note that this option will not correctly highlight stacked discard macros(e.g.#_#_).

COBOLft-cobol-syntax

COBOL highlighting has different needs for legacy code than it does for freshdevelopment. This is due to differences in what is being done (maintenanceversus development) and other factors.To enable legacy code highlighting,add this line to your vimrc:
:let cobol_legacy_code = 1
To disable it again, use this:
:unlet cobol_legacy_code

COLD FUSIONft-coldfusion-syntax

The ColdFusion has its own version of HTML comments. To turn on ColdFusioncomment highlighting, add the following line to your startup file:
:let html_wrong_comments = 1
The ColdFusion syntax file is based on the HTML syntax file.

CPPft-cpp-syntax

Most things are the same asft-c-syntax.
VariableHighlight
cpp_no_cpp11don't highlight C++11 standard itemscpp_no_cpp14don't highlight C++14 standard itemscpp_no_cpp17don't highlight C++17 standard itemscpp_no_cpp20don't highlight C++20 standard items

CSHft-csh-syntax

This covers the shell named "csh". Note that on some systems tcsh is actuallyused.
Detecting whether a file is csh or tcsh is notoriously hard. Some systemssymlink /bin/csh to /bin/tcsh, making it almost impossible to distinguishbetween csh and tcsh. In case VIM guesses wrong you can set the"filetype_csh" variable. For using csh:g:filetype_csh
:let g:filetype_csh = "csh"
For using tcsh:
:let g:filetype_csh = "tcsh"
Any script with a tcsh extension or a standard tcsh filename (.tcshrc,tcsh.tcshrc, tcsh.login) will have filetype tcsh. All other tcsh/csh scriptswill be classified as tcsh, UNLESS the "filetype_csh" variable exists. If the"filetype_csh" variable exists, the filetype will be set to the value of thevariable.

CSVft-csv-syntax

If you change the delimiter of a CSV file, its syntax highlighting will nolonger match the changed file content. You will need to unlet the followingvariable:
:unlet b:csv_delimiter
And afterwards save and reload the file:
:w:e
Now the syntax engine should determine the newly changed CSV delimiter.

CYNLIBft-cynlib-syntax

Cynlib files are C++ files that use the Cynlib class library to enablehardware modelling and simulation using C++. Typically Cynlib files have a.cc or a .cpp extension, which makes it very difficult to distinguish themfrom a normal C++ file. Thus, to enable Cynlib highlighting for .cc files,add this line to your vimrc file:
:let cynlib_cyntax_for_cc=1
Similarly for cpp files (this extension is only usually used in Windows)
:let cynlib_cyntax_for_cpp=1
To disable these again, use this:
:unlet cynlib_cyntax_for_cc:unlet cynlib_cyntax_for_cpp

CWEBft-cweb-syntax

Files matching "*.w" could be Progress or cweb. If the automatic detectiondoesn't work for you, or you don't edit Progress at all, use this in yourstartup vimrc:
:let filetype_w = "cweb"

CSHARPft-cs-syntax

C# raw string literals may use any number of quote marks to encapsulate theblock, and raw interpolated string literals may use any number of braces toencapsulate the interpolation, e.g.
$$$""""Hello {{{name}}}""""
By default, Vim highlights 3-8 quote marks, and 1-8 interpolation braces.The maximum numbers of quotes and braces recognized can configured using thefollowing variables:
VariableDefault
g:cs_raw_string_quote_count8 g:cs_raw_string_interpolation_brace_count8

DARTft-dart-syntax

Dart is an object-oriented, typed, class defined, garbage collected languageused for developing mobile, desktop, web, and back-end applications. Dartuses a C-like syntax derived from C, Java, and JavaScript, with featuresadopted from Smalltalk, Python, Ruby, and others.
More information about the language and its development environment at theofficial Dart language website athttps://dart.dev
dart.vim syntax detects and highlights Dart statements, reserved words,type declarations, storage classes, conditionals, loops, interpolated values,and comments. There is no support idioms from Flutter or any other Dartframework.
Changes, fixes? Submit an issue or pull request via:
https://github.com/pr3d4t0r/dart-vim-syntax/

DESKTOPft-desktop-syntax

Primary goal of this syntax file is to highlight .desktop and .directory filesaccording to freedesktop.org standard:https://specifications.freedesktop.org/desktop-entry-spec/latest/To highlight nonstandard extensions that does not begin with X-, set
let g:desktop_enable_nonstd = 1
Note that this may cause wrong highlight.To highlight KDE-reserved features, set
let g:desktop_enable_kde = 1
g:desktop_enable_kde follows g:desktop_enable_nonstd if not supplied

DIFFdiff.vim

The diff highlighting normally finds translated headers. This can be slow ifthere are very long lines in the file. To disable translations:
:let diff_translations = 0
Also seediff-slow.

DIRCOLORSft-dircolors-syntax

The dircolors utility highlighting definition has one option. It exists toprovide compatibility with the Slackware GNU/Linux distributions version ofthe command. It adds a few keywords that are generally ignored by mostversions. On Slackware systems, however, the utility accepts the keywords anduses them for processing. To enable the Slackware keywords add the followingline to your startup file:
let dircolors_is_slackware = 1

DOCBOOKft-docbk-syntaxdocbook

DOCBOOK XMLft-docbkxml-syntax

DOCBOOK SGMLft-docbksgml-syntax

There are two types of DocBook files: SGML and XML. To specify what type youare using the "b:docbk_type" variable should be set. Vim does this for youautomatically if it can recognize the type. When Vim can't guess it the typedefaults to XML.You can set the type manually:
:let docbk_type = "sgml"
or:
:let docbk_type = "xml"
You need to do this before loading the syntax file, which is complicated.Simpler is setting the filetype to "docbkxml" or "docbksgml":
:set filetype=docbksgml
or:
:set filetype=docbkxml
You can specify the DocBook version:
:let docbk_ver = 3
When not set 4 is used.

DOSBATCHft-dosbatch-syntax

Select the set of Windows Command interpreter extensions that should besupported with the variable dosbatch_cmdextversion. For versions of WindowsNT (before Windows 2000) this should have the value of 1. For Windows 2000and later it should be 2.Select the version you want with the following line:
:let dosbatch_cmdextversion = 1
If this variable is not defined it defaults to a value of 2 to supportWindows 2000 and later.
The original MS-DOS supports an idiom of using a double colon (::) as analternative way to enter a comment line. This idiom can be used with thecurrent Windows Command Interpreter, but it can lead to problems when usedinside ( ... ) command blocks. You can find a discussion about this onStack Overflow -
https://stackoverflow.com/questions/12407800/which-comment-style-should-i-use-in-batch-files
To allow the use of the :: idiom for comments in command blocks with theWindows Command Interpreter set the dosbatch_colons_comment variable toanything:
:let dosbatch_colons_comment = 1
If this variable is set then a :: comment that is the last line in a commandblock will be highlighted as an error.
There is an option that covers whether*.btm files should be detected as type"dosbatch" (MS-DOS batch files) or type "btm" (4DOS batch files). The latteris used by default. You may select the former with the following line:
:let g:dosbatch_syntax_for_btm = 1
If this variable is undefined or zero, btm syntax is selected.

DOXYGENdoxygen-syntax

Doxygen generates code documentation using a special documentation format(similar to Javadoc). This syntax script adds doxygen highlighting to c, cpp,idl and php files, and should also work with java.
There are a few of ways to turn on doxygen formatting. It can be doneexplicitly or in a modeline by appending '.doxygen' to the syntax of the file.Example:
:set syntax=c.doxygen
or
// vim:syntax=c.doxygen
It can also be done automatically for C, C++, C#, IDL and PHP files by settingthe global or buffer-local variable load_doxygen_syntax. This is done byadding the following to your vimrc.
:let g:load_doxygen_syntax=1
There are a couple of variables that have an effect on syntax highlighting,and are to do with non-standard highlighting options.
VariableDefaultEffect
g:doxygen_enhanced_colorg:doxygen_enhanced_colour0Use non-standard highlighting fordoxygen comments.
doxygen_my_rendering0Disable rendering of HTML bold, italicand html_my_rendering underline.
doxygen_javadoc_autobrief1Set to 0 to disable javadoc autobriefcolour highlighting.
doxygen_end_punctuation'[.]'Set to regexp match for the endingpunctuation of brief
There are also some highlight groups worth mentioning as they can be useful inconfiguration.
HighlightEffect
doxygenErrorCommentThe colour of an end-comment when missingpunctuation in a code, verbatim or dot sectiondoxygenLinkErrorThe colour of an end-comment when missing the\endlink from a \link section.

DTDft-dtd-syntax

The DTD syntax highlighting is case sensitive by default. To disablecase-sensitive highlighting, add the following line to your startup file:
:let dtd_ignore_case=1
The DTD syntax file will highlight unknown tags as errors. Ifthis is annoying, it can be turned off by setting:
:let dtd_no_tag_errors=1
before sourcing the dtd.vim syntax file.Parameter entity names are highlighted in the definition using the'Type' highlighting group and 'Comment' for punctuation and '%'.Parameter entity instances are highlighted using the 'Constant'highlighting group and the 'Type' highlighting group for thedelimiters % and ;. This can be turned off by setting:
:let dtd_no_param_entities=1
The DTD syntax file is also included by xml.vim to highlight included dtd's.

EIFFELft-eiffel-syntax

While Eiffel is not case-sensitive, its style guidelines are, and thesyntax highlighting file encourages their use. This also allows tohighlight class names differently. If you want to disable case-sensitivehighlighting, add the following line to your startup file:
:let eiffel_ignore_case=1
Case still matters for class names and TODO marks in comments.
Conversely, for even stricter checks, add one of the following lines:
:let eiffel_strict=1:let eiffel_pedantic=1
Setting eiffel_strict will only catch improper capitalization for thefive predefined words "Current", "Void", "Result", "Precursor", and"NONE", to warn against their accidental use as feature or class names.
Setting eiffel_pedantic will enforce adherence to the Eiffel styleguidelines fairly rigorously (like arbitrary mixes of upper- andlowercase letters as well as outdated ways to capitalize keywords).
If you want to use the lower-case version of "Current", "Void","Result", and "Precursor", you can use
:let eiffel_lower_case_predef=1
instead of completely turning case-sensitive highlighting off.
Support for ISE's proposed new creation syntax that is alreadyexperimentally handled by some compilers can be enabled by:
:let eiffel_ise=1
Finally, some vendors support hexadecimal constants. To handle them, add
:let eiffel_hex_constants=1
to your startup file.

EUPHORIAft-euphoria-syntax

Two syntax highlighting files exist for Euphoria. One for Euphoriaversion 3.1.1, which is the default syntax highlighting file, and one forEuphoria version 4.0.5 or later.
Euphoria version 3.1.1 (https://www.rapideuphoria.com/ link seems dead) isstill necessary for developing applications for the DOS platform, whichEuphoria version 4 (https://www.openeuphoria.org/) does not support.
The following file extensions are auto-detected as Euphoria file type:
*.e, *.eu, *.ew, *.ex, *.exu, *.exw*.E, *.EU, *.EW, *.EX, *.EXU, *.EXW
To select syntax highlighting file for Euphoria, as well as forauto-detecting the*.e and*.E file extensions as Euphoria file type,add the following line to your startup file:
:let g:filetype_euphoria = "euphoria3"
or
:let g:filetype_euphoria = "euphoria4"
Elixir and Euphoria share the*.ex file extension. If the filetype isspecifically set as Euphoria with the g:filetype_euphoria variable, or thefile is determined to be Euphoria based on keywords in the file, then thefiletype will be set as Euphoria. Otherwise, the filetype will default toElixir.

ERLANGft-erlang-syntax

Erlang is a functional programming language developed by Ericsson. Files withthe following extensions are recognized as Erlang files: erl, hrl, yaws.
Vim highlights triple-quoted docstrings as comments by default.
If you want triple-quoted docstrings highlighted as Markdown, add thefollowing line to yourvimrc:
:let g:erlang_use_markdown_for_docs = 1
The plain text inside the docstrings (that is, the characters that are nothighlighted by the Markdown syntax) is still highlighted as a comment.
If you want to highlight the plain text inside the docstrings using adifferent highlight group, add the following line to yourvimrc (theexample highlights plain text using the String highlight group):
:let g:erlang_docstring_default_highlight = 'String'
If you don't enable Markdown, this line highlights the full docstringsaccording to the specified highlight group.
Use the following line to disable highlighting for the plain text:
:let g:erlang_docstring_default_highlight = ''
Configuration examples:
" Highlight docstrings as Markdown.:let g:erlang_use_markdown_for_docs = 1" 1. Highlight Markdown elements in docstrings as Markdown." 2. Highlight the plain text in docstrings as String.:let g:erlang_use_markdown_for_docs = 1:let g:erlang_docstring_default_highlight = 'String'" Highlight docstrings as strings (no Markdown).:let g:erlang_docstring_default_highlight = 'String'" 1. Highlight Markdown elements in docstrings as Markdown." 2. Don't highlight the plain text in docstrings.:let g:erlang_use_markdown_for_docs = 1:let g:erlang_docstring_default_highlight = ''

ELIXIRft-elixir-syntax

Elixir is a dynamic, functional language for building scalable andmaintainable applications.
The following file extensions are auto-detected as Elixir file types:
*.ex, *.exs, *.eex, *.leex, *.lock
Elixir and Euphoria share the*.ex file extension. If the filetype isspecifically set as Euphoria with the g:filetype_euphoria variable, or thefile is determined to be Euphoria based on keywords in the file, then thefiletype will be set as Euphoria. Otherwise, the filetype will default toElixir.

FLEXWIKIft-flexwiki-syntax

FlexWiki is an ASP.NET-based wiki package available atwww.flexwiki.comNOTE: This site currently doesn't work, on Wikipedia is mentioned thatdevelopment stopped in 2009.
Syntax highlighting is available for the most common elements of FlexWikisyntax. The associated ftplugin script sets some buffer-local options to makeediting FlexWiki pages more convenient. FlexWiki considers a newline as thestart of a new paragraph, so the ftplugin sets'tw'=0 (unlimited line length),'wrap' (wrap long lines instead of using horizontal scrolling),'linebreak'(to wrap at a character in'breakat' instead of at the last char on screen),and so on. It also includes some keymaps that are disabled by default.
If you want to enable the keymaps that make "j" and "k" and the cursor keysmove up and down by display lines, add this to your vimrc:
:let flexwiki_maps = 1

FORMft-form-syntax

The coloring scheme for syntax elements in the FORM file uses the defaultmodes Conditional, Number, Statement, Comment, PreProc, Type, and String,following the language specifications in 'Symbolic Manipulation with FORM' byJ.A.M. Vermaseren, CAN, Netherlands, 1991.
If you want to include your own changes to the default colors, you have toredefine the following syntax groups:
formConditional
formNumber
formStatement
formHeaderStatement
formComment
formPreProc
formDirective
formType
formString
Note that the form.vim syntax file implements FORM preprocessor commands anddirectives per default in the same syntax group.
A predefined enhanced color mode for FORM is available to distinguish betweenheader statements and statements in the body of a FORM program. To activatethis mode define the following variable in your vimrc file
:let form_enhanced_color=1
The enhanced mode also takes advantage of additional color features for a darkgvim display. Here, statements are colored LightYellow instead of Yellow, andconditionals are LightBlue for better distinction.
Both Visual Basic and FORM use the extension ".frm". To detect which oneshould be used, Vim checks for the string "VB_Name" in the first five lines ofthe file. If it is found, filetype will be "vb", otherwise "form".
If the automatic detection doesn't work for you or you only edit, forexample, FORM files, use this in your startup vimrc:
:let filetype_frm = "form"

FORTHft-forth-syntax

Files matching "*.f" could be Fortran or Forth and those matching "*.fs" couldbe F# or Forth. If the automatic detection doesn't work for you, or you don'tedit F# or Fortran at all, use this in your startup vimrc:
:let filetype_f  = "forth":let filetype_fs = "forth"

FORTRANft-fortran-syntax

Default highlighting and dialect
Vim highlights according to Fortran 2023 (the most recent standard). Thischoice should be appropriate for most users most of the time because Fortran2023 is almost a superset of previous versions (Fortran 2018, 2008, 2003, 95,90, 77, and 66). A few legacy constructs deleted or declared obsolescent,respectively, in recent Fortran standards are highlighted as errors and todoitems.
The syntax script no longer supports Fortran dialects. The variablefortran_dialect is now silently ignored. Since computers are much faster now,the variable fortran_more_precise is no longer needed and is silently ignored.
Fortran source code form
Fortran code can be in either fixed or free source form. Note that thesyntax highlighting will not be correct if the form is incorrectly set.
When you create a new Fortran file, the syntax script assumes fixed sourceform. If you always use free source form, then
:let fortran_free_source=1
If you always use fixed source form, then
:let fortran_fixed_source=1
If the form of the source code depends, in a non-standard way, upon the fileextension, then it is most convenient to set fortran_free_source in a ftpluginfile. For more information on ftplugin files, seeftplugin. Note that thiswill work only if the "filetype plugin indent on" command precedes the "syntaxon" command in your .vimrc file.
When you edit an existing Fortran file, the syntax script will assume freesource form if the fortran_free_source variable has been set, and assumesfixed source form if the fortran_fixed_source variable has been set. Supposeneither of these variables have been set. In that case, the syntax scriptattempts to determine which source form has been used by examining the fileextension using conventions common to the ifort, gfortran, Cray, NAG, andPathScale compilers (.f, .for, .f77 for fixed-source, .f90, .f95, .f03, .f08for free-source). No default is used for the .fpp and .ftn file extensionsbecause different compilers treat them differently. If none of this works,then the script examines the first five columns of the first 500 lines of yourfile. If no signs of free source form are detected, then the file is assumedto be in fixed source form. The algorithm should work in the vast majority ofcases. In some cases, such as a file that begins with 500 or more full-linecomments, the script may incorrectly decide that the code is in fixed form.If that happens, just add a non-comment statement beginning anywhere in thefirst five columns of the first twenty-five lines, save (:w), and then reload(:e!) the file.
Vendor extensions
Fixed-form Fortran requires a maximum line length of 72 characters but thescript allows a maximum line length of 80 characters as do all compilerscreated in the last three decades. An even longer line length of 132characters is allowed if you set the variable fortran_extended_line_lengthwith a command such as
:let fortran_extended_line_length=1
If you want additional highlighting of the CUDA Fortran extensions, you shouldset the variable fortran_CUDA with a command such as
:let fortran_CUDA=1
To activate recognition of some common, non-standard, vendor-suppliedintrinsics, you should set the variable fortran_vendor_intrinsics with acommand such as
:let fortran_vendor_intrinsics=1
Tabs in Fortran files
Tabs are not recognized by the Fortran standards. Tabs are not a good idea infixed format Fortran source code which requires fixed column boundaries.Therefore, tabs are marked as errors. Nevertheless, some programmers likeusing tabs. If your Fortran files contain tabs, then you should set thevariable fortran_have_tabs in your vimrc with a command such as
:let fortran_have_tabs=1
Unfortunately, the use of tabs will mean that the syntax file will not be ableto detect incorrect margins.
Syntax folding of Fortran files
Vim will fold your file using foldmethod=syntax, if you set the variablefortran_fold in your .vimrc with a command such as
:let fortran_fold=1
to instruct the syntax script to define fold regions for program units, thatis main programs starting with a program statement, subroutines, functionsubprograms, modules, submodules, blocks of comment lines, and block dataunits. Block, interface, associate, critical, type definition, and changeteam constructs will also be folded. If you also set the variablefortran_fold_conditionals with a command such as
:let fortran_fold_conditionals=1
then fold regions will also be defined for do loops, if blocks, select case,select type, and select rank constructs. Note that defining fold regions canbe slow for large files.
The syntax/fortran.vim script contains embedded comments that tell you how tocomment and/or uncomment some lines to (a) activate recognition of somenon-standard, vendor-supplied intrinsics and (b) to prevent features deletedor declared obsolescent in the 2008 standard from being highlighted as todoitems.
Limitations
Parenthesis checking does not catch too few closing parentheses. Hollerithstrings are not recognized. Some keywords may be highlighted incorrectlybecause Fortran90 has no reserved words.
For further information related to Fortran, seeft-fortran-indent andft-fortran-plugin.

FREEBASICft-freebasic-syntax

FreeBASIC files will be highlighted differently for each of the four availabledialects, "fb", "qb", "fblite" and "deprecated". Seeft-freebasic-pluginfor how to select the correct dialect.
Highlighting is further configurable via the following variables.
VariableHighlight
freebasic_no_comment_fold disable multiline comment foldingfreebasic_operators non-alpha operatorsfreebasic_space_errors trailing white space and spaces before a<Tab>freebasic_type_suffixes QuickBASIC style type suffixes

FVWM CONFIGURATION FILESft-fvwm-syntax

In order for Vim to recognize Fvwm configuration files that do not matchthe patternsfvwmrc orfvwm2rc , you must put additional patternsappropriate to your system in your myfiletypes.vim file. For thesepatterns, you must set the variable "b:fvwm_version" to the major versionnumber of Fvwm, and the'filetype' option to fvwm.
For example, to make Vim identify all files in /etc/X11/fvwm2/as Fvwm2 configuration files, add the following:
:au! BufNewFile,BufRead /etc/X11/fvwm2/*  let b:fvwm_version = 2 |                                       \ set filetype=fvwm

GSPft-gsp-syntax

The default coloring style for GSP pages is defined byft-html-syntax, andthe coloring for java code (within java tags or inline between backticks) isdefined byft-java-syntax. The following HTML groups defined inft-html-syntax are redefined to incorporate and highlight inline java code:
htmlString htmlValue htmlEndTag htmlTag htmlTagN
Highlighting should look fine most of the places where you'd see inlinejava code, but in some special cases it may not. To add another HTMLgroup where you will have inline java code where it does not highlightcorrectly, just copy the line you want fromft-html-syntax and add gspJavato the contains clause.
The backticks for inline java are highlighted according to the htmlErrorgroup to make them easier to see.

GROFFft-groff-syntax

The groff syntax file is a wrapper forft-nroff-syntax, see the notesunder that heading for examples of use and configuration. The purposeof this wrapper is to set up groff syntax extensions by setting thefiletype from amodeline or in a personal filetype definitions file(seefiletype.txt).

HASKELLft-haskell-syntax

The Haskell syntax files support plain Haskell code as well as literateHaskell code, the latter in both Bird style and TeX style. The Haskellsyntax highlighting will also highlight C preprocessor directives.
If you want to highlight delimiter characters (useful if you have alight-coloured background), add to your vimrc:
:let hs_highlight_delimiters = 1
To treat True and False as keywords as opposed to ordinary identifiers,add:
:let hs_highlight_boolean = 1
To also treat the names of primitive types as keywords:
:let hs_highlight_types = 1
And to treat the names of even more relatively common types as keywords:
:let hs_highlight_more_types = 1
If you want to highlight the names of debugging functions, put inyour vimrc:
:let hs_highlight_debug = 1
The Haskell syntax highlighting also highlights C preprocessordirectives, and flags lines that start with # but are not validdirectives as erroneous. This interferes with Haskell's syntax foroperators, as they may start with #. If you want to highlight thoseas operators as opposed to errors, put in your vimrc:
:let hs_allow_hash_operator = 1
The syntax highlighting for literate Haskell code will try toautomatically guess whether your literate Haskell code containsTeX markup or not, and correspondingly highlight TeX constructsor nothing at all. You can override this globally by puttingin your vimrc
:let lhs_markup = none
for no highlighting at all, or
:let lhs_markup = tex
to force the highlighting to always try to highlight TeX markup.For more flexibility, you may also use buffer local versions ofthis variable, so e.g.
:let b:lhs_markup = tex
will force TeX highlighting for a particular buffer. It has to beset before turning syntax highlighting on for the buffer orloading a file.

HTMLft-html-syntax

The coloring scheme for tags in the HTML file works as follows.
The <> of opening tags are colored differently than the </> of a closing tag.This is on purpose! For opening tags the 'Function' color is used, while forclosing tags the 'Identifier' color is used (See syntax.vim to check how thoseare defined for you)
Known tag names are colored the same way as statements in C. Unknown tagnames are colored with the same color as the <> or </> respectively whichmakes it easy to spot errors
Note that the same is true for argument (or attribute) names. Known attributenames are colored differently than unknown ones.
Some HTML tags are used to change the rendering of text. The following tagsare recognized by the html.vim syntax coloring file and change the way normaltext is shown:<B><I><U><EM><STRONG> (<EM> is used as an alias for<I>,while<STRONG> as an alias for<B>),<H1> -<H6>,<HEAD>,<TITLE> and<A>, butonly if used as a link (that is, it must include a href as in<A href="somefile.html">).
If you want to change how such text is rendered, you must redefine thefollowing syntax groups:
htmlBold
htmlBoldUnderline
htmlBoldUnderlineItalic
htmlUnderline
htmlUnderlineItalic
htmlItalic
htmlTitle for titles
htmlH1 - htmlH6 for headings
To make this redefinition work you must redefine them all with the exceptionof the last two (htmlTitle and htmlH[1-6], which are optional) and define thefollowing variable in your vimrc (this is due to the order in which the filesare read during initialization)
:let html_my_rendering=1
If you'd like to see an example download mysyntax.vim athttps://web.archive.org/web/20241129015117/https://www.fleiner.com/vim/download.html
You can also disable this rendering by adding the following line to yourvimrc file:
:let html_no_rendering=1
By default Vim synchronises the syntax to 250 lines before the first displayedline. This can be configured using:
:let html_minlines = 500
HTML comments are rather special (see an HTML reference document for thedetails), and the syntax coloring scheme will highlight all errors.However, if you prefer to use the wrong style (starts with <!-- andends with -->) you can define
:let html_wrong_comments=1
JavaScript and Visual Basic embedded inside HTML documents are highlighted as'Special' with statements, comments, strings and so on colored as in standardprogramming languages. Note that only JavaScript and Visual Basic arecurrently supported, no other scripting language has been added yet.
Embedded and inlined cascading style sheets (CSS) are highlighted too.
There are several html preprocessor languages out there. html.vim has beenwritten such that it should be trivial to include it. To do so add thefollowing two lines to the syntax coloring file for that language(the example comes from the asp.vim file):
runtime! syntax/html.vimsyn cluster htmlPreproc add=asp
Now you just need to make sure that you add all regions that containthe preprocessor language to the cluster htmlPreproc.
html-folding
The HTML syntax file provides syntaxfolding (see:syn-fold) between startand end tags. This can be turned on by
:let g:html_syntax_folding = 1:set foldmethod=syntax
Note: Syntax folding might slow down syntax highlighting significantly,especially for large files.
HTML/OS (BY AESTIVA)ft-htmlos-syntax
The coloring scheme for HTML/OS works as follows:
Functions and variable names are the same color by default, because VIMdoesn't specify different colors for Functions and Identifiers. To changethis (which is recommended if you want function names to be recognizable in adifferent color) you need to add the following line to your vimrc:
:hi Function cterm=bold ctermfg=LightGray
Of course, the ctermfg can be a different color if you choose.
Another issues that HTML/OS runs into is that there is no special filetype tosignify that it is a file with HTML/OS coding.You can change this by openinga file and turning on HTML/OS syntax by doing the following:
:set syntax=htmlos
Lastly, it should be noted that the opening and closing characters to begin ablock of HTML/OS code can either be << or [[ and >> or ]], respectively.

IA64intel-itaniumft-ia64-syntax

Highlighting for the Intel Itanium 64 assembly language. Seeft-asm-syntaxfor how to recognize this filetype.
To have*.inc files be recognized as IA64, add this to your vimrc file:
:let g:filetype_inc = "ia64"

INFORMft-inform-syntax

Inform highlighting includes symbols provided by the Inform Library, asmost programs make extensive use of it. If do not wish Library symbolsto be highlighted add this to your vim startup:
:let inform_highlight_simple=1
By default it is assumed that Inform programs are Z-machine targeted,and highlights Z-machine assembly language symbols appropriately. Ifyou intend your program to be targeted to a Glulx/Glk environment youneed to add this to your startup sequence:
:let inform_highlight_glulx=1
This will highlight Glulx opcodes instead, and also adds glk() to theset of highlighted system functions.
The Inform compiler will flag certain obsolete keywords as errors whenit encounters them. These keywords are normally highlighted as errorsby Vim. To prevent such error highlighting, you must add this to yourstartup sequence:
:let inform_suppress_obsolete=1
By default, the language features highlighted conform to Compilerversion 6.30 and Library version 6.11. If you are using an olderInform development environment, you may with to add this to yourstartup sequence:
:let inform_highlight_old=1

IDLidl-syntax

IDL (Interface Definition Language) files are used to define RPC calls. InMicrosoft land, this is also used for defining COM interfaces and calls.
IDL's structure is simple enough to permit a full grammar based approach torather than using a few heuristics. The result is large and somewhatrepetitive but seems to work.
There are some Microsoft extensions to idl files that are here. Some of themare disabled by defining idl_no_ms_extensions.
The more complex of the extensions are disabled by defining idl_no_extensions.
VariableEffect
idl_no_ms_extensionsDisable some of the Microsoft specificextensionsidl_no_extensionsDisable complex extensionsidlsyntax_showerrorShow IDL errors (can be rather intrusive, butquite helpful)idlsyntax_showerror_softUse softer colours by default for errors

JAVAft-java-syntax

The java.vim syntax highlighting file offers several options.
In Java 1.0.2, it was never possible to have braces inside parens, so this wasflagged as an error. Since Java 1.1, this is possible (with anonymousclasses); and, therefore, is no longer marked as an error. If you prefer theold way, put the following line into your Vim startup file:
:let g:java_mark_braces_in_parens_as_errors = 1
All (exported) public types declared injava.lang are always automaticallyimported and available as simple names. To highlight them, use:
:let g:java_highlight_java_lang_ids = 1
You can also generate syntax items for other public and protected types andopt in to highlight some of their names; seejava-package-info-url.
Headers of indented function declarations can be highlighted (along with partsof lambda expressions and method reference expressions), but it depends on howyou write Java code. Two formats are recognized:
1) If you write function declarations that are consistently indented by eithera tab, or a space . . . or eight space character(s), you may want to set oneof
:let g:java_highlight_functions = "indent":let g:java_highlight_functions = "indent1":let g:java_highlight_functions = "indent2":let g:java_highlight_functions = "indent3":let g:java_highlight_functions = "indent4":let g:java_highlight_functions = "indent5":let g:java_highlight_functions = "indent6":let g:java_highlight_functions = "indent7":let g:java_highlight_functions = "indent8"
Note that in terms of'shiftwidth', this is the leftmost step of indentation.
2) However, if you follow the Java guidelines about how functions and typesare supposed to be named (with respect to upper- and lowercase) and there isany amount of indentation, you may want to set
:let g:java_highlight_functions = "style"
In addition, you can combine any value of "g:java_highlight_functions" with
:let g:java_highlight_signature = 1
to have the name of a function with its parameter list parens distinctlyhighlighted from its type parameters, return type, and formal parameters; andto have the parameter list parens of a lambda expression with its arrowdistinctly highlighted from its formal parameters or identifiers.
If neither setting does work for you, but you would still want headers offunction declarations to be highlighted, modify the current syntax definitionsor compose new ones.
Higher-order function types can be hard to parse by eye, so uniformly toningdown some of their components may be of value. Provided that such type namesconform to the Java naming guidelines, you may arrange it with
:let g:java_highlight_generics = 1
In Java 1.1, the functionsSystem.out.println() andSystem.err.println()should only be used for debugging. Consider adding the following definitionin your startup file:
:let g:java_highlight_debug = 1
to have the bulk of those statements colored as*Debug debugging statements,and to make some of their own items further grouped and linked:*Special as DebugSpecial,*String as DebugString,*Boolean as DebugBoolean,*Type as DebugType,which are used for special characters appearing in strings, strings proper,boolean literals, and special instance references (super,this,null),respectively.
Javadoc is a program that takes special comments out of Java program files andcreates HTML pages. The standard configuration will highlight this HTML codesimilarly to HTML files (seeft-html-syntax). You can even add JavaScriptand CSS inside this code (see below). The HTML rendering and the Markdownrendering diverge as follows: 1. The first sentence (all characters up to the first period., which is followed by a whitespace character or a line terminator, or up to the first block tag, e.g.@param,@return) is colored as*SpecialComment special comments. 2. The text is colored as*Comment comments. 3. HTML comments are colored as*Special special symbols. 4. The standard Javadoc tags (@code,@see, etc.) are colored as*Special special symbols and some of their arguments are colored as*Function function names.To turn this feature off for both HTML and Markdown, add the following line toyour startup file:
:let g:java_ignore_javadoc = 1
Alternatively, only suppress HTML comments or Markdown comments:
:let g:java_ignore_html = 1:let g:java_ignore_markdown = 1
Seeft-java-plugin for additional support available for Markdown comments.
If you use the special Javadoc comment highlighting described above, you canalso turn on special highlighting for JavaScript, Visual Basic scripts, andembedded CSS (stylesheets). This only makes sense if any of these languagesactually appear in Javadoc comments. The variables to use are
:let g:java_javascript = 1:let g:java_css = 1:let g:java_vb = 1
Note that these three variables are maintained in the HTML syntax file.
Numbers and strings can be recognized in non-Javadoc comments with
:let g:java_comment_strings = 1
When'foldmethod' is set to "syntax", multi-line blocks of code ("b"), plaincomments ("c"), Javadoc comments ("d"), and adjacent "import" declarations("i") will be folded by default. Syntax items of any supported kind willremain NOT foldable when its abbreviated name is delisted with
:let g:java_ignore_folding = "bcdi"
No text is usually written in the first line of a multi-line comment, makingfolded contents of Javadoc comments less informative with the default'foldtext' value; you may opt for showing the contents of a second line forany comments written in this way, and showing the contents of a first lineotherwise, with
:let g:java_foldtext_show_first_or_second_line = 1
HTML tags in Javadoc comments can additionally be folded by following theinstructions listed underhtml-folding and giving explicit consent with
:let g:java_consent_to_html_syntax_folding = 1
Do not default to this kind of folding unless ALL start tags and optional endtags are balanced in Javadoc comments; otherwise, put up with creating runawayfolds that break syntax highlighting.
Trailing whitespace characters or a run of space characters before a tabcharacter can be marked as an error with
:let g:java_space_errors = 1
but either kind of an error can be suppressed by also defining one of
:let g:java_no_trail_space_error = 1:let g:java_no_tab_space_error = 1
In order to highlight nested parens with different colors, define colors forjavaParen,javaParen1, andjavaParen2. For example,
:hi link javaParen Comment
or
:hi javaParen ctermfg=blue guifg=#0000ff
Certain modifiers are incompatible with each other, e.g.abstract andfinal:
:syn list javaConceptKind
and can be differently highlighted as a group than other modifiers with
:hi link javaConceptKind NonText
All instances of variable-width lookbehind assertions (/\@<! and/\@<=),resorted to in syntax item definitions, are confined to arbitrary byte counts.Another arbitrary value can be selected for a related group of definitions.For example:
:let g:java_lookbehind_byte_counts = {'javaMarkdownCommentTitle': 240}
Where each key name of this dictionary is the name of a syntax item. The useof these assertions in syntax items may vary among revisions, so no definitiveset of supported key names is committed to.
If you notice highlighting errors while scrolling backwards, which are fixedwhen redrawing withCTRL-L, try setting the "g:java_minlines" variable toa larger number:
:let g:java_minlines = 50
This will make the syntax synchronization start 50 lines before the firstdisplayed line. The default value is 10. The disadvantage of using a largernumber is that redrawing can become slow.
Significant changes to the Java platform are gradually introduced in the formof JDK Enhancement Proposals (JEPs) that can be implemented for a release andoffered as its preview features. It may take several JEPs and a few releasecycles for such a feature to become either integrated into the platform orwithdrawn from this effort. To cater for early adopters, there is optionalsupport in Vim for syntax related preview features that are implemented. Youcan request it by specifying a list of preview feature numbers as follows:
:let g:java_syntax_previews = [507]
The supported JEP numbers are to be drawn from this table:430: String Templates [JDK 21]507: Primitive types in Patterns, instanceof, and switch
Note that as soon as the particular preview feature will have been integratedinto the Java platform, its entry will be removed from the table and relatedoptionality will be discontinued.java-package-info-url
https://github.com/zzzyxwvut/java-vim/blob/master/tools/javaid/src/javaid/package-info.java

JSONft-json-syntaxg:vim_json_conceal

g:vim_json_warnings
The json syntax file provides syntax highlighting with conceal support bydefault. To disable concealment:
let g:vim_json_conceal = 0
To disable syntax highlighting of errors:
let g:vim_json_warnings = 0

JQjq_quote_highlightft-jq-syntax

To disable numbers having their own color add the following to your vimrc:
hi link jqNumber Normal
If you want quotes to have different highlighting than strings
let g:jq_quote_highlight = 1

KCONFIGft-kconfig-syntax

Kconfig syntax highlighting language. For syntax syncing, you can configurethe following variable (default: 50):
let kconfig_minlines = 50
To configure a bit more (heavier) highlighting, set the following variable:
let kconfig_syntax_heavy = 1

LACEft-lace-syntax

Lace (Language for Assembly of Classes in Eiffel) is case insensitive, but thestyle guide lines are not. If you prefer case insensitive highlighting, justdefine the vim variable 'lace_case_insensitive' in your startup file:
:let lace_case_insensitive=1

LF (LFRC)ft-lf-syntaxg:lf_shell_syntax

b:lf_shell_syntax
For the lf file manager configuration files (lfrc) the shell commands syntaxhighlighting can be changed globally and per buffer by setting a different'include' command search pattern using these variables:
let g:lf_shell_syntax = "syntax/dosbatch.vim"let b:lf_shell_syntax = "syntax/zsh.vim"
These variables are unset by default.
The default'include' command search pattern is 'syntax/sh.vim'.

LEXft-lex-syntax

Lex uses brute-force synchronizing as the "^%%$" section delimitergives no clue as to what section follows. Consequently, the value for
:syn sync minlines=300
may be changed by the user if they are experiencing synchronizationdifficulties (such as may happen with large lex files).

LIFELINESft-lifelines-syntax

To highlight deprecated functions as errors, add in your vimrc:
:let g:lifelines_deprecated = 1

LISPft-lisp-syntax

The lisp syntax highlighting provides two options:
g:lisp_instring : If it exists, then "(...)" strings are highlighted                  as if the contents of the string were lisp.                  Useful for AutoLisp.g:lisp_rainbow  : If it exists and is nonzero, then differing levels                  of parenthesization will receive different                  highlighting.
The g:lisp_rainbow option provides 10 levels of individual colorization forthe parentheses and backquoted parentheses. Because of the quantity ofcolorization levels, unlike non-rainbow highlighting, the rainbow modespecifies its highlighting using ctermfg and guifg, thereby bypassing theusual color scheme control using standard highlighting groups. The actualhighlighting used depends on the dark/bright setting (see'bg').

LITEft-lite-syntax

There are two options for the lite syntax highlighting.
If you like SQL syntax highlighting inside Strings, use this:
:let lite_sql_query = 1
For syncing, minlines defaults to 100.If you prefer another value, you canset "lite_minlines" to the value you desire. Example:
:let lite_minlines = 200

LOGft-log-syntax

Vim comes with a simplistic generic log syntax highlighter. Because the logfile format is so generic, highlighting is not enabled by default, since itcan be distracting. If you want to enable this, simply set the "log" filetypemanually:
:set ft=log
To enable this automatically for "*.log" files, add the following to yourpersonalfiletype.vim file (usually located in~/.config/nvim/filetype.vimon Unix, see alsonew-filetype):
augroup filetypedetect  au! BufNewFile,BufRead *.logsetfiletype logaugroup END

LPCft-lpc-syntax

LPC stands for a simple, memory-efficient language: Lars Pensjö C. Thefile name of LPC is usually*.c. Recognizing these files as LPC would botherusers writing only C programs.If you want to use LPC syntax in Vim, youshould set a variable in your vimrc file:
:let lpc_syntax_for_c = 1
If it doesn't work properly for some particular C or LPC files, use amodeline. For a LPC file:
// vim:set ft=lpc:
For a C file that is recognized as LPC:
// vim:set ft=c:
If you don't want to set the variable, use the modeline in EVERY LPC file.
There are several implementations for LPC, we intend to support most widelyused ones. Here the default LPC syntax is for MudOS series, for MudOS v22and before, you should turn off the sensible modifiers, and this will alsoassert the new efuns after v22 to be invalid, don't set this variable whenyou are using the latest version of MudOS:
:let lpc_pre_v22 = 1
For LpMud 3.2 series of LPC:
:let lpc_compat_32 = 1
For LPC4 series of LPC:
:let lpc_use_lpc4_syntax = 1
For uLPC series of LPC:uLPC has been developed to Pike, so you should use Pike syntaxinstead, and the name of your source file should be*.pike

LUAft-lua-syntax

The Lua syntax file can be used for versions 4.0, 5.0+. You can select one ofthese versions using the global variablesg:lua_version andg:lua_subversion.

MAILft-mail.vim

Vim highlights all the standard elements of an email (headers, signatures,quoted text and URLs / email addresses). In keeping with standardconventions, signatures begin in a line containing only "--" followedoptionally by whitespaces and end with a newline.
Vim treats lines beginning with "]", "}", "|", ">" or a word followed by ">"as quoted text. However Vim highlights headers and signatures in quoted textonly if the text is quoted with ">" (optionally followed by one space).
By default mail.vim synchronises syntax to 100 lines before the firstdisplayed line. If you have a slow machine, and generally deal with emailswith short headers, you can change this to a smaller value:
:let mail_minlines = 30

MAKEft-make-syntax

In makefiles, commands are usually highlighted to make it easy for you to spoterrors. However, this may be too much coloring for you. You can turn thisfeature off by using:
:let make_no_commands = 1
Comments are also highlighted by default. You can turn this off by using:
:let make_no_comments = 1
There are various Make implementations, which add extensions other than thePOSIX specification and thus are mutually incompatible. If the filename isBSDmakefile or GNUmakefile, the corresponding implementation is automaticallydetermined; otherwise vim tries to detect it by the file contents. If you seeany wrong highlights because of this, you can enforce a flavor by setting oneof the following:
:let g:make_flavor = 'bsd'  " or:let g:make_flavor = 'gnu'  " or:let g:make_flavor = 'microsoft'

MAPLEft-maple-syntax

Maple V, by Waterloo Maple Inc, supports symbolic algebra. The languagesupports many packages of functions which are selectively loaded by the user.The standard set of packages' functions as supplied in Maple V release 4 maybe highlighted at the user's discretion. Users may place in their vimrcfile:
:let mvpkg_all= 1
to get all package functions highlighted, or users may select any subset bychoosing a variable/package from the table below and setting that variable to1, also in their vimrc file (prior to sourcing$VIMRUNTIME/syntax/syntax.vim).
Table of Maple V Package Function Selectors
mv_DEtools mv_genfuncmv_networksmv_processmv_Galois mv_geometrymv_numapproxmv_simplexmv_GaussInt mv_grobnermv_numtheorymv_statsmv_LREtools mv_groupmv_orthopolymv_studentmv_combinat mv_inttransmv_padicmv_sumtoolsmv_combstruct mv_liesymmmv_plotsmv_tensormv_difforms mv_linalgmv_plottoolsmv_totordermv_finance mv_logicmv_powseries

MARKDOWNft-markdown-syntaxg:markdown_minlines

g:markdown_fenced_languagesg:markdown_syntax_conceal
If you have long regions there may be incorrect highlighting. At the cost ofslowing down displaying, you can have the engine look further back to sync onthe start of a region, for example 500 lines (default is 50):
:let g:markdown_minlines = 500
If you want to enable fenced code block syntax highlighting in your Markdowndocuments, set the following variable:
:let g:markdown_fenced_languages = ['html', 'python', 'bash=sh']
To disable Markdown syntax concealing, add the following to your vimrc:
:let g:markdown_syntax_conceal = 0
For extended Markdown support with enhanced features such as citations,footnotes, mathematical formulas, academic writing elements and embedded codeblock highlighting, consider using the pandoc syntax plugin. Setg:filetype_md to "pandoc" and seeft-pandoc-syntax for configurationdetails.

MATHEMATICAft-mma-syntaxft-mathematica-syntax

Empty*.m files will automatically be presumed to be Matlab files unless youhave the following in your vimrc:
let filetype_m = "mma"

MBSYNCft-mbsync-syntax

The mbsync application uses a configuration file to setup mailboxes names,user and password. All files ending with.mbsyncrc or with the nameisyncrc will be recognized as mbsync configuration files.

MEDIAWIKIft-mediawiki-syntax

By default, syntax highlighting includes basic HTML tags like style andheadersft-html-syntax. For strict Mediawiki syntax highlighting:
let g:html_no_rendering = 1
If HTML highlighting is desired, terminal-based text formatting such as boldand italic is possible by:
let g:html_style_rendering = 1

MODULA2ft-modula2-syntax

Vim will recognise comments with dialect tags to automatically select a givendialect.
The syntax for a dialect tag comment is:
taggedComment :=  '(*!' dialectTag '*)'  ;dialectTag :=  m2pim | m2iso | m2r10  ;reserved words  m2pim = 'm2pim', m2iso = 'm2iso', m2r10 = 'm2r10'
A dialect tag comment is recognised by Vim if it occurs within the first 200lines of the source file. Only the very first such comment is recognised, anyadditional dialect tag comments are ignored.
Example:
DEFINITION MODULE FooLib; (*!m2pim*)...
Variable g:modula2_default_dialect sets the default Modula-2 dialect when thedialect cannot be determined from the contents of the Modula-2 file: ifdefined and set to 'm2pim', the default dialect is PIM.
Example:
let g:modula2_default_dialect = 'm2pim'
Highlighting is further configurable for each dialect via the followingvariables.
VariableHighlight
modula2_iso_allow_lowline allow low line in identifiersmodula2_iso_disallow_octals disallow octal integer literalsmodula2_iso_disallow_synonyms disallow "@", "&" and "~" synonyms
modula2_pim_allow_lowline allow low line in identifiersmodula2_pim_disallow_octals disallow octal integer literalsmodula2_pim_disallow_synonyms disallow "&" and "~" synonyms
modula2_r10_allow_lowline allow low line in identifiers

MOOft-moo-syntax

If you use C-style comments inside expressions and find it mangles yourhighlighting, you may want to use extended (slow!) matches for C-stylecomments:
:let moo_extended_cstyle_comments = 1
To disable highlighting of pronoun substitution patterns inside strings:
:let moo_no_pronoun_sub = 1
To disable highlighting of the regular expression operator "%|", and matching"%(" and "%)" inside strings:
:let moo_no_regexp = 1
Unmatched double quotes can be recognized and highlighted as errors:
:let moo_unmatched_quotes = 1
To highlight builtin properties (.name, .location, .programmer etc.):
:let moo_builtin_properties = 1
Unknown builtin functions can be recognized and highlighted as errors. If youuse this option, add your own extensions to the mooKnownBuiltinFunction group.To enable this option:
:let moo_unknown_builtin_functions = 1
An example of adding sprintf() to the list of known builtin functions:
:syn keyword mooKnownBuiltinFunction sprintf contained

MSQLft-msql-syntax

There are two options for the msql syntax highlighting.
If you like SQL syntax highlighting inside Strings, use this:
:let msql_sql_query = 1
For syncing, minlines defaults to 100.If you prefer another value, you canset "msql_minlines" to the value you desire. Example:
:let msql_minlines = 200

NEOMUTTft-neomuttrc-syntax

ft-neomuttlog-syntax
To disable the default NeoMutt log colors:
:let g:neolog_disable_default_colors = 1

N1QLft-n1ql-syntax

N1QL is a SQL-like declarative language for manipulating JSON documents inCouchbase Server databases.
Vim syntax highlights N1QL statements, keywords, operators, types, comments,and special values. Vim ignores syntactical elements specific to SQL or itsmany dialects, like COLUMN or CHAR, that don't exist in N1QL.

NCFft-ncf-syntax

There is one option for NCF syntax highlighting.
If you want to have unrecognized (by ncf.vim) statements highlighted aserrors, use this:
:let ncf_highlight_unknowns = 1
If you don't want to highlight these errors, leave it unset.

NROFFft-nroff-syntax

The nroff syntax file works with AT&T n/troff out of the box. You need toactivate the GNU groff extra features included in the syntax file before youcan use them.
For example, Linux and BSD distributions use groff as their default textprocessing package. In order to activate the extra syntax highlightingfeatures for groff, arrange for files to be recognized as groff (seeft-groff-syntax) or add the following option to your start-up files:
:let nroff_is_groff = 1
Groff is different from the old AT&T n/troff that you may still find inSolaris. Groff macro and request names can be longer than 2 characters andthere are extensions to the language primitives. For example, in AT&T troffyou access the year as a 2-digit number with the request \(yr. In groff youcan use the same request, recognized for compatibility, or you can use groff'snative syntax, \[yr]. Furthermore, you can use a 4-digit year directly:\[year]. Macro requests can be longer than 2 characters, for example, GNU mmaccepts the requests ".VERBON" and ".VERBOFF" for creating verbatimenvironments.
In order to obtain the best formatted output g/troff can give you, you shouldfollow a few simple rules about spacing and punctuation.
1. Do not leave empty spaces at the end of lines.
2. Leave one space and one space only after an end-of-sentence period, exclamation mark, etc.
3. For reasons stated below, it is best to follow all period marks with a carriage return.
The reason behind these unusual tips is that g/n/troff have a line breakingalgorithm that can be easily upset if you don't follow the rules given above.
Unlike TeX, troff fills text line-by-line, not paragraph-by-paragraph and,furthermore, it does not have a concept of glue or stretch, all horizontal andvertical space input will be output as is.
Therefore, you should be careful about not using more space between sentencesthan you intend to have in your final document. For this reason, the commonpractice is to insert a carriage return immediately after all punctuationmarks. If you want to have "even" text in your final processed output, youneed to maintain regular spacing in the input text. To mark both trailingspaces and two or more spaces after a punctuation as an error, use:
:let nroff_space_errors = 1
Another technique to detect extra spacing and other errors that will interferewith the correct typesetting of your file, is to define an eye-catchinghighlighting definition for the syntax groups "nroffDefinition" and"nroffDefSpecial" in your configuration files. For example:
hi def nroffDefinition cterm=italic gui=reversehi def nroffDefSpecial cterm=italic,bold gui=reverse,bold
If you want to navigate preprocessor entries in your source file as easily aswith section markers, you can activate the following option in your vimrcfile:
let b:preprocs_as_sections = 1
As well, the syntax file adds an extra paragraph marker for the extendedparagraph macro (.XP) in the ms package.
Finally, there is aft-groff-syntax syntax file that can be used forenabling groff syntax highlighting either on a file basis or globally bydefault.

OCAMLft-ocaml-syntax

The OCaml syntax file handles files having the following prefixes: .ml,.mli, .mll and .mly. By setting the following variable
:let ocaml_revised = 1
you can switch from standard OCaml-syntax to revised syntax as supportedby the camlp4 preprocessor. Setting the variable
:let ocaml_noend_error = 1
prevents highlighting of "end" as error, which is useful when sourcescontain very long structures that Vim does not synchronize anymore.

PANDOCft-pandoc-syntax

By default, markdown files will be detected as filetype "markdown".Alternatively, you may want them to be detected as filetype "pandoc" instead.To do so, set theg:filetype_md var:
:let g:filetype_md = 'pandoc'
The pandoc syntax plugin usesconceal for pretty highlighting. Default is 1
:let g:pandoc#syntax#conceal#use = 1
To specify elements that should not be concealed, set the following variable:
:let g:pandoc#syntax#conceal#blacklist = []
This is a list of the rules which can be used here:
titleblock
image
block
subscript
superscript
strikeout
atx
codeblock_start
codeblock_delim
footnote
definition
list
newline
dashes
ellipses
quotes
inlinecode
inlinemath
You can customize the way concealing works. For example, if you prefer tomark footnotes with the* symbol:
:let g:pandoc#syntax#conceal#cchar_overrides = {"footnote" : "*"}
To conceal the urls in links, use:
:let g:pandoc#syntax#conceal#urls = 1
Prevent highlighting specific codeblock types so that they remain Normal.Codeblock types include "definition" for codeblocks inside definition blocksand "delimited" for delimited codeblocks. Default = []
:let g:pandoc#syntax#codeblocks#ignore = ['definition']
Use embedded highlighting for delimited codeblocks where a language isspecified. Default = 1
:let g:pandoc#syntax#codeblocks#embeds#use = 1
For specify what languages and using what syntax files to highlight embeds.This is a list of language names. When the language pandoc and vim use don'tmatch, you can use the "PANDOC=VIM" syntax. For example:
:let g:pandoc#syntax#codeblocks#embeds#langs = ["ruby", "bash=sh"]
To use italics and strong in emphases. Default = 1
:let g:pandoc#syntax#style#emphases = 1
"0" will add "block" to g:pandoc#syntax#conceal#blacklist, because otherwiseyou couldn't tell where the styles are applied.
To add underline subscript, superscript and strikeout text styles. Default = 1
:let g:pandoc#syntax#style#underline_special = 1
Detect and highlight definition lists. Disabling this can improveperformance. Default = 1 (i.e., enabled by default)
:let g:pandoc#syntax#style#use_definition_lists = 1
The pandoc syntax script also comes with the following commands:
:PandocHighlight LANG
Enables embedded highlighting for language LANG in codeblocks. Uses thesyntax for items in g:pandoc#syntax#codeblocks#embeds#langs.
:PandocUnhighlight LANG
Disables embedded highlighting for language LANG in codeblocks.

PAPPft-papp-syntax

The PApp syntax file handles .papp files and, to a lesser extent, .pxmland .pxsl files which are all a mixture of perl/xml/html/other using xmlas the top-level file format. By default everything inside phtml or pxmlsections is treated as a string with embedded preprocessor commands. Ifyou set the variable:
:let papp_include_html=1
in your startup file it will try to syntax-highlight html code inside phtmlsections, but this is relatively slow and much too colourful to be able toedit sensibly. ;)
The newest version of the papp.vim syntax file can usually be found athttp://papp.plan9.de.

PASCALft-pascal-syntax

Files matching "*.p" could be Progress or Pascal and those matching "*.pp"could be Puppet or Pascal. If the automatic detection doesn't work for you,or you only edit Pascal files, use this in your startup vimrc:
:let filetype_p  = "pascal":let filetype_pp = "pascal"
The Pascal syntax file has been extended to take into account some extensionsprovided by Turbo Pascal, Free Pascal Compiler and GNU Pascal Compiler.Delphi keywords are also supported. By default, Turbo Pascal 7.0 features areenabled. If you prefer to stick with the standard Pascal keywords, add thefollowing line to your startup file:
:let pascal_traditional=1
To switch on Delphi specific constructions (such as one-line comments,keywords, etc):
:let pascal_delphi=1
The option pascal_symbol_operator controls whether symbol operators such as +,*, .., etc. are displayed using the Operator color or not. To colorize symboloperators, add the following line to your startup file:
:let pascal_symbol_operator=1
Some functions are highlighted by default. To switch it off:
:let pascal_no_functions=1
Furthermore, there are specific variables for some compilers. Besidespascal_delphi, there are pascal_gpc and pascal_fpc. Default extensions try tomatch Turbo Pascal.
:let pascal_gpc=1
or
:let pascal_fpc=1
To ensure that strings are defined on a single line, you can define thepascal_one_line_string variable.
:let pascal_one_line_string=1
If you dislike<Tab> chars, you can set the pascal_no_tabs variable. Tabswill be highlighted as Error.
:let pascal_no_tabs=1

PERLft-perl-syntax

There are a number of possible options to the perl syntax highlighting.
Inline POD highlighting is now turned on by default. If you don't wishto have the added complexity of highlighting POD embedded within Perlfiles, you may set the 'perl_include_pod' option to 0:
:let perl_include_pod = 0
To reduce the complexity of parsing (and increase performance) you can switchoff two elements in the parsing of variable names and contents.To handle package references in variable and function names not differentlyfrom the rest of the name (like 'PkgName::' in '$PkgName::VarName'):
:let perl_no_scope_in_variables = 1
(In Vim 6.x it was the other way around: "perl_want_scope_in_variables"enabled it.)
If you do not want complex things like@{${"foo"}} to be parsed:
:let perl_no_extended_vars = 1
(In Vim 6.x it was the other way around: "perl_extended_vars" enabled it.)
The coloring strings can be changed. By default strings and qq friends willbe highlighted like the first line. If you set the variableperl_string_as_statement, it will be highlighted as in the second line.
"hello world!"; qq|hello world|; ^^^^^^^^^^^^^^NN^^^^^^^^^^^^^^^N (unlet perl_string_as_statement) S^^^^^^^^^^^^SNNSSS^^^^^^^^^^^SN (let perl_string_as_statement)
(^ = perlString, S = perlStatement, N = None at all)
The syncing has 3 options. The first two switch off some triggering ofsynchronization and should only be needed in case it fails to work properly.If while scrolling all of a sudden the whole screen changes color completelythen you should try and switch off one of those. Let the developer know ifyou can figure out the line that causes the mistake.
One triggers on "^\s*sub\s*" and the other on "^[$@%]" more or less.
:let perl_no_sync_on_sub:let perl_no_sync_on_global_var
Below you can set the maximum distance VIM should look for starting points forits attempts in syntax highlighting.
:let perl_sync_dist = 100
If you want to use folding with perl, set perl_fold:
:let perl_fold = 1
If you want to fold blocks in if statements, etc. as well set the following:
:let perl_fold_blocks = 1
Subroutines are folded by default if 'perl_fold' is set. If you do not wantthis, you can set 'perl_nofold_subs':
:let perl_nofold_subs = 1
Anonymous subroutines are not folded by default; you may enable their foldingvia 'perl_fold_anonymous_subs':
:let perl_fold_anonymous_subs = 1
Packages are also folded by default if 'perl_fold' is set. To disable thisbehavior, set 'perl_nofold_packages':
:let perl_nofold_packages = 1
PHP3 and PHP4ft-php-syntaxft-php3-syntax
[Note: Previously this was called "php3", but since it now also supports php4it has been renamed to "php"]
There are the following options for the php syntax highlighting.
If you like SQL syntax highlighting inside Strings:
let php_sql_query = 1
For highlighting the Baselib methods:
let php_baselib = 1
Enable HTML syntax highlighting inside strings:
let php_htmlInStrings = 1
Using the old colorstyle:
let php_oldStyle = 1
Enable highlighting ASP-style short tags:
let php_asp_tags = 1
Disable short tags:
let php_noShortTags = 1
For highlighting parent error ] or ):
let php_parent_error_close = 1
For skipping a php end tag, if there exists an open ( or [ without a closingone:
let php_parent_error_open = 1
Enable folding for classes and functions:
let php_folding = 1
Selecting syncing method:
let php_sync_method = x
x = -1 to sync by search (default),x > 0 to sync at least x lines backwards,x = 0 to sync from start.

PLAINTEXft-plaintex-syntax

TeX is a typesetting language, and plaintex is the file type for the "plain"variant of TeX. If you never want your*.tex files recognized as plain TeX,seeft-tex-plugin.
This syntax file has the option
let g:plaintex_delimiters = 1
if you want to highlight brackets "[]" and braces "{}".

PPWIZARDft-ppwiz-syntax

PPWizard is a preprocessor for HTML and OS/2 INF files
This syntax file has the options:
ppwiz_highlight_defs : Determines highlighting mode for PPWizard's definitions. Possible values are
ppwiz_highlight_defs = 1 : PPWizard #define statements retain the colors of their contents (e.g. PPWizard macros and variables).
ppwiz_highlight_defs = 2 : Preprocessor #define and #evaluate statements are shown in a single color with the exception of line continuation symbols.
The default setting for ppwiz_highlight_defs is 1.
ppwiz_with_html : If the value is 1 (the default), highlight literal HTML code; if 0, treat HTML code like ordinary text.

PHTMLft-phtml-syntax

There are two options for the phtml syntax highlighting.
If you like SQL syntax highlighting inside Strings, use this:
:let phtml_sql_query = 1
For syncing, minlines defaults to 100.If you prefer another value, you canset "phtml_minlines" to the value you desire. Example:
:let phtml_minlines = 200

POSTSCRIPTft-postscr-syntax

There are several options when it comes to highlighting PostScript.
First which version of the PostScript language to highlight. There arecurrently three defined language versions, or levels. Level 1 is the originaland base version, and includes all extensions prior to the release of level 2.Level 2 is the most common version around, and includes its own set ofextensions prior to the release of level 3. Level 3 is currently the highestlevel supported. You select which level of the PostScript language you wanthighlighted by defining the postscr_level variable as follows:
:let postscr_level=2
If this variable is not defined it defaults to 2 (level 2) since this isthe most prevalent version currently.
Note: Not all PS interpreters will support all language features for aparticular language level. In particular the %!PS-Adobe-3.0 at the start ofPS files does NOT mean the PostScript present is level 3 PostScript!
If you are working with Display PostScript, you can include highlighting ofDisplay PS language features by defining the postscr_display variable asfollows:
:let postscr_display=1
If you are working with Ghostscript, you can include highlighting ofGhostscript specific language features by defining the variablepostscr_ghostscript as follows:
:let postscr_ghostscript=1
PostScript is a large language, with many predefined elements.While ituseful to have all these elements highlighted, on slower machines this cancause Vim to slow down. In an attempt to be machine friendly font names andcharacter encodings are not highlighted by default. Unless you are workingexplicitly with either of these this should be ok. If you want them to behighlighted you should set one or both of the following variables:
:let postscr_fonts=1:let postscr_encodings=1
There is a stylistic option to the highlighting of and, or, and not. InPostScript the function of these operators depends on the types of theiroperands - if the operands are booleans then they are the logical operators,if they are integers then they are binary operators. As binary and logicaloperators can be highlighted differently they have to be highlighted one wayor the other. By default they are treated as logical operators. They can behighlighted as binary operators by defining the variablepostscr_andornot_binary as follows:
:let postscr_andornot_binary=1
ft-printcap-syntax
PRINTCAP + TERMCAPft-ptcap-syntaxft-termcap-syntax
This syntax file applies to the printcap and termcap databases.
In order for Vim to recognize printcap/termcap files that do not matchthe patterns "*printcap*", or "*termcap*", you must put additional patternsappropriate to your system in yourmyfiletypefile file. For thesepatterns, you must set the variable "b:ptcap_type" to either "print" or"term", and then the'filetype' option to ptcap.
For example, to make Vim identify all files in /etc/termcaps/ as termcapfiles, add the following:
:au BufNewFile,BufRead /etc/termcaps/* let b:ptcap_type = "term" |                                    \ set filetype=ptcap
If you notice highlighting errors while scrolling backwards, whichare fixed when redrawing withCTRL-L, try setting the "ptcap_minlines"internal variable to a larger number:
:let ptcap_minlines = 50
(The default is 20 lines.)

PROGRESSft-progress-syntax

Files matching "*.w" could be Progress or cweb. If the automatic detectiondoesn't work for you, or you don't edit cweb at all, use this in yourstartup vimrc:
:let filetype_w = "progress"
The same happens for "*.i", which could be assembly, and "*.p", which could bePascal. Use this if you don't use assembly and Pascal:
:let filetype_i = "progress":let filetype_p = "progress"

PYTHONft-python-syntax

There are six options to control Python syntax highlighting.
For highlighted numbers:
:let python_no_number_highlight = 1
For highlighted builtin functions:
:let python_no_builtin_highlight = 1
For highlighted standard exceptions:
:let python_no_exception_highlight = 1
For highlighted doctests and code inside:
:let python_no_doctest_highlight = 1
or
:let python_no_doctest_code_highlight = 1
The first option implies the second one.
For highlighted trailing whitespace and mix of spaces and tabs:
:let python_space_error_highlight = 1
If you want all possible Python highlighting:
:let python_highlight_all = 1
This has the same effect as setting python_space_error_highlight andunsetting all the other ones.
If you use Python 2 or straddling code (Python 2 and 3 compatible),you can enforce the use of an older syntax file with support forPython 2 and up to Python 3.5.
:let python_use_python2_syntax = 1
This option will exclude all modern Python 3.6 or higher features.
Note: Only existence of these options matters, not their value. You can replace 1 above with anything.

QUAKEft-quake-syntax

The Quake syntax definition should work for most FPS (First Person Shooter)based on one of the Quake engines. However, the command names vary a bitbetween the three games (Quake, Quake 2, and Quake 3 Arena) so the syntaxdefinition checks for the existence of three global variables to allow usersto specify what commands are legal in their files. The three variables canbe set for the following effects:
set to highlight commands only available in Quake:
:let quake_is_quake1 = 1
set to highlight commands only available in Quake 2:
:let quake_is_quake2 = 1
set to highlight commands only available in Quake 3 Arena:
:let quake_is_quake3 = 1
Any combination of these three variables is legal, but might highlight morecommands than are actually available to you by the game.
Rft-r-syntax
The parsing of R code for syntax highlight starts 40 lines backwards, but youcan set a different value in yourvimrc. Example:
let r_syntax_minlines = 60
You can also turn off syntax highlighting of ROxygen:
let r_syntax_hl_roxygen = 0
enable folding of code delimited by parentheses, square brackets and curlybraces:
let r_syntax_folding = 1
and highlight as functions all keywords followed by an opening parenthesis:
let r_syntax_fun_pattern = 1
R MARKDOWNft-rmd-syntax
To disable syntax highlight of YAML header, add to yourvimrc:
let rmd_syn_hl_yaml = 0
To disable syntax highlighting of citation keys:
let rmd_syn_hl_citations = 0
To highlight R code in knitr chunk headers:
let rmd_syn_hl_chunk = 1
By default, chunks of R code will be highlighted following the rules of Rlanguage. Moreover, whenever the buffer is saved, Vim scans the buffer andhighlights other languages if they are present in new chunks. LaTeX code alsois automatically recognized and highlighted when the buffer is saved. Thisbehavior can be controlled with the variablesrmd_dynamic_fenced_languages,andrmd_include_latex whose valid values are:
let rmd_dynamic_fenced_languages = 0 " No autodetection of languageslet rmd_dynamic_fenced_languages = 1 " Autodetection of languageslet rmd_include_latex = 0 " Don't highlight LaTeX codelet rmd_include_latex = 1 " Autodetect LaTeX codelet rmd_include_latex = 2 " Always include LaTeX highlighting
If the value ofrmd_dynamic_fenced_languages is 0, you still can set thelist of languages whose chunks of code should be properly highlighted, as inthe example:
let rmd_fenced_languages = ['r', 'python']
R RESTRUCTURED TEXTft-rrst-syntax
To highlight R code in knitr chunk headers, add to yourvimrc:
let rrst_syn_hl_chunk = 1

RASIft-rasi-syntax

Rasi stands for Rofi Advanced Style Information. It is used by the programrofi to style the rendering of the search window. The language is heavilyinspired by CSS stylesheet. Files with the following extensions arerecognized as rasi files: .rasi.

READLINEft-readline-syntax

The readline library is primarily used by the BASH shell, which adds quite afew commands and options to the ones already available. To highlight theseitems as well you can add the following to yourvimrc or just type it in thecommand line before loading a file with the readline syntax:
let readline_has_bash = 1
This will add highlighting for the commands that BASH (version 2.05a andlater, and part earlier) adds.

REGOft-rego-syntax

Rego is a query language developed by Styra. It is mostly used as a policylanguage for kubernetes, but can be applied to almost anything. Files withthe following extensions are recognized as rego files: .rego.

RESTRUCTURED TEXTft-rst-syntax

Syntax highlighting is enabled for code blocks within the document for aselect number of file types. See $VIMRUNTIME/syntax/rst.vim for the defaultsyntax list.
To set a user-defined list of code block syntax highlighting:
let rst_syntax_code_list = ['vim', 'lisp', ...]
To assign multiple code block types to a single syntax, definerst_syntax_code_list as a mapping:
let rst_syntax_code_list = {        \ 'cpp': ['cpp', 'c++'],        \ 'bash': ['bash', 'sh'],        ...\ }
To use color highlighting for emphasis text:
let rst_use_emphasis_colors = 1
To enable folding of sections:
let rst_fold_enabled = 1
Note that folding can cause performance issues on some platforms.
The minimum line syntax sync is set to 50. To modify this number:
let rst_minlines = 100

REXXft-rexx-syntax

If you notice highlighting errors while scrolling backwards, which are fixedwhen redrawing withCTRL-L, try setting the "rexx_minlines" internal variableto a larger number:
:let rexx_minlines = 50
This will make the syntax synchronization start 50 lines before the firstdisplayed line. The default value is 10. The disadvantage of using a largernumber is that redrawing can become slow.
Vim tries to guess what type a ".r" file is. If it can't be detected (fromcomment lines), the default is "r". To make the default rexx add this line toyour vimrc:g:filetype_r
:let g:filetype_r = "r"

RUBYft-ruby-syntax

Ruby: Operator highlightingruby_operators Ruby: Whitespace errorsruby_space_errors Ruby: Foldingruby_foldruby_foldable_groups Ruby: Reducing expensive operationsruby_no_expensiveruby_minlines Ruby: Spellchecking stringsruby_spellcheck_strings
ruby_operators
Ruby: Operator highlighting
Operators can be highlighted by defining "ruby_operators":
:let ruby_operators = 1
ruby_space_errors
Ruby: Whitespace errors
Whitespace errors can be highlighted by defining "ruby_space_errors":
:let ruby_space_errors = 1
This will highlight trailing whitespace and tabs preceded by a space characteras errors. This can be refined by defining "ruby_no_trail_space_error" and"ruby_no_tab_space_error" which will ignore trailing whitespace and tabs afterspaces respectively.
ruby_foldruby_foldable_groups
Ruby: Folding
Folding can be enabled by defining "ruby_fold":
:let ruby_fold = 1
This will set the value of'foldmethod' to "syntax" locally to the currentbuffer or window, which will enable syntax-based folding when editing Rubyfiletypes.
Default folding is rather detailed, i.e., small syntax units like "if", "do","%w[]" may create corresponding fold levels.
You can set "ruby_foldable_groups" to restrict which groups are foldable:
:let ruby_foldable_groups = 'if case %'
The value is a space-separated list of keywords:
keyword meaning
-------- -------------------------------------
ALL Most block syntax (default) NONE Nothing if "if" or "unless" block def "def" block class "class" block module "module" block do "do" block begin "begin" block case "case" block for "for", "while", "until" loops { Curly bracket block or hash literal [ Array literal % Literal with "%" notation, e.g.: %w(STRING), %!STRING! / Regexp string String and shell command output (surrounded by ', ", "`") : Symbol # Multiline comment << Here documents __END__ Source code after "__END__" directive
ruby_no_expensive
Ruby: Reducing expensive operations
By default, the "end" keyword is colorized according to the opening statementof the block it closes. While useful, this feature can be expensive; if youexperience slow redrawing (or you are on a terminal with poor color support)you may want to turn it off by defining the "ruby_no_expensive" variable:
:let ruby_no_expensive = 1
In this case the same color will be used for all control keywords.
ruby_minlines
If you do want this feature enabled, but notice highlighting errors whilescrolling backwards, which are fixed when redrawing withCTRL-L, try settingthe "ruby_minlines" variable to a value larger than 50:
:let ruby_minlines = 100
Ideally, this value should be a number of lines large enough to embrace yourlargest class or module.
ruby_spellcheck_strings
Ruby: Spellchecking strings
Ruby syntax will perform spellchecking of strings if you define"ruby_spellcheck_strings":
:let ruby_spellcheck_strings = 1

SCHEMEft-scheme-syntax

By default only R7RS keywords are highlighted and properly indented.
scheme.vim also supports extensions of the CHICKEN Scheme->C compiler.Define b:is_chicken or g:is_chicken, if you need them.

SDLft-sdl-syntax

The SDL highlighting probably misses a few keywords, but SDL has so manyof them it's almost impossibly to cope.
The new standard, SDL-2000, specifies that all identifiers arecase-sensitive (which was not so before), and that all keywords can beused either completely lowercase or completely uppercase. To have thehighlighting reflect this, you can set the following variable:
:let sdl_2000=1
This also sets many new keywords. If you want to disable the oldkeywords, which is probably a good idea, use:
:let SDL_no_96=1
The indentation is probably also incomplete, but right now I am verysatisfied with it for my own projects.

SEDft-sed-syntax

To make tabs stand out from regular blanks (accomplished by using Todohighlighting on the tabs), define "g:sed_highlight_tabs" by putting
:let g:sed_highlight_tabs = 1
in the vimrc file. (This special highlighting only applies for tabsinside search patterns, replacement texts, addresses or text includedby an Append/Change/Insert command.) If you enable this option, it isalso a good idea to set the tab width to one character; by doing that,you can easily count the number of tabs in a string.
GNU sed allows comments after text on the same line. BSD sed only allowscomments where "#" is the first character of the line. To enforce BSD-stylecomments, i.e. mark end-of-line comments as errors, use:
:let g:sed_dialect = "bsd"
Note that there are other differences between GNU sed and BSD sed which arenot (yet) affected by this setting.
Bugs:
The transform command (y) is treated exactly like the substitute command. This means that, as far as this syntax file is concerned, transform accepts the same flags as substitute, which is wrong. (Transform accepts no flags.) I tolerate this bug because the involved commands need very complex treatment (95 patterns, one for each plausible pattern delimiter).

SGMLft-sgml-syntax

The coloring scheme for tags in the SGML file works as follows.
The <> of opening tags are colored differently than the </> of a closing tag.This is on purpose! For opening tags the 'Function' color is used, while forclosing tags the 'Type' color is used (See syntax.vim to check how those aredefined for you)
Known tag names are colored the same way as statements in C. Unknown tagnames are not colored which makes it easy to spot errors.
Note that the same is true for argument (or attribute) names. Known attributenames are colored differently than unknown ones.
Some SGML tags are used to change the rendering of text. The following tagsare recognized by the sgml.vim syntax coloring file and change the way normaltext is shown:<varname><emphasis><command><function><literal><replaceable><ulink> and<link>.
If you want to change how such text is rendered, you must redefine thefollowing syntax groups:
sgmlBold
sgmlBoldItalic
sgmlUnderline
sgmlItalic
sgmlLink for links
To make this redefinition work you must redefine them all and define thefollowing variable in your vimrc (this is due to the order in which the filesare read during initialization)
let sgml_my_rendering=1
You can also disable this rendering by adding the following line to yourvimrc file:
let sgml_no_rendering=1
(Adapted from the html.vim help text by Claudio Fleiner <[email protected]>)
ft-posix-syntaxft-dash-syntax

SHft-sh-syntaxft-bash-syntaxft-ksh-syntax

This covers syntax highlighting for the older Unix (Bourne) sh, and newershells such as bash, dash, posix, and the Korn shells.
Vim attempts to determine which shell type is in use by specifying thatvarious filenames are of specific types, e.g.:
ksh : .kshrc* *.kshbash: .bashrc* bashrc bash.bashrc .bash_profile* *.bash
See $VIMRUNTIME/filetype.vim for the full list of patterns. If none of thesecases pertain, then the first line of the file is examined (ex. looking for/bin/sh /bin/ksh /bin/bash). If the first line specifies a shelltype, thenthat shelltype is used. However some files (ex. .profile) are known to beshell files but the type is not apparent. Furthermore, on many systems sh issymbolically linked to "bash" (Linux, Windows+cygwin) or "ksh" (POSIX).
One may specify a global default by instantiating one of the followingvariables in your vimrc:
ksh:
let g:is_kornshell = 1
posix: (default)
let g:is_posix     = 1
bash:
let g:is_bash   = 1
dash:
let g:is_dash   = 1
sh: Bourne shell
let g:is_sh   = 1
Specific shell features are automatically enabled based on the shell detectedfrom the shebang line ("#! ..."). For KornShell Vim detects different shellfeatures for mksh, ksh88, ksh93, ksh93u, ksh93v, and ksh2020.
If there's no "#! ..." line, and the user hasn't availed themself of a defaultsh.vim syntax setting as just shown, then syntax/sh.vim will assume the POSIXshell syntax. No need to quote RFCs or market penetration statistics in errorreports, please -- just select the default version of the sh your system usesand install the associated "let..." in your <.vimrc>.
The syntax/sh.vim file provides several levels of syntax-based folding:
let g:sh_fold_enabled= 0     (default, no syntax folding)let g:sh_fold_enabled= 1     (enable function folding)let g:sh_fold_enabled= 2     (enable heredoc folding)let g:sh_fold_enabled= 4     (enable if/do/for folding)
then various syntax items (ie. HereDocuments and function bodies) becomesyntax-foldable (see:syn-fold). You also may add these togetherto get multiple types of folding:
let g:sh_fold_enabled= 3     (enables function and heredoc folding)
If you notice highlighting errors while scrolling backwards which are fixedwhen one redraws withCTRL-L, try setting the "sh_minlines" internal variableto a larger number. Example:
let sh_minlines = 500
This will make syntax synchronization start 500 lines before the firstdisplayed line. The default value is 200. The disadvantage of using a largernumber is that redrawing can become slow.
If you don't have much to synchronize on, displaying can be very slow.Toreduce this, the "sh_maxlines" internal variable can be set. Example:
let sh_maxlines = 100
The default is to use the twice sh_minlines. Set it to a smaller number tospeed up displaying. The disadvantage is that highlight errors may appear.
syntax/sh.vim tries to flag certain problems as errors; usually things likeunmatched "]", "done", "fi", etc. If you find the error handling problematicfor your purposes, you may suppress such error highlighting by puttingthe following line in your .vimrc:
let g:sh_no_error= 1
sh-embedsh-awk Sh: EMBEDDING LANGUAGES~
You may wish to embed languages into sh. I'll give an example courtesy ofLorance Stinson on how to do this with awk as an example. Put the followingfile into $HOME/.config/nvim/after/syntax/sh/awkembed.vim:
" AWK Embedding:" ==============" Shamelessly ripped from aspperl.vim by Aaron Hope.if exists("b:current_syntax")  unlet b:current_syntaxendifsyn include @AWKScript syntax/awk.vimsyn region AWKScriptCode matchgroup=AWKCommand start=+[=\\]\@<!'+ skip=+\\'+ end=+'+ contains=@AWKScript containedsyn region AWKScriptEmbedded matchgroup=AWKCommand start=+\<awk\>+ skip=+\\$+ end=+[=\\]\@<!'+me=e-1 contains=@shIdList,@shExprList2 nextgroup=AWKScriptCodesyn cluster shCommandSubList add=AWKScriptEmbeddedhi def link AWKCommand Type
This code will then let the awk code in the single quotes:
awk '...awk code here...'
be highlighted using the awk highlighting syntax. Clearly this may beextended to other languages.

SPEEDUPft-spup-syntax

(AspenTech plant simulator)
The Speedup syntax file has some options:
strict_subsections : If this variable is defined, only keywords for sections and subsections will be highlighted as statements but not other keywords (like WITHIN in the OPERATION section).
highlight_types : Definition of this variable causes stream types like temperature or pressure to be highlighted as Type, not as a plain Identifier. Included are the types that are usually found in the DECLARE section; if you defined own types, you have to include them in the syntax file.
oneline_comments : This value ranges from 1 to 3 and determines the highlighting of # style comments.
oneline_comments = 1 : Allow normal Speedup code after an even number of #s.
oneline_comments = 2 : Show code starting with the second # as error. This is the default setting.
oneline_comments = 3 : Show the whole line as error if it contains more than one #.
Since especially OPERATION sections tend to become very large due toPRESETting variables, syncing may be critical. If your computer isfast enough, you can increase minlines and/or maxlines near the end ofthe syntax file.

SQLft-sql-syntax

ft-sqlinformix-syntax
ft-sqlanywhere-syntax
While there is an ANSI standard for SQL, most database engines add their owncustom extensions. Vim currently supports the Oracle and Informix dialects ofSQL. Vim assumes "*.sql" files are Oracle SQL by default.
Vim currently has SQL support for a variety of different vendors via syntaxscripts. You can change Vim's default from Oracle to any of the current SQLsupported types. You can also easily alter the SQL dialect being used on abuffer by buffer basis.
For more detailed instructions seeft_sql.txt.

SQUIRRELft-squirrel-syntax

Squirrel is a high level imperative, object-oriented programming language,designed to be a light-weight scripting language that fits in the size, memorybandwidth, and real-time requirements of applications like video games. Fileswith the following extensions are recognized as squirrel files: .nut.

TCSHft-tcsh-syntax

This covers the shell named "tcsh". It is a superset of csh. Seeft-csh-syntax for how the filetype is detected.
Tcsh does not allow \" in strings unless the "backslash_quote" shell variableis set. If you want VIM to assume that no backslash quote constructs existadd this line to your vimrc:
:let tcsh_backslash_quote = 0
If you notice highlighting errors while scrolling backwards, which are fixedwhen redrawing withCTRL-L, try setting the "tcsh_minlines" internal variableto a larger number:
:let tcsh_minlines = 1000
This will make the syntax synchronization start 1000 lines before the firstdisplayed line. If you set "tcsh_minlines" to "fromstart", thensynchronization is done from the start of the file. The default value fortcsh_minlines is 100. The disadvantage of using a larger number is thatredrawing can become slow.

TEXft-tex-syntaxlatex-syntax

syntax-texsyntax-latex
Tex Contents~Tex: Want Syntax Folding?tex-folding Tex: No Spell Checking Wantedg:tex_nospell Tex: Don't Want Spell Checking In Comments?tex-nospell Tex: Want Spell Checking in Verbatim Zones?tex-verb Tex: Run-on Comments or MathZonestex-runon Tex: Slow Syntax Highlighting?tex-slow Tex: Want To Highlight More Commands?tex-morecommands Tex: Excessive Error Highlighting?tex-error Tex: Need a new Math Group?tex-math Tex: Starting a New Style?tex-style Tex: Taking Advantage of Conceal Modetex-conceal Tex: Selective Conceal Modeg:tex_conceal Tex: Controlling iskeywordg:tex_isk Tex: Fine Subscript and Superscript Controltex-supersub Tex: Match Check Controltex-matchcheck
tex-foldingg:tex_fold_enabled
Tex: Want Syntax Folding?
As of version 28 of <syntax/tex.vim>, syntax-based folding of parts, chapters,sections, subsections, etc are supported. Put
let g:tex_fold_enabled=1
in your vimrc, and :set fdm=syntax. I suggest doing the latter via amodeline at the end of your LaTeX file:
% vim: fdm=syntax
If your system becomes too slow, then you might wish to look into
https://vimhelp.org/vim_faq.txt.html#faq-29.7
g:tex_nospell
Tex: No Spell Checking Wanted~
If you don't want spell checking anywhere in your LaTeX document, put
let g:tex_nospell=1
into your vimrc. If you merely wish to suppress spell checking insidecomments only, seeg:tex_comment_nospell.
tex-nospellg:tex_comment_nospell
Tex: Don't Want Spell Checking In Comments?
Some folks like to include things like source code in comments and so wouldprefer that spell checking be disabled in comments in LaTeX files. To dothis, put the following in your vimrc:
let g:tex_comment_nospell= 1
If you want to suppress spell checking everywhere inside your LaTeX document,seeg:tex_nospell.
tex-verbg:tex_verbspell Tex: Want Spell Checking in Verbatim Zones?~
Often verbatim regions are used for things like source code; seldom doesone want source code spell-checked. However, for those of you who dowant your verbatim zones spell-checked, put the following in your vimrc:
let g:tex_verbspell= 1
tex-runontex-stopzone
Tex: Run-on Comments or MathZones
The <syntax/tex.vim> highlighting supports TeX, LaTeX, and some AmsTeX. Thehighlighting supports three primary zones/regions: normal, texZone, andtexMathZone. Although considerable effort has been made to have these zonesterminate properly, zones delineated by $..$ and $$..$$ cannot be synchronizedas there's no difference between start and end patterns. Consequently, aspecial "TeX comment" has been provided
%stopzone
which will forcibly terminate the highlighting of either a texZone or atexMathZone.
tex-slowtex-sync
Tex: Slow Syntax Highlighting?
If you have a slow computer, you may wish to reduce the values for
:syn sync maxlines=200:syn sync minlines=50
(especially the latter). If your computer is fast, you may wish toincrease them.This primarily affects synchronizing (i.e. just what group,if any, is the text at the top of the screen supposed to be in?).
Another cause of slow highlighting is due to syntax-driven folding; seetex-folding for a way around this.
g:tex_fast
Finally, if syntax highlighting is still too slow, you may set
:let g:tex_fast= ""
in your vimrc. Used this way, the g:tex_fast variable causes the syntaxhighlighting script to avoid defining any regions and associatedsynchronization. The result will be much faster syntax highlighting; theprice: you will no longer have as much highlighting or any syntax-basedfolding, and you will be missing syntax-based error checking.
You may decide that some syntax is acceptable; you may use the following tableselectively to enable just some syntax highlighting:
b : allow bold and italic syntaxc : allow texComment syntaxm : allow texMatcher syntax (ie. {...} and [...])M : allow texMath syntaxp : allow parts, chapter, section, etc syntaxr : allow texRefZone syntax (nocite, bibliography, label, pageref, eqref)s : allow superscript/subscript regionsS : allow texStyle syntaxv : allow verbatim syntaxV : allow texNewEnv and texNewCmd syntax
As an example, let g:tex_fast= "M" will allow math-associated highlightingbut suppress all the other region-based syntax highlighting.(also see:g:tex_conceal andtex-supersub)
tex-morecommandstex-package
Tex: Want To Highlight More Commands?
LaTeX is a programmable language, and so there are thousands of packages fullof specialized LaTeX commands, syntax, and fonts. If you're using such apackage you'll often wish that the distributed syntax/tex.vim would supportit. However, clearly this is impractical. So please consider using thetechniques inmysyntaxfile-add to extend or modify the highlighting providedby syntax/tex.vim.
I've included some support for various popular packages on my website:
https://www.drchip.org/astronaut/vim/index.html#LATEXPKGS
The syntax files there go into your .../after/syntax/tex/ directory.
tex-errorg:tex_no_error
Tex: Excessive Error Highlighting?
The <tex.vim> supports lexical error checking of various sorts. Thus,although the error checking is ofttimes very useful, it can indicateerrors where none actually are. If this proves to be a problem for you,you may put in your vimrc the following statement:
let g:tex_no_error=1
and all error checking by <syntax/tex.vim> will be suppressed.
tex-math
Tex: Need a new Math Group?
If you want to include a new math group in your LaTeX, the followingcode shows you an example as to how you might do so:
call TexNewMathZone(sfx,mathzone,starform)
You'll want to provide the new math group with a unique suffix(currently, A-L and V-Z are taken by <syntax/tex.vim> itself).As an example, consider how eqnarray is set up by <syntax/tex.vim>:
call TexNewMathZone("D","eqnarray",1)
You'll need to change "mathzone" to the name of your new math group,and then to the call to it in .vim/after/syntax/tex.vim.The "starform" variable, if true, implies that your new math grouphas a starred form (ie. eqnarray*).
tex-styleb:tex_stylish
Tex: Starting a New Style?
One may use "\makeatletter" in*.tex files, thereby making the use of "@" incommands available. However, since the*.tex file doesn't have one of thefollowing suffices: sty cls clo dtx ltx, the syntax highlighting will flagsuch use of @ as an error. To solve this:
:let b:tex_stylish = 1:set ft=tex
Putting "let g:tex_stylish=1" into your vimrc will make <syntax/tex.vim>always accept such use of @.
tex-cchartex-coletex-conceal Tex: Taking Advantage of Conceal Mode~
If you have'conceallevel' set to 2 and if your encoding is utf-8, then anumber of character sequences can be translated into appropriate utf-8 glyphs,including various accented characters, Greek characters in MathZones, andsuperscripts and subscripts in MathZones. Not all characters can be made intosuperscripts or subscripts; the constraint is due to what utf-8 supports.In fact, only a few characters are supported as subscripts.
One way to use this is to have vertically split windows (seeCTRL-W_v); onewith'conceallevel' at 0 and the other at 2; and both using'scrollbind'.
g:tex_conceal
Tex: Selective Conceal Mode~
You may selectively use conceal mode by setting g:tex_conceal in yourvimrc. By default, g:tex_conceal is set to "admgs" to enable concealmentfor the following sets of characters:
a = accents/ligaturesb = bold and italicd = delimitersm = math symbolsg = Greeks = superscripts/subscripts
By leaving one or more of these out, the associated conceal-charactersubstitution will not be made.
g:tex_iskg:tex_stylish Tex: Controlling iskeyword~
Normally, LaTeX keywords support 0-9, a-z, A-z, and 192-255 only. Latexkeywords don't support the underscore - except when in*.sty files. Thesyntax highlighting script handles this with the following logic:
* If g:tex_stylish exists and is 1then the file will be treated as a "sty" file, so the "_"will be allowed as part of keywords(regardless of g:tex_isk)* Else if the file's suffix is sty, cls, clo, dtx, or ltx,then the file will be treated as a "sty" file, so the "_"will be allowed as part of keywords(regardless of g:tex_isk)
* If g:tex_isk exists, then it will be used for the local'iskeyword'* Else the local'iskeyword' will be set to 48-57,a-z,A-Z,192-255
tex-supersubg:tex_superscriptsg:tex_subscripts Tex: Fine Subscript and Superscript Control~
Seetex-conceal for how to enable concealed character replacement.
Seeg:tex_conceal for selectively concealing accents, bold/italic,math, Greek, and superscripts/subscripts.
One may exert fine control over which superscripts and subscripts onewants syntax-based concealment for (see:syn-cchar). Since not allfonts support all characters, one may override theconcealed-replacement lists; by default these lists are given by:
let g:tex_superscripts= "[0-9a-zA-W.,:;+-<>/()=]"let g:tex_subscripts= "[0-9aehijklmnoprstuvx,+-/().]"
For example, I use Luxi Mono Bold; it doesn't support subscriptcharacters for "hklmnpst", so I put
let g:tex_subscripts= "[0-9aeijoruvx,+-/().]"
in ~/.config/nvim/ftplugin/tex/tex.vim in order to avoid havinginscrutable utf-8 glyphs appear.
tex-matchcheckg:tex_matchcheck Tex: Match Check Control~
Sometimes one actually wants mismatched parentheses, square braces,and or curly braces; for example, \text{(1,10]} is a range from butnot including 1 to and including 10. This wish, of course, conflictswith the desire to provide delimiter mismatch detection. Toaccommodate these conflicting goals, syntax/tex.vim provides
g:tex_matchcheck = '[({[]'
which is shown along with its default setting. So, if one doesn'twant [] and () to be checked for mismatches, try using
let g:tex_matchcheck= '[{}]'
If you don't want matching to occur inside bold and italicizedregions,
let g:tex_excludematcher= 1
will prevent the texMatcher group from being included in thoseregions.

TFft-tf-syntax

There is one option for the tf syntax highlighting.
For syncing, minlines defaults to 100.If you prefer another value, you canset "tf_minlines" to the value you desire. Example:
:let tf_minlines = your choice

TYPESCRIPTft-typescript-syntaxft-typescriptreact-syntax

There is one option to control the TypeScript syntax highlighting.
g:typescript_host_keyword
When this variable is set to 1, host-specific APIs such asaddEventListenerare highlighted. To disable set it to zero in your .vimrc:
let g:typescript_host_keyword = 0
The default value is 1.

TYPSTft-typst-syntax

g:typst_embedded_languages
Typst files can embed syntax highlighting for other languages by setting theg:typst_embedded_languages variable. This variable is a list of languagenames whose syntax definitions will be included in Typst files. Example:
let g:typst_embedded_languages = ['python', 'r']

VIMft-vim-syntaxg:vimsyn_minlinesg:vimsyn_maxlines

There is a trade-off between more accurate syntax highlighting versus screenupdating speed. To improve accuracy, you may wish to increase theg:vimsyn_minlines variable. The g:vimsyn_maxlines variable may be used toimprove screen updating rates (see:syn-sync for more on this).
g:vimsyn_minlines : used to set synchronization minlinesg:vimsyn_maxlines : used to set synchronization maxlines
(g:vim_minlines and g:vim_maxlines are deprecated variants ofthese two options)
g:vimsyn_embed
The g:vimsyn_embed option allows users to select what, if any, types ofembedded script highlighting they wish to have.
g:vimsyn_embed == 0       : disable (don't embed any scripts)g:vimsyn_embed ==# 'lpPr' : support embedded Lua, Perl, Python and Ruby
By default, g:vimsyn_embed is unset, and embedded Lua scripts are supported.
g:vimsyn_folding
Some folding is now supported with when'foldmethod' is set to "syntax":
g:vimsyn_folding == 0 or doesn't exist: no syntax-based foldingg:vimsyn_folding =~# 'a' : fold augroupsg:vimsyn_folding =~# 'f' : fold functionsg:vimsyn_folding =~# 'h' : fold let heredocsg:vimsyn_folding =~# 'l' : fold Lua      heredocsg:vimsyn_folding =~# 'p' : fold Perl     heredocsg:vimsyn_folding =~# 'P' : fold Python   heredocsg:vimsyn_folding =~# 'r' : fold Ruby     heredocs
By default, g:vimsyn_folding is unset. Concatenate the indicated charactersto support folding of multiple syntax constructs (e.g.,g:vimsyn_folding = "fh" will enable folding of both functions and heredocs).
g:vimsyn_comment_strings
By default, strings are highlighted inside comments. This may be disabled bysetting g:vimsyn_comment_strings to false.
g:vimsyn_noerror
Not all error highlighting that syntax/vim.vim does may be correct; Vim scriptis a difficult language to highlight correctly. A way to suppress errorhighlighting is to put the following line in yourvimrc:
let g:vimsyn_noerror = 1

WDLwdl-syntax

The Workflow Description Language is a way to specify data processingworkflows with a human-readable and writeable syntax. This is used a lot inbioinformatics. More info on the spec can be found here:https://github.com/openwdl/wdl

XF86CONFIGft-xf86conf-syntax

The syntax of XF86Config file differs in XFree86 v3.x and v4.x. Bothvariants are supported. Automatic detection is used, but is far from perfect.You may need to specify the version manually. Set the variablexf86conf_xfree86_version to 3 or 4 according to your XFree86 version inyour vimrc. Example:
:let xf86conf_xfree86_version=3
When using a mix of versions, set the b:xf86conf_xfree86_version variable.
Note that spaces and underscores in option names are not supported. Use"SyncOnGreen" instead of "__s yn con gr_e_e_n" if you want the option namehighlighted.

XMLft-xml-syntax

Xml namespaces are highlighted by default. This can be inhibited bysetting a global variable:
:let g:xml_namespace_transparent=1
xml-folding
The xml syntax file provides syntaxfolding (see:syn-fold) betweenstart and end tags. This can be turned on by
:let g:xml_syntax_folding = 1:set foldmethod=syntax
Note: Syntax folding might slow down syntax highlighting significantly,especially for large files.
X Pixmaps (XPM)ft-xpm-syntax
xpm.vim creates its syntax items dynamically based upon the contents of theXPM file. Thus if you make changes e.g. in the color specification strings,you have to source it again e.g. with ":set syn=xpm".
To copy a pixel with one of the colors, yank a "pixel" with "yl" and insert itsomewhere else with "P".
Do you want to draw with the mouse? Try the following:
:function! GetPixel():   let c = getline(".")[col(".") - 1]:   echo c:   exe "noremap <LeftMouse> <LeftMouse>r" .. c:   exe "noremap <LeftDrag><LeftMouse>r" .. c:endfunction:noremap <RightMouse> <LeftMouse>:call GetPixel()<CR>:set guicursor=n:hor20   " to see the color beneath the cursor
This turns the right button into a pipette and the left button into a pen.It will work with XPM files that have one character per pixel only and youmust not click outside of the pixel strings, but feel free to improve it.
It will look much better with a font in a quadratic cell size, e.g. for X:
:set guifont=-*-clean-medium-r-*-*-8-*-*-*-*-80-*

YAMLft-yaml-syntax

g:yaml_schemab:yaml_schemaA YAML schema is a combination of a set of tags and a mechanism for resolvingnon-specific tags. For user this means that YAML parser may, depending onplain scalar contents, treat plain scalar (which can actually be only stringand nothing else) as a value of the other type: null, boolean, floating-point,integer.g:yaml_schema option determines according to which schema valueswill be highlighted specially. Supported schemas are
SchemaDescription
failsafeNo additional highlighting.jsonSupports JSON-style numbers, booleans and null.coreSupports more number, boolean and null styles.pyyamlIn addition to core schema supports highlighting timestamps,but there are some differences in what is recognized asnumbers and many additional boolean values not present in coreschema.
Default schema iscore.
Note that schemas are not actually limited to plain scalars, but this is theonly difference between schemas defined in YAML specification and the onlydifference defined in the syntax file.

ZSHft-zsh-syntax

The syntax script for zsh allows for syntax-based folding:
:let g:zsh_fold_enable = 1

6. Defining a syntax:syn-defineE410

Vim understands three types of syntax items:
1. Keyword It can only contain keyword characters, according to the characters specified with:syn-iskeyword or the'iskeyword' option. It cannot contain other syntax items. It will only match with a complete word (there are no keyword characters before or after the match). The keyword "if" would match in "if(a=b)", but not in "ifdef x", because "(" is not a keyword character and "d" is.
2. Match This is a match with a single regexp pattern.
3. Region This starts at a match of the "start" regexp pattern and ends with a match with the "end" regexp pattern. Any other text can appear in between. A "skip" regexp pattern can be used to avoid matching the "end" pattern.
Several syntax ITEMs can be put into one syntax GROUP.For a syntax groupyou can give highlighting attributes. For example, you could have an itemto define a/* ... */ comment and another one that defines a "// ..."comment, and put them both in the "Comment" group. You can then specify thata "Comment" will be in bold font and have a blue color. You are free to makeone highlight group for one syntax item, or put all items into one group.This depends on how you want to specify your highlighting attributes. Puttingeach item in its own group results in having to specify the highlightingfor a lot of groups.
Note that a syntax group and a highlight group are similar. For a highlightgroup you will have given highlight attributes. These attributes will be usedfor the syntax group with the same name.
In case more than one item matches at the same position, the one that wasdefined LAST wins. Thus you can override previously defined syntax items byusing an item that matches the same text. But a keyword always goes before amatch or region. And a keyword with matching case always goes before akeyword with ignoring case.

PRIORITY:syn-priority

When several syntax items may match, these rules are used:
1. When multiple Match or Region items start in the same position, the item defined last has priority.2. A Keyword has priority over Match and Region items.3. An item that starts in an earlier position has priority over items that start in later positions.

DEFINING CASE:syn-caseE390

:sy[ntax] case [match | ignore]This defines if the following ":syntax" commands will work withmatching case, when using "match", or with ignoring case, when using"ignore". Note that any items before this are not affected, and allitems until the next ":syntax case" command are affected.
:sy[ntax] caseShow either "syntax case match" or "syntax case ignore".

DEFINING FOLDLEVEL:syn-foldlevel

:sy[ntax] foldlevel start:sy[ntax] foldlevel minimumThis defines how the foldlevel of a line is computed when usingfoldmethod=syntax (seefold-syntax and:syn-fold):
start:Use level of item containing start of line.minimum:Use lowest local-minimum level of items on line.
The default is "start". Use "minimum" to search a line horizontallyfor the lowest level contained on the line that is followed by ahigher level. This produces more natural folds when syntax itemsmay close and open horizontally within a line.
:sy[ntax] foldlevelShow the current foldlevel method, either "syntax foldlevel start" or"syntax foldlevel minimum".

SPELL CHECKING:syn-spell

:sy[ntax] spell toplevel:sy[ntax] spell notoplevel:sy[ntax] spell defaultThis defines where spell checking is to be done for text that is notin a syntax item:
toplevel:Text is spell checked.notoplevel:Text is not spell checked.default:When there is a @Spell cluster no spell checking.
For text in syntax items use the @Spell and @NoSpell clustersspell-syntax. When there is no @Spell and no @NoSpell cluster thenspell checking is done for "default" and "toplevel".
To activate spell checking the'spell' option must be set.
:sy[ntax] spellShow the current syntax spell checking method, either "syntax spelltoplevel", "syntax spell notoplevel" or "syntax spell default".

SYNTAX ISKEYWORD SETTING:syn-iskeyword

:sy[ntax] iskeyword [clear |{option}]This defines the keyword characters. It's like the'iskeyword' optionfor but only applies to syntax highlighting.
clear:Syntax specific iskeyword setting is disabled and thebuffer-local'iskeyword' setting is used.{option}Set the syntax'iskeyword' option to a new value.
Example:
:syntax iskeyword @,48-57,192-255,$,_
This would set the syntax specific iskeyword option to include allalphabetic characters, plus the numeric characters, all accentedcharacters and also includes the "_" and the "$".
If no argument is given, the current value will be output.
Setting this option influences what/\k matches in syntax patternsand also determines where:syn-keyword will be checked for a newmatch.
It is recommended when writing syntax files, to use this command toset the correct value for the specific syntax language and not changethe'iskeyword' option.

DEFINING KEYWORDS:syn-keyword

:sy[ntax] keyword{group-name} [{options}]{keyword} ... [{options}]
This defines a number of keywords.
{group-name}Is a syntax group name such as "Comment".[{options}]See:syn-arguments below.{keyword} ...Is a list of keywords which are part of this group.
Example:
:syntax keyword   Type   int long char
The{options} can be given anywhere in the line. They will apply toall keywords given, also for options that come after a keyword.These examples do exactly the same:
:syntax keyword   Type   contained int long char:syntax keyword   Type   int long contained char:syntax keyword   Type   int long char contained
E789E890When you have a keyword with an optional tail, like Ex commands inVim, you can put the optional characters inside [], to define all thevariations at once:
:syntax keyword   vimCommand ab[breviate] n[ext]
Don't forget that a keyword can only be recognized if all thecharacters are included in the'iskeyword' option. If one characterisn't, the keyword will never be recognized.Multi-byte characters can also be used. These do not have to be in'iskeyword'.See:syn-iskeyword for defining syntax specific iskeyword settings.
A keyword always has higher priority than a match or region, thekeyword is used if more than one item matches.Keywords do not nestand a keyword can't contain anything else.
Note that when you have a keyword that is the same as an option (evenone that isn't allowed here), you can not use it. Use a matchinstead.
The maximum length of a keyword is 80 characters.
The same keyword can be defined multiple times, when its containmentdiffers. For example, you can define the keyword once not containedand use one highlight group, and once contained, and use a differenthighlight group. Example:
:syn keyword vimCommand tag:syn keyword vimSetting contained tag
When finding "tag" outside of any syntax item, the "vimCommand"highlight group is used. When finding "tag" in a syntax item thatcontains "vimSetting", the "vimSetting" group is used.

DEFINING MATCHES:syn-match

:sy[ntax] match{group-name} [{options}][excludenl][keepend]{pattern}[{options}]
This defines one match.
{group-name}A syntax group name such as "Comment".[{options}]See:syn-arguments below.[excludenl]Don't make a pattern with the end-of-line "$"extend a containing match or region. Must begiven before the pattern.:syn-excludenlkeependDon't allow contained matches to go past amatch with the end pattern. See:syn-keepend.{pattern}The search pattern that defines the match.See:syn-pattern below.Note that the pattern may match more than oneline, which makes the match depend on whereVim starts searching for the pattern. Youneed to make sure syncing takes care of this.
Example (match a character constant):
:syntax match Character /'.'/hs=s+1,he=e-1

DEFINING REGIONS:syn-region:syn-start:syn-skip:syn-end

E398E399:sy[ntax] region{group-name} [{options}][matchgroup={group-name}][keepend][extend][excludenl]start={start-pattern} ...[skip={skip-pattern}]end={end-pattern} ...[{options}]
This defines one region. It may span several lines.
{group-name}A syntax group name such as "Comment".[{options}]See:syn-arguments below.[matchgroup={group-name}] The syntax group to use for the followingstart or end pattern matches only. Not usedfor the text in between the matched start andend patterns. Use NONE to reset to not usinga different group for the start or end match.See:syn-matchgroup.keependDon't allow contained matches to go past amatch with the end pattern. See:syn-keepend.extendOverride a "keepend" for an item this regionis contained in. See:syn-extend.excludenlDon't make a pattern with the end-of-line "$"extend a containing match or item. Onlyuseful for end patterns. Must be given beforethe patterns it applies to.:syn-excludenlstart={start-pattern}The search pattern that defines the start ofthe region. See:syn-pattern below.skip={skip-pattern}The search pattern that defines text insidethe region where not to look for the endpattern. See:syn-pattern below.end={end-pattern}The search pattern that defines the end ofthe region. See:syn-pattern below.
Example:
:syntax region String   start=+"+  skip=+\\"+  end=+"+
The start/skip/end patterns and the options can be given in any order.There can be zero or one skip pattern.There must be one or morestart and end patterns. This means that you can omit the skippattern, but you must give at least one start and one end pattern. Itis allowed to have white space before and after the equal sign(although it mostly looks better without white space).
When more than one start pattern is given, a match with one of theseis sufficient.This means there is an OR relation between the startpatterns. The last one that matches is used. The same is true forthe end patterns.
The search for the end pattern starts right after the start pattern.Offsets are not used for this.This implies that the match for theend pattern will never overlap with the start pattern.
The skip and end pattern can match across line breaks, but since thesearch for the pattern can start in any line it often does not do whatyou want. The skip pattern doesn't avoid a match of an end pattern inthe next line.Use single-line patterns to avoid trouble.
Note: The decision to start a region is only based on a matching startpattern. There is no check for a matching end pattern. This does NOTwork:
:syn region First  start="("  end=":":syn region Second start="("  end=";"
The Second always matches before the First (last defined pattern hashigher priority). The Second region then continues until the next';', no matter if there is a ':' before it. Using a match does work:
:syn match First  "(\_.\{-}:":syn match Second "(\_.\{-};"
This pattern matches any character or line break with "\_." andrepeats that with "\{-}" (repeat as few as possible).
:syn-keepend
By default, a contained match can obscure a match for the end pattern.This is useful for nesting. For example, a region that starts with"{" and ends with "}", can contain another region. An encountered "}"will then end the contained region, but not the outer region: {starts outer "{}" region{starts contained "{}" region}ends contained "{}" region }ends outer "{} regionIf you don't want this, the "keepend" argument will make the matchingof an end pattern of the outer region also end any contained item.This makes it impossible to nest the same region, but allows forcontained items to highlight parts of the end pattern, without causingthat to skip the match with the end pattern. Example:
:syn match  vimComment +"[^"]\+$+:syn region vimCommand start="set" end="$" contains=vimComment keepend
The "keepend" makes the vimCommand always end at the end of the line,even though the contained vimComment includes a match with the<EOL>.
When "keepend" is not used, a match with an end pattern is retriedafter each contained match. When "keepend" is included, the firstencountered match with an end pattern is used, truncating anycontained matches.:syn-extend
The "keepend" behavior can be changed by using the "extend" argument.When an item with "extend" is contained in an item that uses"keepend", the "keepend" is ignored and the containing region will beextended.This can be used to have some contained items extend a region whileothers don't. Example:
:syn region htmlRef start=+<a>+ end=+</a>+ keepend contains=htmlItem,htmlScript:syn match htmlItem +<[^>]*>+ contained:syn region htmlScript start=+<script+ end=+</script[^>]*>+ contained extend
Here the htmlItem item does not make the htmlRef item continuefurther, it is only used to highlight the <> items. The htmlScriptitem does extend the htmlRef item.
Another example:
:syn region xmlFold start="<a>" end="</a>" fold transparent keepend extend
This defines a region with "keepend", so that its end cannot bechanged by contained items, like when the "</a>" is matched tohighlight it differently. But when the xmlFold region is nested (itincludes itself), the "extend" applies, so that the "</a>" of a nestedregion only ends that region, and not the one it is contained in.
:syn-excludenl
When a pattern for a match or end pattern of a region includes a '$'to match the end-of-line, it will make a region item that it iscontained in continue on the next line. For example, a match with"\\$" (backslash at the end of the line) can make a region continuethat would normally stop at the end of the line. This is the defaultbehavior. If this is not wanted, there are two ways to avoid it:1. Use "keepend" for the containing item. This will keep all contained matches from extending the match or region. It can be used when all contained items must not extend the containing item.2. Use "excludenl" in the contained item. This will keep that match from extending the containing match or region. It can be used if only some contained items must not extend the containing item. "excludenl" must be given before the pattern it applies to.
:syn-matchgroup
"matchgroup" can be used to highlight the start and/or end patterndifferently than the body of the region. Example:
:syntax region String matchgroup=Quote start=+"+  skip=+\\"+end=+"+
This will highlight the quotes with the "Quote" group, and the text inbetween with the "String" group.The "matchgroup" is used for all start and end patterns that follow,until the next "matchgroup". Use "matchgroup=NONE" to go back to notusing a matchgroup.
In a start or end pattern that is highlighted with "matchgroup" thecontained items of the region are not used. This can be used to avoidthat a contained item matches in the start or end pattern match. Whenusing "transparent", this does not apply to a start or end patternmatch that is highlighted with "matchgroup".
Here is an example, which highlights three levels of parentheses indifferent colors:
:sy region par1 matchgroup=par1 start=/(/ end=/)/ contains=par2:sy region par2 matchgroup=par2 start=/(/ end=/)/ contains=par3 contained:sy region par3 matchgroup=par3 start=/(/ end=/)/ contains=par1 contained:hi par1 ctermfg=red guifg=red:hi par2 ctermfg=blue guifg=blue:hi par3 ctermfg=darkgreen guifg=darkgreen
E849
The maximum number of syntax groups is 19999.

7. :syntax arguments:syn-arguments

The :syntax commands that define syntax items take a number of arguments.The common ones are explained here. The arguments may be given in any orderand may be mixed with patterns.
Not all commands accept all arguments.This table shows which argumentscan not be used for all commands:E395
contains onelinefold display extend concealends~:syntax keyword - - - - - -:syntax matchyes -yesyesyes -:syntax regionyesyesyesyesyes yes
These arguments can be used for all three commands:concealccharcontainedcontainedinnextgrouptransparentskipwhiteskipnlskipempty
concealconceal:syn-conceal
When the "conceal" argument is given, the item is marked as concealable.Whether or not it is actually concealed depends on the value of the'conceallevel' option. The'concealcursor' option is used to decide whetherconcealable items in the current line are displayed unconcealed to be able toedit the line.
Another way to conceal text is withmatchadd(), but internally this works abit differentlysyntax-vs-match.
concealends:syn-concealends
When the "concealends" argument is given, the start and end matches ofthe region, but not the contents of the region, are marked as concealable.Whether or not they are actually concealed depends on the setting on the'conceallevel' option. The ends of a region can only be concealed separatelyin this way when they have their own highlighting via "matchgroup". Thesynconcealed() function can be used to retrieve information about conealeditems.
cchar:syn-cchar
E844
The "cchar" argument defines the character shown in place of the itemwhen it is concealed (setting "cchar" only makes sense when the concealargument is given.) If "cchar" is not set then the default concealcharacter defined in the'listchars' option is used. The character cannot bea control character such as Tab. Example:
:syntax match Entity "&amp;" conceal cchar=&
Seehl-Conceal for highlighting.
contained:syn-contained
When the "contained" argument is given, this item will not be recognized atthe top level, but only when it is mentioned in the "contains" field ofanother match.Example:
:syntax keyword Todo    TODO    contained:syntax match   Comment "//.*"  contains=Todo
display:syn-display
If the "display" argument is given, this item will be skipped when thedetected highlighting will not be displayed. This will speed up highlighting,by skipping this item when only finding the syntax state for the text that isto be displayed.
Generally, you can use "display" for match and region items that meet theseconditions:
The item does not continue past the end of a line. Example for C: A region for a "/*" comment can't contain "display", because it continues on the next line.
The item does not contain items that continue past the end of the line or make it continue on the next line.
The item does not change the size of any item it is contained in. Example for C: A match with "\\$" in a preprocessor match can't have "display", because it may make that preprocessor match shorter.
The item does not allow other items to match that didn't match otherwise, and that item may extend the match too far. Example for C: A match for a "//" comment can't use "display", because a "/*" inside that comment would match then and start a comment which extends past the end of the line.
Examples, for the C language, where "display" can be used:
match with a number
match with a label
transparent:syn-transparent
If the "transparent" argument is given, this item will not be highlighteditself, but will take the highlighting of the item it is contained in.Thisis useful for syntax items that don't need any highlighting but are usedonly to skip over a part of the text.
The "contains=" argument is also inherited from the item it is contained in,unless a "contains" argument is given for the transparent item itself.Toavoid that unwanted items are contained, use "contains=NONE". Example, whichhighlights words in strings, but makes an exception for "vim":
:syn match myString /'[^']*'/ contains=myWord,myVim:syn match myWord   /\<[a-z]*\>/ contained:syn match myVim    /\<vim\>/ transparent contained contains=NONE:hi link myString String:hi link myWord   Comment
Since the "myVim" match comes after "myWord" it is the preferred match (lastmatch in the same position overrules an earlier one). The "transparent"argument makes the "myVim" match use the same highlighting as "myString". Butit does not contain anything. If the "contains=NONE" argument would be leftout, then "myVim" would use the contains argument from myString and allow"myWord" to be contained, which will be highlighted as a Comment. Thishappens because a contained match doesn't match inside itself in the sameposition, thus the "myVim" match doesn't overrule the "myWord" match here.
When you look at the colored text, it is like looking at layers of containeditems.The contained item is on top of the item it is contained in, thus yousee the contained item. When a contained item is transparent, you can lookthrough, thus you see the item it is contained in. In a picture:
look from here
|| || || VV VV VV
xxxx yyymore contained items ....................contained item (transparent)=============================first item
The 'x', 'y' and '=' represent a highlighted syntax item. The '.' represent atransparent group.
What you see is:
=======xxxx=======yyy========
Thus you look through the transparent "....".
oneline:syn-oneline
The "oneline" argument indicates that the region does not cross a lineboundary. It must match completely in the current line. However, when theregion has a contained item that does cross a line boundary, it continues onthe next line anyway. A contained item can be used to recognize a linecontinuation pattern. But the "end" pattern must still match in the firstline, otherwise the region doesn't even start.
When the start pattern includes a "\n" to match an end-of-line, the endpattern must be found in the same line as where the start pattern ends. Theend pattern may also include an end-of-line. Thus the "oneline" argumentmeans that the end of the start pattern and the start of the end pattern mustbe within one line. This can't be changed by a skip pattern that matches aline break.
fold:syn-fold
The "fold" argument makes the fold level increase by one for this item.Example:
:syn region myFold start="{" end="}" transparent fold:syn sync fromstart:set foldmethod=syntax
This will make each {} block form one fold.
The fold will start on the line where the item starts, and end where the itemends. If the start and end are within the same line, there is no fold.The'foldnestmax' option limits the nesting of syntax folds.See:syn-foldlevel to control how the foldlevel of a line is computedfrom its syntax items.
:syn-containsE405E406E407E408E409contains={group-name},...
The "contains" argument is followed by a list of syntax group names. Thesegroups will be allowed to begin inside the item (they may extend past thecontaining group's end). This allows for recursive nesting of matches andregions. If there is no "contains" argument, no groups will be contained inthis item. The group names do not need to be defined before they can be usedhere.
contains=ALLIf the only item in the contains list is "ALL", then allgroups will be accepted inside the item.
contains=ALLBUT,{group-name},...If the first item in the contains list is "ALLBUT", then allgroups will be accepted inside the item, except the ones thatare listed. Example:
:syntax region Block start="{" end="}" ... contains=ALLBUT,Function
contains=TOPIf the first item in the contains list is "TOP", then allgroups will be accepted that don't have the "contained"argument.contains=TOP,{group-name},...Like "TOP", but excluding the groups that are listed.
contains=CONTAINEDIf the first item in the contains list is "CONTAINED", thenall groups will be accepted that have the "contained"argument.contains=CONTAINED,{group-name},...Like "CONTAINED", but excluding the groups that arelisted.
The{group-name} in the "contains" list can be a pattern. All group namesthat match the pattern will be included (or excluded, if "ALLBUT" is used).The pattern cannot contain white space or a ','. Example:
... contains=Comment.*,Keyw[0-3]
The matching will be done at moment the syntax command is executed. Groupsthat are defined later will not be matched. Also, if the current syntaxcommand defines a new group, it is not matched. Be careful: When puttingsyntax commands in a file you can't rely on groups NOT being defined, becausethe file may have been sourced before, and ":syn clear" doesn't remove thegroup names.
The contained groups will also match in the start and end patterns of aregion. If this is not wanted, the "matchgroup" argument can be used:syn-matchgroup. The "ms=" and "me=" offsets can be used to change theregion where contained items do match.Note that this may also limit thearea that is highlighted
containedin={group-name},...:syn-containedin
The "containedin" argument is followed by a list of syntax group names. Theitem will be allowed to begin inside these groups. This works as if thecontaining item has a "contains=" argument that includes this item.
Only the immediate containing item (the one at the top of the syntax stack) isconsidered. Vim does not search other ancestors. If the immediate containerneither contains this item via:syn-contains nor is named in this item's"containedin=", the match will not start even if some ancestor would allow it.Note that a:syn-transparent region still enforces its own:syn-containslist.
The{group-name},... can be used just like for "contains", as explained above.
This is useful when adding a syntax item afterwards. An item can be told tobe included inside an already existing item, without changing the definitionof that item. For example, to highlight a word in a C comment after loadingthe C syntax:
:syn keyword myword HELP containedin=cComment contained
Note that "contained" is also used, to avoid that the item matches at the toplevel.
Matches for "containedin" are added to the other places where the item canappear. A "contains" argument may also be added as usual. Don't forget thatkeywords never contain another item, thus adding them to "containedin" won'twork.See also::syn-contains,:syn-transparent.
nextgroup={group-name},...:syn-nextgroup
The "nextgroup" argument is followed by a list of syntax group names,separated by commas (just like with "contains", so you can also use patterns).
If the "nextgroup" argument is given, the mentioned syntax groups will betried for a match, after the match or region ends. If none of the groups havea match, highlighting continues normally. If there is a match, this groupwill be used, even when it is not mentioned in the "contains" field of thecurrent group.This is like giving the mentioned group priority over allother groups. Example:
:syntax match  ccFoobar  "Foo.\{-}Bar"  contains=ccFoo:syntax match  ccFoo     "Foo"    contained nextgroup=ccFiller:syntax region ccFiller  start="."  matchgroup=ccBar  end="Bar"  contained
This will highlight "Foo" and "Bar" differently, and only when there is a"Bar" after "Foo". In the text line below, "f" shows where ccFoo is used forhighlighting, and "bbb" where ccBar is used.
Foo asdfasd Bar asdf Foo asdf Bar asdffff       bbbfff bbb
Note the use of ".\{-}" to skip as little as possible until the next Bar.when ".*" would be used, the "asdf" in between "Bar" and "Foo" would behighlighted according to the "ccFoobar" group, because the ccFooBar matchwould include the first "Foo" and the last "Bar" in the line (seepattern).
skipwhite:syn-skipwhite
skipnl:syn-skipnl
skipempty:syn-skipempty
These arguments are only used in combination with "nextgroup".They can beused to allow the next group to match after skipping some text:skipwhiteskip over space and tab charactersskipnlskip over the end of a lineskipemptyskip over empty lines (implies a "skipnl")
When "skipwhite" is present, the white space is only skipped if there is nonext group that matches the white space.
When "skipnl" is present, the match with nextgroup may be found in the nextline. This only happens when the current item ends at the end of the currentline! When "skipnl" is not present, the nextgroup will only be found afterthe current item in the same line.
When skipping text while looking for a next group, the matches for othergroups are ignored. Only when no next group matches, other items are triedfor a match again. This means that matching a next group and skipping whitespace and<EOL>s has a higher priority than other items.
Example:
:syn match ifstart "\<if.*"  nextgroup=ifline skipwhite skipempty:syn match ifline  "[^ \t].*" nextgroup=ifline skipwhite skipempty contained:syn match ifline  "endif"contained
Note that the "[^ \t].*" match matches all non-white text. Thus it would alsomatch "endif".Therefore the "endif" match is put last, so that it takesprecedence.Note that this example doesn't work for nested "if"s. You need to add"contains" arguments to make that work (omitted for simplicity of theexample).

IMPLICIT CONCEAL:syn-conceal-implicit

:sy[ntax] conceal [on|off]This defines if the following ":syntax" commands will define keywords,matches or regions with the "conceal" flag set. After ":syn concealon", all subsequent ":syn keyword", ":syn match" or ":syn region"defined will have the "conceal" flag set implicitly. ":syn concealoff" returns to the normal state where the "conceal" flag must begiven explicitly.
:sy[ntax] concealShow either "syntax conceal on" or "syntax conceal off".

8. Syntax patterns:syn-patternE401E402

In the syntax commands, a pattern must be surrounded by two identicalcharacters. This is like it works for the ":s" command. The most common touse is the double quote. But if the pattern contains a double quote, you canuse another character that is not used in the pattern.Examples:
:syntax region Comment  start="/\*"  end="\*/":syntax region String   start=+"+    end=+"+ skip=+\\"+
Seepattern for the explanation of what a pattern is. Syntax patterns arealways interpreted like the'magic' option is set, no matter what the actualvalue of'magic' is. And the patterns are interpreted like the 'l' flag isnot included in'cpoptions'. This was done to make syntax files portable andindependent of the'magic' setting.
Try to avoid patterns that can match an empty string, such as "[a-z]*".This slows down the highlighting a lot, because it matches everywhere.
:syn-pattern-offset
The pattern can be followed by a character offset. This can be used tochange the highlighted part, and to change the text area included in thematch or region (which only matters when trying to match other items).Bothare relative to the matched pattern. The character offset for a skippattern can be used to tell where to continue looking for an end pattern.
The offset takes the form of "{what}={offset}"The{what} can be one of seven strings:
msMatch Startoffset for the start of the matched textmeMatch Endoffset for the end of the matched texthsHighlight Startoffset for where the highlighting startsheHighlight Endoffset for where the highlighting endsrsRegion Startoffset for where the body of a region startsreRegion Endoffset for where the body of a region endslcLeading Contextoffset past "leading context" of pattern
The{offset} can be:
sstart of the matched patterns+{nr}start of the matched pattern plus{nr} chars to the rights-{nr}start of the matched pattern plus{nr} chars to the lefteend of the matched patterne+{nr}end of the matched pattern plus{nr} chars to the righte-{nr}end of the matched pattern plus{nr} chars to the left{nr}(for "lc" only): start matching{nr} chars right of the start
Examples: "ms=s+1", "hs=e-2", "lc=3".
Although all offsets are accepted after any pattern, they are not alwaysmeaningful. This table shows which offsets are actually used:
ms me hs hers re lc
match item yes yes yes yes- - yesregion item start yes - yes -yes - yesregion item skip - yes - -- - yesregion item end - yes - yes- yes yes
Offsets can be concatenated, with a ',' in between. Example:
:syn match String  /"[^"]*"/hs=s+1,he=e-1
some "string" text ^^^^^^highlighted
Notes:
There must be no white space between the pattern and the character offset(s).
The highlighted area will never be outside of the matched text.
A negative offset for an end pattern may not always work, because the end pattern may be detected when the highlighting should already have stopped.
Before Vim 7.2 the offsets were counted in bytes instead of characters. This didn't work well for multibyte characters, so it was changed with the Vim 7.2 release.
The start of a match cannot be in a line other than where the pattern matched. This doesn't work: "a\nb"ms=e. You can make the highlighting start in another line, this does work: "a\nb"hs=e.
Example (match a comment but don't highlight the/* and */):
:syntax region Comment start="/\*"hs=e+1 end="\*/"he=s-1
/* this is a comment */  ^^^^^^^^^^^^^^^^^^^  highlighted
A more complicated Example:
: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
abcfoostringbarabc   mmmmmmmmmmm    match     sssrrreee    highlight start/region/end ("Foo", "Exa" and "Bar")
Leading context:syn-lc:syn-leading:syn-context
Note: This is an obsolete feature, only included for backwards compatibilitywith previous Vim versions. It's now recommended to use the/\@<= constructin the pattern. You can also often use/\zs.
The "lc" offset specifies leading context -- a part of the pattern that mustbe present, but is not considered part of the match. An offset of "lc=n" willcause Vim to step back n columns before attempting the pattern match, allowingcharacters which have already been matched in previous patterns to also beused as leading context for this match. This can be used, for instance, tospecify that an "escaping" character must not precede the match:
:syn match ZNoBackslash "[^\\]z"ms=s+1:syn match WNoBackslash "[^\\]w"lc=1:syn match Underline "_\+"
___zzzz ___wwww ^^^ ^^^ matches Underline ^ ^ matches ZNoBackslash ^^^^ matches WNoBackslash
The "ms" offset is automatically set to the same value as the "lc" offset,unless you set "ms" explicitly.
Multi-line patterns:syn-multi-line
The patterns can include "\n" to match an end-of-line.Mostly this works asexpected, but there are a few exceptions.
When using a start pattern with an offset, the start of the match is notallowed to start in a following line. The highlighting can start in afollowing line though. Using the "\zs" item also requires that the start ofthe match doesn't move to another line.
The skip pattern can include the "\n", but the search for an end pattern willcontinue in the first character of the next line, also when that character ismatched by the skip pattern. This is because redrawing may start in any linehalfway in a region and there is no check if the skip pattern started in aprevious line. For example, if the skip pattern is "a\nb" and an end patternis "b", the end pattern does match in the second line of this:
x x ab x x
Generally this means that the skip pattern should not match any charactersafter the "\n".
External matches:syn-ext-match
These extra regular expression items are available in region patterns:
/\z(/\z(\)E50E52E879 \z(\)Marks the sub-expression as "external", meaning that it can beaccessed from another pattern match. Currently only usable indefining a syntax region start pattern.
/\z1/\z2/\z3/\z4/\z5 \z1 ... \z9/\z6/\z7/\z8/\z9E66E67Matches the same string that was matched by the correspondingsub-expression in a previous start pattern match.
Sometimes the start and end patterns of a region need to share a commonsub-expression. A common example is the "here" document in Perl and many Unixshells. This effect can be achieved with the "\z" special regular expressionitems, which marks a sub-expression as "external", in the sense that it can bereferenced from outside the pattern in which it is defined. The here-documentexample, for instance, can be done like this:
:syn region hereDoc start="<<\z(\I\i*\)" end="^\z1$"
As can be seen here, the \z actually does double duty.In the start pattern,it marks the "\(\I\i*\)" sub-expression as external; in the end pattern, itchanges the \z1 back-reference into an external reference referring to thefirst external sub-expression in the start pattern. External references canalso be used in skip patterns:
:syn region foo start="start \z(\I\i*\)" skip="not end \z1" end="end \z1"
Note that normal and external sub-expressions are completely orthogonal andindexed separately; for instance, if the pattern "\z(..\)\(..\)" is appliedto the string "aabb", then \1 will refer to "bb" and \z1 will refer to "aa".Note also that external sub-expressions cannot be accessed as back-referenceswithin the same pattern like normal sub-expressions. If you want to use onesub-expression as both a normal and an external sub-expression, you can nestthe two, as in "\(\z(...\)\)".
Note that only matches within a single line can be used. Multi-line matchescannot be referred to.

9. Syntax clusters:syn-clusterE400

:sy[ntax] cluster{cluster-name} [contains={group-name},...] [add={group-name},...] [remove={group-name},...]
This command allows you to cluster a list of syntax groups together under asingle name.
contains={group-name},...The cluster is set to the specified list of groups.add={group-name},...The specified groups are added to the cluster.remove={group-name},...The specified groups are removed from the cluster.
A cluster so defined may be referred to in a contains=..., containedin=...,nextgroup=..., add=... or remove=... list with a "@" prefix. You can also usethis notation to implicitly declare a cluster before specifying its contents.
Example:
:syntax match Thing "# [^#]\+ #" contains=@ThingMembers:syntax cluster ThingMembers contains=ThingMember1,ThingMember2
As the previous example suggests, modifications to a cluster are effectivelyretroactive; the membership of the cluster is checked at the last minute, soto speak:
:syntax keyword A aaa:syntax keyword B bbb:syntax cluster AandB contains=A:syntax match Stuff "( aaa bbb )" contains=@AandB:syntax cluster AandB add=B  " now both keywords are matched in Stuff
This also has implications for nested clusters:
:syntax keyword A aaa:syntax keyword B bbb:syntax cluster SmallGroup contains=B:syntax cluster BigGroup contains=A,@SmallGroup:syntax match Stuff "( aaa bbb )" contains=@BigGroup:syntax cluster BigGroup remove=B" no effect, since B isn't in BigGroup:syntax cluster SmallGroup remove=B" now bbb isn't matched within Stuff
E848
The maximum number of clusters is 9767.

10. Including syntax files:syn-includeE397

It is often useful for one language's syntax file to include a syntax file fora related language. Depending on the exact relationship, this can be done intwo different ways:
If top-level syntax items in the included syntax file are to be allowed at the top level in the including syntax, you can simply use the:runtime command:
" In cpp.vim::runtime! syntax/c.vim:unlet b:current_syntax
If top-level syntax items in the included syntax file are to be contained within a region in the including syntax, you can use the ":syntax include" command:
:sy[ntax] include [@{grouplist-name}]{file-name}
All syntax items declared in the included file will have the "contained" flag added. In addition, if a group list is specified, all top-level syntax items in the included file will be added to that list.
" In perl.vim::syntax include @Pod <script>:p:h/pod.vim:syntax region perlPOD start="^=head" end="^=cut" contains=@Pod
When{file-name} is an absolute path (starts with "/", "c:", "$VAR" or "<script>") that file is sourced. When it is a relative path (e.g., "syntax/pod.vim") the file is searched for in'runtimepath'. All matching files are loaded. Using a relative path is recommended, because it allows a user to replace the included file with their own version, without replacing the file that does the ":syn include".
E847
The maximum number of includes is 999.

11. Synchronizing:syn-syncE403E404

Vim wants to be able to start redrawing in any position in the document. Tomake this possible it needs to know the syntax state at the position whereredrawing starts.
:sy[ntax] sync [ccomment [group-name] | minlines={N} | ...]
There are four ways to synchronize:1. Always parse from the start of the file.:syn-sync-first2. Based on C-style comments. Vim understands how C-comments work and can figure out if the current line starts inside or outside a comment.:syn-sync-second3. Jumping back a certain number of lines and start parsing there.:syn-sync-third4. Searching backwards in the text for a pattern to sync on.:syn-sync-fourth
:syn-sync-maxlines:syn-sync-minlinesFor the last three methods, the line range where the parsing can start islimited by "minlines" and "maxlines".
If the "minlines={N}" argument is given, the parsing always starts at leastthat many lines backwards. This can be used if the parsing may take a fewlines before it's correct, or when it's not possible to use syncing.
If the "maxlines={N}" argument is given, the number of lines that are searchedfor a comment or syncing pattern is restricted to N lines backwards (afteradding "minlines"). This is useful if you have few things to sync on and aslow machine. Example:
:syntax sync maxlines=500 ccomment
:syn-sync-linebreaks
When using a pattern that matches multiple lines, a change in one line maycause a pattern to no longer match in a previous line.This means has tostart above where the change was made.How many lines can be specified withthe "linebreaks" argument. For example, when a pattern may include one linebreak use this:
:syntax sync linebreaks=1
The result is that redrawing always starts at least one line before where achange was made. The default value for "linebreaks" is zero. Usually thevalue for "minlines" is bigger than "linebreaks".
First syncing method::syn-sync-first
:syntax sync fromstart
The file will be parsed from the start. This makes syntax highlightingaccurate, but can be slow for long files. Vim caches previously parsed text,so that it's only slow when parsing the text for the first time. However,when making changes some part of the text needs to be parsed again (worstcase: to the end of the file).
Using "fromstart" is equivalent to using "minlines" with a very large number.
Second syncing method::syn-sync-second:syn-sync-ccomment
For the second method, only the "ccomment" argument needs to be given.Example:
:syntax sync ccomment
When Vim finds that the line where displaying starts is inside a C-stylecomment, the last region syntax item with the group-name "Comment" will beused. This requires that there is a region with the group-name "Comment"!An alternate group name can be specified, for example:
:syntax sync ccomment javaComment
This means that the last item specified with "syn region javaComment" will beused for the detected C comment region. This only works properly if thatregion does have a start pattern "\/*" and an end pattern "*\/".
The "maxlines" argument can be used to restrict the search to a number oflines.The "minlines" argument can be used to at least start a number oflines back (e.g., for when there is some construct that only takes a fewlines, but it hard to sync on).
Note: Syncing on a C comment doesn't work properly when strings are usedthat cross a line and contain a "*/". Since letting strings cross a lineis a bad programming habit (many compilers give a warning message), and thechance of a "*/" appearing inside a comment is very small, this restrictionis hardly ever noticed.
Third syncing method::syn-sync-third
For the third method, only the "minlines={N}" argument needs to be given.Vim will subtract{N} from the line number and start parsing there. Thismeans{N} extra lines need to be parsed, which makes this method a bit slower.Example:
:syntax sync minlines=50
"lines" is equivalent to "minlines" (used by older versions).
Fourth syncing method::syn-sync-fourth
The idea is to synchronize on the end of a few specific regions, called async pattern. Only regions can cross lines, so when we find the end of someregion, we might be able to know in which syntax item we are. The searchstarts in the line just above the one where redrawing starts. From therethe search continues backwards in the file.
This works just like the non-syncing syntax items. You can use containedmatches, nextgroup, etc. But there are a few differences:
Keywords cannot be used.
The syntax items with the "sync" keyword form a completely separated group of syntax items. You can't mix syncing groups and non-syncing groups.
The matching works backwards in the buffer (line by line), instead of forwards.
A line continuation pattern can be given. It is used to decide which group of lines need to be searched like they were one line. This means that the search for a match with the specified items starts in the first of the consecutive lines that contain the continuation pattern.
When using "nextgroup" or "contains", this only works within one line (or group of continued lines).
When using a region, it must start and end in the same line (or group of continued lines). Otherwise the end is assumed to be at the end of the line (or group of continued lines).
When a match with a sync pattern is found, the rest of the line (or group of continued lines) is searched for another match. The last match is used. This is used when a line can contain both the start and the end of a region (e.g., in a C-comment like/* this */, the last "*/" is used).
There are two ways how a match with a sync pattern can be used:1. Parsing for highlighting starts where redrawing starts (and where the search for the sync pattern started). The syntax group that is expected to be valid there must be specified. This works well when the regions that cross lines cannot contain other regions.2. Parsing for highlighting continues just after the match. The syntax group that is expected to be present just after the match must be specified. This can be used when the previous method doesn't work well. It's much slower, because more text needs to be parsed.Both types of sync patterns can be used at the same time.
Besides the sync patterns, other matches and regions can be specified, toavoid finding unwanted matches.
[The reason that the sync patterns are given separately, is that mostly thesearch for the sync point can be much simpler than figuring out thehighlighting. The reduced number of patterns means it will go (much)faster.]
syn-sync-grouphereE393E394 :syntax sync match{sync-group-name} grouphere{group-name} "pattern" ...
Define a match that is used for syncing.{group-name} is thename of a syntax group that follows just after the match. Parsingof the text for highlighting starts just after the match. A regionmust exist for this{group-name}. The first one defined will be used."NONE" can be used for when there is no syntax group after the match.
syn-sync-groupthere
:syntax sync match{sync-group-name} groupthere{group-name} "pattern" ...
Like "grouphere", but{group-name} is the name of a syntax group thatis to be used at the start of the line where searching for the syncpoint started.The text between the match and the start of the syncpattern searching is assumed not to change the syntax highlighting.For example, in C you could search backwards for "/*" and "*/". If"/*" is found first, you know that you are inside a comment, so the"groupthere" is "cComment". If "*/" is found first, you know that youare not in a comment, so the "groupthere" is "NONE". (in practiceit's a bit more complicated, because the "/*" and "*/" could appearinside a string. That's left as an exercise to the reader...).
:syntax sync match ... :syntax sync region ...
Without a "groupthere" argument. Define a region or match that isskipped while searching for a sync point.
syn-sync-linecont
:syntax sync linecont{pattern}
When{pattern} matches in a line, it is considered to continue inthe next line.This means that the search for a sync point willconsider the lines to be concatenated.
If the "maxlines={N}" argument is given too, the number of lines that aresearched for a match is restricted to N. This is useful if you have veryfew things to sync on and a slow machine. Example:
:syntax sync maxlines=100
You can clear all sync settings with:
:syntax sync clear
You can clear specific sync patterns with:
:syntax sync clear {sync-group-name} ...

12. Listing syntax items:syntax:sy:syn:syn-list

This command lists all the syntax items:
:sy[ntax] [list]
To show the syntax items for one syntax group:
:sy[ntax] list {group-name}
To list the syntax groups in one cluster:E392
:sy[ntax] list @{cluster-name}
See above for other arguments for the ":syntax" command.
Note that the ":syntax" command can be abbreviated to ":sy", although ":syn"is mostly used, because it looks better.

13. Highlight command:highlight:hiE28E411E415

Nvim uses a range of highlight groups which fall into two categories: Editorinterface and syntax highlighting. In rough order of importance, these are
basic editorhighlight-groups
standard syntaxgroup-names (in addition, syntax files can define language-specific groups, which are prefixed with the language name)
diagnostic-highlights
treesitter-highlight-groups
lsp-semantic-highlight groups
lsp-highlight of symbols and references
Where appropriate, highlight groups are linked by default to one of the more basicgroups, but colorschemes are expected to cover all of them. Under each tag,the corresponding highlight groups are highlighted using the currentcolorscheme.
:colo:colorschemeE185:colo[rscheme]Output the name of the currently active color scheme.This is basically the same as
:echo g:colors_name
In case g:colors_name has not been defined :colo willoutput "default".
:colo[rscheme]{name}Load color scheme{name}. This searches'runtimepath'for the file "colors/{name}.{vim,lua}". The first onethat is found is loaded.Note: "colors/{name}.vim" is tried first.Also searches all plugins in'packpath', first below"start" and then under "opt".
Doesn't work recursively, thus you can't use":colorscheme" in a color scheme script.
To customize a color scheme use another name, e.g."~/.config/nvim/colors/mine.vim", and use:runtime toload the original color scheme:
runtime colors/evening.vimhi Statement ctermfg=Blue guifg=Blue
Before the color scheme will be loaded theColorSchemePre autocommand event is triggered.After the color scheme has been loaded theColorScheme autocommand event is triggered.For info about writing a color scheme file:
:edit $VIMRUNTIME/colors/README.txt
:hi[ghlight]List all the current highlight groups that haveattributes set.
:hi[ghlight]{group-name}List one highlight group.
highlight-clear:hi-clear:hi[ghlight] clearReset all highlighting to the defaults. Removes allhighlighting for groups added by the user.Uses the current value of'background' to decide whichdefault colors to use.If there was a default link, restore it.:hi-link
:hi[ghlight] clear{group-name}:hi[ghlight]{group-name} NONEDisable the highlighting for one highlight group. Itis _not_ set back to the default colors.
:hi[ghlight] [default]{group-name}{key}={arg} ...Add a highlight group, or change the highlighting foran existing group.Seehighlight-args for the{key}={arg} arguments.See:highlight-default for the optional [default]argument.
Normally a highlight group is added once when starting up. This sets thedefault values for the highlighting. After that, you can use additionalhighlight commands to change the arguments that you want to set to non-defaultvalues. The value "NONE" can be used to switch the value off or go back tothe default value.
A simple way to change colors is with the:colorscheme command. This loadsa file with ":highlight" commands such as this:
:hi Commentgui=bold
Note that all settings that are not included remain the same, only thespecified field is used, and settings are merged with previous ones. So, theresult is like this single command has been used:
:hi Commentctermfg=Cyan guifg=#80a0ff gui=bold
:highlight-verbose
When listing a highlight group and'verbose' is non-zero, the listing willalso tell where it was last set. Example:
:verbose hi Comment
Comment xxx ctermfg=4 guifg=Blue
Last set from /home/mool/vim/vim7/runtime/syntax/syncolor.vim
When ":hi clear" is used then the script where this command is used will bementioned for the default values. See:verbose-cmd for more information.
highlight-argsE416E417E423There are two types of UIs for highlighting:ctermterminal UI (TUI)guiGUI or RGB-capable TUI ('termguicolors')
For each type the highlighting can be given. This makes it possible to usethe same syntax file on all UIs.
1. TUI highlight arguments
boldunderlineundercurlunderdoubleunderdottedunderdashedinverseitalicstandoutstrikethroughaltfontnocombine
cterm={attr-list}attr-listhighlight-ctermE418attr-list is a comma-separated list (without spaces) of thefollowing items (in any order):boldunderlineundercurlcurly underlineunderdoubledouble underlineunderdotteddotted underlineunderdasheddashed underlinestrikethroughreverseinversesame as reverseitalicstandoutaltfontnocombineoverride attributes instead of combining themNONEno attributes used (used to reset it)
Note that "bold" can be used here and by using a bold font. Theyhave the same effect."undercurl", "underdouble", "underdotted", and "underdashed" fall backto "underline" in a terminal that does not support them. The color isset usingguisp.
start={term-list}highlight-startE422stop={term-list}term-listhighlight-stopThese lists of terminal codes can be used to getnon-standard attributes on a terminal.
The escape sequence specified with the "start" argumentis written before the characters in the highlightedarea. It can be anything that you want to send to theterminal to highlight this area. The escape sequencespecified with the "stop" argument is written after thehighlighted area. This should undo the "start" argument.Otherwise the screen will look messed up.
{term-list} is a string with escape sequences. This is any string of characters, except that it can't start with "t_" and blanks are not allowed. The <> notation is recognized here, so you can use things like "<Esc>" and "<Space>". Example:start=<Esc>[27h;<Esc>[<Space>r;
ctermfg={color-nr}ctermfgE421ctermbg={color-nr}ctermbg
The{color-nr} argument is a color number. Its range is zero to(not including) the number oftui-colors available.The actual color with this number depends on the type of terminaland its settings. Sometimes the color also depends on the settings of"cterm". For example, on some systems "cterm=bold ctermfg=3" givesanother color, on others you just get color 3.
The following (case-insensitive) names are recognized:
cterm-colors
NR-16 NR-8 COLOR NAME
0 0 Black 1 4 DarkBlue 2 2 DarkGreen 3 6 DarkCyan 4 1 DarkRed 5 5 DarkMagenta 6 3 Brown, DarkYellow 7 7 LightGray, LightGrey, Gray, Grey 8 0* DarkGray, DarkGrey 9 4* Blue, LightBlue 10 2* Green, LightGreen 11 6* Cyan, LightCyan 12 1* Red, LightRed 13 5* Magenta, LightMagenta 14 3* Yellow, LightYellow 15 7* White
The number under "NR-16" is used for 16-color terminals ('t_Co'greater than or equal to 16). The number under "NR-8" is used for8-color terminals ('t_Co' less than 16). The "*" indicates that thebold attribute is set for ctermfg. In many 8-color terminals (e.g.,"linux"), this causes the bright colors to appear. This doesn't workfor background colors!Without the "*" the bold attribute is removed.If you want to set the bold attribute in a different way, put a"cterm=" argument AFTER the "ctermfg=" or "ctermbg=" argument.Or usea number instead of a color name.
Note that for 16 color ansi style terminals (including xterms), thenumbers in the NR-8 column is used. Here "*" means "add 8" so thatBlue is 12, DarkGray is 8 etc.
Note that for some color terminals these names may result in the wrongcolors!
You can also use "NONE" to remove the color.
:hi-normal-cterm
When setting the "ctermfg" or "ctermbg" colors for the Normal group,these will become the colors used for the non-highlighted text.Example:
:highlight Normal ctermfg=grey ctermbg=darkblue
When setting the "ctermbg" color for the Normal group, the'background' option will be adjusted automatically, under thecondition that the color is recognized and'background' was not setexplicitly. This causes the highlight groups that depend on'background' to change! This means you should set the colors forNormal first, before setting other colors.When a color scheme is being used, changing'background' causes it tobe reloaded, which may reset all colors (including Normal). Firstdelete the "g:colors_name" variable when you don't want this.
When you have set "ctermfg" or "ctermbg" for the Normal group, Vimneeds to reset the color when exiting.This is done with the"orig_pair"terminfo entry.E419E420When Vim knows the normal foreground and background colors, "fg" and"bg" can be used as color names. This only works after setting thecolors for the Normal group and for the MS-Windows console. Example,for reverse video:
:highlight Visual ctermfg=bg ctermbg=fg
Note that the colors are used that are valid at the moment thiscommand are given. If the Normal group colors are changed later, the"fg" and "bg" colors will not be adjusted.
2. GUI highlight arguments
gui={attr-list}highlight-gui
These give the attributes to use in the GUI mode.Seeattr-list for a description.Note that "bold" can be used here and by using a bold font. Theyhave the same effect.Note that the attributes are ignored for the "Normal" group.
font={font-name}highlight-font
font-name is the name of a font, as it is used on the system Vimruns on. For X11 this is a complicated name, for example:
font=-misc-fixed-bold-r-normal--14-130-75-75-c-70-iso8859-1
The font-name "NONE" can be used to revert to the default font.When setting the font for the "Normal" group, this becomes the defaultfont (until the'guifont' option is changed; the last one set isused).The following only works with Motif not with other GUIs:When setting the font for the "Menu" group, the menus will be changed.When setting the font for the "Tooltip" group, the tooltips will bechanged.All fonts used, except for Menu and Tooltip, should be of the samecharacter size as the default font! Otherwise redrawing problems willoccur.To use a font name with an embedded space or other special character,put it in single quotes. The single quote cannot be used then.Example:
:hi comment font='Monospace 10'
guifg={color-name}guifg
guibg={color-name}guibg
guisp={color-name}guisp
These give the foreground (guifg), background (guibg) and special(guisp) color to use in the GUI. "guisp" is used for variousunderlines.There are a few special names:NONEno color (transparent)bguse normal background colorbackgrounduse normal background colorfguse normal foreground colorforegrounduse normal foreground colorTo use a color name with an embedded space or other special character,put it in single quotes. The single quote cannot be used then.Example:
:hi comment guifg='salmon pink'
gui-colors
Suggested color names (these are available on most systems): RedLightRedDarkRed GreenLightGreenDarkGreenSeaGreen BlueLightBlueDarkBlueSlateBlue CyanLightCyanDarkCyan MagentaLightMagentaDarkMagenta YellowLightYellowBrownDarkYellow GrayLightGrayDarkGray BlackWhite OrangePurpleViolet
Colors which define Nvim's default color scheme: NvimDarkBlue NvimLightBlue NvimDarkCyan NvimLightCyan NvimDarkGray1 NvimLightGray1 NvimDarkGray2 NvimLightGray2 NvimDarkGray3 NvimLightGray3 NvimDarkGray4 NvimLightGray4 NvimDarkGreen NvimLightGreen NvimDarkMagenta NvimLightMagenta NvimDarkRed NvimLightRed NvimDarkYellow NvimLightYellow
You can also specify a color by its RGB (red, green, blue) values.The format is "#rrggbb", where"rr"is the Red value"gg"is the Green value"bb"is the Blue valueAll values are hexadecimal, range from "00" to "ff". Examples:
:highlight Comment guifg=#11f0c3 guibg=#ff00ff
blend={integer}highlight-blendopacityOverride the blend level for a highlight group within the popupmenuor floating windows. Only takes effect if'pumblend' or'winblend'is set for the menu or window. See the help at the respective option.
See also the "blend" flag ofnvim_buf_set_extmark().
highlight-groupshighlight-defaultThese are the builtin highlighting groups. Note that the highlighting dependson the value of'background'. You can see the current settings with the":highlight" command.hl-ColorColumn
ColorColumnUsed for the columns set with'colorcolumn'.hl-Conceal
ConcealPlaceholder characters substituted for concealedtext (see'conceallevel').hl-CurSearch
CurSearchCurrent match for the last search pattern (see'hlsearch').Note: This is correct after a search, but may get outdated ifchanges are made or the screen is redrawn.hl-Cursorhl-lCursorCursorCharacter under the cursor.lCursorCharacter under the cursor whenlanguage-mappingis used (see'guicursor').hl-CursorIM
CursorIMLike Cursor, but used when in IME mode.CursorIMhl-CursorColumn
CursorColumnScreen-column at the cursor, when'cursorcolumn' is set.hl-CursorLine
CursorLineScreen-line at the cursor, when'cursorline' is set.Low-priority if foreground (ctermfg OR guifg) is not set.hl-Directory
DirectoryDirectory names (and other special names in listings).hl-DiffAdd
DiffAddDiff mode: Added line.diff.txthl-DiffChange
DiffChangeDiff mode: Changed line.diff.txthl-DiffDelete
DiffDeleteDiff mode: Deleted line.diff.txthl-DiffText
DiffTextDiff mode: Changed text within a changed line.diff.txthl-DiffTextAdd
DiffTextAddDiff mode: Added text within a changed line. Linked tohl-DiffText by default.diff.txthl-EndOfBuffer
EndOfBufferFiller lines (~) after the last line in the buffer.By default, this is highlighted likehl-NonText.hl-TermCursor
TermCursorCursor in a focused terminal.hl-OkMsg
OkMsgSuccess messages.hl-WarningMsg
WarningMsgWarning messages.hl-ErrorMsg
ErrorMsgError messages.hl-StderrMsg
StderrMsgMessages in stderr from shell commands.hl-StdoutMsg
StdoutMsgMessages in stdout from shell commands.hl-WinSeparator
WinSeparatorSeparators between window splits.hl-Folded
FoldedLine used for closed folds.hl-FoldColumn
FoldColumn'foldcolumn'hl-SignColumn
SignColumnColumn wheresigns are displayed.hl-IncSearch
IncSearch'incsearch' highlighting; also used for the text replaced with":s///c".hl-Substitute
Substitute:substitute replacement text highlighting.hl-LineNr
LineNrLine number for ":number" and ":#" commands, and when'number'or'relativenumber' option is set.hl-LineNrAbove
LineNrAboveLine number for when the'relativenumber'option is set, above the cursor line.hl-LineNrBelow
LineNrBelowLine number for when the'relativenumber'option is set, below the cursor line.hl-CursorLineNr
CursorLineNrLike LineNr when'cursorline' is set and'cursorlineopt'contains "number" or is "both", for the cursor line.hl-CursorLineFold
CursorLineFoldLike FoldColumn when'cursorline' is set for the cursor line.hl-CursorLineSign
CursorLineSignLike SignColumn when'cursorline' is set for the cursor line.hl-MatchParen
MatchParenCharacter under the cursor or just before it, if itis a paired bracket, and its match.pi_paren.txthl-ModeMsg
ModeMsg'showmode' message (e.g., "-- INSERT --").hl-MsgArea
MsgAreaArea for messages and command-line, see also'cmdheight'.hl-MsgSeparator
MsgSeparatorSeparator for scrolled messagesmsgsep.hl-MoreMsg
MoreMsgmore-prompthl-NonText
NonText'@' at the end of the window, characters from'showbreak'and other characters that do not really exist in the text(e.g., ">" displayed when a double-wide character doesn'tfit at the end of the line). See alsohl-EndOfBuffer.hl-Normal
NormalNormal text.hl-NormalFloat
NormalFloatNormal text in floating windows.hl-FloatBorder
FloatBorderBorder of floating windows.hl-FloatShadow
FloatShadowBlended areas when border is "shadow".hl-FLoatShadowThrough
FloatShadowThroughShadow corners when border is "shadow".hl-FloatTitle
FloatTitleTitle of floating windows.hl-FloatFooter
FloatFooterFooter of floating windows.hl-NormalNC
NormalNCNormal text in non-current windows.hl-Pmenu
PmenuPopup menu: Normal item.hl-PmenuSel
PmenuSelPopup menu: Selected item. Combined withhl-Pmenu.hl-PmenuKind
PmenuKindPopup menu: Normal item "kind".hl-PmenuKindSel
PmenuKindSelPopup menu: Selected item "kind".hl-PmenuExtra
PmenuExtraPopup menu: Normal item "extra text".hl-PmenuExtraSel
PmenuExtraSelPopup menu: Selected item "extra text".hl-PmenuSbar
PmenuSbarPopup menu: Scrollbar.hl-PmenuThumb
PmenuThumbPopup menu: Thumb of the scrollbar.hl-PmenuMatch
PmenuMatchPopup menu: Matched text in normal item. Combined withhl-Pmenu.hl-PmenuMatchSel
PmenuMatchSelPopup menu: Matched text in selected item. Combined withhl-PmenuMatch andhl-PmenuSel.hl-PmenuBorder
PmenuBorderPopup menu: border of popup menu.hl-PmenuShadow
PmenuShadowPopup menu: blended areas when'pumborder' is "shadow".hl-PmenuShadowThrough
PmenuShadowThroughPopup menu: shadow corners when'pumborder' is "shadow".hl-ComplMatchIns
ComplMatchInsMatched text of the currently inserted completion.hl-PreInsert
PreInsertText inserted when "preinsert" is in'completeopt'.hl-ComplHint
ComplHintVirtual text of the currently selected completion.hl-ComplHintMore
ComplHintMoreThe additional information of the virtual text.hl-Question
Questionhit-enter prompt and yes/no questions.hl-QuickFixLine
QuickFixLineCurrentquickfix item in the quickfix window. Combined withhl-CursorLine when the cursor is there.hl-Search
SearchLast search pattern highlighting (see'hlsearch').Also used for similar items that need to stand out.hl-SnippetTabstop
SnippetTabstopTabstops in snippets.vim.snippethl-SnippetTabstopActive
SnippetTabstopActiveThe currently active tabstop.vim.snippethl-SpecialKey
SpecialKeyUnprintable characters: Text displayed differently from whatit really is. But not'listchars' whitespace.hl-Whitespacehl-SpellBad
SpellBadWord that is not recognized by the spellchecker.spellCombined with the highlighting used otherwise.hl-SpellCap
SpellCapWord that should start with a capital.spellCombined with the highlighting used otherwise.hl-SpellLocal
SpellLocalWord that is recognized by the spellchecker as one that isused in another region.spellCombined with the highlighting used otherwise.hl-SpellRare
SpellRareWord that is recognized by the spellchecker as one that ishardly ever used.spellCombined with the highlighting used otherwise.hl-StatusLine
StatusLineStatus line of current window.hl-StatusLineNC
StatusLineNCStatus lines of not-current windows.hl-StatusLineTerm
StatusLineTermStatus line ofterminal window.hl-StatusLineTermNC
StatusLineTermNCStatus line of non-currentterminal windows.hl-TabLine
TabLineTab pages line, not active tab page label.hl-TabLineFill
TabLineFillTab pages line, where there are no labels.hl-TabLineSel
TabLineSelTab pages line, active tab page label.hl-Title
TitleTitles for output from ":set all", ":autocmd" etc.hl-Visual
VisualVisual mode selection.hl-VisualNOS
VisualNOSVisual mode selection when vim is "Not Owning the Selection".hl-Whitespace
Whitespace"nbsp", "space", "tab", "multispace", "lead" and "trail"in'listchars'.hl-WildMenu
WildMenuCurrent match in'wildmenu' completion.hl-WinBar
WinBarWindow bar of current window.hl-WinBarNC
WinBarNCWindow bar of not-current windows.
hl-User1hl-User1..9hl-User9The'statusline' syntax allows the use of 9 different highlights in thestatusline and ruler (via'rulerformat'). The names are User1 to User9.
For the GUI you can use the following groups to set the colors for the menu,scrollbars and tooltips. They don't have defaults. This doesn't work for theWin32 GUI. Only three highlight arguments have any effect here: font, guibg,and guifg.
hl-Menu
MenuCurrent font, background and foreground colors of the menus.Also used for the toolbar.Applicable highlight arguments: font, guibg, guifg.
hl-Scrollbar
ScrollbarCurrent background and foreground of the main window'sscrollbars.Applicable highlight arguments: guibg, guifg.
hl-Tooltip
TooltipCurrent font, background and foreground of the tooltips.Applicable highlight arguments: font, guibg, guifg.

14. Linking groups:hi-link:highlight-linkE412E413

When you want to use the same highlighting for several syntax groups, youcan do this more easily by linking the groups into one common highlightgroup, and give the color attributes only for that group.
To set a link:
:hi[ghlight][!] [default] link{from-group}{to-group}
To remove a link:
:hi[ghlight][!] [default] link{from-group} NONE
Notes:E414
If the{from-group} and/or{to-group} doesn't exist, it is created. You don't get an error message for a non-existing group.
As soon as you use a ":highlight" command for a linked group, the link is removed.
If there are already highlight settings for the{from-group}, the link is not made, unless the '!' is given. For a ":highlight link" command in a sourced file, you don't get an error message. This can be used to skip links for groups that already have settings.
:hi-default:highlight-defaultThe [default] argument is used for setting the default highlighting for agroup.If highlighting has already been specified for the group the commandwill be ignored. Also when there is an existing link.
Using [default] is especially useful to overrule the highlighting of aspecific syntax file. For example, the C syntax file contains:
:highlight default link cComment Comment
If you like Question highlighting for C comments, put this in your vimrc file:
:highlight link cComment Question
Without the "default" in the C syntax file, the highlighting would beoverruled when the syntax file is loaded.
To have a link survive:highlight clear, which is useful if you havehighlighting for a specific filetype and you want to keep it when selectinganother color scheme, put a command like this in the"after/syntax/{filetype}.vim" file:
highlight! default link cComment Question

15. Cleaning up:syn-clearE391

If you want to clear the syntax stuff for the current buffer, you can use thiscommand:
:syntax clear
This command should be used when you want to switch off syntax highlighting,or when you want to switch to using another syntax. It's normally not neededin a syntax file itself, because syntax is cleared by the autocommands thatload the syntax file.The command also deletes the "b:current_syntax" variable, since no syntax isloaded after this command.
To clean up specific syntax groups for the current buffer:
:syntax clear {group-name} ...
This removes all patterns and keywords for{group-name}.
To clean up specific syntax group lists for the current buffer:
:syntax clear @{grouplist-name} ...
This sets{grouplist-name}'s contents to an empty list.
:syntax-off:syn-offIf you want to disable syntax highlighting for all buffers, you need to removethe autocommands that load the syntax files:
:syntax off
What this command actually does, is executing the command
:source $VIMRUNTIME/syntax/nosyntax.vim
See the "nosyntax.vim" file for details. Note that for this to work$VIMRUNTIME must be valid. See$VIMRUNTIME.
:syntax-reset:syn-resetIf you have changed the colors and messed them up, use this command to get thedefaults back:
:syntax reset
It is a bit of a wrong name, since it does not reset any syntax items, it onlyaffects the highlighting.
Note that the syntax colors that you set in your vimrc file will also be resetback to their Vim default.Note that if you are using a color scheme, the colors defined by the colorscheme for syntax highlighting will be lost.
Note that when a color scheme is used, there might be some confusion whetheryour defined colors are to be used or the colors from the scheme. Thisdepends on the color scheme file. See:colorscheme.

16. Highlighting tagstag-highlight

If you want to highlight all the tags in your file, you can use the followingmappings.
<F11>-- Generate tags.vim file, and highlight tags.<F12>-- Just highlight tags based on existing tags.vim file.
:map <F11>  :sp tags<CR>:%s/^\([^:]*:\)\=\([^]*\).*/syntax keyword Tag \2/<CR>:wq! tags.vim<CR>/^<CR><F12>:map <F12>  :so tags.vim<CR>
WARNING: The longer the tags file, the slower this will be, and the morememory Vim will consume.
Only highlighting typedefs, unions and structs can be done too. For this youmust use Universal Ctags (https://ctags.io) or Exuberant ctags.
Put these lines in your Makefile:
# Make a highlight file for types.  Requires Universal/Exuberant ctags and awktypes: types.vimtypes.vim: *.[ch]        ctags --c-kinds=gstu -o- *.[ch] |\                awk 'BEGIN{printf("syntax keyword Type\t")}\                        {printf("%s ", $$1)}END{print ""}' > $@
And put these lines in your vimrc:
" load the types.vim highlighting file, if it existsautocmd BufRead,BufNewFile *.[ch] let fname = expand('<afile>:p:h') .. '/types.vim'autocmd BufRead,BufNewFile *.[ch] if filereadable(fname)autocmd BufRead,BufNewFile *.[ch]   exe 'so ' .. fnameautocmd BufRead,BufNewFile *.[ch] endif

17. Color xtermsxterm-colorcolor-xterm

colortest.vim
To test your color setup, a file has been included in the Vim distribution.To use it, execute this command:
:runtime syntax/colortest.vim
Nvim uses 256-color andtrue-color terminal capabilities wherever possible.

18. When syntax is slow:synti:syntime

This is aimed at authors of a syntax file.
If your syntax causes redrawing to be slow, here are a few hints on making itfaster. To see slowness switch on some features that usually interfere, suchas'relativenumber' andfolding.
To find out what patterns are consuming the most time, get an overview withthis sequence:
:syntime on[ redraw the text at least once with CTRL-L ]:syntime report
This will display a list of syntax patterns that were used, sorted by the timeit took to match them against the text.
:synti[me] onStart measuring syntax times. This will add someoverhead to compute the time spent on syntax patternmatching.
:synti[me] offStop measuring syntax times.
:synti[me] clearSet all the counters to zero, restart measuring.
:synti[me] reportShow the syntax items used since ":syntime on" in thecurrent window. Use a wider display to see more ofthe output.
The list is sorted by total time. The columns are:TOTALTotal time in seconds spent onmatching this pattern.COUNTNumber of times the pattern was used.MATCHNumber of times the pattern actuallymatchedSLOWESTThe longest time for one try.AVERAGEThe average time for one try.NAMEName of the syntax item. Note thatthis is not unique.PATTERNThe pattern being used.
Pattern matching gets slow when it has to try many alternatives. Try toinclude as much literal text as possible to reduce the number of ways apattern does NOT match.
When using the "\@<=" and "\@<!" items, add a maximum size to avoid trying atall positions in the current and previous line. For example, if the item isliteral text specify the size of that text (in bytes):
"<\@<=span"Matches "span" in "<span". This tries matching with "<" inmany places."<\@1<=span"Matches the same, but only tries one byte before "span".
Main
Commands index
Quick reference

1. Quick start
2. Syntax files
3. Syntax loading procedure
4. Conversion to HTML
5. Syntax file remarks
6. Defining a syntax
7. :syntax arguments
8. Syntax patterns
9. Syntax clusters
10. Including syntax files
11. Synchronizing
12. Listing syntax items
13. Highlight command
14. Linking groups
15. Cleaning up
16. Highlighting tags
17. Color xterms
18. When syntax is slow

[8]ページ先頭

©2009-2025 Movatter.jp