vim: runtime/doc/syntax.txt annotate

annotate runtime/doc/syntax.txt @ 32669:448aef880252

normalize line endings

author	Christian Brabandt <cb@256bit.org>
date	Mon, 26 Jun 2023 09:54:34 +0200
parents	2a17771529af
children	695b50472e85

rev	line source
32669 448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1 syntax.txt For Vim version 9.0. Last change: 2023 Apr 24
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4 VIM REFERENCE MANUAL by Bram Moolenaar
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	6
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	7 Syntax highlighting syntax syntax-highlighting coloring
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	8
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	9 Syntax highlighting enables Vim to show parts of the text in another font or
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	10 color. Those parts can be specific keywords or text matching a pattern. Vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	11 doesn't parse the whole file (to keep it fast), so the highlighting has its
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	12 limitations. Lexical highlighting might be a better name, but since everybody
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	13 calls it syntax highlighting we'll stick with that.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	14
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	15 Vim supports syntax highlighting on all terminals. But since most ordinary
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	16 terminals have very limited highlighting possibilities, it works best in the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	17 GUI version, gvim.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	18
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	19 In the User Manual:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	20 \|usr_06.txt\| introduces syntax highlighting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	21 \|usr_44.txt\| introduces writing a syntax file.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	22
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	23 1. Quick start \|:syn-qstart\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	24 2. Syntax files \|:syn-files\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	25 3. Syntax loading procedure \|syntax-loading\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	26 4. Converting to HTML \|2html.vim\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	27 5. Syntax file remarks \|:syn-file-remarks\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	28 6. Defining a syntax \|:syn-define\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	29 7. :syntax arguments \|:syn-arguments\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	30 8. Syntax patterns \|:syn-pattern\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	31 9. Syntax clusters \|:syn-cluster\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	32 10. Including syntax files \|:syn-include\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	33 11. Synchronizing \|:syn-sync\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	34 12. Listing syntax items \|:syntax\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	35 13. Colorschemes \|color-schemes\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	36 14. Highlight command \|:highlight\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	37 15. Linking groups \|:highlight-link\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	38 16. Cleaning up \|:syn-clear\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	39 17. Highlighting tags \|tag-highlight\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	40 18. Window-local syntax \|:ownsyntax\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	41 19. Color xterms \|xterm-color\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	42 20. When syntax is slow \|:syntime\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	43
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	44 {Vi does not have any of these commands}
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	45
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	46 Syntax highlighting is not available when the \|+syntax\| feature has been
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	47 disabled at compile time.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	48
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	49 ==============================================================================
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	50 1. Quick start :syn-qstart
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	51
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	52 :syn-enable :syntax-enable
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	53 This command switches on syntax highlighting: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	54
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	55 :syntax enable
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	56
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	57 What this command actually does is to execute the command >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	58 :source $VIMRUNTIME/syntax/syntax.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	59
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	60 If the VIM environment variable is not set, Vim will try to find
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	61 the path in another way (see \|$VIMRUNTIME\|). Usually this works just
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	62 fine. If it doesn't, try setting the VIM environment variable to the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	63 directory where the Vim stuff is located. For example, if your syntax files
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	64 are in the "/usr/vim/vim82/syntax" directory, set $VIMRUNTIME to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	65 "/usr/vim/vim82". You must do this in the shell, before starting Vim.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	66 This command also sources the \|menu.vim\| script when the GUI is running or
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	67 will start soon. See \|'go-M'\| about avoiding that.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	68
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	69 :syn-on :syntax-on
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	70 The `:syntax enable` command will keep most of your current color settings.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	71 This allows using `:highlight` commands to set your preferred colors before or
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	72 after using this command. If you want Vim to overrule your settings with the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	73 defaults, use: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	74 :syntax on
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	75 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	76 :hi-normal :highlight-normal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	77 If you are running in the GUI, you can get white text on a black background
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	78 with: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	79 :highlight Normal guibg=Black guifg=White
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	80 For a color terminal see \|:hi-normal-cterm\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	81 For setting up your own colors syntax highlighting see \|syncolor\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	82
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	83 NOTE: The syntax files on MS-Windows have lines that end in <CR><NL>.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	84 The files for Unix end in <NL>. This means you should use the right type of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	85 file for your system. Although on MS-Windows the right format is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	86 automatically selected if the 'fileformats' option is not empty.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	87
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	88 NOTE: When using reverse video ("gvim -fg white -bg black"), the default value
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	89 of 'background' will not be set until the GUI window is opened, which is after
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	90 reading the \|gvimrc\|. This will cause the wrong default highlighting to be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	91 used. To set the default value of 'background' before switching on
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	92 highlighting, include the ":gui" command in the \|gvimrc\|: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	93
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	94 :gui " open window and set default for 'background'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	95 :syntax on " start highlighting, use 'background' to set colors
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	96
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	97 NOTE: Using ":gui" in the \|gvimrc\| means that "gvim -f" won't start in the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	98 foreground! Use ":gui -f" then.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	99
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	100 g:syntax_on
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	101 You can toggle the syntax on/off with this command: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	102 :if exists("g:syntax_on") \| syntax off \| else \| syntax enable \| endif
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	103
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	104 To put this into a mapping, you can use: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	105 :map <F7> :if exists("g:syntax_on") <Bar>
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	106 \ syntax off <Bar>
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	107 \ else <Bar>
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	108 \ syntax enable <Bar>
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	109 \ endif <CR>
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	110 [using the \|<>\| notation, type this literally]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	111
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	112 Details:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	113 The ":syntax" commands are implemented by sourcing a file. To see exactly how
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	114 this works, look in the file:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	115 command file ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	116 :syntax enable $VIMRUNTIME/syntax/syntax.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	117 :syntax on $VIMRUNTIME/syntax/syntax.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	118 :syntax manual $VIMRUNTIME/syntax/manual.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	119 :syntax off $VIMRUNTIME/syntax/nosyntax.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	120 Also see \|syntax-loading\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	121
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	122 NOTE: If displaying long lines is slow and switching off syntax highlighting
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	123 makes it fast, consider setting the 'synmaxcol' option to a lower value.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	124
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	125 ==============================================================================
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	126 2. Syntax files :syn-files
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	127
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	128 The syntax and highlighting commands for one language are normally stored in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	129 a syntax file. The name convention is: "{name}.vim". Where {name} is the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	130 name of the language, or an abbreviation (to fit the name in 8.3 characters,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	131 a requirement in case the file is used on a DOS filesystem).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	132 Examples:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	133 c.vim perl.vim java.vim html.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	134 cpp.vim sh.vim csh.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	135
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	136 The syntax file can contain any Ex commands, just like a vimrc file. But
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	137 the idea is that only commands for a specific language are included. When a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	138 language is a superset of another language, it may include the other one,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	139 for example, the cpp.vim file could include the c.vim file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	140 :so $VIMRUNTIME/syntax/c.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	141
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	142 The .vim files are normally loaded with an autocommand. For example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	143 :au Syntax c runtime! syntax/c.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	144 :au Syntax cpp runtime! syntax/cpp.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	145 These commands are normally in the file $VIMRUNTIME/syntax/synload.vim.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	146
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	147
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	148 MAKING YOUR OWN SYNTAX FILES mysyntaxfile
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	149
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	150 When you create your own syntax files, and you want to have Vim use these
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	151 automatically with ":syntax enable", do this:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	152
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	153 1. Create your user runtime directory. You would normally use the first item
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	154 of the 'runtimepath' option. Example for Unix: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	155 mkdir ~/.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	156
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	157 2. Create a directory in there called "syntax". For Unix: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	158 mkdir ~/.vim/syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	159
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	160 3. Write the Vim syntax file. Or download one from the internet. Then write
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	161 it in your syntax directory. For example, for the "mine" syntax: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	162 :w ~/.vim/syntax/mine.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	163
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	164 Now you can start using your syntax file manually: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	165 :set syntax=mine
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	166 You don't have to exit Vim to use this.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	167
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	168 If you also want Vim to detect the type of file, see \|new-filetype\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	169
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	170 If you are setting up a system with many users and you don't want each user
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	171 to add the same syntax file, you can use another directory from 'runtimepath'.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	172
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	173
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	174 ADDING TO AN EXISTING SYNTAX FILE mysyntaxfile-add
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	175
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	176 If you are mostly satisfied with an existing syntax file, but would like to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	177 add a few items or change the highlighting, follow these steps:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	178
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	179 1. Create your user directory from 'runtimepath', see above.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	180
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	181 2. Create a directory in there called "after/syntax". For Unix: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	182 mkdir ~/.vim/after
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	183 mkdir ~/.vim/after/syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	184
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	185 3. Write a Vim script that contains the commands you want to use. For
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	186 example, to change the colors for the C syntax: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	187 highlight cComment ctermfg=Green guifg=Green
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	188
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	189 4. Write that file in the "after/syntax" directory. Use the name of the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	190 syntax, with ".vim" added. For our C syntax: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	191 :w ~/.vim/after/syntax/c.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	192
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	193 That's it. The next time you edit a C file the Comment color will be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	194 different. You don't even have to restart Vim.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	195
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	196 If you have multiple files, you can use the filetype as the directory name.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	197 All the "*.vim" files in this directory will be used, for example:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	198 ~/.vim/after/syntax/c/one.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	199 ~/.vim/after/syntax/c/two.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	200
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	201
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	202 REPLACING AN EXISTING SYNTAX FILE mysyntaxfile-replace
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	203
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	204 If you don't like a distributed syntax file, or you have downloaded a new
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	205 version, follow the same steps as for \|mysyntaxfile\| above. Just make sure
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	206 that you write the syntax file in a directory that is early in 'runtimepath'.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	207 Vim will only load the first syntax file found, assuming that it sets
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	208 b:current_syntax.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	209
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	210
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	211 NAMING CONVENTIONS group-name {group-name} E669 W18
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	212
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	213 A syntax group name is to be used for syntax items that match the same kind of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	214 thing. These are then linked to a highlight group that specifies the color.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	215 A syntax group name doesn't specify any color or attributes itself.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	216
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	217 The name for a highlight or syntax group must consist of ASCII letters, digits
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	218 and the underscore. As a regexp: "[a-zA-Z0-9_]*". However, Vim does not give
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	219 an error when using other characters. The maximum length of a group name is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	220 about 200 bytes. E1249
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	221
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	222 To be able to allow each user to pick their favorite set of colors, there must
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	223 be preferred names for highlight groups that are common for many languages.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	224 These are the suggested group names (if syntax highlighting works properly
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	225 you can see the actual color, except for "Ignore"):
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	226
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	227 *Comment any comment
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	228
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	229 *Constant any constant
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	230 String a string constant: "this is a string"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	231 Character a character constant: 'c', '\n'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	232 Number a number constant: 234, 0xff
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	233 Boolean a boolean constant: TRUE, false
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	234 Float a floating point constant: 2.3e10
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	235
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	236 *Identifier any variable name
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	237 Function function name (also: methods for classes)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	238
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	239 *Statement any statement
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	240 Conditional if, then, else, endif, switch, etc.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	241 Repeat for, do, while, etc.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	242 Label case, default, etc.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	243 Operator "sizeof", "+", "*", etc.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	244 Keyword any other keyword
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	245 Exception try, catch, throw
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	246
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	247 *PreProc generic Preprocessor
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	248 Include preprocessor #include
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	249 Define preprocessor #define
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	250 Macro same as Define
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	251 PreCondit preprocessor #if, #else, #endif, etc.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	252
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	253 *Type int, long, char, etc.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	254 StorageClass static, register, volatile, etc.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	255 Structure struct, union, enum, etc.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	256 Typedef A typedef
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	257
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	258 *Special any special symbol
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	259 SpecialChar special character in a constant
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	260 Tag you can use CTRL-] on this
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	261 Delimiter character that needs attention
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	262 SpecialComment special things inside a comment
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	263 Debug debugging statements
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	264
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	265 *Underlined text that stands out, HTML links
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	266
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	267 *Ignore left blank, hidden \|hl-Ignore\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	268
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	269 *Error any erroneous construct
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	270
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	271 *Todo anything that needs extra attention; mostly the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	272 keywords TODO FIXME and XXX
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	273
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	274 The names marked with * are the preferred groups; the others are minor groups.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	275 For the preferred groups, the "syntax.vim" file contains default highlighting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	276 The minor groups are linked to the preferred groups, so they get the same
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	277 highlighting. You can override these defaults by using ":highlight" commands
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	278 after sourcing the "syntax.vim" file.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	279
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	280 Note that highlight group names are not case sensitive. "String" and "string"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	281 can be used for the same group.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	282
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	283 The following names are reserved and cannot be used as a group name:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	284 NONE ALL ALLBUT contains contained
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	285
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	286 hl-Ignore
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	287 When using the Ignore group, you may also consider using the conceal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	288 mechanism. See \|conceal\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	289
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	290 ==============================================================================
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	291 3. Syntax loading procedure syntax-loading
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	292
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	293 This explains the details that happen when the command ":syntax enable" is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	294 issued. When Vim initializes itself, it finds out where the runtime files are
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	295 located. This is used here as the variable \|$VIMRUNTIME\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	296
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	297 ":syntax enable" and ":syntax on" do the following:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	298
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	299 Source $VIMRUNTIME/syntax/syntax.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	300 \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	301 +- Clear out any old syntax by sourcing $VIMRUNTIME/syntax/nosyntax.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	302 \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	303 +- Source first syntax/synload.vim in 'runtimepath'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	304 \| \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	305 \| +- Setup the colors for syntax highlighting. If a color scheme is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	306 \| \| defined it is loaded again with ":colors {name}". Otherwise
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	307 \| \| ":runtime! syntax/syncolor.vim" is used. ":syntax on" overrules
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	308 \| \| existing colors, ":syntax enable" only sets groups that weren't
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	309 \| \| set yet.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	310 \| \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	311 \| +- Set up syntax autocmds to load the appropriate syntax file when
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	312 \| \| the 'syntax' option is set. synload-1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	313 \| \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	314 \| +- Source the user's optional file, from the \|mysyntaxfile\| variable.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	315 \| This is for backwards compatibility with Vim 5.x only. synload-2
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	316 \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	317 +- Do ":filetype on", which does ":runtime! filetype.vim". It loads any
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	318 \| filetype.vim files found. It should always Source
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	319 \| $VIMRUNTIME/filetype.vim, which does the following.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	320 \| \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	321 \| +- Install autocmds based on suffix to set the 'filetype' option
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	322 \| \| This is where the connection between file name and file type is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	323 \| \| made for known file types. synload-3
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	324 \| \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	325 \| +- Source the user's optional file, from the myfiletypefile
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	326 \| \| variable. This is for backwards compatibility with Vim 5.x only.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	327 \| \| synload-4
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	328 \| \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	329 \| +- Install one autocommand which sources scripts.vim when no file
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	330 \| \| type was detected yet. synload-5
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	331 \| \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	332 \| +- Source $VIMRUNTIME/menu.vim, to setup the Syntax menu. \|menu.vim\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	333 \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	334 +- Install a FileType autocommand to set the 'syntax' option when a file
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	335 \| type has been detected. synload-6
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	336 \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	337 +- Execute syntax autocommands to start syntax highlighting for each
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	338 already loaded buffer.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	339
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	340
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	341 Upon loading a file, Vim finds the relevant syntax file as follows:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	342
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	343 Loading the file triggers the BufReadPost autocommands.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	344 \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	345 +- If there is a match with one of the autocommands from \|synload-3\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	346 \| (known file types) or \|synload-4\| (user's file types), the 'filetype'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	347 \| option is set to the file type.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	348 \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	349 +- The autocommand at \|synload-5\| is triggered. If the file type was not
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	350 \| found yet, then scripts.vim is searched for in 'runtimepath'. This
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	351 \| should always load $VIMRUNTIME/scripts.vim, which does the following.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	352 \| \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	353 \| +- Source the user's optional file, from the myscriptsfile
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	354 \| \| variable. This is for backwards compatibility with Vim 5.x only.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	355 \| \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	356 \| +- If the file type is still unknown, check the contents of the file,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	357 \| again with checks like "getline(1) =~ pattern" as to whether the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	358 \| file type can be recognized, and set 'filetype'.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	359 \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	360 +- When the file type was determined and 'filetype' was set, this
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	361 \| triggers the FileType autocommand \|synload-6\| above. It sets
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	362 \| 'syntax' to the determined file type.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	363 \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	364 +- When the 'syntax' option was set above, this triggers an autocommand
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	365 \| from \|synload-1\| (and \|synload-2\|). This find the main syntax file in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	366 \| 'runtimepath', with this command:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	367 \| runtime! syntax/<name>.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	368 \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	369 +- Any other user installed FileType or Syntax autocommands are
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	370 triggered. This can be used to change the highlighting for a specific
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	371 syntax.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	372
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	373 ==============================================================================
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	374 4. Conversion to HTML 2html.vim convert-to-HTML
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	375
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	376 2html is not a syntax file itself, but a script that converts the current
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	377 window into HTML. Vim opens a new window in which it builds the HTML file.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	378
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	379 After you save the resulting file, you can view it with any browser. The
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	380 colors should be exactly the same as you see them in Vim. With
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	381 \|g:html_line_ids\| you can jump to specific lines by adding (for example) #L123
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	382 or #123 to the end of the URL in your browser's address bar. And with
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	383 \|g:html_dynamic_folds\| enabled, you can show or hide the text that is folded
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	384 in Vim.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	385
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	386 You are not supposed to set the 'filetype' or 'syntax' option to "2html"!
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	387 Source the script to convert the current file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	388
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	389 :runtime! syntax/2html.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	390 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	391 Many variables affect the output of 2html.vim; see below. Any of the on/off
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	392 options listed below can be enabled or disabled by setting them explicitly to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	393 the desired value, or restored to their default by removing the variable using
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	394 \|:unlet\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	395
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	396 Remarks:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	397 - Some truly ancient browsers may not show the background colors.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	398 - From most browsers you can also print the file (in color)!
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	399 - The latest TOhtml may actually work with older versions of Vim, but some
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	400 features such as conceal support will not function, and the colors may be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	401 incorrect for an old Vim without GUI support compiled in.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	402
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	403 Here is an example how to run the script over all .c and .h files from a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	404 Unix shell: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	405 for f in *.[ch]; do gvim -f +"syn on" +"run! syntax/2html.vim" +"wq" +"q" $f; done
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	406 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	407 g:html_start_line g:html_end_line
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	408 To restrict the conversion to a range of lines, use a range with the \|:TOhtml\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	409 command below, or set "g:html_start_line" and "g:html_end_line" to the first
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	410 and last line to be converted. Example, using the last set Visual area: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	411
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	412 :let g:html_start_line = line("'<")
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	413 :let g:html_end_line = line("'>")
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	414 :runtime! syntax/2html.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	415 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	416 :TOhtml
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	417 :[range]TOhtml The ":TOhtml" command is defined in a standard plugin.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	418 This command will source \|2html.vim\| for you. When a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	419 range is given, this command sets \|g:html_start_line\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	420 and \|g:html_end_line\| to the start and end of the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	421 range, respectively. Default range is the entire
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	422 buffer.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	423
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	424 If the current window is part of a \|diff\|, unless
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	425 \|g:html_diff_one_file\| is set, :TOhtml will convert
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	426 all windows which are part of the diff in the current
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	427 tab and place them side-by-side in a <table> element
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	428 in the generated HTML. With \|g:html_line_ids\| you can
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	429 jump to lines in specific windows with (for example)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	430 #W1L42 for line 42 in the first diffed window, or
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	431 #W3L87 for line 87 in the third.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	432
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	433 Examples: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	434
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	435 :10,40TOhtml " convert lines 10-40 to html
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	436 :'<,'>TOhtml " convert current/last visual selection
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	437 :TOhtml " convert entire buffer
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	438 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	439 g:html_diff_one_file
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	440 Default: 0.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	441 When 0, and using \|:TOhtml\| all windows involved in a \|diff\| in the current tab
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	442 page are converted to HTML and placed side-by-side in a <table> element. When
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	443 1, only the current buffer is converted.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	444 Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	445
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	446 let g:html_diff_one_file = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	447 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	448 g:html_whole_filler
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	449 Default: 0.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	450 When 0, if \|g:html_diff_one_file\| is 1, a sequence of more than 3 filler lines
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	451 is displayed as three lines with the middle line mentioning the total number
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	452 of inserted lines.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	453 When 1, always display all inserted lines as if \|g:html_diff_one_file\| were
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	454 not set.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	455 >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	456 :let g:html_whole_filler = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	457 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	458 TOhtml-performance g:html_no_progress
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	459 Default: 0.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	460 When 0, display a progress bar in the statusline for each major step in the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	461 2html.vim conversion process.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	462 When 1, do not display the progress bar. This offers a minor speed improvement
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	463 but you won't have any idea how much longer the conversion might take; for big
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	464 files it can take a long time!
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	465 Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	466
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	467 let g:html_no_progress = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	468 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	469 You can obtain better performance improvements by also instructing Vim to not
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	470 run interactively, so that too much time is not taken to redraw as the script
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	471 moves through the buffer, switches windows, and the like: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	472
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	473 vim -E -s -c "let g:html_no_progress=1" -c "syntax on" -c "set ft=c" -c "runtime syntax/2html.vim" -cwqa myfile.c
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	474 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	475 Note that the -s flag prevents loading your .vimrc and any plugins, so you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	476 need to explicitly source/enable anything that will affect the HTML
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	477 conversion. See \|-E\| and \|-s-ex\| for details. It is probably best to create a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	478 script to replace all the -c commands and use it with the -u flag instead of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	479 specifying each command separately.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	480
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	481 hl-TOhtmlProgress TOhtml-progress-color
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	482 When displayed, the progress bar will show colored boxes along the statusline
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	483 as the HTML conversion proceeds. By default, the background color as the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	484 current "DiffDelete" highlight group is used. If "DiffDelete" and "StatusLine"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	485 have the same background color, TOhtml will automatically adjust the color to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	486 differ. If you do not like the automatically selected colors, you can define
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	487 your own highlight colors for the progress bar. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	488
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	489 hi TOhtmlProgress guifg=#c0ffee ctermbg=7
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	490 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	491 g:html_number_lines
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	492 Default: Current 'number' setting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	493 When 0, buffer text is displayed in the generated HTML without line numbering.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	494 When 1, a column of line numbers is added to the generated HTML with the same
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	495 highlighting as the line number column in Vim (\|hl-LineNr\|).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	496 Force line numbers even if 'number' is not set: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	497 :let g:html_number_lines = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	498 Force to omit the line numbers: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	499 :let g:html_number_lines = 0
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	500 Go back to the default to use 'number' by deleting the variable: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	501 :unlet g:html_number_lines
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	502 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	503 g:html_line_ids
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	504 Default: 1 if \|g:html_number_lines\| is set, 0 otherwise.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	505 When 1, adds an HTML id attribute to each line number, or to an empty <span>
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	506 inserted for that purpose if no line numbers are shown. This ID attribute
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	507 takes the form of L123 for single-buffer HTML pages, or W2L123 for diff-view
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	508 pages, and is used to jump to a specific line (in a specific window of a diff
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	509 view). Javascript is inserted to open any closed dynamic folds
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	510 (\|g:html_dynamic_folds\|) containing the specified line before jumping. The
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	511 javascript also allows omitting the window ID in the url, and the leading L.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	512 For example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	513
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	514 page.html#L123 jumps to line 123 in a single-buffer file
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	515 page.html#123 does the same
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	516
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	517 diff.html#W1L42 jumps to line 42 in the first window in a diff
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	518 diff.html#42 does the same
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	519 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	520 g:html_use_css
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	521 Default: 1.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	522 When 1, generate valid HTML 5 markup with CSS styling, supported in all modern
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	523 browsers and many old browsers.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	524 When 0, generate <font> tags and similar outdated markup. This is not
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	525 recommended but it may work better in really old browsers, email clients,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	526 forum posts, and similar situations where basic CSS support is unavailable.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	527 Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	528 :let g:html_use_css = 0
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	529 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	530 g:html_ignore_conceal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	531 Default: 0.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	532 When 0, concealed text is removed from the HTML and replaced with a character
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	533 from \|:syn-cchar\| or 'listchars' as appropriate, depending on the current
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	534 value of 'conceallevel'.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	535 When 1, include all text from the buffer in the generated HTML, even if it is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	536 \|conceal\|ed.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	537
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	538 Either of the following commands will ensure that all text in the buffer is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	539 included in the generated HTML (unless it is folded): >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	540 :let g:html_ignore_conceal = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	541 :setl conceallevel=0
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	542 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	543 g:html_ignore_folding
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	544 Default: 0.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	545 When 0, text in a closed fold is replaced by the text shown for the fold in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	546 Vim (\|fold-foldtext\|). See \|g:html_dynamic_folds\| if you also want to allow
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	547 the user to expand the fold as in Vim to see the text inside.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	548 When 1, include all text from the buffer in the generated HTML; whether the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	549 text is in a fold has no impact at all. \|g:html_dynamic_folds\| has no effect.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	550
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	551 Either of these commands will ensure that all text in the buffer is included
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	552 in the generated HTML (unless it is concealed): >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	553 zR
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	554 :let g:html_ignore_folding = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	555 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	556 g:html_dynamic_folds
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	557 Default: 0.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	558 When 0, text in a closed fold is not included at all in the generated HTML.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	559 When 1, generate javascript to open a fold and show the text within, just like
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	560 in Vim.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	561
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	562 Setting this variable to 1 causes 2html.vim to always use CSS for styling,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	563 regardless of what \|g:html_use_css\| is set to.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	564
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	565 This variable is ignored when \|g:html_ignore_folding\| is set.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	566 >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	567 :let g:html_dynamic_folds = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	568 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	569 g:html_no_foldcolumn
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	570 Default: 0.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	571 When 0, if \|g:html_dynamic_folds\| is 1, generate a column of text similar to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	572 Vim's foldcolumn (\|fold-foldcolumn\|) the user can click on to toggle folds
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	573 open or closed. The minimum width of the generated text column is the current
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	574 'foldcolumn' setting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	575 When 1, do not generate this column; instead, hovering the mouse cursor over
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	576 folded text will open the fold as if \|g:html_hover_unfold\| were set.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	577 >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	578 :let g:html_no_foldcolumn = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	579 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	580 TOhtml-uncopyable-text g:html_prevent_copy
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	581 Default: Empty string.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	582 This option prevents certain regions of the generated HTML from being copied,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	583 when you select all text in document rendered in a browser and copy it. Useful
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	584 for allowing users to copy-paste only the source text even if a fold column or
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	585 line numbers are shown in the generated content. Specify regions to be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	586 affected in this way as follows:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	587 f: fold column
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	588 n: line numbers (also within fold text)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	589 t: fold text
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	590 d: diff filler
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	591
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	592 Example, to make the fold column and line numbers uncopyable: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	593 :let g:html_prevent_copy = "fn"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	594 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	595 The method used to prevent copying in the generated page depends on the value
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	596 of \|g:html_use_input_for_pc\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	597
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	598 g:html_use_input_for_pc
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	599 Default: "fallback"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	600 If \|g:html_prevent_copy\| is non-empty, then:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	601
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	602 When "all", read-only <input> elements are used in place of normal text for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	603 uncopyable regions. In some browsers, especially older browsers, after
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	604 selecting an entire page and copying the selection, the <input> tags are not
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	605 pasted with the page text. If \|g:html_no_invalid\| is 0, the <input> tags have
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	606 invalid type; this works in more browsers, but the page will not validate.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	607 Note: This method does NOT work in recent versions of Chrome and equivalent
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	608 browsers; the <input> tags get pasted with the text.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	609
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	610 When "fallback" (default value), the same <input> elements are generated for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	611 older browsers, but newer browsers (detected by CSS feature query) hide the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	612 <input> elements and instead use generated content in an ::before pseudoelement
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	613 to display the uncopyable text. This method should work with the largest
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	614 number of browsers, both old and new.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	615
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	616 When "none", the <input> elements are not generated at all. Only the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	617 generated-content method is used. This means that old browsers, notably
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	618 Internet Explorer, will either copy the text intended not to be copyable, or
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	619 the non-copyable text may not appear at all. However, this is the most
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	620 standards-based method, and there will be much less markup.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	621
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	622 g:html_no_invalid
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	623 Default: 0.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	624 When 0, if \|g:html_prevent_copy\| is non-empty and \|g:html_use_input_for_pc\| is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	625 not "none", an invalid attribute is intentionally inserted into the <input>
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	626 element for the uncopyable areas. This prevents pasting the <input> elements
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	627 in some applications. Specifically, some versions of Microsoft Word will not
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	628 paste the <input> elements if they contain this invalid attribute. When 1, no
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	629 invalid markup is inserted, and the generated page should validate. However,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	630 <input> elements may be pasted into some applications and can be difficult to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	631 remove afterward.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	632
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	633 g:html_hover_unfold
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	634 Default: 0.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	635 When 0, the only way to open a fold generated by 2html.vim with
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	636 \|g:html_dynamic_folds\| set, is to click on the generated fold column.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	637 When 1, use CSS 2.0 to allow the user to open a fold by moving the mouse
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	638 cursor over the displayed fold text. This is useful to allow users with
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	639 disabled javascript to view the folded text.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	640
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	641 Note that old browsers (notably Internet Explorer 6) will not support this
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	642 feature. Browser-specific markup for IE6 is included to fall back to the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	643 normal CSS1 styling so that the folds show up correctly for this browser, but
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	644 they will not be openable without a foldcolumn.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	645 >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	646 :let g:html_hover_unfold = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	647 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	648 g:html_id_expr
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	649 Default: ""
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	650 Dynamic folding and jumping to line IDs rely on unique IDs within the document
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	651 to work. If generated HTML is copied into a larger document, these IDs are no
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	652 longer guaranteed to be unique. Set g:html_id_expr to an expression Vim can
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	653 evaluate to get a unique string to append to each ID used in a given document,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	654 so that the full IDs will be unique even when combined with other content in a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	655 larger HTML document. Example, to append _ and the buffer number to each ID: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	656
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	657 :let g:html_id_expr = '"_" .. bufnr("%")'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	658 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	659 To append a string "_mystring" to the end of each ID: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	660
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	661 :let g:html_id_expr = '"_mystring"'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	662 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	663 Note: When converting a diff view to HTML, the expression will only be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	664 evaluated for the first window in the diff, and the result used for all the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	665 windows.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	666
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	667 TOhtml-wrap-text g:html_pre_wrap
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	668 Default: Current 'wrap' setting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	669 When 0, if \|g:html_no_pre\| is 0 or unset, the text in the generated HTML does
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	670 not wrap at the edge of the browser window.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	671 When 1, if \|g:html_use_css\| is 1, the CSS 2.0 "white-space:pre-wrap" value is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	672 used, causing the text to wrap at whitespace at the edge of the browser
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	673 window.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	674 Explicitly enable text wrapping: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	675 :let g:html_pre_wrap = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	676 Explicitly disable wrapping: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	677 :let g:html_pre_wrap = 0
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	678 Go back to default, determine wrapping from 'wrap' setting: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	679 :unlet g:html_pre_wrap
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	680 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	681 g:html_no_pre
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	682 Default: 0.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	683 When 0, buffer text in the generated HTML is surrounded by <pre>...</pre>
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	684 tags. Series of whitespace is shown as in Vim without special markup, and tab
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	685 characters can be included literally (see \|g:html_expand_tabs\|).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	686 When 1 (not recommended), the <pre> tags are omitted, and a plain <div> is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	687 used instead. Whitespace is replaced by a series of   character
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	688 references, and <br> is used to end each line. This is another way to allow
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	689 text in the generated HTML is wrap (see \|g:html_pre_wrap\|) which also works in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	690 old browsers, but may cause noticeable differences between Vim's display and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	691 the rendered page generated by 2html.vim.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	692 >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	693 :let g:html_no_pre = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	694 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	695 g:html_no_doc
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	696 Default: 0.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	697 When 1 it doesn't generate a full HTML document with a DOCTYPE, <head>,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	698 <body>, etc. If \|g:html_use_css\| is enabled (the default) you'll have to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	699 define the CSS manually. The \|g:html_dynamic_folds\| and \|g:html_line_ids\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	700 settings (off by default) also insert some JavaScript.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	701
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	702
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	703 g:html_no_links
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	704 Default: 0.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	705 Don't generate <a> tags for text that looks like an URL.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	706
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	707 g:html_no_modeline
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	708 Default: 0.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	709 Don't generate a modeline disabling folding.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	710
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	711 g:html_expand_tabs
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	712 Default: 0 if 'tabstop' is 8, 'expandtab' is 0, 'vartabstop' is not in use,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	713 and no fold column or line numbers occur in the generated HTML;
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	714 1 otherwise.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	715 When 1, <Tab> characters in the buffer text are replaced with an appropriate
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	716 number of space characters, or   references if \|g:html_no_pre\| is 1.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	717 When 0, if \|g:html_no_pre\| is 0 or unset, <Tab> characters in the buffer text
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	718 are included as-is in the generated HTML. This is useful for when you want to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	719 allow copy and paste from a browser without losing the actual whitespace in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	720 the source document. Note that this can easily break text alignment and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	721 indentation in the HTML, unless set by default.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	722
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	723 Force \|2html.vim\| to keep <Tab> characters: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	724 :let g:html_expand_tabs = 0
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	725 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	726 Force tabs to be expanded: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	727 :let g:html_expand_tabs = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	728 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	729 TOhtml-encoding-detect TOhtml-encoding
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	730 It is highly recommended to set your desired encoding with
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	731 \|g:html_use_encoding\| for any content which will be placed on a web server.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	732
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	733 If you do not specify an encoding, \|2html.vim\| uses the preferred IANA name
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	734 for the current value of 'fileencoding' if set, or 'encoding' if not.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	735 'encoding' is always used for certain 'buftype' values. 'fileencoding' will be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	736 set to match the chosen document encoding.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	737
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	738 Automatic detection works for the encodings mentioned specifically by name in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	739 \|encoding-names\|, but TOhtml will only automatically use those encodings with
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	740 wide browser support. However, you can override this to support specific
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	741 encodings that may not be automatically detected by default (see options
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	742 below). See http://www.iana.org/assignments/character-sets for the IANA names.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	743
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	744 Note: By default all Unicode encodings are converted to UTF-8 with no BOM in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	745 the generated HTML, as recommended by W3C:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	746
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	747 http://www.w3.org/International/questions/qa-choosing-encodings
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	748 http://www.w3.org/International/questions/qa-byte-order-mark
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	749
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	750 g:html_use_encoding
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	751 Default: none, uses IANA name for current 'fileencoding' as above.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	752 To overrule all automatic charset detection, set g:html_use_encoding to the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	753 name of the charset to be used. It is recommended to set this variable to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	754 something widely supported, like UTF-8, for anything you will be hosting on a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	755 webserver: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	756 :let g:html_use_encoding = "UTF-8"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	757 You can also use this option to omit the line that specifies the charset
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	758 entirely, by setting g:html_use_encoding to an empty string (NOT recommended): >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	759 :let g:html_use_encoding = ""
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	760 To go back to the automatic mechanism, delete the \|g:html_use_encoding\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	761 variable: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	762 :unlet g:html_use_encoding
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	763 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	764 g:html_encoding_override
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	765 Default: none, autoload/tohtml.vim contains default conversions for encodings
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	766 mentioned by name at \|encoding-names\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	767 This option allows \|2html.vim\| to detect the correct 'fileencoding' when you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	768 specify an encoding with \|g:html_use_encoding\| which is not in the default
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	769 list of conversions.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	770
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	771 This is a dictionary of charset-encoding pairs that will replace existing
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	772 pairs automatically detected by TOhtml, or supplement with new pairs.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	773
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	774 Detect the HTML charset "windows-1252" as the encoding "8bit-cp1252": >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	775 :let g:html_encoding_override = {'windows-1252': '8bit-cp1252'}
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	776 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	777 g:html_charset_override
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	778 Default: none, autoload/tohtml.vim contains default conversions for encodings
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	779 mentioned by name at \|encoding-names\| and which have wide
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	780 browser support.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	781 This option allows \|2html.vim\| to detect the HTML charset for any
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	782 'fileencoding' or 'encoding' which is not detected automatically. You can also
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	783 use it to override specific existing encoding-charset pairs. For example,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	784 TOhtml will by default use UTF-8 for all Unicode/UCS encodings. To use UTF-16
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	785 and UTF-32 instead, use: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	786 :let g:html_charset_override = {'ucs-4': 'UTF-32', 'utf-16': 'UTF-16'}
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	787
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	788 Note that documents encoded in either UTF-32 or UTF-16 have known
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	789 compatibility problems with some major browsers.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	790
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	791 g:html_font
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	792 Default: "monospace"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	793 You can specify the font or fonts used in the converted document using
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	794 g:html_font. If this option is set to a string, then the value will be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	795 surrounded with single quotes. If this option is set to a list then each list
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	796 item is surrounded by single quotes and the list is joined with commas. Either
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	797 way, "monospace" is added as the fallback generic family name and the entire
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	798 result used as the font family (using CSS) or font face (if not using CSS).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	799 Examples: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	800
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	801 " font-family: 'Consolas', monospace;
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	802 :let g:html_font = "Consolas"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	803
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	804 " font-family: 'DejaVu Sans Mono', 'Consolas', monospace;
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	805 :let g:html_font = ["DejaVu Sans Mono", "Consolas"]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	806 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	807 convert-to-XML convert-to-XHTML g:html_use_xhtml
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	808 Default: 0.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	809 When 0, generate standard HTML 4.01 (strict when possible).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	810 When 1, generate XHTML 1.0 instead (XML compliant HTML).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	811 >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	812 :let g:html_use_xhtml = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	813 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	814 ==============================================================================
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	815 5. Syntax file remarks :syn-file-remarks
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	816
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	817 b:current_syntax-variable
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	818 Vim stores the name of the syntax that has been loaded in the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	819 "b:current_syntax" variable. You can use this if you want to load other
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	820 settings, depending on which syntax is active. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	821 :au BufReadPost * if b:current_syntax == "csh"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	822 :au BufReadPost * do-some-things
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	823 :au BufReadPost * endif
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	824
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	825
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	826
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	827 ABEL abel.vim ft-abel-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	828
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	829 ABEL highlighting provides some user-defined options. To enable them, assign
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	830 any value to the respective variable. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	831 :let abel_obsolete_ok=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	832 To disable them use ":unlet". Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	833 :unlet abel_obsolete_ok
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	834
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	835 Variable Highlight ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	836 abel_obsolete_ok obsolete keywords are statements, not errors
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	837 abel_cpp_comments_illegal do not interpret '//' as inline comment leader
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	838
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	839
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	840 ADA
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	841
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	842 See \|ft-ada-syntax\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	843
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	844
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	845 ANT ant.vim ft-ant-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	846
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	847 The ant syntax file provides syntax highlighting for javascript and python
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	848 by default. Syntax highlighting for other script languages can be installed
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	849 by the function AntSyntaxScript(), which takes the tag name as first argument
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	850 and the script syntax file name as second argument. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	851
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	852 :call AntSyntaxScript('perl', 'perl.vim')
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	853
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	854 will install syntax perl highlighting for the following ant code >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	855
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	856 <script language = 'perl'><![CDATA[
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	857 # everything inside is highlighted as perl
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	858 ]]></script>
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	859
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	860 See \|mysyntaxfile-add\| for installing script languages permanently.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	861
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	862
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	863 APACHE apache.vim ft-apache-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	864
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	865 The apache syntax file provides syntax highlighting for Apache HTTP server
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	866 version 2.2.3.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	867
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	868
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	869 asm.vim asmh8300.vim nasm.vim masm.vim asm68k
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	870 ASSEMBLY ft-asm-syntax ft-asmh8300-syntax ft-nasm-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	871 ft-masm-syntax ft-asm68k-syntax fasm.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	872
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	873 Files matching "*.i" could be Progress or Assembly. If the automatic detection
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	874 doesn't work for you, or you don't edit Progress at all, use this in your
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	875 startup vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	876 :let filetype_i = "asm"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	877 Replace "asm" with the type of assembly you use.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	878
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	879 There are many types of assembly languages that all use the same file name
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	880 extensions. Therefore you will have to select the type yourself, or add a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	881 line in the assembly file that Vim will recognize. Currently these syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	882 files are included:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	883 asm GNU assembly (the default)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	884 asm68k Motorola 680x0 assembly
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	885 asmh8300 Hitachi H-8300 version of GNU assembly
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	886 ia64 Intel Itanium 64
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	887 fasm Flat assembly (http://flatassembler.net)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	888 masm Microsoft assembly (probably works for any 80x86)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	889 nasm Netwide assembly
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	890 tasm Turbo Assembly (with opcodes 80x86 up to Pentium, and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	891 MMX)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	892 pic PIC assembly (currently for PIC16F84)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	893
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	894 The most flexible is to add a line in your assembly file containing: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	895 asmsyntax=nasm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	896 Replace "nasm" with the name of the real assembly syntax. This line must be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	897 one of the first five lines in the file. No non-white text must be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	898 immediately before or after this text. Note that specifying asmsyntax=foo is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	899 equivalent to setting ft=foo in a \|modeline\|, and that in case of a conflict
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	900 between the two settings the one from the modeline will take precedence (in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	901 particular, if you have ft=asm in the modeline, you will get the GNU syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	902 highlighting regardless of what is specified as asmsyntax).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	903
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	904 The syntax type can always be overruled for a specific buffer by setting the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	905 b:asmsyntax variable: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	906 :let b:asmsyntax = "nasm"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	907
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	908 If b:asmsyntax is not set, either automatically or by hand, then the value of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	909 the global variable asmsyntax is used. This can be seen as a default assembly
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	910 language: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	911 :let asmsyntax = "nasm"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	912
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	913 As a last resort, if nothing is defined, the "asm" syntax is used.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	914
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	915
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	916 Netwide assembler (nasm.vim) optional highlighting ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	917
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	918 To enable a feature: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	919 :let {variable}=1\|set syntax=nasm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	920 To disable a feature: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	921 :unlet {variable} \|set syntax=nasm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	922
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	923 Variable Highlight ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	924 nasm_loose_syntax unofficial parser allowed syntax not as Error
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	925 (parser dependent; not recommended)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	926 nasm_ctx_outside_macro contexts outside macro not as Error
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	927 nasm_no_warn potentially risky syntax not as ToDo
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	928
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	929
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	930 ASPPERL and ASPVBS ft-aspperl-syntax ft-aspvbs-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	931
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	932 .asp and .asa files could be either Perl or Visual Basic script. Since it's
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	933 hard to detect this you can set two global variables to tell Vim what you are
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	934 using. For Perl script use: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	935 :let g:filetype_asa = "aspperl"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	936 :let g:filetype_asp = "aspperl"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	937 For Visual Basic use: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	938 :let g:filetype_asa = "aspvbs"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	939 :let g:filetype_asp = "aspvbs"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	940
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	941
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	942 BAAN baan.vim baan-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	943
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	944 The baan.vim gives syntax support for BaanC of release BaanIV up to SSA ERP LN
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	945 for both 3 GL and 4 GL programming. Large number of standard defines/constants
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	946 are supported.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	947
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	948 Some special violation of coding standards will be signalled when one specify
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	949 in ones \|.vimrc\|: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	950 let baan_code_stds=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	951
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	952 baan-folding
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	953
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	954 Syntax folding can be enabled at various levels through the variables
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	955 mentioned below (Set those in your \|.vimrc\|). The more complex folding on
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	956 source blocks and SQL can be CPU intensive.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	957
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	958 To allow any folding and enable folding at function level use: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	959 let baan_fold=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	960 Folding can be enabled at source block level as if, while, for ,... The
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	961 indentation preceding the begin/end keywords has to match (spaces are not
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	962 considered equal to a tab). >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	963 let baan_fold_block=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	964 Folding can be enabled for embedded SQL blocks as SELECT, SELECTDO,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	965 SELECTEMPTY, ... The indentation preceding the begin/end keywords has to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	966 match (spaces are not considered equal to a tab). >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	967 let baan_fold_sql=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	968 Note: Block folding can result in many small folds. It is suggested to \|:set\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	969 the options 'foldminlines' and 'foldnestmax' in \|.vimrc\| or use \|:setlocal\| in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	970 .../after/syntax/baan.vim (see \|after-directory\|). Eg: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	971 set foldminlines=5
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	972 set foldnestmax=6
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	973
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	974
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	975 BASIC basic.vim vb.vim ft-basic-syntax ft-vb-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	976
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	977 Both Visual Basic and "normal" BASIC use the extension ".bas". To detect
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	978 which one should be used, Vim checks for the string "VB_Name" in the first
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	979 five lines of the file. If it is not found, filetype will be "basic",
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	980 otherwise "vb". Files with the ".frm" extension will always be seen as Visual
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	981 Basic.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	982
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	983 If the automatic detection doesn't work for you or you only edit, for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	984 example, FreeBASIC files, use this in your startup vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	985 :let filetype_bas = "freebasic"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	986
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	987
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	988 C c.vim ft-c-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	989
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	990 A few things in C highlighting are optional. To enable them assign any value
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	991 (including zero) to the respective variable. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	992 :let c_comment_strings = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	993 :let c_no_bracket_error = 0
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	994 To disable them use `:unlet`. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	995 :unlet c_comment_strings
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	996 Setting the value to zero doesn't work!
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	997
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	998 An alternative is to switch to the C++ highlighting: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	999 :set filetype=cpp
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1000
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1001 Variable Highlight ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1002 c_gnu GNU gcc specific items
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1003 c_comment_strings strings and numbers inside a comment
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1004 c_space_errors trailing white space and spaces before a <Tab>
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1005 c_no_trail_space_error ... but no trailing spaces
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1006 c_no_tab_space_error ... but no spaces before a <Tab>
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1007 c_no_bracket_error don't highlight {}; inside [] as errors
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1008 c_no_curly_error don't highlight {}; inside [] and () as errors;
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1009 except { and } in first column
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1010 Default is to highlight them, otherwise you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1011 can't spot a missing ")".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1012 c_curly_error highlight a missing } by finding all pairs; this
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1013 forces syncing from the start of the file, can be slow
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1014 c_no_ansi don't do standard ANSI types and constants
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1015 c_ansi_typedefs ... but do standard ANSI types
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1016 c_ansi_constants ... but do standard ANSI constants
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1017 c_no_utf don't highlight \u and \U in strings
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1018 c_syntax_for_h for *.h files use C syntax instead of C++ and use objc
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1019 syntax instead of objcpp
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1020 c_no_if0 don't highlight "#if 0" blocks as comments
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1021 c_no_cformat don't highlight %-formats in strings
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1022 c_no_c99 don't highlight C99 standard items
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1023 c_no_c11 don't highlight C11 standard items
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1024 c_no_bsd don't highlight BSD specific types
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1025
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1026 When 'foldmethod' is set to "syntax" then /* */ comments and { } blocks will
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1027 become a fold. If you don't want comments to become a fold use: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1028 :let c_no_comment_fold = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1029 "#if 0" blocks are also folded, unless: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1030 :let c_no_if0_fold = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1031
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1032 If you notice highlighting errors while scrolling backwards, which are fixed
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1033 when redrawing with CTRL-L, try setting the "c_minlines" internal variable
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1034 to a larger number: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1035 :let c_minlines = 100
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1036 This will make the syntax synchronization start 100 lines before the first
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1037 displayed line. The default value is 50 (15 when c_no_if0 is set). The
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1038 disadvantage of using a larger number is that redrawing can become slow.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1039
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1040 When using the "#if 0" / "#endif" comment highlighting, notice that this only
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1041 works when the "#if 0" is within "c_minlines" from the top of the window. If
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1042 you have a long "#if 0" construct it will not be highlighted correctly.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1043
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1044 To match extra items in comments, use the cCommentGroup cluster.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1045 Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1046 :au Syntax c call MyCadd()
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1047 :function MyCadd()
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1048 : syn keyword cMyItem contained Ni
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1049 : syn cluster cCommentGroup add=cMyItem
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1050 : hi link cMyItem Title
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1051 :endfun
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1052
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1053 ANSI constants will be highlighted with the "cConstant" group. This includes
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1054 "NULL", "SIG_IGN" and others. But not "TRUE", for example, because this is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1055 not in the ANSI standard. If you find this confusing, remove the cConstant
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1056 highlighting: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1057 :hi link cConstant NONE
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1058
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1059 If you see '{' and '}' highlighted as an error where they are OK, reset the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1060 highlighting for cErrInParen and cErrInBracket.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1061
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1062 If you want to use folding in your C files, you can add these lines in a file
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1063 in the "after" directory in 'runtimepath'. For Unix this would be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1064 ~/.vim/after/syntax/c.vim. >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1065 syn sync fromstart
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1066 set foldmethod=syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1067
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1068 CH ch.vim ft-ch-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1069
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1070 C/C++ interpreter. Ch has similar syntax highlighting to C and builds upon
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1071 the C syntax file. See \|c.vim\| for all the settings that are available for C.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1072
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1073 By setting a variable you can tell Vim to use Ch syntax for *.h files, instead
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1074 of C or C++: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1075 :let ch_syntax_for_h = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1076
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1077
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1078 CHILL chill.vim ft-chill-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1079
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1080 Chill syntax highlighting is similar to C. See \|c.vim\| for all the settings
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1081 that are available. Additionally there is:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1082
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1083 chill_space_errors like c_space_errors
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1084 chill_comment_string like c_comment_strings
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1085 chill_minlines like c_minlines
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1086
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1087
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1088 CHANGELOG changelog.vim ft-changelog-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1089
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1090 ChangeLog supports highlighting spaces at the start of a line.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1091 If you do not like this, add following line to your .vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1092 let g:changelog_spacing_errors = 0
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1093 This works the next time you edit a changelog file. You can also use
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1094 "b:changelog_spacing_errors" to set this per buffer (before loading the syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1095 file).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1096
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1097 You can change the highlighting used, e.g., to flag the spaces as an error: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1098 :hi link ChangelogError Error
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1099 Or to avoid the highlighting: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1100 :hi link ChangelogError NONE
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1101 This works immediately.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1102
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1103
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1104 CLOJURE ft-clojure-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1105
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1106 g:clojure_syntax_keywords
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1107
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1108 Syntax highlighting of public vars in "clojure.core" is provided by default,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1109 but additional symbols can be highlighted by adding them to the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1110 \|g:clojure_syntax_keywords\| variable. The value should be a \|Dictionary\| of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1111 syntax group names, each containing a \|List\| of identifiers.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1112 >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1113 let g:clojure_syntax_keywords = {
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1114 \ 'clojureMacro': ["defproject", "defcustom"],
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1115 \ 'clojureFunc': ["string/join", "string/replace"]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1116 \ }
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1117 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1118 Refer to the Clojure syntax script for valid syntax group names.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1119
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1120 There is also b:clojure_syntax_keywords which is a buffer-local variant of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1121 this variable intended for use by plugin authors to highlight symbols
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1122 dynamically.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1123
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1124 By setting the b:clojure_syntax_without_core_keywords variable, vars from
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1125 "clojure.core" will not be highlighted by default. This is useful for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1126 namespaces that have set `(:refer-clojure :only [])`
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1127
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1128
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1129 g:clojure_fold
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1130
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1131 Setting \|g:clojure_fold\| to `1` will enable the folding of Clojure code. Any
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1132 list, vector or map that extends over more than one line can be folded using
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1133 the standard Vim \|fold-commands\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1134
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1135
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1136 g:clojure_discard_macro
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1137
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1138 Set this variable to `1` to enable basic highlighting of Clojure's "discard
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1139 reader macro".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1140 >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1141 #_(defn foo [x]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1142 (println x))
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1143 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1144 Note that this option will not correctly highlight stacked discard macros
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1145 (e.g. `#_#_`).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1146
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1147
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1148 COBOL cobol.vim ft-cobol-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1149
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1150 COBOL highlighting has different needs for legacy code than it does for fresh
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1151 development. This is due to differences in what is being done (maintenance
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1152 versus development) and other factors. To enable legacy code highlighting,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1153 add this line to your .vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1154 :let cobol_legacy_code = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1155 To disable it again, use this: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1156 :unlet cobol_legacy_code
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1157
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1158
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1159 COLD FUSION coldfusion.vim ft-coldfusion-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1160
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1161 The ColdFusion has its own version of HTML comments. To turn on ColdFusion
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1162 comment highlighting, add the following line to your startup file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1163
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1164 :let html_wrong_comments = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1165
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1166 The ColdFusion syntax file is based on the HTML syntax file.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1167
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1168
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1169 CPP cpp.vim ft-cpp-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1170
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1171 Most things are the same as \|ft-c-syntax\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1172
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1173 Variable Highlight ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1174 cpp_no_cpp11 don't highlight C++11 standard items
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1175 cpp_no_cpp14 don't highlight C++14 standard items
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1176 cpp_no_cpp17 don't highlight C++17 standard items
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1177 cpp_no_cpp20 don't highlight C++20 standard items
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1178
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1179
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1180 CSH csh.vim ft-csh-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1181
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1182 This covers the shell named "csh". Note that on some systems tcsh is actually
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1183 used.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1184
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1185 Detecting whether a file is csh or tcsh is notoriously hard. Some systems
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1186 symlink /bin/csh to /bin/tcsh, making it almost impossible to distinguish
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1187 between csh and tcsh. In case VIM guesses wrong you can set the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1188 "filetype_csh" variable. For using csh: g:filetype_csh
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1189 >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1190 :let g:filetype_csh = "csh"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1191
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1192 For using tcsh: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1193
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1194 :let g:filetype_csh = "tcsh"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1195
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1196 Any script with a tcsh extension or a standard tcsh filename (.tcshrc,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1197 tcsh.tcshrc, tcsh.login) will have filetype tcsh. All other tcsh/csh scripts
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1198 will be classified as tcsh, UNLESS the "filetype_csh" variable exists. If the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1199 "filetype_csh" variable exists, the filetype will be set to the value of the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1200 variable.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1201
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1202
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1203 CYNLIB cynlib.vim ft-cynlib-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1204
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1205 Cynlib files are C++ files that use the Cynlib class library to enable
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1206 hardware modelling and simulation using C++. Typically Cynlib files have a .cc
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1207 or a .cpp extension, which makes it very difficult to distinguish them from a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1208 normal C++ file. Thus, to enable Cynlib highlighting for .cc files, add this
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1209 line to your .vimrc file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1210
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1211 :let cynlib_cyntax_for_cc=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1212
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1213 Similarly for cpp files (this extension is only usually used in Windows) >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1214
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1215 :let cynlib_cyntax_for_cpp=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1216
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1217 To disable these again, use this: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1218
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1219 :unlet cynlib_cyntax_for_cc
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1220 :unlet cynlib_cyntax_for_cpp
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1221 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1222
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1223 CWEB cweb.vim ft-cweb-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1224
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1225 Files matching "*.w" could be Progress or cweb. If the automatic detection
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1226 doesn't work for you, or you don't edit Progress at all, use this in your
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1227 startup vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1228 :let filetype_w = "cweb"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1229
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1230
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1231 DART dart.vim ft-dart-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1232
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1233 Dart is an object-oriented, typed, class defined, garbage collected language
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1234 used for developing mobile, desktop, web, and back-end applications. Dart uses
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1235 a C-like syntax derived from C, Java, and JavaScript, with features adopted
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1236 from Smalltalk, Python, Ruby, and others.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1237
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1238 More information about the language and its development environment at the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1239 official Dart language website at https://dart.dev
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1240
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1241 dart.vim syntax detects and highlights Dart statements, reserved words,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1242 type declarations, storage classes, conditionals, loops, interpolated values,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1243 and comments. There is no support idioms from Flutter or any other Dart
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1244 framework.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1245
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1246 Changes, fixes? Submit an issue or pull request via:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1247
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1248 https://github.com/pr3d4t0r/dart-vim-syntax/
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1249
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1250
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1251 DESKTOP desktop.vim ft-desktop-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1252
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1253 Primary goal of this syntax file is to highlight .desktop and .directory files
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1254 according to freedesktop.org standard:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1255 https://specifications.freedesktop.org/desktop-entry-spec/latest/
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1256 To highlight nonstandard extensions that does not begin with X-, set >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1257 let g:desktop_enable_nonstd = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1258 Note that this may cause wrong highlight.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1259 To highlight KDE-reserved features, set >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1260 let g:desktop_enable_kde = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1261 g:desktop_enable_kde follows g:desktop_enable_nonstd if not supplied
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1262
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1263
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1264 DIFF diff.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1265
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1266 The diff highlighting normally finds translated headers. This can be slow if
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1267 there are very long lines in the file. To disable translations: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1268
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1269 :let diff_translations = 0
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1270
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1271 Also see \|diff-slow\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1272
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1273
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1274 DIRCOLORS dircolors.vim ft-dircolors-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1275
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1276 The dircolors utility highlighting definition has one option. It exists to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1277 provide compatibility with the Slackware GNU/Linux distributions version of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1278 the command. It adds a few keywords that are generally ignored by most
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1279 versions. On Slackware systems, however, the utility accepts the keywords and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1280 uses them for processing. To enable the Slackware keywords add the following
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1281 line to your startup file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1282 let dircolors_is_slackware = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1283
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1284
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1285 DOCBOOK docbk.vim ft-docbk-syntax docbook
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1286 DOCBOOK XML docbkxml.vim ft-docbkxml-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1287 DOCBOOK SGML docbksgml.vim ft-docbksgml-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1288
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1289 There are two types of DocBook files: SGML and XML. To specify what type you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1290 are using the "b:docbk_type" variable should be set. Vim does this for you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1291 automatically if it can recognize the type. When Vim can't guess it the type
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1292 defaults to XML.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1293 You can set the type manually: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1294 :let docbk_type = "sgml"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1295 or: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1296 :let docbk_type = "xml"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1297 You need to do this before loading the syntax file, which is complicated.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1298 Simpler is setting the filetype to "docbkxml" or "docbksgml": >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1299 :set filetype=docbksgml
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1300 or: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1301 :set filetype=docbkxml
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1302
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1303 You can specify the DocBook version: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1304 :let docbk_ver = 3
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1305 When not set 4 is used.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1306
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1307
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1308 DOSBATCH dosbatch.vim ft-dosbatch-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1309
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1310 Select the set of Windows Command interpreter extensions that should be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1311 supported with the variable dosbatch_cmdextversion. For versions of Windows
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1312 NT (before Windows 2000) this should have the value of 1. For Windows 2000
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1313 and later it should be 2.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1314 Select the version you want with the following line: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1315
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1316 :let dosbatch_cmdextversion = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1317
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1318 If this variable is not defined it defaults to a value of 2 to support
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1319 Windows 2000 and later.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1320
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1321 The original MS-DOS supports an idiom of using a double colon (::) as an
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1322 alternative way to enter a comment line. This idiom can be used with the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1323 current Windows Command Interpreter, but it can lead to problems when used
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1324 inside ( ... ) command blocks. You can find a discussion about this on
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1325 Stack Overflow -
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1326
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1327 https://stackoverflow.com/questions/12407800/which-comment-style-should-i-use-in-batch-files
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1328
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1329 To allow the use of the :: idiom for comments in the Windows Command
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1330 Interpreter or working with MS-DOS bat files, set the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1331 dosbatch_colons_comment variable to anything: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1332
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1333 :let dosbatch_colons_comment = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1334
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1335 There is an option that covers whether *.btm files should be detected as type
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1336 "dosbatch" (MS-DOS batch files) or type "btm" (4DOS batch files). The latter
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1337 is used by default. You may select the former with the following line: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1338
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1339 :let g:dosbatch_syntax_for_btm = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1340
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1341 If this variable is undefined or zero, btm syntax is selected.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1342
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1343
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1344 DOXYGEN doxygen.vim doxygen-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1345
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1346 Doxygen generates code documentation using a special documentation format
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1347 (similar to Javadoc). This syntax script adds doxygen highlighting to c, cpp,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1348 idl and php files, and should also work with java.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1349
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1350 There are a few of ways to turn on doxygen formatting. It can be done
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1351 explicitly or in a modeline by appending '.doxygen' to the syntax of the file.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1352 Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1353 :set syntax=c.doxygen
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1354 or >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1355 // vim:syntax=c.doxygen
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1356
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1357 It can also be done automatically for C, C++, C#, IDL and PHP files by setting
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1358 the global or buffer-local variable load_doxygen_syntax. This is done by
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1359 adding the following to your .vimrc. >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1360 :let g:load_doxygen_syntax=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1361
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1362 There are a couple of variables that have an effect on syntax highlighting,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1363 and are to do with non-standard highlighting options.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1364
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1365 Variable Default Effect ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1366 g:doxygen_enhanced_color
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1367 g:doxygen_enhanced_colour 0 Use non-standard highlighting for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1368 doxygen comments.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1369
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1370 doxygen_my_rendering 0 Disable rendering of HTML bold, italic
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1371 and html_my_rendering underline.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1372
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1373 doxygen_javadoc_autobrief 1 Set to 0 to disable javadoc autobrief
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1374 colour highlighting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1375
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1376 doxygen_end_punctuation '[.]' Set to regexp match for the ending
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1377 punctuation of brief
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1378
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1379 There are also some highlight groups worth mentioning as they can be useful in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1380 configuration.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1381
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1382 Highlight Effect ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1383 doxygenErrorComment The colour of an end-comment when missing
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1384 punctuation in a code, verbatim or dot section
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1385 doxygenLinkError The colour of an end-comment when missing the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1386 \endlink from a \link section.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1387
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1388
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1389 DTD dtd.vim ft-dtd-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1390
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1391 The DTD syntax highlighting is case sensitive by default. To disable
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1392 case-sensitive highlighting, add the following line to your startup file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1393
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1394 :let dtd_ignore_case=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1395
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1396 The DTD syntax file will highlight unknown tags as errors. If
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1397 this is annoying, it can be turned off by setting: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1398
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1399 :let dtd_no_tag_errors=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1400
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1401 before sourcing the dtd.vim syntax file.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1402 Parameter entity names are highlighted in the definition using the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1403 'Type' highlighting group and 'Comment' for punctuation and '%'.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1404 Parameter entity instances are highlighted using the 'Constant'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1405 highlighting group and the 'Type' highlighting group for the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1406 delimiters % and ;. This can be turned off by setting: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1407
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1408 :let dtd_no_param_entities=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1409
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1410 The DTD syntax file is also included by xml.vim to highlight included dtd's.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1411
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1412
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1413 EIFFEL eiffel.vim ft-eiffel-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1414
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1415 While Eiffel is not case-sensitive, its style guidelines are, and the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1416 syntax highlighting file encourages their use. This also allows to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1417 highlight class names differently. If you want to disable case-sensitive
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1418 highlighting, add the following line to your startup file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1419
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1420 :let eiffel_ignore_case=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1421
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1422 Case still matters for class names and TODO marks in comments.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1423
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1424 Conversely, for even stricter checks, add one of the following lines: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1425
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1426 :let eiffel_strict=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1427 :let eiffel_pedantic=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1428
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1429 Setting eiffel_strict will only catch improper capitalization for the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1430 five predefined words "Current", "Void", "Result", "Precursor", and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1431 "NONE", to warn against their accidental use as feature or class names.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1432
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1433 Setting eiffel_pedantic will enforce adherence to the Eiffel style
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1434 guidelines fairly rigorously (like arbitrary mixes of upper- and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1435 lowercase letters as well as outdated ways to capitalize keywords).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1436
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1437 If you want to use the lower-case version of "Current", "Void",
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1438 "Result", and "Precursor", you can use >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1439
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1440 :let eiffel_lower_case_predef=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1441
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1442 instead of completely turning case-sensitive highlighting off.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1443
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1444 Support for ISE's proposed new creation syntax that is already
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1445 experimentally handled by some compilers can be enabled by: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1446
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1447 :let eiffel_ise=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1448
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1449 Finally, some vendors support hexadecimal constants. To handle them, add >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1450
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1451 :let eiffel_hex_constants=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1452
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1453 to your startup file.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1454
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1455
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1456 EUPHORIA euphoria3.vim euphoria4.vim ft-euphoria-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1457
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1458 Two syntax highlighting files exist for Euphoria. One for Euphoria
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1459 version 3.1.1, which is the default syntax highlighting file, and one for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1460 Euphoria version 4.0.5 or later.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1461
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1462 Euphoria version 3.1.1 (http://www.rapideuphoria.com/) is still necessary
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1463 for developing applications for the DOS platform, which Euphoria version 4
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1464 (http://www.openeuphoria.org/) does not support.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1465
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1466 The following file extensions are auto-detected as Euphoria file type:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1467
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1468 .e, .eu, .ew, .ex, .exu, .exw
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1469 .E, .EU, .EW, .EX, .EXU, .EXW
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1470
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1471 To select syntax highlighting file for Euphoria, as well as for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1472 auto-detecting the .e and .E file extensions as Euphoria file type,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1473 add the following line to your startup file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1474
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1475 :let g:filetype_euphoria = "euphoria3"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1476
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1477 < or >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1478
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1479 :let g:filetype_euphoria = "euphoria4"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1480
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1481 Elixir and Euphoria share the *.ex file extension. If the filetype is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1482 specifically set as Euphoria with the g:filetype_euphoria variable, or the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1483 file is determined to be Euphoria based on keywords in the file, then the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1484 filetype will be set as Euphoria. Otherwise, the filetype will default to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1485 Elixir.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1486
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1487
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1488 ERLANG erlang.vim ft-erlang-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1489
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1490 Erlang is a functional programming language developed by Ericsson. Files with
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1491 the following extensions are recognized as Erlang files: erl, hrl, yaws.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1492
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1493 The BIFs (built-in functions) are highlighted by default. To disable this,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1494 put the following line in your vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1495
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1496 :let g:erlang_highlight_bifs = 0
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1497
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1498 To enable highlighting some special atoms, put this in your vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1499
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1500 :let g:erlang_highlight_special_atoms = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1501
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1502
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1503 ELIXIR elixir.vim ft-elixir-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1504
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1505 Elixir is a dynamic, functional language for building scalable and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1506 maintainable applications.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1507
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1508 The following file extensions are auto-detected as Elixir file types:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1509
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1510 .ex, .exs, .eex, .leex, *.lock
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1511
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1512 Elixir and Euphoria share the *.ex file extension. If the filetype is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1513 specifically set as Euphoria with the g:filetype_euphoria variable, or the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1514 file is determined to be Euphoria based on keywords in the file, then the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1515 filetype will be set as Euphoria. Otherwise, the filetype will default to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1516 Elixir.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1517
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1518
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1519 FLEXWIKI flexwiki.vim ft-flexwiki-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1520
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1521 FlexWiki is an ASP.NET-based wiki package available at http://www.flexwiki.com
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1522 NOTE: This site currently doesn't work, on Wikipedia is mentioned that
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1523 development stopped in 2009.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1524
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1525 Syntax highlighting is available for the most common elements of FlexWiki
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1526 syntax. The associated ftplugin script sets some buffer-local options to make
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1527 editing FlexWiki pages more convenient. FlexWiki considers a newline as the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1528 start of a new paragraph, so the ftplugin sets 'tw'=0 (unlimited line length),
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1529 'wrap' (wrap long lines instead of using horizontal scrolling), 'linebreak'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1530 (to wrap at a character in 'breakat' instead of at the last char on screen),
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1531 and so on. It also includes some keymaps that are disabled by default.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1532
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1533 If you want to enable the keymaps that make "j" and "k" and the cursor keys
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1534 move up and down by display lines, add this to your .vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1535 :let flexwiki_maps = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1536
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1537
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1538 FORM form.vim ft-form-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1539
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1540 The coloring scheme for syntax elements in the FORM file uses the default
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1541 modes Conditional, Number, Statement, Comment, PreProc, Type, and String,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1542 following the language specifications in 'Symbolic Manipulation with FORM' by
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1543 J.A.M. Vermaseren, CAN, Netherlands, 1991.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1544
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1545 If you want to include your own changes to the default colors, you have to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1546 redefine the following syntax groups:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1547
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1548 - formConditional
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1549 - formNumber
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1550 - formStatement
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1551 - formHeaderStatement
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1552 - formComment
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1553 - formPreProc
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1554 - formDirective
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1555 - formType
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1556 - formString
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1557
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1558 Note that the form.vim syntax file implements FORM preprocessor commands and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1559 directives per default in the same syntax group.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1560
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1561 A predefined enhanced color mode for FORM is available to distinguish between
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1562 header statements and statements in the body of a FORM program. To activate
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1563 this mode define the following variable in your vimrc file >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1564
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1565 :let form_enhanced_color=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1566
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1567 The enhanced mode also takes advantage of additional color features for a dark
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1568 gvim display. Here, statements are colored LightYellow instead of Yellow, and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1569 conditionals are LightBlue for better distinction.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1570
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1571 Both Visual Basic and FORM use the extension ".frm". To detect which one
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1572 should be used, Vim checks for the string "VB_Name" in the first five lines of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1573 the file. If it is found, filetype will be "vb", otherwise "form".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1574
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1575 If the automatic detection doesn't work for you or you only edit, for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1576 example, FORM files, use this in your startup vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1577 :let filetype_frm = "form"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1578
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1579
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1580 FORTH forth.vim ft-forth-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1581
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1582 Files matching "*.fs" could be F# or Forth. If the automatic detection
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1583 doesn't work for you, or you don't edit F# at all, use this in your
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1584 startup vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1585 :let filetype_fs = "forth"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1586
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1587
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1588 FORTRAN fortran.vim ft-fortran-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1589
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1590 Default highlighting and dialect ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1591 Highlighting appropriate for Fortran 2008 is used by default. This choice
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1592 should be appropriate for most users most of the time because Fortran 2008 is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1593 almost a superset of previous versions (Fortran 2003, 95, 90, and 77).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1594
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1595 Fortran source code form ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1596 Fortran code can be in either fixed or free source form. Note that the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1597 syntax highlighting will not be correct if the form is incorrectly set.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1598
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1599 When you create a new fortran file, the syntax script assumes fixed source
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1600 form. If you always use free source form, then >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1601 :let fortran_free_source=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1602 in your .vimrc prior to the :syntax on command. If you always use fixed
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1603 source form, then >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1604 :let fortran_fixed_source=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1605 in your .vimrc prior to the :syntax on command.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1606
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1607 If the form of the source code depends, in a non-standard way, upon the file
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1608 extension, then it is most convenient to set fortran_free_source in a ftplugin
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1609 file. For more information on ftplugin files, see \|ftplugin\|. Note that this
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1610 will work only if the "filetype plugin indent on" command precedes the "syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1611 on" command in your .vimrc file.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1612
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1613 When you edit an existing fortran file, the syntax script will assume free
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1614 source form if the fortran_free_source variable has been set, and assumes
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1615 fixed source form if the fortran_fixed_source variable has been set. If
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1616 neither of these variables have been set, the syntax script attempts to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1617 determine which source form has been used by examining the file extension
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1618 using conventions common to the ifort, gfortran, Cray, NAG, and PathScale
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1619 compilers (.f, .for, .f77 for fixed-source, .f90, .f95, .f03, .f08 for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1620 free-source). If none of this works, then the script examines the first five
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1621 columns of the first 500 lines of your file. If no signs of free source form
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1622 are detected, then the file is assumed to be in fixed source form. The
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1623 algorithm should work in the vast majority of cases. In some cases, such as a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1624 file that begins with 500 or more full-line comments, the script may
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1625 incorrectly decide that the fortran code is in fixed form. If that happens,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1626 just add a non-comment statement beginning anywhere in the first five columns
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1627 of the first twenty-five lines, save (:w) and then reload (:e!) the file.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1628
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1629 Tabs in fortran files ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1630 Tabs are not recognized by the Fortran standards. Tabs are not a good idea in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1631 fixed format fortran source code which requires fixed column boundaries.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1632 Therefore, tabs are marked as errors. Nevertheless, some programmers like
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1633 using tabs. If your fortran files contain tabs, then you should set the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1634 variable fortran_have_tabs in your .vimrc with a command such as >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1635 :let fortran_have_tabs=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1636 placed prior to the :syntax on command. Unfortunately, the use of tabs will
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1637 mean that the syntax file will not be able to detect incorrect margins.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1638
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1639 Syntax folding of fortran files ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1640 If you wish to use foldmethod=syntax, then you must first set the variable
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1641 fortran_fold with a command such as >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1642 :let fortran_fold=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1643 to instruct the syntax script to define fold regions for program units, that
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1644 is main programs starting with a program statement, subroutines, function
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1645 subprograms, block data subprograms, interface blocks, and modules. If you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1646 also set the variable fortran_fold_conditionals with a command such as >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1647 :let fortran_fold_conditionals=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1648 then fold regions will also be defined for do loops, if blocks, and select
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1649 case constructs. If you also set the variable
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1650 fortran_fold_multilinecomments with a command such as >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1651 :let fortran_fold_multilinecomments=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1652 then fold regions will also be defined for three or more consecutive comment
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1653 lines. Note that defining fold regions can be slow for large files.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1654
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1655 If fortran_fold, and possibly fortran_fold_conditionals and/or
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1656 fortran_fold_multilinecomments, have been set, then vim will fold your file if
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1657 you set foldmethod=syntax. Comments or blank lines placed between two program
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1658 units are not folded because they are seen as not belonging to any program
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1659 unit.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1660
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1661 More precise fortran syntax ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1662 If you set the variable fortran_more_precise with a command such as >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1663 :let fortran_more_precise=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1664 then the syntax coloring will be more precise but slower. In particular,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1665 statement labels used in do, goto and arithmetic if statements will be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1666 recognized, as will construct names at the end of a do, if, select or forall
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1667 construct.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1668
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1669 Non-default fortran dialects ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1670 The syntax script supports two Fortran dialects: f08 and F. You will probably
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1671 find the default highlighting (f08) satisfactory. A few legacy constructs
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1672 deleted or declared obsolescent in the 2008 standard are highlighted as todo
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1673 items.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1674
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1675 If you use F, the advantage of setting the dialect appropriately is that
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1676 other legacy features excluded from F will be highlighted as todo items and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1677 that free source form will be assumed.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1678
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1679 The dialect can be selected in various ways. If all your fortran files use
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1680 the same dialect, set the global variable fortran_dialect in your .vimrc prior
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1681 to your syntax on statement. The case-sensitive, permissible values of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1682 fortran_dialect are "f08" or "F". Invalid values of fortran_dialect are
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1683 ignored.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1684
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1685 If the dialect depends upon the file extension, then it is most convenient to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1686 set a buffer-local variable in a ftplugin file. For more information on
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1687 ftplugin files, see \|ftplugin\|. For example, if all your fortran files with
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1688 an .f90 extension are written in the F subset, your ftplugin file should
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1689 contain the code >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1690 let s:extfname = expand("%:e")
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1691 if s:extfname ==? "f90"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1692 let b:fortran_dialect="F"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1693 else
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1694 unlet! b:fortran_dialect
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1695 endif
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1696 Note that this will work only if the "filetype plugin indent on" command
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1697 precedes the "syntax on" command in your .vimrc file.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1698
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1699 Finer control is necessary if the file extension does not uniquely identify
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1700 the dialect. You can override the default dialect, on a file-by-file basis,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1701 by including a comment with the directive "fortran_dialect=xx" (where xx=F or
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1702 f08) in one of the first three lines in your file. For example, your older .f
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1703 files may be legacy code but your newer ones may be F codes, and you would
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1704 identify the latter by including in the first three lines of those files a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1705 Fortran comment of the form >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1706 ! fortran_dialect=F
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1707
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1708 For previous versions of the syntax, you may have set fortran_dialect to the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1709 now-obsolete values "f77", "f90", "f95", or "elf". Such settings will be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1710 silently handled as "f08". Users of "elf" may wish to experiment with "F"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1711 instead.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1712
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1713 The syntax/fortran.vim script contains embedded comments that tell you how to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1714 comment and/or uncomment some lines to (a) activate recognition of some
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1715 non-standard, vendor-supplied intrinsics and (b) to prevent features deleted
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1716 or declared obsolescent in the 2008 standard from being highlighted as todo
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1717 items.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1718
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1719 Limitations ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1720 Parenthesis checking does not catch too few closing parentheses. Hollerith
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1721 strings are not recognized. Some keywords may be highlighted incorrectly
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1722 because Fortran90 has no reserved words.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1723
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1724 For further information related to fortran, see \|ft-fortran-indent\| and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1725 \|ft-fortran-plugin\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1726
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1727 FREEBASIC freebasic.vim ft-freebasic-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1728
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1729 FreeBASIC files will be highlighted differently for each of the four available
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1730 dialects, "fb", "qb", "fblite" and "deprecated". See \|ft-freebasic-plugin\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1731 for how to select the correct dialect.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1732
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1733 Highlighting is further configurable via the following variables.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1734
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1735 Variable Highlight ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1736 freebasic_no_comment_fold disable multiline comment folding
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1737 freebasic_operators non-alpha operators
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1738 freebasic_space_errors trailing white space and spaces before a <Tab>
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1739 freebasic_type_suffixes QuickBASIC style type suffixes
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1740
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1741
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1742
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1743 FVWM CONFIGURATION FILES fvwm.vim ft-fvwm-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1744
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1745 In order for Vim to recognize Fvwm configuration files that do not match
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1746 the patterns fvwmrc or fvwm2rc , you must put additional patterns
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1747 appropriate to your system in your myfiletypes.vim file. For these
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1748 patterns, you must set the variable "b:fvwm_version" to the major version
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1749 number of Fvwm, and the 'filetype' option to fvwm.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1750
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1751 For example, to make Vim identify all files in /etc/X11/fvwm2/
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1752 as Fvwm2 configuration files, add the following: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1753
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1754 :au! BufNewFile,BufRead /etc/X11/fvwm2/* let b:fvwm_version = 2 \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1755 \ set filetype=fvwm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1756
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1757 GSP gsp.vim ft-gsp-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1758
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1759 The default coloring style for GSP pages is defined by \|html.vim\|, and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1760 the coloring for java code (within java tags or inline between backticks)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1761 is defined by \|java.vim\|. The following HTML groups defined in \|html.vim\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1762 are redefined to incorporate and highlight inline java code:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1763
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1764 htmlString
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1765 htmlValue
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1766 htmlEndTag
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1767 htmlTag
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1768 htmlTagN
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1769
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1770 Highlighting should look fine most of the places where you'd see inline
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1771 java code, but in some special cases it may not. To add another HTML
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1772 group where you will have inline java code where it does not highlight
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1773 correctly, just copy the line you want from \|html.vim\| and add gspJava
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1774 to the contains clause.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1775
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1776 The backticks for inline java are highlighted according to the htmlError
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1777 group to make them easier to see.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1778
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1779
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1780 GROFF groff.vim ft-groff-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1781
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1782 The groff syntax file is a wrapper for \|nroff.vim\|, see the notes
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1783 under that heading for examples of use and configuration. The purpose
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1784 of this wrapper is to set up groff syntax extensions by setting the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1785 filetype from a \|modeline\| or in a personal filetype definitions file
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1786 (see \|filetype.txt\|).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1787
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1788
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1789 HASKELL haskell.vim lhaskell.vim ft-haskell-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1790
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1791 The Haskell syntax files support plain Haskell code as well as literate
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1792 Haskell code, the latter in both Bird style and TeX style. The Haskell
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1793 syntax highlighting will also highlight C preprocessor directives.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1794
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1795 If you want to highlight delimiter characters (useful if you have a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1796 light-coloured background), add to your .vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1797 :let hs_highlight_delimiters = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1798 To treat True and False as keywords as opposed to ordinary identifiers,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1799 add: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1800 :let hs_highlight_boolean = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1801 To also treat the names of primitive types as keywords: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1802 :let hs_highlight_types = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1803 And to treat the names of even more relatively common types as keywords: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1804 :let hs_highlight_more_types = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1805 If you want to highlight the names of debugging functions, put in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1806 your .vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1807 :let hs_highlight_debug = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1808
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1809 The Haskell syntax highlighting also highlights C preprocessor
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1810 directives, and flags lines that start with # but are not valid
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1811 directives as erroneous. This interferes with Haskell's syntax for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1812 operators, as they may start with #. If you want to highlight those
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1813 as operators as opposed to errors, put in your .vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1814 :let hs_allow_hash_operator = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1815
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1816 The syntax highlighting for literate Haskell code will try to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1817 automatically guess whether your literate Haskell code contains
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1818 TeX markup or not, and correspondingly highlight TeX constructs
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1819 or nothing at all. You can override this globally by putting
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1820 in your .vimrc >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1821 :let lhs_markup = none
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1822 for no highlighting at all, or >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1823 :let lhs_markup = tex
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1824 to force the highlighting to always try to highlight TeX markup.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1825 For more flexibility, you may also use buffer local versions of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1826 this variable, so e.g. >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1827 :let b:lhs_markup = tex
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1828 will force TeX highlighting for a particular buffer. It has to be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1829 set before turning syntax highlighting on for the buffer or
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1830 loading a file.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1831
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1832
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1833 HTML html.vim ft-html-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1834
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1835 The coloring scheme for tags in the HTML file works as follows.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1836
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1837 The <> of opening tags are colored differently than the </> of a closing tag.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1838 This is on purpose! For opening tags the 'Function' color is used, while for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1839 closing tags the 'Identifier' color is used (See syntax.vim to check how those
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1840 are defined for you)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1841
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1842 Known tag names are colored the same way as statements in C. Unknown tag
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1843 names are colored with the same color as the <> or </> respectively which
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1844 makes it easy to spot errors
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1845
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1846 Note that the same is true for argument (or attribute) names. Known attribute
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1847 names are colored differently than unknown ones.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1848
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1849 Some HTML tags are used to change the rendering of text. The following tags
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1850 are recognized by the html.vim syntax coloring file and change the way normal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1851 text is shown: <B> <I> <U> <EM> <STRONG> (<EM> is used as an alias for <I>,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1852 while <STRONG> as an alias for <B>), <H1> - <H6>, <HEAD>, <TITLE> and <A>, but
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1853 only if used as a link (that is, it must include a href as in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1854 <A href="somefile.html">).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1855
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1856 If you want to change how such text is rendered, you must redefine the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1857 following syntax groups:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1858
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1859 - htmlBold
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1860 - htmlBoldUnderline
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1861 - htmlBoldUnderlineItalic
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1862 - htmlUnderline
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1863 - htmlUnderlineItalic
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1864 - htmlItalic
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1865 - htmlTitle for titles
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1866 - htmlH1 - htmlH6 for headings
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1867
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1868 To make this redefinition work you must redefine them all with the exception
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1869 of the last two (htmlTitle and htmlH[1-6], which are optional) and define the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1870 following variable in your vimrc (this is due to the order in which the files
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1871 are read during initialization) >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1872 :let html_my_rendering=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1873
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1874 If you'd like to see an example download mysyntax.vim at
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1875 http://www.fleiner.com/vim/download.html
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1876
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1877 You can also disable this rendering by adding the following line to your
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1878 vimrc file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1879 :let html_no_rendering=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1880
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1881 HTML comments are rather special (see an HTML reference document for the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1882 details), and the syntax coloring scheme will highlight all errors.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1883 However, if you prefer to use the wrong style (starts with <!-- and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1884 ends with -->) you can define >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1885 :let html_wrong_comments=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1886
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1887 JavaScript and Visual Basic embedded inside HTML documents are highlighted as
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1888 'Special' with statements, comments, strings and so on colored as in standard
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1889 programming languages. Note that only JavaScript and Visual Basic are
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1890 currently supported, no other scripting language has been added yet.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1891
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1892 Embedded and inlined cascading style sheets (CSS) are highlighted too.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1893
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1894 There are several html preprocessor languages out there. html.vim has been
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1895 written such that it should be trivial to include it. To do so add the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1896 following two lines to the syntax coloring file for that language
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1897 (the example comes from the asp.vim file):
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1898 >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1899 runtime! syntax/html.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1900 syn cluster htmlPreproc add=asp
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1901
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1902 Now you just need to make sure that you add all regions that contain
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1903 the preprocessor language to the cluster htmlPreproc.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1904
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1905 html-folding
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1906 The HTML syntax file provides syntax \|folding\| (see \|:syn-fold\|) between start
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1907 and end tags. This can be turned on by >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1908
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1909 :let g:html_syntax_folding = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1910 :set foldmethod=syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1911
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1912 Note: Syntax folding might slow down syntax highlighting significantly,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1913 especially for large files.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1914
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1915
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1916 HTML/OS (by Aestiva) htmlos.vim ft-htmlos-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1917
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1918 The coloring scheme for HTML/OS works as follows:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1919
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1920 Functions and variable names are the same color by default, because VIM
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1921 doesn't specify different colors for Functions and Identifiers. To change
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1922 this (which is recommended if you want function names to be recognizable in a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1923 different color) you need to add the following line to either your ~/.vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1924 :hi Function term=underline cterm=bold ctermfg=LightGray
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1925
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1926 Of course, the ctermfg can be a different color if you choose.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1927
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1928 Another issues that HTML/OS runs into is that there is no special filetype to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1929 signify that it is a file with HTML/OS coding. You can change this by opening
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1930 a file and turning on HTML/OS syntax by doing the following: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1931 :set syntax=htmlos
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1932
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1933 Lastly, it should be noted that the opening and closing characters to begin a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1934 block of HTML/OS code can either be << or [[ and >> or ]], respectively.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1935
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1936
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1937 IA64 ia64.vim intel-itanium ft-ia64-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1938
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1939 Highlighting for the Intel Itanium 64 assembly language. See \|asm.vim\| for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1940 how to recognize this filetype.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1941
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1942 To have *.inc files be recognized as IA64, add this to your .vimrc file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1943 :let g:filetype_inc = "ia64"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1944
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1945
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1946 INFORM inform.vim ft-inform-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1947
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1948 Inform highlighting includes symbols provided by the Inform Library, as
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1949 most programs make extensive use of it. If do not wish Library symbols
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1950 to be highlighted add this to your vim startup: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1951 :let inform_highlight_simple=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1952
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1953 By default it is assumed that Inform programs are Z-machine targeted,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1954 and highlights Z-machine assembly language symbols appropriately. If
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1955 you intend your program to be targeted to a Glulx/Glk environment you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1956 need to add this to your startup sequence: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1957 :let inform_highlight_glulx=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1958
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1959 This will highlight Glulx opcodes instead, and also adds glk() to the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1960 set of highlighted system functions.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1961
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1962 The Inform compiler will flag certain obsolete keywords as errors when
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1963 it encounters them. These keywords are normally highlighted as errors
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1964 by Vim. To prevent such error highlighting, you must add this to your
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1965 startup sequence: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1966 :let inform_suppress_obsolete=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1967
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1968 By default, the language features highlighted conform to Compiler
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1969 version 6.30 and Library version 6.11. If you are using an older
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1970 Inform development environment, you may with to add this to your
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1971 startup sequence: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1972 :let inform_highlight_old=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1973
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1974 IDL idl.vim idl-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1975
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1976 IDL (Interface Definition Language) files are used to define RPC calls. In
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1977 Microsoft land, this is also used for defining COM interfaces and calls.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1978
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1979 IDL's structure is simple enough to permit a full grammar based approach to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1980 rather than using a few heuristics. The result is large and somewhat
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1981 repetitive but seems to work.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1982
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1983 There are some Microsoft extensions to idl files that are here. Some of them
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1984 are disabled by defining idl_no_ms_extensions.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1985
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1986 The more complex of the extensions are disabled by defining idl_no_extensions.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1987
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1988 Variable Effect ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1989
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1990 idl_no_ms_extensions Disable some of the Microsoft specific
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1991 extensions
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1992 idl_no_extensions Disable complex extensions
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1993 idlsyntax_showerror Show IDL errors (can be rather intrusive, but
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1994 quite helpful)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1995 idlsyntax_showerror_soft Use softer colours by default for errors
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1996
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1997
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1998 JAVA java.vim ft-java-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	1999
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2000 The java.vim syntax highlighting file offers several options:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2001
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2002 In Java 1.0.2 it was never possible to have braces inside parens, so this was
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2003 flagged as an error. Since Java 1.1 this is possible (with anonymous
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2004 classes), and therefore is no longer marked as an error. If you prefer the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2005 old way, put the following line into your vim startup file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2006 :let java_mark_braces_in_parens_as_errors=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2007
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2008 All identifiers in java.lang.* are always visible in all classes. To
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2009 highlight them use: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2010 :let java_highlight_java_lang_ids=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2011
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2012 You can also highlight identifiers of most standard Java packages if you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2013 download the javaid.vim script at http://www.fleiner.com/vim/download.html.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2014 If you prefer to only highlight identifiers of a certain package, say java.io
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2015 use the following: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2016 :let java_highlight_java_io=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2017 Check the javaid.vim file for a list of all the packages that are supported.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2018
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2019 Function names are not highlighted, as the way to find functions depends on
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2020 how you write Java code. The syntax file knows two possible ways to highlight
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2021 functions:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2022
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2023 If you write function declarations that are always indented by either
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2024 a tab, 8 spaces or 2 spaces you may want to set >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2025 :let java_highlight_functions="indent"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2026 However, if you follow the Java guidelines about how functions and classes are
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2027 supposed to be named (with respect to upper and lowercase), use >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2028 :let java_highlight_functions="style"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2029 If both options do not work for you, but you would still want function
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2030 declarations to be highlighted create your own definitions by changing the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2031 definitions in java.vim or by creating your own java.vim which includes the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2032 original one and then adds the code to highlight functions.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2033
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2034 In Java 1.1 the functions System.out.println() and System.err.println() should
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2035 only be used for debugging. Therefore it is possible to highlight debugging
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2036 statements differently. To do this you must add the following definition in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2037 your startup file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2038 :let java_highlight_debug=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2039 The result will be that those statements are highlighted as 'Special'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2040 characters. If you prefer to have them highlighted differently you must define
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2041 new highlightings for the following groups.:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2042 Debug, DebugSpecial, DebugString, DebugBoolean, DebugType
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2043 which are used for the statement itself, special characters used in debug
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2044 strings, strings, boolean constants and types (this, super) respectively. I
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2045 have opted to choose another background for those statements.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2046
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2047 Javadoc is a program that takes special comments out of Java program files and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2048 creates HTML pages. The standard configuration will highlight this HTML code
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2049 similarly to HTML files (see \|html.vim\|). You can even add Javascript
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2050 and CSS inside this code (see below). There are four differences however:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2051 1. The title (all characters up to the first '.' which is followed by
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2052 some white space or up to the first '@') is colored differently (to change
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2053 the color change the group CommentTitle).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2054 2. The text is colored as 'Comment'.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2055 3. HTML comments are colored as 'Special'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2056 4. The special Javadoc tags (@see, @param, ...) are highlighted as specials
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2057 and the argument (for @see, @param, @exception) as Function.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2058 To turn this feature off add the following line to your startup file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2059 :let java_ignore_javadoc=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2060
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2061 If you use the special Javadoc comment highlighting described above you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2062 can also turn on special highlighting for Javascript, visual basic
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2063 scripts and embedded CSS (stylesheets). This makes only sense if you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2064 actually have Javadoc comments that include either Javascript or embedded
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2065 CSS. The options to use are >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2066 :let java_javascript=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2067 :let java_css=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2068 :let java_vb=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2069
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2070 In order to highlight nested parens with different colors define colors
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2071 for javaParen, javaParen1 and javaParen2, for example with >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2072 :hi link javaParen Comment
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2073 or >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2074 :hi javaParen ctermfg=blue guifg=#0000ff
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2075
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2076 If you notice highlighting errors while scrolling backwards, which are fixed
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2077 when redrawing with CTRL-L, try setting the "java_minlines" internal variable
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2078 to a larger number: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2079 :let java_minlines = 50
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2080 This will make the syntax synchronization start 50 lines before the first
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2081 displayed line. The default value is 10. The disadvantage of using a larger
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2082 number is that redrawing can become slow.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2083
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2084
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2085 JSON json.vim ft-json-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2086
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2087 The json syntax file provides syntax highlighting with conceal support by
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2088 default. To disable concealment: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2089 let g:vim_json_conceal = 0
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2090
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2091 To disable syntax highlighting of errors: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2092 let g:vim_json_warnings = 0
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2093
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2094
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2095 LACE lace.vim ft-lace-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2096
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2097 Lace (Language for Assembly of Classes in Eiffel) is case insensitive, but the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2098 style guide lines are not. If you prefer case insensitive highlighting, just
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2099 define the vim variable 'lace_case_insensitive' in your startup file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2100 :let lace_case_insensitive=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2101
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2102
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2103 LEX lex.vim ft-lex-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2104
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2105 Lex uses brute-force synchronizing as the "^%%$" section delimiter
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2106 gives no clue as to what section follows. Consequently, the value for >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2107 :syn sync minlines=300
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2108 may be changed by the user if s/he is experiencing synchronization
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2109 difficulties (such as may happen with large lex files).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2110
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2111
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2112 LIFELINES lifelines.vim ft-lifelines-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2113
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2114 To highlight deprecated functions as errors, add in your .vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2115
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2116 :let g:lifelines_deprecated = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2117 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2118
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2119 LISP lisp.vim ft-lisp-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2120
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2121 The lisp syntax highlighting provides two options: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2122
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2123 g:lisp_instring : If it exists, then "(...)" strings are highlighted
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2124 as if the contents of the string were lisp.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2125 Useful for AutoLisp.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2126 g:lisp_rainbow : If it exists and is nonzero, then differing levels
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2127 of parenthesization will receive different
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2128 highlighting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2129 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2130 The g:lisp_rainbow option provides 10 levels of individual colorization for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2131 the parentheses and backquoted parentheses. Because of the quantity of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2132 colorization levels, unlike non-rainbow highlighting, the rainbow mode
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2133 specifies its highlighting using ctermfg and guifg, thereby bypassing the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2134 usual color scheme control using standard highlighting groups. The actual
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2135 highlighting used depends on the dark/bright setting (see \|'bg'\|).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2136
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2137
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2138 LITE lite.vim ft-lite-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2139
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2140 There are two options for the lite syntax highlighting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2141
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2142 If you like SQL syntax highlighting inside Strings, use this: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2143
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2144 :let lite_sql_query = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2145
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2146 For syncing, minlines defaults to 100. If you prefer another value, you can
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2147 set "lite_minlines" to the value you desire. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2148
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2149 :let lite_minlines = 200
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2150
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2151
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2152 LPC lpc.vim ft-lpc-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2153
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2154 LPC stands for a simple, memory-efficient language: Lars Pensjö C. The
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2155 file name of LPC is usually *.c. Recognizing these files as LPC would bother
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2156 users writing only C programs. If you want to use LPC syntax in Vim, you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2157 should set a variable in your .vimrc file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2158
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2159 :let lpc_syntax_for_c = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2160
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2161 If it doesn't work properly for some particular C or LPC files, use a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2162 modeline. For a LPC file:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2163
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2164 // vim:set ft=lpc:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2165
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2166 For a C file that is recognized as LPC:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2167
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2168 // vim:set ft=c:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2169
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2170 If you don't want to set the variable, use the modeline in EVERY LPC file.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2171
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2172 There are several implementations for LPC, we intend to support most widely
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2173 used ones. Here the default LPC syntax is for MudOS series, for MudOS v22
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2174 and before, you should turn off the sensible modifiers, and this will also
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2175 assert the new efuns after v22 to be invalid, don't set this variable when
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2176 you are using the latest version of MudOS: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2177
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2178 :let lpc_pre_v22 = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2179
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2180 For LpMud 3.2 series of LPC: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2181
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2182 :let lpc_compat_32 = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2183
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2184 For LPC4 series of LPC: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2185
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2186 :let lpc_use_lpc4_syntax = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2187
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2188 For uLPC series of LPC:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2189 uLPC has been developed to Pike, so you should use Pike syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2190 instead, and the name of your source file should be *.pike
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2191
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2192
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2193 LUA lua.vim ft-lua-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2194
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2195 The Lua syntax file can be used for versions 4.0, 5.0, 5.1 and 5.2 (5.2 is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2196 the default). You can select one of these versions using the global variables
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2197 lua_version and lua_subversion. For example, to activate Lua
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2198 5.1 syntax highlighting, set the variables like this:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2199
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2200 :let lua_version = 5
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2201 :let lua_subversion = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2202
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2203
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2204 MAIL mail.vim ft-mail.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2205
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2206 Vim highlights all the standard elements of an email (headers, signatures,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2207 quoted text and URLs / email addresses). In keeping with standard conventions,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2208 signatures begin in a line containing only "--" followed optionally by
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2209 whitespaces and end with a newline.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2210
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2211 Vim treats lines beginning with ']', '}', '\|', '>' or a word followed by '>'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2212 as quoted text. However Vim highlights headers and signatures in quoted text
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2213 only if the text is quoted with '>' (optionally followed by one space).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2214
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2215 By default mail.vim synchronises syntax to 100 lines before the first
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2216 displayed line. If you have a slow machine, and generally deal with emails
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2217 with short headers, you can change this to a smaller value: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2218
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2219 :let mail_minlines = 30
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2220
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2221
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2222 MAKE make.vim ft-make-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2223
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2224 In makefiles, commands are usually highlighted to make it easy for you to spot
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2225 errors. However, this may be too much coloring for you. You can turn this
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2226 feature off by using: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2227
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2228 :let make_no_commands = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2229
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2230
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2231 MAPLE maple.vim ft-maple-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2232
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2233 Maple V, by Waterloo Maple Inc, supports symbolic algebra. The language
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2234 supports many packages of functions which are selectively loaded by the user.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2235 The standard set of packages' functions as supplied in Maple V release 4 may be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2236 highlighted at the user's discretion. Users may place in their .vimrc file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2237
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2238 :let mvpkg_all= 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2239
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2240 to get all package functions highlighted, or users may select any subset by
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2241 choosing a variable/package from the table below and setting that variable to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2242 1, also in their .vimrc file (prior to sourcing
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2243 $VIMRUNTIME/syntax/syntax.vim).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2244
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2245 Table of Maple V Package Function Selectors >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2246 mv_DEtools mv_genfunc mv_networks mv_process
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2247 mv_Galois mv_geometry mv_numapprox mv_simplex
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2248 mv_GaussInt mv_grobner mv_numtheory mv_stats
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2249 mv_LREtools mv_group mv_orthopoly mv_student
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2250 mv_combinat mv_inttrans mv_padic mv_sumtools
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2251 mv_combstruct mv_liesymm mv_plots mv_tensor
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2252 mv_difforms mv_linalg mv_plottools mv_totorder
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2253 mv_finance mv_logic mv_powseries
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2254
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2255
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2256 MARKDOWN ft-markdown-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2257
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2258 If you have long regions there might be wrong highlighting. At the cost of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2259 slowing down displaying, you can have the engine look further back to sync on
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2260 the start of a region, for example 500 lines: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2261
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2262 :let g:markdown_minlines = 500
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2263
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2264
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2265 MATHEMATICA mma.vim ft-mma-syntax ft-mathematica-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2266
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2267 Empty *.m files will automatically be presumed to be Matlab files unless you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2268 have the following in your .vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2269
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2270 let filetype_m = "mma"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2271
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2272
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2273 MOO moo.vim ft-moo-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2274
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2275 If you use C-style comments inside expressions and find it mangles your
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2276 highlighting, you may want to use extended (slow!) matches for C-style
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2277 comments: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2278
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2279 :let moo_extended_cstyle_comments = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2280
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2281 To disable highlighting of pronoun substitution patterns inside strings: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2282
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2283 :let moo_no_pronoun_sub = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2284
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2285 To disable highlighting of the regular expression operator '%\|', and matching
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2286 '%(' and '%)' inside strings: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2287
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2288 :let moo_no_regexp = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2289
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2290 Unmatched double quotes can be recognized and highlighted as errors: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2291
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2292 :let moo_unmatched_quotes = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2293
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2294 To highlight builtin properties (.name, .location, .programmer etc.): >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2295
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2296 :let moo_builtin_properties = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2297
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2298 Unknown builtin functions can be recognized and highlighted as errors. If you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2299 use this option, add your own extensions to the mooKnownBuiltinFunction group.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2300 To enable this option: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2301
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2302 :let moo_unknown_builtin_functions = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2303
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2304 An example of adding sprintf() to the list of known builtin functions: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2305
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2306 :syn keyword mooKnownBuiltinFunction sprintf contained
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2307
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2308
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2309 MSQL msql.vim ft-msql-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2310
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2311 There are two options for the msql syntax highlighting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2312
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2313 If you like SQL syntax highlighting inside Strings, use this: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2314
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2315 :let msql_sql_query = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2316
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2317 For syncing, minlines defaults to 100. If you prefer another value, you can
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2318 set "msql_minlines" to the value you desire. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2319
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2320 :let msql_minlines = 200
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2321
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2322
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2323 N1QL n1ql.vim ft-n1ql-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2324
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2325 N1QL is a SQL-like declarative language for manipulating JSON documents in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2326 Couchbase Server databases.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2327
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2328 Vim syntax highlights N1QL statements, keywords, operators, types, comments,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2329 and special values. Vim ignores syntactical elements specific to SQL or its
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2330 many dialects, like COLUMN or CHAR, that don't exist in N1QL.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2331
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2332
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2333 NCF ncf.vim ft-ncf-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2334
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2335 There is one option for NCF syntax highlighting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2336
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2337 If you want to have unrecognized (by ncf.vim) statements highlighted as
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2338 errors, use this: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2339
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2340 :let ncf_highlight_unknowns = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2341
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2342 If you don't want to highlight these errors, leave it unset.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2343
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2344
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2345 NROFF nroff.vim ft-nroff-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2346
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2347 The nroff syntax file works with AT&T n/troff out of the box. You need to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2348 activate the GNU groff extra features included in the syntax file before you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2349 can use them.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2350
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2351 For example, Linux and BSD distributions use groff as their default text
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2352 processing package. In order to activate the extra syntax highlighting
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2353 features for groff, arrange for files to be recognized as groff (see
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2354 \|ft-groff-syntax\|) or add the following option to your start-up files: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2355
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2356 :let nroff_is_groff = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2357
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2358 Groff is different from the old AT&T n/troff that you may still find in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2359 Solaris. Groff macro and request names can be longer than 2 characters and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2360 there are extensions to the language primitives. For example, in AT&T troff
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2361 you access the year as a 2-digit number with the request \(yr. In groff you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2362 can use the same request, recognized for compatibility, or you can use groff's
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2363 native syntax, \[yr]. Furthermore, you can use a 4-digit year directly:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2364 \[year]. Macro requests can be longer than 2 characters, for example, GNU mm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2365 accepts the requests ".VERBON" and ".VERBOFF" for creating verbatim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2366 environments.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2367
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2368 In order to obtain the best formatted output g/troff can give you, you should
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2369 follow a few simple rules about spacing and punctuation.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2370
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2371 1. Do not leave empty spaces at the end of lines.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2372
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2373 2. Leave one space and one space only after an end-of-sentence period,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2374 exclamation mark, etc.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2375
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2376 3. For reasons stated below, it is best to follow all period marks with a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2377 carriage return.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2378
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2379 The reason behind these unusual tips is that g/n/troff have a line breaking
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2380 algorithm that can be easily upset if you don't follow the rules given above.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2381
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2382 Unlike TeX, troff fills text line-by-line, not paragraph-by-paragraph and,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2383 furthermore, it does not have a concept of glue or stretch, all horizontal and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2384 vertical space input will be output as is.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2385
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2386 Therefore, you should be careful about not using more space between sentences
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2387 than you intend to have in your final document. For this reason, the common
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2388 practice is to insert a carriage return immediately after all punctuation
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2389 marks. If you want to have "even" text in your final processed output, you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2390 need to maintain regular spacing in the input text. To mark both trailing
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2391 spaces and two or more spaces after a punctuation as an error, use: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2392
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2393 :let nroff_space_errors = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2394
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2395 Another technique to detect extra spacing and other errors that will interfere
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2396 with the correct typesetting of your file, is to define an eye-catching
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2397 highlighting definition for the syntax groups "nroffDefinition" and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2398 "nroffDefSpecial" in your configuration files. For example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2399
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2400 hi def nroffDefinition term=italic cterm=italic gui=reverse
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2401 hi def nroffDefSpecial term=italic,bold cterm=italic,bold
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2402 \ gui=reverse,bold
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2403
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2404 If you want to navigate preprocessor entries in your source file as easily as
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2405 with section markers, you can activate the following option in your .vimrc
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2406 file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2407
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2408 let b:preprocs_as_sections = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2409
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2410 As well, the syntax file adds an extra paragraph marker for the extended
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2411 paragraph macro (.XP) in the ms package.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2412
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2413 Finally, there is a \|groff.vim\| syntax file that can be used for enabling
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2414 groff syntax highlighting either on a file basis or globally by default.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2415
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2416
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2417 OCAML ocaml.vim ft-ocaml-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2418
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2419 The OCaml syntax file handles files having the following prefixes: .ml,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2420 .mli, .mll and .mly. By setting the following variable >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2421
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2422 :let ocaml_revised = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2423
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2424 you can switch from standard OCaml-syntax to revised syntax as supported
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2425 by the camlp4 preprocessor. Setting the variable >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2426
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2427 :let ocaml_noend_error = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2428
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2429 prevents highlighting of "end" as error, which is useful when sources
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2430 contain very long structures that Vim does not synchronize anymore.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2431
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2432
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2433 PAPP papp.vim ft-papp-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2434
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2435 The PApp syntax file handles .papp files and, to a lesser extent, .pxml
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2436 and .pxsl files which are all a mixture of perl/xml/html/other using xml
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2437 as the top-level file format. By default everything inside phtml or pxml
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2438 sections is treated as a string with embedded preprocessor commands. If
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2439 you set the variable: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2440
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2441 :let papp_include_html=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2442
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2443 in your startup file it will try to syntax-highlight html code inside phtml
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2444 sections, but this is relatively slow and much too colourful to be able to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2445 edit sensibly. ;)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2446
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2447 The newest version of the papp.vim syntax file can usually be found at
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2448 http://papp.plan9.de.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2449
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2450
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2451 PASCAL pascal.vim ft-pascal-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2452
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2453 Files matching ".p" could be Progress or Pascal and those matching ".pp"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2454 could be Puppet or Pascal. If the automatic detection doesn't work for you,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2455 or you only edit Pascal files, use this in your startup vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2456
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2457 :let filetype_p = "pascal"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2458 :let filetype_pp = "pascal"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2459
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2460 The Pascal syntax file has been extended to take into account some extensions
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2461 provided by Turbo Pascal, Free Pascal Compiler and GNU Pascal Compiler.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2462 Delphi keywords are also supported. By default, Turbo Pascal 7.0 features are
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2463 enabled. If you prefer to stick with the standard Pascal keywords, add the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2464 following line to your startup file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2465
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2466 :let pascal_traditional=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2467
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2468 To switch on Delphi specific constructions (such as one-line comments,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2469 keywords, etc): >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2470
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2471 :let pascal_delphi=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2472
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2473
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2474 The option pascal_symbol_operator controls whether symbol operators such as +,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2475 *, .., etc. are displayed using the Operator color or not. To colorize symbol
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2476 operators, add the following line to your startup file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2477
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2478 :let pascal_symbol_operator=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2479
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2480 Some functions are highlighted by default. To switch it off: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2481
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2482 :let pascal_no_functions=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2483
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2484 Furthermore, there are specific variables for some compilers. Besides
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2485 pascal_delphi, there are pascal_gpc and pascal_fpc. Default extensions try to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2486 match Turbo Pascal. >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2487
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2488 :let pascal_gpc=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2489
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2490 or >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2491
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2492 :let pascal_fpc=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2493
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2494 To ensure that strings are defined on a single line, you can define the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2495 pascal_one_line_string variable. >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2496
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2497 :let pascal_one_line_string=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2498
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2499 If you dislike <Tab> chars, you can set the pascal_no_tabs variable. Tabs
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2500 will be highlighted as Error. >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2501
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2502 :let pascal_no_tabs=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2503
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2504
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2505
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2506 PERL perl.vim ft-perl-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2507
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2508 There are a number of possible options to the perl syntax highlighting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2509
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2510 Inline POD highlighting is now turned on by default. If you don't wish
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2511 to have the added complexity of highlighting POD embedded within Perl
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2512 files, you may set the 'perl_include_pod' option to 0: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2513
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2514 :let perl_include_pod = 0
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2515
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2516 To reduce the complexity of parsing (and increase performance) you can switch
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2517 off two elements in the parsing of variable names and contents. >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2518
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2519 To handle package references in variable and function names not differently
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2520 from the rest of the name (like 'PkgName::' in '$PkgName::VarName'): >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2521
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2522 :let perl_no_scope_in_variables = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2523
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2524 (In Vim 6.x it was the other way around: "perl_want_scope_in_variables"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2525 enabled it.)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2526
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2527 If you do not want complex things like '@{${"foo"}}' to be parsed: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2528
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2529 :let perl_no_extended_vars = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2530
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2531 (In Vim 6.x it was the other way around: "perl_extended_vars" enabled it.)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2532
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2533 The coloring strings can be changed. By default strings and qq friends will
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2534 be highlighted like the first line. If you set the variable
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2535 perl_string_as_statement, it will be highlighted as in the second line.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2536
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2537 "hello world!"; qq\|hello world\|;
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2538 ^^^^^^^^^^^^^^NN^^^^^^^^^^^^^^^N (unlet perl_string_as_statement)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2539 S^^^^^^^^^^^^SNNSSS^^^^^^^^^^^SN (let perl_string_as_statement)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2540
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2541 (^ = perlString, S = perlStatement, N = None at all)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2542
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2543 The syncing has 3 options. The first two switch off some triggering of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2544 synchronization and should only be needed in case it fails to work properly.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2545 If while scrolling all of a sudden the whole screen changes color completely
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2546 then you should try and switch off one of those. Let me know if you can
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2547 figure out the line that causes the mistake.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2548
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2549 One triggers on "^\ssub\s" and the other on "^[$@%]" more or less. >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2550
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2551 :let perl_no_sync_on_sub
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2552 :let perl_no_sync_on_global_var
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2553
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2554 Below you can set the maximum distance VIM should look for starting points for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2555 its attempts in syntax highlighting. >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2556
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2557 :let perl_sync_dist = 100
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2558
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2559 If you want to use folding with perl, set perl_fold: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2560
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2561 :let perl_fold = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2562
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2563 If you want to fold blocks in if statements, etc. as well set the following: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2564
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2565 :let perl_fold_blocks = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2566
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2567 Subroutines are folded by default if 'perl_fold' is set. If you do not want
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2568 this, you can set 'perl_nofold_subs': >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2569
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2570 :let perl_nofold_subs = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2571
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2572 Anonymous subroutines are not folded by default; you may enable their folding
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2573 via 'perl_fold_anonymous_subs': >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2574
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2575 :let perl_fold_anonymous_subs = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2576
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2577 Packages are also folded by default if 'perl_fold' is set. To disable this
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2578 behavior, set 'perl_nofold_packages': >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2579
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2580 :let perl_nofold_packages = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2581
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2582 PHP3 and PHP4 php.vim php3.vim ft-php-syntax ft-php3-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2583
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2584 [Note: Previously this was called "php3", but since it now also supports php4
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2585 it has been renamed to "php"]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2586
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2587 There are the following options for the php syntax highlighting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2588
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2589 If you like SQL syntax highlighting inside Strings: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2590
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2591 let php_sql_query = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2592
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2593 For highlighting the Baselib methods: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2594
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2595 let php_baselib = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2596
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2597 Enable HTML syntax highlighting inside strings: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2598
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2599 let php_htmlInStrings = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2600
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2601 Using the old colorstyle: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2602
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2603 let php_oldStyle = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2604
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2605 Enable highlighting ASP-style short tags: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2606
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2607 let php_asp_tags = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2608
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2609 Disable short tags: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2610
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2611 let php_noShortTags = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2612
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2613 For highlighting parent error ] or ): >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2614
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2615 let php_parent_error_close = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2616
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2617 For skipping a php end tag, if there exists an open ( or [ without a closing
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2618 one: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2619
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2620 let php_parent_error_open = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2621
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2622 Enable folding for classes and functions: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2623
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2624 let php_folding = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2625
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2626 Selecting syncing method: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2627
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2628 let php_sync_method = x
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2629
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2630 x = -1 to sync by search (default),
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2631 x > 0 to sync at least x lines backwards,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2632 x = 0 to sync from start.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2633
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2634
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2635 PLAINTEX plaintex.vim ft-plaintex-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2636
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2637 TeX is a typesetting language, and plaintex is the file type for the "plain"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2638 variant of TeX. If you never want your *.tex files recognized as plain TeX,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2639 see \|ft-tex-plugin\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2640
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2641 This syntax file has the option >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2642
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2643 let g:plaintex_delimiters = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2644
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2645 if you want to highlight brackets "[]" and braces "{}".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2646
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2647
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2648 PPWIZARD ppwiz.vim ft-ppwiz-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2649
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2650 PPWizard is a preprocessor for HTML and OS/2 INF files
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2651
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2652 This syntax file has the options:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2653
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2654 - ppwiz_highlight_defs : Determines highlighting mode for PPWizard's
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2655 definitions. Possible values are
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2656
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2657 ppwiz_highlight_defs = 1 : PPWizard #define statements retain the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2658 colors of their contents (e.g. PPWizard macros and variables).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2659
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2660 ppwiz_highlight_defs = 2 : Preprocessor #define and #evaluate
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2661 statements are shown in a single color with the exception of line
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2662 continuation symbols.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2663
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2664 The default setting for ppwiz_highlight_defs is 1.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2665
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2666 - ppwiz_with_html : If the value is 1 (the default), highlight literal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2667 HTML code; if 0, treat HTML code like ordinary text.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2668
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2669
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2670 PHTML phtml.vim ft-phtml-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2671
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2672 There are two options for the phtml syntax highlighting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2673
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2674 If you like SQL syntax highlighting inside Strings, use this: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2675
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2676 :let phtml_sql_query = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2677
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2678 For syncing, minlines defaults to 100. If you prefer another value, you can
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2679 set "phtml_minlines" to the value you desire. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2680
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2681 :let phtml_minlines = 200
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2682
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2683
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2684 POSTSCRIPT postscr.vim ft-postscr-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2685
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2686 There are several options when it comes to highlighting PostScript.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2687
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2688 First which version of the PostScript language to highlight. There are
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2689 currently three defined language versions, or levels. Level 1 is the original
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2690 and base version, and includes all extensions prior to the release of level 2.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2691 Level 2 is the most common version around, and includes its own set of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2692 extensions prior to the release of level 3. Level 3 is currently the highest
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2693 level supported. You select which level of the PostScript language you want
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2694 highlighted by defining the postscr_level variable as follows: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2695
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2696 :let postscr_level=2
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2697
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2698 If this variable is not defined it defaults to 2 (level 2) since this is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2699 the most prevalent version currently.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2700
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2701 Note: Not all PS interpreters will support all language features for a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2702 particular language level. In particular the %!PS-Adobe-3.0 at the start of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2703 PS files does NOT mean the PostScript present is level 3 PostScript!
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2704
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2705 If you are working with Display PostScript, you can include highlighting of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2706 Display PS language features by defining the postscr_display variable as
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2707 follows: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2708
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2709 :let postscr_display=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2710
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2711 If you are working with Ghostscript, you can include highlighting of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2712 Ghostscript specific language features by defining the variable
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2713 postscr_ghostscript as follows: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2714
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2715 :let postscr_ghostscript=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2716
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2717 PostScript is a large language, with many predefined elements. While it
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2718 useful to have all these elements highlighted, on slower machines this can
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2719 cause Vim to slow down. In an attempt to be machine friendly font names and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2720 character encodings are not highlighted by default. Unless you are working
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2721 explicitly with either of these this should be ok. If you want them to be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2722 highlighted you should set one or both of the following variables: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2723
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2724 :let postscr_fonts=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2725 :let postscr_encodings=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2726
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2727 There is a stylistic option to the highlighting of and, or, and not. In
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2728 PostScript the function of these operators depends on the types of their
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2729 operands - if the operands are booleans then they are the logical operators,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2730 if they are integers then they are binary operators. As binary and logical
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2731 operators can be highlighted differently they have to be highlighted one way
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2732 or the other. By default they are treated as logical operators. They can be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2733 highlighted as binary operators by defining the variable
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2734 postscr_andornot_binary as follows: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2735
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2736 :let postscr_andornot_binary=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2737 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2738
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2739 ptcap.vim ft-printcap-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2740 PRINTCAP + TERMCAP ft-ptcap-syntax ft-termcap-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2741
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2742 This syntax file applies to the printcap and termcap databases.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2743
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2744 In order for Vim to recognize printcap/termcap files that do not match
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2745 the patterns printcap, or termcap, you must put additional patterns
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2746 appropriate to your system in your \|myfiletypefile\| file. For these
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2747 patterns, you must set the variable "b:ptcap_type" to either "print" or
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2748 "term", and then the 'filetype' option to ptcap.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2749
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2750 For example, to make Vim identify all files in /etc/termcaps/ as termcap
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2751 files, add the following: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2752
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2753 :au BufNewFile,BufRead /etc/termcaps/* let b:ptcap_type = "term" \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2754 \ set filetype=ptcap
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2755
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2756 If you notice highlighting errors while scrolling backwards, which
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2757 are fixed when redrawing with CTRL-L, try setting the "ptcap_minlines"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2758 internal variable to a larger number: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2759
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2760 :let ptcap_minlines = 50
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2761
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2762 (The default is 20 lines.)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2763
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2764
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2765 PROGRESS progress.vim ft-progress-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2766
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2767 Files matching "*.w" could be Progress or cweb. If the automatic detection
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2768 doesn't work for you, or you don't edit cweb at all, use this in your
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2769 startup vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2770 :let filetype_w = "progress"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2771 The same happens for ".i", which could be assembly, and ".p", which could be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2772 Pascal. Use this if you don't use assembly and Pascal: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2773 :let filetype_i = "progress"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2774 :let filetype_p = "progress"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2775
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2776
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2777 PYTHON python.vim ft-python-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2778
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2779 There are six options to control Python syntax highlighting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2780
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2781 For highlighted numbers: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2782 :let python_no_number_highlight = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2783
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2784 For highlighted builtin functions: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2785 :let python_no_builtin_highlight = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2786
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2787 For highlighted standard exceptions: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2788 :let python_no_exception_highlight = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2789
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2790 For highlighted doctests and code inside: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2791 :let python_no_doctest_highlight = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2792 or >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2793 :let python_no_doctest_code_highlight = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2794 The first option implies the second one.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2795
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2796 For highlighted trailing whitespace and mix of spaces and tabs: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2797 :let python_space_error_highlight = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2798
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2799 If you want all possible Python highlighting:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2800 :let python_highlight_all = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2801 This has the same effect as setting python_space_error_highlight and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2802 unsetting all the other ones.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2803
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2804 If you use Python 2 or straddling code (Python 2 and 3 compatible),
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2805 you can enforce the use of an older syntax file with support for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2806 Python 2 and up to Python 3.5. >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2807 :let python_use_python2_syntax = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2808 This option will exclude all modern Python 3.6 or higher features.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2809
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2810 Note: Only existence of these options matters, not their value.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2811 You can replace 1 above with anything.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2812
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2813
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2814 QUAKE quake.vim ft-quake-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2815
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2816 The Quake syntax definition should work for most FPS (First Person Shooter)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2817 based on one of the Quake engines. However, the command names vary a bit
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2818 between the three games (Quake, Quake 2, and Quake 3 Arena) so the syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2819 definition checks for the existence of three global variables to allow users
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2820 to specify what commands are legal in their files. The three variables can
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2821 be set for the following effects:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2822
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2823 set to highlight commands only available in Quake: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2824 :let quake_is_quake1 = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2825
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2826 set to highlight commands only available in Quake 2: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2827 :let quake_is_quake2 = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2828
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2829 set to highlight commands only available in Quake 3 Arena: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2830 :let quake_is_quake3 = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2831
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2832 Any combination of these three variables is legal, but might highlight more
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2833 commands than are actually available to you by the game.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2834
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2835
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2836 R r.vim ft-r-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2837
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2838 The parsing of R code for syntax highlight starts 40 lines backwards, but you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2839 can set a different value in your \|vimrc\|. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2840 let r_syntax_minlines = 60
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2841
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2842 You can also turn off syntax highlighting of ROxygen: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2843 let r_syntax_hl_roxygen = 0
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2844
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2845 enable folding of code delimited by parentheses, square brackets and curly
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2846 braces: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2847 let r_syntax_folding = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2848
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2849 and highlight as functions all keywords followed by an opening parenthesis: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2850 let r_syntax_fun_pattern = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2851
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2852
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2853 R MARKDOWN rmd.vim ft-rmd-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2854
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2855 To disable syntax highlight of YAML header, add to your \|vimrc\|: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2856 let rmd_syn_hl_yaml = 0
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2857
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2858 To disable syntax highlighting of citation keys: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2859 let rmd_syn_hl_citations = 0
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2860
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2861 To highlight R code in knitr chunk headers: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2862 let rmd_syn_hl_chunk = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2863
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2864 By default, chunks of R code will be highlighted following the rules of R
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2865 language. If you want proper syntax highlighting of chunks of other languages,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2866 you should add them to either `markdown_fenced_languages` or
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2867 `rmd_fenced_languages`. For example to properly highlight both R and Python,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2868 you may add this to your \|vimrc\|: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2869 let rmd_fenced_languages = ['r', 'python']
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2870
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2871
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2872 R RESTRUCTURED TEXT rrst.vim ft-rrst-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2873
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2874 To highlight R code in knitr chunk headers, add to your \|vimrc\|: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2875 let rrst_syn_hl_chunk = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2876
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2877
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2878 READLINE readline.vim ft-readline-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2879
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2880 The readline library is primarily used by the BASH shell, which adds quite a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2881 few commands and options to the ones already available. To highlight these
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2882 items as well you can add the following to your \|vimrc\| or just type it in the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2883 command line before loading a file with the readline syntax: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2884 let readline_has_bash = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2885
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2886 This will add highlighting for the commands that BASH (version 2.05a and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2887 later, and part earlier) adds.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2888
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2889
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2890 REGO rego.vim ft-rego-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2891
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2892 Rego is a query language developed by Styra. It is mostly used as a policy
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2893 language for kubernetes, but can be applied to almost anything. Files with
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2894 the following extensions are recognized as rego files: .rego.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2895
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2896
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2897 RESTRUCTURED TEXT rst.vim ft-rst-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2898
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2899 Syntax highlighting is enabled for code blocks within the document for a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2900 select number of file types. See $VIMRUNTIME/syntax/rst.vim for the default
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2901 syntax list.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2902
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2903 To set a user-defined list of code block syntax highlighting: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2904 let rst_syntax_code_list = ['vim', 'lisp', ...]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2905
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2906 To assign multiple code block types to a single syntax, define
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2907 `rst_syntax_code_list` as a mapping: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2908 let rst_syntax_code_list = {
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2909 \ 'cpp': ['cpp', 'c++'],
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2910 \ 'bash': ['bash', 'sh'],
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2911 ...
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2912 \ }
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2913
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2914 To use color highlighting for emphasis text: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2915 let rst_use_emphasis_colors = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2916
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2917 To enable folding of sections: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2918 let rst_fold_enabled = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2919
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2920 Note that folding can cause performance issues on some platforms.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2921
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2922
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2923 REXX rexx.vim ft-rexx-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2924
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2925 If you notice highlighting errors while scrolling backwards, which are fixed
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2926 when redrawing with CTRL-L, try setting the "rexx_minlines" internal variable
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2927 to a larger number: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2928 :let rexx_minlines = 50
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2929 This will make the syntax synchronization start 50 lines before the first
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2930 displayed line. The default value is 10. The disadvantage of using a larger
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2931 number is that redrawing can become slow.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2932
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2933 Vim tries to guess what type a ".r" file is. If it can't be detected (from
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2934 comment lines), the default is "r". To make the default rexx add this line to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2935 your .vimrc: g:filetype_r
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2936 >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2937 :let g:filetype_r = "r"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2938
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2939
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2940 RUBY ruby.vim ft-ruby-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2941
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2942 Ruby: Operator highlighting \|ruby_operators\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2943 Ruby: Whitespace errors \|ruby_space_errors\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2944 Ruby: Folding \|ruby_fold\| \|ruby_foldable_groups\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2945 Ruby: Reducing expensive operations \|ruby_no_expensive\| \|ruby_minlines\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2946 Ruby: Spellchecking strings \|ruby_spellcheck_strings\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2947
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2948 ruby_operators
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2949 Ruby: Operator highlighting ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2950
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2951 Operators can be highlighted by defining "ruby_operators": >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2952
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2953 :let ruby_operators = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2954 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2955 ruby_space_errors
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2956 Ruby: Whitespace errors ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2957
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2958 Whitespace errors can be highlighted by defining "ruby_space_errors": >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2959
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2960 :let ruby_space_errors = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2961 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2962 This will highlight trailing whitespace and tabs preceded by a space character
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2963 as errors. This can be refined by defining "ruby_no_trail_space_error" and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2964 "ruby_no_tab_space_error" which will ignore trailing whitespace and tabs after
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2965 spaces respectively.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2966
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2967 ruby_fold ruby_foldable_groups
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2968 Ruby: Folding ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2969
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2970 Folding can be enabled by defining "ruby_fold": >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2971
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2972 :let ruby_fold = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2973 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2974 This will set the value of 'foldmethod' to "syntax" locally to the current
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2975 buffer or window, which will enable syntax-based folding when editing Ruby
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2976 filetypes.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2977
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2978 Default folding is rather detailed, i.e., small syntax units like "if", "do",
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2979 "%w[]" may create corresponding fold levels.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2980
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2981 You can set "ruby_foldable_groups" to restrict which groups are foldable: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2982
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2983 :let ruby_foldable_groups = 'if case %'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2984 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2985 The value is a space-separated list of keywords:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2986
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2987 keyword meaning ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2988 -------- ------------------------------------- ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2989 ALL Most block syntax (default)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2990 NONE Nothing
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2991 if "if" or "unless" block
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2992 def "def" block
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2993 class "class" block
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2994 module "module" block
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2995 do "do" block
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2996 begin "begin" block
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2997 case "case" block
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2998 for "for", "while", "until" loops
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	2999 { Curly bracket block or hash literal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3000 [ Array literal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3001 % Literal with "%" notation, e.g.: %w(STRING), %!STRING!
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3002 / Regexp
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3003 string String and shell command output (surrounded by ', ", `)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3004 : Symbol
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3005 # Multiline comment
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3006 << Here documents
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3007 __END__ Source code after "__END__" directive
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3008
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3009 ruby_no_expensive
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3010 Ruby: Reducing expensive operations ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3011
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3012 By default, the "end" keyword is colorized according to the opening statement
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3013 of the block it closes. While useful, this feature can be expensive; if you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3014 experience slow redrawing (or you are on a terminal with poor color support)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3015 you may want to turn it off by defining the "ruby_no_expensive" variable: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3016
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3017 :let ruby_no_expensive = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3018 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3019 In this case the same color will be used for all control keywords.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3020
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3021 ruby_minlines
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3022
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3023 If you do want this feature enabled, but notice highlighting errors while
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3024 scrolling backwards, which are fixed when redrawing with CTRL-L, try setting
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3025 the "ruby_minlines" variable to a value larger than 50: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3026
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3027 :let ruby_minlines = 100
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3028 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3029 Ideally, this value should be a number of lines large enough to embrace your
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3030 largest class or module.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3031
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3032 ruby_spellcheck_strings
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3033 Ruby: Spellchecking strings ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3034
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3035 Ruby syntax will perform spellchecking of strings if you define
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3036 "ruby_spellcheck_strings": >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3037
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3038 :let ruby_spellcheck_strings = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3039 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3040
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3041 SCHEME scheme.vim ft-scheme-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3042
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3043 By default only R7RS keywords are highlighted and properly indented.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3044
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3045 scheme.vim also supports extensions of the CHICKEN Scheme->C compiler.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3046 Define b:is_chicken or g:is_chicken, if you need them.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3047
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3048
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3049 SDL sdl.vim ft-sdl-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3050
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3051 The SDL highlighting probably misses a few keywords, but SDL has so many
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3052 of them it's almost impossibly to cope.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3053
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3054 The new standard, SDL-2000, specifies that all identifiers are
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3055 case-sensitive (which was not so before), and that all keywords can be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3056 used either completely lowercase or completely uppercase. To have the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3057 highlighting reflect this, you can set the following variable: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3058 :let sdl_2000=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3059
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3060 This also sets many new keywords. If you want to disable the old
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3061 keywords, which is probably a good idea, use: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3062 :let SDL_no_96=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3063
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3064
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3065 The indentation is probably also incomplete, but right now I am very
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3066 satisfied with it for my own projects.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3067
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3068
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3069 SED sed.vim ft-sed-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3070
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3071 To make tabs stand out from regular blanks (accomplished by using Todo
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3072 highlighting on the tabs), define "g:sed_highlight_tabs" by putting >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3073
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3074 :let g:sed_highlight_tabs = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3075 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3076 in the vimrc file. (This special highlighting only applies for tabs
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3077 inside search patterns, replacement texts, addresses or text included
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3078 by an Append/Change/Insert command.) If you enable this option, it is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3079 also a good idea to set the tab width to one character; by doing that,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3080 you can easily count the number of tabs in a string.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3081
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3082 GNU sed allows comments after text on the same line. BSD sed only allows
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3083 comments where "#" is the first character of the line. To enforce BSD-style
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3084 comments, i.e. mark end-of-line comments as errors, use: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3085
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3086 :let g:sed_dialect = "bsd"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3087 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3088 Note that there are other differences between GNU sed and BSD sed which are
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3089 not (yet) affected by this setting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3090
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3091 Bugs:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3092
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3093 The transform command (y) is treated exactly like the substitute
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3094 command. This means that, as far as this syntax file is concerned,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3095 transform accepts the same flags as substitute, which is wrong.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3096 (Transform accepts no flags.) I tolerate this bug because the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3097 involved commands need very complex treatment (95 patterns, one for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3098 each plausible pattern delimiter).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3099
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3100
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3101 SGML sgml.vim ft-sgml-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3102
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3103 The coloring scheme for tags in the SGML file works as follows.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3104
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3105 The <> of opening tags are colored differently than the </> of a closing tag.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3106 This is on purpose! For opening tags the 'Function' color is used, while for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3107 closing tags the 'Type' color is used (See syntax.vim to check how those are
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3108 defined for you)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3109
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3110 Known tag names are colored the same way as statements in C. Unknown tag
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3111 names are not colored which makes it easy to spot errors.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3112
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3113 Note that the same is true for argument (or attribute) names. Known attribute
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3114 names are colored differently than unknown ones.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3115
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3116 Some SGML tags are used to change the rendering of text. The following tags
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3117 are recognized by the sgml.vim syntax coloring file and change the way normal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3118 text is shown: <varname> <emphasis> <command> <function> <literal>
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3119 <replaceable> <ulink> and <link>.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3120
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3121 If you want to change how such text is rendered, you must redefine the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3122 following syntax groups:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3123
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3124 - sgmlBold
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3125 - sgmlBoldItalic
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3126 - sgmlUnderline
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3127 - sgmlItalic
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3128 - sgmlLink for links
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3129
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3130 To make this redefinition work you must redefine them all and define the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3131 following variable in your vimrc (this is due to the order in which the files
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3132 are read during initialization) >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3133 let sgml_my_rendering=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3134
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3135 You can also disable this rendering by adding the following line to your
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3136 vimrc file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3137 let sgml_no_rendering=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3138
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3139 (Adapted from the html.vim help text by Claudio Fleiner <claudio@fleiner.com>)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3140
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3141
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3142 ft-posix-syntax ft-dash-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3143 SH sh.vim ft-sh-syntax ft-bash-syntax ft-ksh-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3144
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3145 This covers syntax highlighting for the older Unix (Bourne) sh, and newer
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3146 shells such as bash, dash, posix, and the Korn shells.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3147
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3148 Vim attempts to determine which shell type is in use by specifying that
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3149 various filenames are of specific types, e.g.: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3150
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3151 ksh : .kshrc* *.ksh
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3152 bash: .bashrc* bashrc bash.bashrc .bash_profile* *.bash
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3153 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3154 See $VIMRUNTIME/filetype.vim for the full list of patterns. If none of these
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3155 cases pertain, then the first line of the file is examined (ex. looking for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3156 /bin/sh /bin/ksh /bin/bash). If the first line specifies a shelltype, then
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3157 that shelltype is used. However some files (ex. .profile) are known to be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3158 shell files but the type is not apparent. Furthermore, on many systems sh is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3159 symbolically linked to "bash" (Linux, Windows+cygwin) or "ksh" (Posix).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3160
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3161 One may specify a global default by instantiating one of the following
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3162 variables in your <.vimrc>:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3163
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3164 ksh: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3165 let g:is_kornshell = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3166 < posix: (using this is nearly the same as setting g:is_kornshell to 1) >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3167 let g:is_posix = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3168 < bash: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3169 let g:is_bash = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3170 < sh: (default) Bourne shell >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3171 let g:is_sh = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3172
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3173 < (dash users should use posix)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3174
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3175 If there's no "#! ..." line, and the user hasn't availed himself/herself of a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3176 default sh.vim syntax setting as just shown, then syntax/sh.vim will assume
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3177 the Bourne shell syntax. No need to quote RFCs or market penetration
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3178 statistics in error reports, please -- just select the default version of the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3179 sh your system uses and install the associated "let..." in your <.vimrc>.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3180
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3181 The syntax/sh.vim file provides several levels of syntax-based folding: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3182
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3183 let g:sh_fold_enabled= 0 (default, no syntax folding)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3184 let g:sh_fold_enabled= 1 (enable function folding)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3185 let g:sh_fold_enabled= 2 (enable heredoc folding)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3186 let g:sh_fold_enabled= 4 (enable if/do/for folding)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3187 >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3188 then various syntax items (ie. HereDocuments and function bodies) become
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3189 syntax-foldable (see \|:syn-fold\|). You also may add these together
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3190 to get multiple types of folding: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3191
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3192 let g:sh_fold_enabled= 3 (enables function and heredoc folding)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3193
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3194 If you notice highlighting errors while scrolling backwards which are fixed
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3195 when one redraws with CTRL-L, try setting the "sh_minlines" internal variable
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3196 to a larger number. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3197
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3198 let sh_minlines = 500
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3199
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3200 This will make syntax synchronization start 500 lines before the first
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3201 displayed line. The default value is 200. The disadvantage of using a larger
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3202 number is that redrawing can become slow.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3203
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3204 If you don't have much to synchronize on, displaying can be very slow. To
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3205 reduce this, the "sh_maxlines" internal variable can be set. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3206
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3207 let sh_maxlines = 100
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3208 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3209 The default is to use the twice sh_minlines. Set it to a smaller number to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3210 speed up displaying. The disadvantage is that highlight errors may appear.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3211
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3212 syntax/sh.vim tries to flag certain problems as errors; usually things like
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3213 unmatched "]", "done", "fi", etc. If you find the error handling problematic
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3214 for your purposes, you may suppress such error highlighting by putting
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3215 the following line in your .vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3216
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3217 let g:sh_no_error= 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3218 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3219
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3220 sh-embed sh-awk
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3221 Sh: EMBEDDING LANGUAGES~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3222
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3223 You may wish to embed languages into sh. I'll give an example courtesy of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3224 Lorance Stinson on how to do this with awk as an example. Put the following
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3225 file into $HOME/.vim/after/syntax/sh/awkembed.vim: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3226
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3227 " AWK Embedding:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3228 " ==============
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3229 " Shamelessly ripped from aspperl.vim by Aaron Hope.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3230 if exists("b:current_syntax")
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3231 unlet b:current_syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3232 endif
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3233 syn include @AWKScript syntax/awk.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3234 syn region AWKScriptCode matchgroup=AWKCommand start=+[=\\]\@<!'+ skip=+\\'+ end=+'+ contains=@AWKScript contained
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3235 syn region AWKScriptEmbedded matchgroup=AWKCommand start=+\<awk\>+ skip=+\\$+ end=+[=\\]\@<!'+me=e-1 contains=@shIdList,@shExprList2 nextgroup=AWKScriptCode
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3236 syn cluster shCommandSubList add=AWKScriptEmbedded
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3237 hi def link AWKCommand Type
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3238 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3239 This code will then let the awk code in the single quotes: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3240 awk '...awk code here...'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3241 be highlighted using the awk highlighting syntax. Clearly this may be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3242 extended to other languages.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3243
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3244
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3245 SPEEDUP spup.vim ft-spup-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3246 (AspenTech plant simulator)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3247
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3248 The Speedup syntax file has some options:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3249
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3250 - strict_subsections : If this variable is defined, only keywords for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3251 sections and subsections will be highlighted as statements but not
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3252 other keywords (like WITHIN in the OPERATION section).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3253
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3254 - highlight_types : Definition of this variable causes stream types
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3255 like temperature or pressure to be highlighted as Type, not as a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3256 plain Identifier. Included are the types that are usually found in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3257 the DECLARE section; if you defined own types, you have to include
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3258 them in the syntax file.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3259
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3260 - oneline_comments : This value ranges from 1 to 3 and determines the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3261 highlighting of # style comments.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3262
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3263 oneline_comments = 1 : Allow normal Speedup code after an even
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3264 number of #s.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3265
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3266 oneline_comments = 2 : Show code starting with the second # as
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3267 error. This is the default setting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3268
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3269 oneline_comments = 3 : Show the whole line as error if it contains
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3270 more than one #.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3271
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3272 Since especially OPERATION sections tend to become very large due to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3273 PRESETting variables, syncing may be critical. If your computer is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3274 fast enough, you can increase minlines and/or maxlines near the end of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3275 the syntax file.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3276
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3277
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3278 SQL sql.vim ft-sql-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3279 sqlinformix.vim ft-sqlinformix-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3280 sqlanywhere.vim ft-sqlanywhere-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3281
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3282 While there is an ANSI standard for SQL, most database engines add their own
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3283 custom extensions. Vim currently supports the Oracle and Informix dialects of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3284 SQL. Vim assumes "*.sql" files are Oracle SQL by default.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3285
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3286 Vim currently has SQL support for a variety of different vendors via syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3287 scripts. You can change Vim's default from Oracle to any of the current SQL
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3288 supported types. You can also easily alter the SQL dialect being used on a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3289 buffer by buffer basis.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3290
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3291 For more detailed instructions see \|ft_sql.txt\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3292
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3293
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3294 SQUIRREL squirrel.vim ft-squirrel-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3295
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3296 Squirrel is a high level imperative, object-oriented programming language,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3297 designed to be a light-weight scripting language that fits in the size, memory
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3298 bandwidth, and real-time requirements of applications like video games. Files
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3299 with the following extensions are recognized as squirrel files: .nut.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3300
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3301
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3302 TCSH tcsh.vim ft-tcsh-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3303
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3304 This covers the shell named "tcsh". It is a superset of csh. See \|csh.vim\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3305 for how the filetype is detected.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3306
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3307 Tcsh does not allow \" in strings unless the "backslash_quote" shell variable
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3308 is set. If you want VIM to assume that no backslash quote constructs exist
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3309 add this line to your .vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3310
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3311 :let tcsh_backslash_quote = 0
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3312
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3313 If you notice highlighting errors while scrolling backwards, which are fixed
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3314 when redrawing with CTRL-L, try setting the "tcsh_minlines" internal variable
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3315 to a larger number: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3316
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3317 :let tcsh_minlines = 1000
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3318
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3319 This will make the syntax synchronization start 1000 lines before the first
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3320 displayed line. If you set "tcsh_minlines" to "fromstart", then
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3321 synchronization is done from the start of the file. The default value for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3322 tcsh_minlines is 100. The disadvantage of using a larger number is that
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3323 redrawing can become slow.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3324
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3325
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3326 TEX tex.vim ft-tex-syntax latex-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3327 syntax-tex syntax-latex
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3328
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3329 Tex Contents~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3330 Tex: Want Syntax Folding? \|tex-folding\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3331 Tex: No Spell Checking Wanted \|g:tex_nospell\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3332 Tex: Don't Want Spell Checking In Comments? \|tex-nospell\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3333 Tex: Want Spell Checking in Verbatim Zones? \|tex-verb\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3334 Tex: Run-on Comments or MathZones \|tex-runon\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3335 Tex: Slow Syntax Highlighting? \|tex-slow\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3336 Tex: Want To Highlight More Commands? \|tex-morecommands\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3337 Tex: Excessive Error Highlighting? \|tex-error\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3338 Tex: Need a new Math Group? \|tex-math\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3339 Tex: Starting a New Style? \|tex-style\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3340 Tex: Taking Advantage of Conceal Mode \|tex-conceal\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3341 Tex: Selective Conceal Mode \|g:tex_conceal\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3342 Tex: Controlling iskeyword \|g:tex_isk\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3343 Tex: Fine Subscript and Superscript Control \|tex-supersub\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3344 Tex: Match Check Control \|tex-matchcheck\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3345
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3346 tex-folding g:tex_fold_enabled
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3347 Tex: Want Syntax Folding? ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3348
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3349 As of version 28 of <syntax/tex.vim>, syntax-based folding of parts, chapters,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3350 sections, subsections, etc are supported. Put >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3351 let g:tex_fold_enabled=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3352 in your <.vimrc>, and :set fdm=syntax. I suggest doing the latter via a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3353 modeline at the end of your LaTeX file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3354 % vim: fdm=syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3355 If your system becomes too slow, then you might wish to look into >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3356 https://vimhelp.org/vim_faq.txt.html#faq-29.7
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3357 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3358 g:tex_nospell
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3359 Tex: No Spell Checking Wanted~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3360
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3361 If you don't want spell checking anywhere in your LaTeX document, put >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3362 let g:tex_nospell=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3363 into your .vimrc. If you merely wish to suppress spell checking inside
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3364 comments only, see \|g:tex_comment_nospell\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3365
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3366 tex-nospell g:tex_comment_nospell
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3367 Tex: Don't Want Spell Checking In Comments? ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3368
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3369 Some folks like to include things like source code in comments and so would
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3370 prefer that spell checking be disabled in comments in LaTeX files. To do
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3371 this, put the following in your <.vimrc>: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3372 let g:tex_comment_nospell= 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3373 If you want to suppress spell checking everywhere inside your LaTeX document,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3374 see \|g:tex_nospell\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3375
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3376 tex-verb g:tex_verbspell
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3377 Tex: Want Spell Checking in Verbatim Zones?~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3378
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3379 Often verbatim regions are used for things like source code; seldom does
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3380 one want source code spell-checked. However, for those of you who do
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3381 want your verbatim zones spell-checked, put the following in your <.vimrc>: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3382 let g:tex_verbspell= 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3383 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3384 tex-runon tex-stopzone
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3385 Tex: Run-on Comments or MathZones ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3386
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3387 The <syntax/tex.vim> highlighting supports TeX, LaTeX, and some AmsTeX. The
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3388 highlighting supports three primary zones/regions: normal, texZone, and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3389 texMathZone. Although considerable effort has been made to have these zones
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3390 terminate properly, zones delineated by $..$ and $$..$$ cannot be synchronized
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3391 as there's no difference between start and end patterns. Consequently, a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3392 special "TeX comment" has been provided >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3393 %stopzone
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3394 which will forcibly terminate the highlighting of either a texZone or a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3395 texMathZone.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3396
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3397 tex-slow tex-sync
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3398 Tex: Slow Syntax Highlighting? ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3399
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3400 If you have a slow computer, you may wish to reduce the values for >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3401 :syn sync maxlines=200
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3402 :syn sync minlines=50
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3403 (especially the latter). If your computer is fast, you may wish to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3404 increase them. This primarily affects synchronizing (i.e. just what group,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3405 if any, is the text at the top of the screen supposed to be in?).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3406
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3407 Another cause of slow highlighting is due to syntax-driven folding; see
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3408 \|tex-folding\| for a way around this.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3409
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3410 g:tex_fast
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3411
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3412 Finally, if syntax highlighting is still too slow, you may set >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3413
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3414 :let g:tex_fast= ""
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3415
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3416 in your .vimrc. Used this way, the g:tex_fast variable causes the syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3417 highlighting script to avoid defining any regions and associated
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3418 synchronization. The result will be much faster syntax highlighting; the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3419 price: you will no longer have as much highlighting or any syntax-based
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3420 folding, and you will be missing syntax-based error checking.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3421
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3422 You may decide that some syntax is acceptable; you may use the following table
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3423 selectively to enable just some syntax highlighting: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3424
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3425 b : allow bold and italic syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3426 c : allow texComment syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3427 m : allow texMatcher syntax (ie. {...} and [...])
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3428 M : allow texMath syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3429 p : allow parts, chapter, section, etc syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3430 r : allow texRefZone syntax (nocite, bibliography, label, pageref, eqref)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3431 s : allow superscript/subscript regions
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3432 S : allow texStyle syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3433 v : allow verbatim syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3434 V : allow texNewEnv and texNewCmd syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3435 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3436 As an example, let g:tex_fast= "M" will allow math-associated highlighting
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3437 but suppress all the other region-based syntax highlighting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3438 (also see: \|g:tex_conceal\| and \|tex-supersub\|)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3439
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3440 tex-morecommands tex-package
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3441 Tex: Want To Highlight More Commands? ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3442
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3443 LaTeX is a programmable language, and so there are thousands of packages full
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3444 of specialized LaTeX commands, syntax, and fonts. If you're using such a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3445 package you'll often wish that the distributed syntax/tex.vim would support
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3446 it. However, clearly this is impractical. So please consider using the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3447 techniques in \|mysyntaxfile-add\| to extend or modify the highlighting provided
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3448 by syntax/tex.vim. Please consider uploading any extensions that you write,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3449 which typically would go in $HOME/after/syntax/tex/[pkgname].vim, to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3450 http://vim.sf.net/.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3451
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3452 I've included some support for various popular packages on my website: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3453
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3454 http://www.drchip.org/astronaut/vim/index.html#LATEXPKGS
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3455 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3456 The syntax files there go into your .../after/syntax/tex/ directory.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3457
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3458 tex-error g:tex_no_error
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3459 Tex: Excessive Error Highlighting? ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3460
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3461 The <tex.vim> supports lexical error checking of various sorts. Thus,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3462 although the error checking is ofttimes very useful, it can indicate
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3463 errors where none actually are. If this proves to be a problem for you,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3464 you may put in your <.vimrc> the following statement: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3465 let g:tex_no_error=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3466 and all error checking by <syntax/tex.vim> will be suppressed.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3467
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3468 tex-math
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3469 Tex: Need a new Math Group? ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3470
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3471 If you want to include a new math group in your LaTeX, the following
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3472 code shows you an example as to how you might do so: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3473 call TexNewMathZone(sfx,mathzone,starform)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3474 You'll want to provide the new math group with a unique suffix
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3475 (currently, A-L and V-Z are taken by <syntax/tex.vim> itself).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3476 As an example, consider how eqnarray is set up by <syntax/tex.vim>: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3477 call TexNewMathZone("D","eqnarray",1)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3478 You'll need to change "mathzone" to the name of your new math group,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3479 and then to the call to it in .vim/after/syntax/tex.vim.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3480 The "starform" variable, if true, implies that your new math group
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3481 has a starred form (ie. eqnarray*).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3482
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3483 tex-style b:tex_stylish
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3484 Tex: Starting a New Style? ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3485
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3486 One may use "\makeatletter" in *.tex files, thereby making the use of "@" in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3487 commands available. However, since the *.tex file doesn't have one of the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3488 following suffices: sty cls clo dtx ltx, the syntax highlighting will flag
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3489 such use of @ as an error. To solve this: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3490
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3491 :let b:tex_stylish = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3492 :set ft=tex
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3493
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3494 Putting "let g:tex_stylish=1" into your <.vimrc> will make <syntax/tex.vim>
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3495 always accept such use of @.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3496
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3497 tex-cchar tex-cole tex-conceal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3498 Tex: Taking Advantage of Conceal Mode~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3499
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3500 If you have \|'conceallevel'\| set to 2 and if your encoding is utf-8, then a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3501 number of character sequences can be translated into appropriate utf-8 glyphs,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3502 including various accented characters, Greek characters in MathZones, and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3503 superscripts and subscripts in MathZones. Not all characters can be made into
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3504 superscripts or subscripts; the constraint is due to what utf-8 supports.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3505 In fact, only a few characters are supported as subscripts.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3506
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3507 One way to use this is to have vertically split windows (see \|CTRL-W_v\|); one
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3508 with \|'conceallevel'\| at 0 and the other at 2; and both using \|'scrollbind'\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3509
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3510 g:tex_conceal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3511 Tex: Selective Conceal Mode~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3512
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3513 You may selectively use conceal mode by setting g:tex_conceal in your
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3514 <.vimrc>. By default, g:tex_conceal is set to "admgs" to enable concealment
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3515 for the following sets of characters: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3516
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3517 a = accents/ligatures
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3518 b = bold and italic
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3519 d = delimiters
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3520 m = math symbols
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3521 g = Greek
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3522 s = superscripts/subscripts
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3523 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3524 By leaving one or more of these out, the associated conceal-character
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3525 substitution will not be made.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3526
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3527 g:tex_isk g:tex_stylish
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3528 Tex: Controlling iskeyword~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3529
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3530 Normally, LaTeX keywords support 0-9, a-z, A-z, and 192-255 only. Latex
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3531 keywords don't support the underscore - except when in *.sty files. The
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3532 syntax highlighting script handles this with the following logic:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3533
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3534 * If g:tex_stylish exists and is 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3535 then the file will be treated as a "sty" file, so the "_"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3536 will be allowed as part of keywords
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3537 (regardless of g:tex_isk)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3538 * Else if the file's suffix is sty, cls, clo, dtx, or ltx,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3539 then the file will be treated as a "sty" file, so the "_"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3540 will be allowed as part of keywords
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3541 (regardless of g:tex_isk)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3542
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3543 * If g:tex_isk exists, then it will be used for the local 'iskeyword'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3544 * Else the local 'iskeyword' will be set to 48-57,a-z,A-Z,192-255
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3545
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3546 tex-supersub g:tex_superscripts g:tex_subscripts
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3547 Tex: Fine Subscript and Superscript Control~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3548
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3549 See \|tex-conceal\| for how to enable concealed character replacement.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3550
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3551 See \|g:tex_conceal\| for selectively concealing accents, bold/italic,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3552 math, Greek, and superscripts/subscripts.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3553
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3554 One may exert fine control over which superscripts and subscripts one
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3555 wants syntax-based concealment for (see \|:syn-cchar\|). Since not all
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3556 fonts support all characters, one may override the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3557 concealed-replacement lists; by default these lists are given by: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3558
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3559 let g:tex_superscripts= "[0-9a-zA-W.,:;+-<>/()=]"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3560 let g:tex_subscripts= "[0-9aehijklmnoprstuvx,+-/().]"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3561 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3562 For example, I use Luxi Mono Bold; it doesn't support subscript
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3563 characters for "hklmnpst", so I put >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3564 let g:tex_subscripts= "[0-9aeijoruvx,+-/().]"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3565 < in ~/.vim/ftplugin/tex/tex.vim in order to avoid having inscrutable
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3566 utf-8 glyphs appear.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3567
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3568 tex-matchcheck g:tex_matchcheck
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3569 Tex: Match Check Control~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3570
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3571 Sometimes one actually wants mismatched parentheses, square braces,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3572 and or curly braces; for example, \text{(1,10]} is a range from but
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3573 not including 1 to and including 10. This wish, of course, conflicts
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3574 with the desire to provide delimiter mismatch detection. To
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3575 accommodate these conflicting goals, syntax/tex.vim provides >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3576 g:tex_matchcheck = '[({[]'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3577 < which is shown along with its default setting. So, if one doesn't
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3578 want [] and () to be checked for mismatches, try using >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3579 let g:tex_matchcheck= '[{}]'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3580 < If you don't want matching to occur inside bold and italicized
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3581 regions, >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3582 let g:tex_excludematcher= 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3583 < will prevent the texMatcher group from being included in those regions.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3584
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3585 TF tf.vim ft-tf-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3586
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3587 There is one option for the tf syntax highlighting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3588
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3589 For syncing, minlines defaults to 100. If you prefer another value, you can
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3590 set "tf_minlines" to the value you desire. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3591
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3592 :let tf_minlines = your choice
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3593 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3594 VIM vim.vim ft-vim-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3595 g:vimsyn_minlines g:vimsyn_maxlines
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3596 There is a trade-off between more accurate syntax highlighting versus screen
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3597 updating speed. To improve accuracy, you may wish to increase the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3598 g:vimsyn_minlines variable. The g:vimsyn_maxlines variable may be used to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3599 improve screen updating rates (see \|:syn-sync\| for more on this). >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3600
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3601 g:vimsyn_minlines : used to set synchronization minlines
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3602 g:vimsyn_maxlines : used to set synchronization maxlines
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3603 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3604 (g:vim_minlines and g:vim_maxlines are deprecated variants of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3605 these two options)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3606
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3607 g:vimsyn_embed
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3608 The g:vimsyn_embed option allows users to select what, if any, types of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3609 embedded script highlighting they wish to have. >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3610
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3611 g:vimsyn_embed == 0 : don't support any embedded scripts
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3612 g:vimsyn_embed =~ 'l' : support embedded lua
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3613 g:vimsyn_embed =~ 'm' : support embedded mzscheme
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3614 g:vimsyn_embed =~ 'p' : support embedded perl
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3615 g:vimsyn_embed =~ 'P' : support embedded python
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3616 g:vimsyn_embed =~ 'r' : support embedded ruby
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3617 g:vimsyn_embed =~ 't' : support embedded tcl
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3618 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3619 By default, g:vimsyn_embed is a string supporting interpreters that your vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3620 itself supports. Concatenate multiple characters to support multiple types
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3621 of embedded interpreters; ie. g:vimsyn_embed= "mp" supports embedded mzscheme
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3622 and embedded perl.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3623 g:vimsyn_folding
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3624
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3625 Some folding is now supported with syntax/vim.vim: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3626
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3627 g:vimsyn_folding == 0 or doesn't exist: no syntax-based folding
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3628 g:vimsyn_folding =~ 'a' : augroups
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3629 g:vimsyn_folding =~ 'f' : fold functions
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3630 g:vimsyn_folding =~ 'l' : fold lua script
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3631 g:vimsyn_folding =~ 'm' : fold mzscheme script
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3632 g:vimsyn_folding =~ 'p' : fold perl script
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3633 g:vimsyn_folding =~ 'P' : fold python script
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3634 g:vimsyn_folding =~ 'r' : fold ruby script
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3635 g:vimsyn_folding =~ 't' : fold tcl script
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3636 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3637 g:vimsyn_noerror
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3638 Not all error highlighting that syntax/vim.vim does may be correct; Vim script
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3639 is a difficult language to highlight correctly. A way to suppress error
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3640 highlighting is to put the following line in your \|vimrc\|: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3641
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3642 let g:vimsyn_noerror = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3643 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3644
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3645
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3646 WDL wdl.vim wdl-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3647
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3648 The Workflow Description Language is a way to specify data processing workflows
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3649 with a human-readable and writeable syntax. This is used a lot in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3650 bioinformatics. More info on the spec can be found here:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3651 https://github.com/openwdl/wdl
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3652
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3653
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3654 XF86CONFIG xf86conf.vim ft-xf86conf-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3655
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3656 The syntax of XF86Config file differs in XFree86 v3.x and v4.x. Both
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3657 variants are supported. Automatic detection is used, but is far from perfect.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3658 You may need to specify the version manually. Set the variable
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3659 xf86conf_xfree86_version to 3 or 4 according to your XFree86 version in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3660 your .vimrc. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3661 :let xf86conf_xfree86_version=3
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3662 When using a mix of versions, set the b:xf86conf_xfree86_version variable.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3663
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3664 Note that spaces and underscores in option names are not supported. Use
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3665 "SyncOnGreen" instead of "__s yn con gr_e_e_n" if you want the option name
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3666 highlighted.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3667
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3668
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3669 XML xml.vim ft-xml-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3670
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3671 Xml namespaces are highlighted by default. This can be inhibited by
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3672 setting a global variable: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3673
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3674 :let g:xml_namespace_transparent=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3675 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3676 xml-folding
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3677 The xml syntax file provides syntax \|folding\| (see \|:syn-fold\|) between
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3678 start and end tags. This can be turned on by >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3679
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3680 :let g:xml_syntax_folding = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3681 :set foldmethod=syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3682
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3683 Note: Syntax folding might slow down syntax highlighting significantly,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3684 especially for large files.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3685
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3686
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3687 X Pixmaps (XPM) xpm.vim ft-xpm-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3688
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3689 xpm.vim creates its syntax items dynamically based upon the contents of the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3690 XPM file. Thus if you make changes e.g. in the color specification strings,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3691 you have to source it again e.g. with ":set syn=xpm".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3692
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3693 To copy a pixel with one of the colors, yank a "pixel" with "yl" and insert it
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3694 somewhere else with "P".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3695
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3696 Do you want to draw with the mouse? Try the following: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3697 :function! GetPixel()
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3698 : let c = getline(".")[col(".") - 1]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3699 : echo c
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3700 : exe "noremap <LeftMouse> <LeftMouse>r" .. c
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3701 : exe "noremap <LeftDrag> <LeftMouse>r" .. c
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3702 :endfunction
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3703 :noremap <RightMouse> <LeftMouse>:call GetPixel()<CR>
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3704 :set guicursor=n:hor20 " to see the color beneath the cursor
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3705 This turns the right button into a pipette and the left button into a pen.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3706 It will work with XPM files that have one character per pixel only and you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3707 must not click outside of the pixel strings, but feel free to improve it.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3708
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3709 It will look much better with a font in a quadratic cell size, e.g. for X: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3710 :set guifont=--clean-medium-r---8-----80-
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3711
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3712
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3713 YAML yaml.vim ft-yaml-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3714
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3715 g:yaml_schema b:yaml_schema
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3716 A YAML schema is a combination of a set of tags and a mechanism for resolving
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3717 non-specific tags. For user this means that YAML parser may, depending on
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3718 plain scalar contents, treat plain scalar (which can actually be only string
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3719 and nothing else) as a value of the other type: null, boolean, floating-point,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3720 integer. `g:yaml_schema` option determines according to which schema values
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3721 will be highlighted specially. Supported schemas are
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3722
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3723 Schema Description ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3724 failsafe No additional highlighting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3725 json Supports JSON-style numbers, booleans and null.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3726 core Supports more number, boolean and null styles.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3727 pyyaml In addition to core schema supports highlighting timestamps,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3728 but there are some differences in what is recognized as
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3729 numbers and many additional boolean values not present in core
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3730 schema.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3731
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3732 Default schema is `core`.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3733
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3734 Note that schemas are not actually limited to plain scalars, but this is the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3735 only difference between schemas defined in YAML specification and the only
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3736 difference defined in the syntax file.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3737
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3738
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3739 ZSH zsh.vim ft-zsh-syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3740
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3741 The syntax script for zsh allows for syntax-based folding: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3742
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3743 :let g:zsh_fold_enable = 1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3744
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3745 ==============================================================================
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3746 6. Defining a syntax :syn-define E410
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3747
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3748 Vim understands three types of syntax items:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3749
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3750 1. Keyword
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3751 It can only contain keyword characters, according to the characters
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3752 specified with \|:syn-iskeyword\| or the 'iskeyword' option. It cannot
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3753 contain other syntax items. It will only match with a complete word (there
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3754 are no keyword characters before or after the match). The keyword "if"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3755 would match in "if(a=b)", but not in "ifdef x", because "(" is not a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3756 keyword character and "d" is.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3757
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3758 2. Match
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3759 This is a match with a single regexp pattern.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3760
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3761 3. Region
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3762 This starts at a match of the "start" regexp pattern and ends with a match
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3763 with the "end" regexp pattern. Any other text can appear in between. A
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3764 "skip" regexp pattern can be used to avoid matching the "end" pattern.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3765
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3766 Several syntax ITEMs can be put into one syntax GROUP. For a syntax group
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3767 you can give highlighting attributes. For example, you could have an item
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3768 to define a "/* .. */" comment and another one that defines a "// .." comment,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3769 and put them both in the "Comment" group. You can then specify that a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3770 "Comment" will be in bold font and have a blue color. You are free to make
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3771 one highlight group for one syntax item, or put all items into one group.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3772 This depends on how you want to specify your highlighting attributes. Putting
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3773 each item in its own group results in having to specify the highlighting
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3774 for a lot of groups.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3775
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3776 Note that a syntax group and a highlight group are similar. For a highlight
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3777 group you will have given highlight attributes. These attributes will be used
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3778 for the syntax group with the same name.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3779
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3780 In case more than one item matches at the same position, the one that was
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3781 defined LAST wins. Thus you can override previously defined syntax items by
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3782 using an item that matches the same text. But a keyword always goes before a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3783 match or region. And a keyword with matching case always goes before a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3784 keyword with ignoring case.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3785
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3786
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3787 PRIORITY :syn-priority
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3788
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3789 When several syntax items may match, these rules are used:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3790
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3791 1. When multiple Match or Region items start in the same position, the item
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3792 defined last has priority.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3793 2. A Keyword has priority over Match and Region items.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3794 3. An item that starts in an earlier position has priority over items that
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3795 start in later positions.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3796
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3797
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3798 DEFINING CASE :syn-case E390
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3799
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3800 :sy[ntax] case [match \| ignore]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3801 This defines if the following ":syntax" commands will work with
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3802 matching case, when using "match", or with ignoring case, when using
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3803 "ignore". Note that any items before this are not affected, and all
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3804 items until the next ":syntax case" command are affected.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3805
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3806 :sy[ntax] case
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3807 Show either "syntax case match" or "syntax case ignore".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3808
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3809
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3810 DEFINING FOLDLEVEL :syn-foldlevel
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3811
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3812 :sy[ntax] foldlevel start
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3813 :sy[ntax] foldlevel minimum
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3814 This defines how the foldlevel of a line is computed when using
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3815 foldmethod=syntax (see \|fold-syntax\| and \|:syn-fold\|):
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3816
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3817 start: Use level of item containing start of line.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3818 minimum: Use lowest local-minimum level of items on line.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3819
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3820 The default is "start". Use "minimum" to search a line horizontally
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3821 for the lowest level contained on the line that is followed by a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3822 higher level. This produces more natural folds when syntax items
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3823 may close and open horizontally within a line.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3824
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3825 :sy[ntax] foldlevel
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3826 Show the current foldlevel method, either "syntax foldlevel start" or
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3827 "syntax foldlevel minimum".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3828
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3829 {not meaningful when Vim was compiled without \|+folding\| feature}
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3830
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3831 SPELL CHECKING :syn-spell
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3832
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3833 :sy[ntax] spell toplevel
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3834 :sy[ntax] spell notoplevel
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3835 :sy[ntax] spell default
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3836 This defines where spell checking is to be done for text that is not
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3837 in a syntax item:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3838
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3839 toplevel: Text is spell checked.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3840 notoplevel: Text is not spell checked.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3841 default: When there is a @Spell cluster no spell checking.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3842
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3843 For text in syntax items use the @Spell and @NoSpell clusters
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3844 \|spell-syntax\|. When there is no @Spell and no @NoSpell cluster then
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3845 spell checking is done for "default" and "toplevel".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3846
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3847 To activate spell checking the 'spell' option must be set.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3848
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3849 :sy[ntax] spell
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3850 Show the current syntax spell checking method, either "syntax spell
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3851 toplevel", "syntax spell notoplevel" or "syntax spell default".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3852
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3853
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3854 SYNTAX ISKEYWORD SETTING :syn-iskeyword
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3855
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3856 :sy[ntax] iskeyword [clear \| {option}]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3857 This defines the keyword characters. It's like the 'iskeyword' option
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3858 for but only applies to syntax highlighting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3859
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3860 clear: Syntax specific iskeyword setting is disabled and the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3861 buffer-local 'iskeyword' setting is used.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3862 {option} Set the syntax 'iskeyword' option to a new value.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3863
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3864 Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3865 :syntax iskeyword @,48-57,192-255,$,_
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3866 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3867 This would set the syntax specific iskeyword option to include all
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3868 alphabetic characters, plus the numeric characters, all accented
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3869 characters and also includes the "_" and the "$".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3870
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3871 If no argument is given, the current value will be output.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3872
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3873 Setting this option influences what \|/\k\| matches in syntax patterns
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3874 and also determines where \|:syn-keyword\| will be checked for a new
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3875 match.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3876
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3877 It is recommended when writing syntax files, to use this command to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3878 set the correct value for the specific syntax language and not change
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3879 the 'iskeyword' option.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3880
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3881 DEFINING KEYWORDS :syn-keyword
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3882
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3883 :sy[ntax] keyword {group-name} [{options}] {keyword} .. [{options}]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3884
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3885 This defines a number of keywords.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3886
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3887 {group-name} Is a syntax group name such as "Comment".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3888 [{options}] See \|:syn-arguments\| below.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3889 {keyword} .. Is a list of keywords which are part of this group.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3890
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3891 Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3892 :syntax keyword Type int long char
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3893 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3894 The {options} can be given anywhere in the line. They will apply to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3895 all keywords given, also for options that come after a keyword.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3896 These examples do exactly the same: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3897 :syntax keyword Type contained int long char
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3898 :syntax keyword Type int long contained char
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3899 :syntax keyword Type int long char contained
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3900 < E789 E890
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3901 When you have a keyword with an optional tail, like Ex commands in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3902 Vim, you can put the optional characters inside [], to define all the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3903 variations at once: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3904 :syntax keyword vimCommand ab[breviate] n[ext]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3905 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3906 Don't forget that a keyword can only be recognized if all the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3907 characters are included in the 'iskeyword' option. If one character
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3908 isn't, the keyword will never be recognized.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3909 Multi-byte characters can also be used. These do not have to be in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3910 'iskeyword'.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3911 See \|:syn-iskeyword\| for defining syntax specific iskeyword settings.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3912
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3913 A keyword always has higher priority than a match or region, the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3914 keyword is used if more than one item matches. Keywords do not nest
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3915 and a keyword can't contain anything else.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3916
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3917 Note that when you have a keyword that is the same as an option (even
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3918 one that isn't allowed here), you can not use it. Use a match
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3919 instead.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3920
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3921 The maximum length of a keyword is 80 characters.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3922
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3923 The same keyword can be defined multiple times, when its containment
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3924 differs. For example, you can define the keyword once not contained
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3925 and use one highlight group, and once contained, and use a different
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3926 highlight group. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3927 :syn keyword vimCommand tag
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3928 :syn keyword vimSetting contained tag
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3929 < When finding "tag" outside of any syntax item, the "vimCommand"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3930 highlight group is used. When finding "tag" in a syntax item that
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3931 contains "vimSetting", the "vimSetting" group is used.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3932
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3933
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3934 DEFINING MATCHES :syn-match
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3935
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3936 :sy[ntax] match {group-name} [{options}]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3937 [excludenl]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3938 [keepend]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3939 {pattern}
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3940 [{options}]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3941
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3942 This defines one match.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3943
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3944 {group-name} A syntax group name such as "Comment".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3945 [{options}] See \|:syn-arguments\| below.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3946 [excludenl] Don't make a pattern with the end-of-line "$"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3947 extend a containing match or region. Must be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3948 given before the pattern. \|:syn-excludenl\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3949 keepend Don't allow contained matches to go past a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3950 match with the end pattern. See
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3951 \|:syn-keepend\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3952 {pattern} The search pattern that defines the match.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3953 See \|:syn-pattern\| below.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3954 Note that the pattern may match more than one
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3955 line, which makes the match depend on where
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3956 Vim starts searching for the pattern. You
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3957 need to make sure syncing takes care of this.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3958
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3959 Example (match a character constant): >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3960 :syntax match Character /'.'/hs=s+1,he=e-1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3961 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3962
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3963 DEFINING REGIONS :syn-region :syn-start :syn-skip :syn-end
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3964 E398 E399
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3965 :sy[ntax] region {group-name} [{options}]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3966 [matchgroup={group-name}]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3967 [keepend]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3968 [extend]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3969 [excludenl]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3970 start={start-pattern} ..
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3971 [skip={skip-pattern}]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3972 end={end-pattern} ..
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3973 [{options}]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3974
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3975 This defines one region. It may span several lines.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3976
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3977 {group-name} A syntax group name such as "Comment".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3978 [{options}] See \|:syn-arguments\| below.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3979 [matchgroup={group-name}] The syntax group to use for the following
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3980 start or end pattern matches only. Not used
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3981 for the text in between the matched start and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3982 end patterns. Use NONE to reset to not using
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3983 a different group for the start or end match.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3984 See \|:syn-matchgroup\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3985 keepend Don't allow contained matches to go past a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3986 match with the end pattern. See
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3987 \|:syn-keepend\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3988 extend Override a "keepend" for an item this region
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3989 is contained in. See \|:syn-extend\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3990 excludenl Don't make a pattern with the end-of-line "$"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3991 extend a containing match or item. Only
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3992 useful for end patterns. Must be given before
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3993 the patterns it applies to. \|:syn-excludenl\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3994 start={start-pattern} The search pattern that defines the start of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3995 the region. See \|:syn-pattern\| below.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3996 skip={skip-pattern} The search pattern that defines text inside
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3997 the region where not to look for the end
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3998 pattern. See \|:syn-pattern\| below.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	3999 end={end-pattern} The search pattern that defines the end of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4000 the region. See \|:syn-pattern\| below.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4001
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4002 Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4003 :syntax region String start=+"+ skip=+\\"+ end=+"+
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4004 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4005 The start/skip/end patterns and the options can be given in any order.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4006 There can be zero or one skip pattern. There must be one or more
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4007 start and end patterns. This means that you can omit the skip
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4008 pattern, but you must give at least one start and one end pattern. It
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4009 is allowed to have white space before and after the equal sign
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4010 (although it mostly looks better without white space).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4011
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4012 When more than one start pattern is given, a match with one of these
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4013 is sufficient. This means there is an OR relation between the start
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4014 patterns. The last one that matches is used. The same is true for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4015 the end patterns.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4016
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4017 The search for the end pattern starts right after the start pattern.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4018 Offsets are not used for this. This implies that the match for the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4019 end pattern will never overlap with the start pattern.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4020
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4021 The skip and end pattern can match across line breaks, but since the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4022 search for the pattern can start in any line it often does not do what
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4023 you want. The skip pattern doesn't avoid a match of an end pattern in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4024 the next line. Use single-line patterns to avoid trouble.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4025
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4026 Note: The decision to start a region is only based on a matching start
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4027 pattern. There is no check for a matching end pattern. This does NOT
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4028 work: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4029 :syn region First start="(" end=":"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4030 :syn region Second start="(" end=";"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4031 < The Second always matches before the First (last defined pattern has
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4032 higher priority). The Second region then continues until the next
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4033 ';', no matter if there is a ':' before it. Using a match does work: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4034 :syn match First "(\_.\{-}:"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4035 :syn match Second "(\_.\{-};"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4036 < This pattern matches any character or line break with "\_." and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4037 repeats that with "\{-}" (repeat as few as possible).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4038
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4039 :syn-keepend
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4040 By default, a contained match can obscure a match for the end pattern.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4041 This is useful for nesting. For example, a region that starts with
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4042 "{" and ends with "}", can contain another region. An encountered "}"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4043 will then end the contained region, but not the outer region:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4044 { starts outer "{}" region
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4045 { starts contained "{}" region
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4046 } ends contained "{}" region
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4047 } ends outer "{} region
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4048 If you don't want this, the "keepend" argument will make the matching
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4049 of an end pattern of the outer region also end any contained item.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4050 This makes it impossible to nest the same region, but allows for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4051 contained items to highlight parts of the end pattern, without causing
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4052 that to skip the match with the end pattern. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4053 :syn match vimComment +"[^"]\+$+
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4054 :syn region vimCommand start="set" end="$" contains=vimComment keepend
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4055 < The "keepend" makes the vimCommand always end at the end of the line,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4056 even though the contained vimComment includes a match with the <EOL>.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4057
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4058 When "keepend" is not used, a match with an end pattern is retried
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4059 after each contained match. When "keepend" is included, the first
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4060 encountered match with an end pattern is used, truncating any
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4061 contained matches.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4062 :syn-extend
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4063 The "keepend" behavior can be changed by using the "extend" argument.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4064 When an item with "extend" is contained in an item that uses
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4065 "keepend", the "keepend" is ignored and the containing region will be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4066 extended.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4067 This can be used to have some contained items extend a region while
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4068 others don't. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4069
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4070 :syn region htmlRef start=+<a>+ end=+</a>+ keepend contains=htmlItem,htmlScript
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4071 :syn match htmlItem +<[^>]*>+ contained
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4072 :syn region htmlScript start=+<script+ end=+</script[^>]*>+ contained extend
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4073
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4074 < Here the htmlItem item does not make the htmlRef item continue
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4075 further, it is only used to highlight the <> items. The htmlScript
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4076 item does extend the htmlRef item.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4077
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4078 Another example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4079 :syn region xmlFold start="<a>" end="</a>" fold transparent keepend extend
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4080 < This defines a region with "keepend", so that its end cannot be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4081 changed by contained items, like when the "</a>" is matched to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4082 highlight it differently. But when the xmlFold region is nested (it
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4083 includes itself), the "extend" applies, so that the "</a>" of a nested
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4084 region only ends that region, and not the one it is contained in.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4085
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4086 :syn-excludenl
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4087 When a pattern for a match or end pattern of a region includes a '$'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4088 to match the end-of-line, it will make a region item that it is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4089 contained in continue on the next line. For example, a match with
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4090 "\\$" (backslash at the end of the line) can make a region continue
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4091 that would normally stop at the end of the line. This is the default
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4092 behavior. If this is not wanted, there are two ways to avoid it:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4093 1. Use "keepend" for the containing item. This will keep all
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4094 contained matches from extending the match or region. It can be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4095 used when all contained items must not extend the containing item.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4096 2. Use "excludenl" in the contained item. This will keep that match
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4097 from extending the containing match or region. It can be used if
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4098 only some contained items must not extend the containing item.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4099 "excludenl" must be given before the pattern it applies to.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4100
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4101 :syn-matchgroup
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4102 "matchgroup" can be used to highlight the start and/or end pattern
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4103 differently than the body of the region. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4104 :syntax region String matchgroup=Quote start=+"+ skip=+\\"+ end=+"+
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4105 < This will highlight the quotes with the "Quote" group, and the text in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4106 between with the "String" group.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4107 The "matchgroup" is used for all start and end patterns that follow,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4108 until the next "matchgroup". Use "matchgroup=NONE" to go back to not
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4109 using a matchgroup.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4110
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4111 In a start or end pattern that is highlighted with "matchgroup" the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4112 contained items of the region are not used. This can be used to avoid
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4113 that a contained item matches in the start or end pattern match. When
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4114 using "transparent", this does not apply to a start or end pattern
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4115 match that is highlighted with "matchgroup".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4116
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4117 Here is an example, which highlights three levels of parentheses in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4118 different colors: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4119 :sy region par1 matchgroup=par1 start=/(/ end=/)/ contains=par2
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4120 :sy region par2 matchgroup=par2 start=/(/ end=/)/ contains=par3 contained
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4121 :sy region par3 matchgroup=par3 start=/(/ end=/)/ contains=par1 contained
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4122 :hi par1 ctermfg=red guifg=red
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4123 :hi par2 ctermfg=blue guifg=blue
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4124 :hi par3 ctermfg=darkgreen guifg=darkgreen
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4125 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4126 E849
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4127 The maximum number of syntax groups is 19999.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4128
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4129 ==============================================================================
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4130 7. :syntax arguments :syn-arguments
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4131
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4132 The :syntax commands that define syntax items take a number of arguments.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4133 The common ones are explained here. The arguments may be given in any order
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4134 and may be mixed with patterns.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4135
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4136 Not all commands accept all arguments. This table shows which arguments
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4137 can not be used for all commands:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4138 E395
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4139 contains oneline fold display extend concealends~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4140 :syntax keyword - - - - - -
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4141 :syntax match yes - yes yes yes -
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4142 :syntax region yes yes yes yes yes yes
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4143
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4144 These arguments can be used for all three commands:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4145 conceal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4146 cchar
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4147 contained
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4148 containedin
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4149 nextgroup
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4150 transparent
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4151 skipwhite
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4152 skipnl
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4153 skipempty
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4154
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4155 conceal conceal :syn-conceal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4156
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4157 When the "conceal" argument is given, the item is marked as concealable.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4158 Whether or not it is actually concealed depends on the value of the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4159 'conceallevel' option. The 'concealcursor' option is used to decide whether
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4160 concealable items in the current line are displayed unconcealed to be able to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4161 edit the line.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4162 Another way to conceal text is with \|matchadd()\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4163
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4164 concealends :syn-concealends
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4165
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4166 When the "concealends" argument is given, the start and end matches of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4167 the region, but not the contents of the region, are marked as concealable.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4168 Whether or not they are actually concealed depends on the setting on the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4169 'conceallevel' option. The ends of a region can only be concealed separately
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4170 in this way when they have their own highlighting via "matchgroup"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4171
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4172 cchar :syn-cchar
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4173 E844
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4174 The "cchar" argument defines the character shown in place of the item
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4175 when it is concealed (setting "cchar" only makes sense when the conceal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4176 argument is given.) If "cchar" is not set then the default conceal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4177 character defined in the 'listchars' option is used. The character cannot be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4178 a control character such as Tab. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4179 :syntax match Entity "&" conceal cchar=&
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4180 See \|hl-Conceal\| for highlighting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4181
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4182 contained :syn-contained
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4183
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4184 When the "contained" argument is given, this item will not be recognized at
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4185 the top level, but only when it is mentioned in the "contains" field of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4186 another match. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4187 :syntax keyword Todo TODO contained
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4188 :syntax match Comment "//.*" contains=Todo
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4189
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4190
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4191 display :syn-display
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4192
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4193 If the "display" argument is given, this item will be skipped when the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4194 detected highlighting will not be displayed. This will speed up highlighting,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4195 by skipping this item when only finding the syntax state for the text that is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4196 to be displayed.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4197
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4198 Generally, you can use "display" for match and region items that meet these
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4199 conditions:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4200 - The item does not continue past the end of a line. Example for C: A region
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4201 for a "/*" comment can't contain "display", because it continues on the next
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4202 line.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4203 - The item does not contain items that continue past the end of the line or
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4204 make it continue on the next line.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4205 - The item does not change the size of any item it is contained in. Example
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4206 for C: A match with "\\$" in a preprocessor match can't have "display",
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4207 because it may make that preprocessor match shorter.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4208 - The item does not allow other items to match that didn't match otherwise,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4209 and that item may extend the match too far. Example for C: A match for a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4210 "//" comment can't use "display", because a "/*" inside that comment would
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4211 match then and start a comment which extends past the end of the line.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4212
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4213 Examples, for the C language, where "display" can be used:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4214 - match with a number
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4215 - match with a label
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4216
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4217
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4218 transparent :syn-transparent
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4219
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4220 If the "transparent" argument is given, this item will not be highlighted
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4221 itself, but will take the highlighting of the item it is contained in. This
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4222 is useful for syntax items that don't need any highlighting but are used
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4223 only to skip over a part of the text.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4224
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4225 The "contains=" argument is also inherited from the item it is contained in,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4226 unless a "contains" argument is given for the transparent item itself. To
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4227 avoid that unwanted items are contained, use "contains=NONE". Example, which
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4228 highlights words in strings, but makes an exception for "vim": >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4229 :syn match myString /'[^']*'/ contains=myWord,myVim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4230 :syn match myWord /\<[a-z]*\>/ contained
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4231 :syn match myVim /\<vim\>/ transparent contained contains=NONE
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4232 :hi link myString String
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4233 :hi link myWord Comment
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4234 Since the "myVim" match comes after "myWord" it is the preferred match (last
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4235 match in the same position overrules an earlier one). The "transparent"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4236 argument makes the "myVim" match use the same highlighting as "myString". But
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4237 it does not contain anything. If the "contains=NONE" argument would be left
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4238 out, then "myVim" would use the contains argument from myString and allow
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4239 "myWord" to be contained, which will be highlighted as a Comment. This
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4240 happens because a contained match doesn't match inside itself in the same
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4241 position, thus the "myVim" match doesn't overrule the "myWord" match here.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4242
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4243 When you look at the colored text, it is like looking at layers of contained
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4244 items. The contained item is on top of the item it is contained in, thus you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4245 see the contained item. When a contained item is transparent, you can look
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4246 through, thus you see the item it is contained in. In a picture:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4247
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4248 look from here
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4249
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4250 \| \| \| \| \| \|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4251 V V V V V V
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4252
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4253 xxxx yyy more contained items
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4254 .................... contained item (transparent)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4255 ============================= first item
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4256
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4257 The 'x', 'y' and '=' represent a highlighted syntax item. The '.' represent a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4258 transparent group.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4259
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4260 What you see is:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4261
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4262 =======xxxx=======yyy========
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4263
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4264 Thus you look through the transparent "....".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4265
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4266
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4267 oneline :syn-oneline
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4268
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4269 The "oneline" argument indicates that the region does not cross a line
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4270 boundary. It must match completely in the current line. However, when the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4271 region has a contained item that does cross a line boundary, it continues on
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4272 the next line anyway. A contained item can be used to recognize a line
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4273 continuation pattern. But the "end" pattern must still match in the first
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4274 line, otherwise the region doesn't even start.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4275
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4276 When the start pattern includes a "\n" to match an end-of-line, the end
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4277 pattern must be found in the same line as where the start pattern ends. The
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4278 end pattern may also include an end-of-line. Thus the "oneline" argument
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4279 means that the end of the start pattern and the start of the end pattern must
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4280 be within one line. This can't be changed by a skip pattern that matches a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4281 line break.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4282
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4283
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4284 fold :syn-fold
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4285
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4286 The "fold" argument makes the fold level increase by one for this item.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4287 Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4288 :syn region myFold start="{" end="}" transparent fold
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4289 :syn sync fromstart
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4290 :set foldmethod=syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4291 This will make each {} block form one fold.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4292
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4293 The fold will start on the line where the item starts, and end where the item
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4294 ends. If the start and end are within the same line, there is no fold.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4295 The 'foldnestmax' option limits the nesting of syntax folds.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4296 See \|:syn-foldlevel\| to control how the foldlevel of a line is computed
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4297 from its syntax items.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4298 {not available when Vim was compiled without \|+folding\| feature}
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4299
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4300
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4301 :syn-contains E405 E406 E407 E408 E409
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4302 contains={group-name},..
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4303
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4304 The "contains" argument is followed by a list of syntax group names. These
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4305 groups will be allowed to begin inside the item (they may extend past the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4306 containing group's end). This allows for recursive nesting of matches and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4307 regions. If there is no "contains" argument, no groups will be contained in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4308 this item. The group names do not need to be defined before they can be used
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4309 here.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4310
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4311 contains=ALL
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4312 If the only item in the contains list is "ALL", then all
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4313 groups will be accepted inside the item.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4314
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4315 contains=ALLBUT,{group-name},..
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4316 If the first item in the contains list is "ALLBUT", then all
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4317 groups will be accepted inside the item, except the ones that
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4318 are listed. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4319 :syntax region Block start="{" end="}" ... contains=ALLBUT,Function
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4320
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4321 contains=TOP
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4322 If the first item in the contains list is "TOP", then all
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4323 groups will be accepted that don't have the "contained"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4324 argument.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4325 contains=TOP,{group-name},..
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4326 Like "TOP", but excluding the groups that are listed.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4327
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4328 contains=CONTAINED
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4329 If the first item in the contains list is "CONTAINED", then
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4330 all groups will be accepted that have the "contained"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4331 argument.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4332 contains=CONTAINED,{group-name},..
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4333 Like "CONTAINED", but excluding the groups that are
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4334 listed.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4335
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4336
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4337 The {group-name} in the "contains" list can be a pattern. All group names
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4338 that match the pattern will be included (or excluded, if "ALLBUT" is used).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4339 The pattern cannot contain white space or a ','. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4340 ... contains=Comment.*,Keyw[0-3]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4341 The matching will be done at moment the syntax command is executed. Groups
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4342 that are defined later will not be matched. Also, if the current syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4343 command defines a new group, it is not matched. Be careful: When putting
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4344 syntax commands in a file you can't rely on groups NOT being defined, because
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4345 the file may have been sourced before, and ":syn clear" doesn't remove the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4346 group names.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4347
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4348 The contained groups will also match in the start and end patterns of a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4349 region. If this is not wanted, the "matchgroup" argument can be used
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4350 \|:syn-matchgroup\|. The "ms=" and "me=" offsets can be used to change the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4351 region where contained items do match. Note that this may also limit the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4352 area that is highlighted
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4353
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4354
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4355 containedin={group-name}... :syn-containedin
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4356
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4357 The "containedin" argument is followed by a list of syntax group names. The
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4358 item will be allowed to begin inside these groups. This works as if the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4359 containing item has a "contains=" argument that includes this item.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4360
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4361 The {group-name}... can be used just like for "contains", as explained above.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4362
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4363 This is useful when adding a syntax item afterwards. An item can be told to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4364 be included inside an already existing item, without changing the definition
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4365 of that item. For example, to highlight a word in a C comment after loading
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4366 the C syntax: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4367 :syn keyword myword HELP containedin=cComment contained
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4368 Note that "contained" is also used, to avoid that the item matches at the top
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4369 level.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4370
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4371 Matches for "containedin" are added to the other places where the item can
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4372 appear. A "contains" argument may also be added as usual. Don't forget that
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4373 keywords never contain another item, thus adding them to "containedin" won't
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4374 work.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4375
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4376
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4377 nextgroup={group-name},.. :syn-nextgroup
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4378
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4379 The "nextgroup" argument is followed by a list of syntax group names,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4380 separated by commas (just like with "contains", so you can also use patterns).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4381
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4382 If the "nextgroup" argument is given, the mentioned syntax groups will be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4383 tried for a match, after the match or region ends. If none of the groups have
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4384 a match, highlighting continues normally. If there is a match, this group
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4385 will be used, even when it is not mentioned in the "contains" field of the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4386 current group. This is like giving the mentioned group priority over all
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4387 other groups. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4388 :syntax match ccFoobar "Foo.\{-}Bar" contains=ccFoo
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4389 :syntax match ccFoo "Foo" contained nextgroup=ccFiller
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4390 :syntax region ccFiller start="." matchgroup=ccBar end="Bar" contained
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4391
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4392 This will highlight "Foo" and "Bar" differently, and only when there is a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4393 "Bar" after "Foo". In the text line below, "f" shows where ccFoo is used for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4394 highlighting, and "bbb" where ccBar is used. >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4395
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4396 Foo asdfasd Bar asdf Foo asdf Bar asdf
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4397 fff bbb fff bbb
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4398
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4399 Note the use of ".\{-}" to skip as little as possible until the next Bar.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4400 when ".*" would be used, the "asdf" in between "Bar" and "Foo" would be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4401 highlighted according to the "ccFoobar" group, because the ccFooBar match
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4402 would include the first "Foo" and the last "Bar" in the line (see \|pattern\|).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4403
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4404
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4405 skipwhite :syn-skipwhite
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4406 skipnl :syn-skipnl
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4407 skipempty :syn-skipempty
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4408
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4409 These arguments are only used in combination with "nextgroup". They can be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4410 used to allow the next group to match after skipping some text:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4411 skipwhite skip over space and tab characters
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4412 skipnl skip over the end of a line
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4413 skipempty skip over empty lines (implies a "skipnl")
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4414
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4415 When "skipwhite" is present, the white space is only skipped if there is no
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4416 next group that matches the white space.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4417
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4418 When "skipnl" is present, the match with nextgroup may be found in the next
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4419 line. This only happens when the current item ends at the end of the current
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4420 line! When "skipnl" is not present, the nextgroup will only be found after
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4421 the current item in the same line.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4422
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4423 When skipping text while looking for a next group, the matches for other
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4424 groups are ignored. Only when no next group matches, other items are tried
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4425 for a match again. This means that matching a next group and skipping white
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4426 space and <EOL>s has a higher priority than other items.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4427
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4428 Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4429 :syn match ifstart "\<if.*" nextgroup=ifline skipwhite skipempty
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4430 :syn match ifline "[^ \t].*" nextgroup=ifline skipwhite skipempty contained
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4431 :syn match ifline "endif" contained
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4432 Note that the "[^ \t].*" match matches all non-white text. Thus it would also
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4433 match "endif". Therefore the "endif" match is put last, so that it takes
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4434 precedence.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4435 Note that this example doesn't work for nested "if"s. You need to add
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4436 "contains" arguments to make that work (omitted for simplicity of the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4437 example).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4438
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4439 IMPLICIT CONCEAL :syn-conceal-implicit
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4440
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4441 :sy[ntax] conceal [on\|off]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4442 This defines if the following ":syntax" commands will define keywords,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4443 matches or regions with the "conceal" flag set. After ":syn conceal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4444 on", all subsequent ":syn keyword", ":syn match" or ":syn region"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4445 defined will have the "conceal" flag set implicitly. ":syn conceal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4446 off" returns to the normal state where the "conceal" flag must be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4447 given explicitly.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4448
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4449 :sy[ntax] conceal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4450 Show either "syntax conceal on" or "syntax conceal off".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4451
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4452 ==============================================================================
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4453 8. Syntax patterns :syn-pattern E401 E402
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4454
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4455 In the syntax commands, a pattern must be surrounded by two identical
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4456 characters. This is like it works for the ":s" command. The most common to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4457 use is the double quote. But if the pattern contains a double quote, you can
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4458 use another character that is not used in the pattern. Examples: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4459 :syntax region Comment start="/\" end="\/"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4460 :syntax region String start=+"+ end=+"+ skip=+\\"+
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4461
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4462 See \|pattern\| for the explanation of what a pattern is. Syntax patterns are
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4463 always interpreted like the 'magic' option is set, no matter what the actual
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4464 value of 'magic' is. And the patterns are interpreted like the 'l' flag is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4465 not included in 'cpoptions'. This was done to make syntax files portable and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4466 independent of 'compatible' and 'magic' settings.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4467
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4468 Try to avoid patterns that can match an empty string, such as "[a-z]*".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4469 This slows down the highlighting a lot, because it matches everywhere.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4470
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4471 :syn-pattern-offset
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4472 The pattern can be followed by a character offset. This can be used to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4473 change the highlighted part, and to change the text area included in the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4474 match or region (which only matters when trying to match other items). Both
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4475 are relative to the matched pattern. The character offset for a skip
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4476 pattern can be used to tell where to continue looking for an end pattern.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4477
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4478 The offset takes the form of "{what}={offset}"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4479 The {what} can be one of seven strings:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4480
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4481 ms Match Start offset for the start of the matched text
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4482 me Match End offset for the end of the matched text
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4483 hs Highlight Start offset for where the highlighting starts
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4484 he Highlight End offset for where the highlighting ends
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4485 rs Region Start offset for where the body of a region starts
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4486 re Region End offset for where the body of a region ends
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4487 lc Leading Context offset past "leading context" of pattern
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4488
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4489 The {offset} can be:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4490
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4491 s start of the matched pattern
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4492 s+{nr} start of the matched pattern plus {nr} chars to the right
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4493 s-{nr} start of the matched pattern plus {nr} chars to the left
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4494 e end of the matched pattern
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4495 e+{nr} end of the matched pattern plus {nr} chars to the right
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4496 e-{nr} end of the matched pattern plus {nr} chars to the left
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4497 {nr} (for "lc" only): start matching {nr} chars right of the start
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4498
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4499 Examples: "ms=s+1", "hs=e-2", "lc=3".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4500
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4501 Although all offsets are accepted after any pattern, they are not always
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4502 meaningful. This table shows which offsets are actually used:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4503
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4504 ms me hs he rs re lc ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4505 match item yes yes yes yes - - yes
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4506 region item start yes - yes - yes - yes
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4507 region item skip - yes - - - - yes
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4508 region item end - yes - yes - yes yes
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4509
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4510 Offsets can be concatenated, with a ',' in between. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4511 :syn match String /"[^"]*"/hs=s+1,he=e-1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4512 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4513 some "string" text
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4514 ^^^^^^ highlighted
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4515
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4516 Notes:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4517 - There must be no white space between the pattern and the character
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4518 offset(s).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4519 - The highlighted area will never be outside of the matched text.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4520 - A negative offset for an end pattern may not always work, because the end
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4521 pattern may be detected when the highlighting should already have stopped.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4522 - Before Vim 7.2 the offsets were counted in bytes instead of characters.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4523 This didn't work well for multibyte characters, so it was changed with the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4524 Vim 7.2 release.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4525 - The start of a match cannot be in a line other than where the pattern
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4526 matched. This doesn't work: "a\nb"ms=e. You can make the highlighting
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4527 start in another line, this does work: "a\nb"hs=e.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4528
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4529 Example (match a comment but don't highlight the /* and */): >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4530 :syntax region Comment start="/\"hs=e+1 end="\/"he=s-1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4531 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4532 /* this is a comment */
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4533 ^^^^^^^^^^^^^^^^^^^ highlighted
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4534
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4535 A more complicated Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4536 :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
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4537 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4538 abcfoostringbarabc
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4539 mmmmmmmmmmm match
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4540 sssrrreee highlight start/region/end ("Foo", "Exa" and "Bar")
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4541
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4542 Leading context :syn-lc :syn-leading :syn-context
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4543
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4544 Note: This is an obsolete feature, only included for backwards compatibility
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4545 with previous Vim versions. It's now recommended to use the \|/\@<=\| construct
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4546 in the pattern. You can also often use \|/\zs\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4547
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4548 The "lc" offset specifies leading context -- a part of the pattern that must
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4549 be present, but is not considered part of the match. An offset of "lc=n" will
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4550 cause Vim to step back n columns before attempting the pattern match, allowing
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4551 characters which have already been matched in previous patterns to also be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4552 used as leading context for this match. This can be used, for instance, to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4553 specify that an "escaping" character must not precede the match: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4554
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4555 :syn match ZNoBackslash "[^\\]z"ms=s+1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4556 :syn match WNoBackslash "[^\\]w"lc=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4557 :syn match Underline "_\+"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4558 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4559 ___zzzz ___wwww
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4560 ^^^ ^^^ matches Underline
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4561 ^ ^ matches ZNoBackslash
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4562 ^^^^ matches WNoBackslash
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4563
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4564 The "ms" offset is automatically set to the same value as the "lc" offset,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4565 unless you set "ms" explicitly.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4566
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4567
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4568 Multi-line patterns :syn-multi-line
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4569
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4570 The patterns can include "\n" to match an end-of-line. Mostly this works as
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4571 expected, but there are a few exceptions.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4572
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4573 When using a start pattern with an offset, the start of the match is not
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4574 allowed to start in a following line. The highlighting can start in a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4575 following line though. Using the "\zs" item also requires that the start of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4576 the match doesn't move to another line.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4577
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4578 The skip pattern can include the "\n", but the search for an end pattern will
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4579 continue in the first character of the next line, also when that character is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4580 matched by the skip pattern. This is because redrawing may start in any line
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4581 halfway a region and there is no check if the skip pattern started in a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4582 previous line. For example, if the skip pattern is "a\nb" and an end pattern
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4583 is "b", the end pattern does match in the second line of this: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4584 x x a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4585 b x x
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4586 Generally this means that the skip pattern should not match any characters
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4587 after the "\n".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4588
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4589
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4590 External matches :syn-ext-match
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4591
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4592 These extra regular expression items are available in region patterns:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4593
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4594 /\z( /\z(\) E50 E52 E879
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4595 \z(\) Marks the sub-expression as "external", meaning that it can be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4596 accessed from another pattern match. Currently only usable in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4597 defining a syntax region start pattern.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4598
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4599 /\z1 /\z2 /\z3 /\z4 /\z5
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4600 \z1 ... \z9 /\z6 /\z7 /\z8 /\z9 E66 E67
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4601 Matches the same string that was matched by the corresponding
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4602 sub-expression in a previous start pattern match.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4603
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4604 Sometimes the start and end patterns of a region need to share a common
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4605 sub-expression. A common example is the "here" document in Perl and many Unix
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4606 shells. This effect can be achieved with the "\z" special regular expression
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4607 items, which marks a sub-expression as "external", in the sense that it can be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4608 referenced from outside the pattern in which it is defined. The here-document
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4609 example, for instance, can be done like this: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4610 :syn region hereDoc start="<<\z(\I\i*\)" end="^\z1$"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4611
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4612 As can be seen here, the \z actually does double duty. In the start pattern,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4613 it marks the "$\I\i*$" sub-expression as external; in the end pattern, it
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4614 changes the \z1 back-reference into an external reference referring to the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4615 first external sub-expression in the start pattern. External references can
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4616 also be used in skip patterns: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4617 :syn region foo start="start \z(\I\i*\)" skip="not end \z1" end="end \z1"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4618
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4619 Note that normal and external sub-expressions are completely orthogonal and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4620 indexed separately; for instance, if the pattern "\z(..\)$..$" is applied
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4621 to the string "aabb", then \1 will refer to "bb" and \z1 will refer to "aa".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4622 Note also that external sub-expressions cannot be accessed as back-references
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4623 within the same pattern like normal sub-expressions. If you want to use one
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4624 sub-expression as both a normal and an external sub-expression, you can nest
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4625 the two, as in "$\z(...$\)".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4626
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4627 Note that only matches within a single line can be used. Multi-line matches
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4628 cannot be referred to.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4629
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4630 ==============================================================================
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4631 9. Syntax clusters :syn-cluster E400
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4632
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4633 :sy[ntax] cluster {cluster-name} [contains={group-name}..]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4634 [add={group-name}..]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4635 [remove={group-name}..]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4636
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4637 This command allows you to cluster a list of syntax groups together under a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4638 single name.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4639
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4640 contains={group-name}..
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4641 The cluster is set to the specified list of groups.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4642 add={group-name}..
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4643 The specified groups are added to the cluster.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4644 remove={group-name}..
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4645 The specified groups are removed from the cluster.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4646
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4647 A cluster so defined may be referred to in a contains=.., containedin=..,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4648 nextgroup=.., add=.. or remove=.. list with a "@" prefix. You can also use
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4649 this notation to implicitly declare a cluster before specifying its contents.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4650
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4651 Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4652 :syntax match Thing "# [^#]\+ #" contains=@ThingMembers
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4653 :syntax cluster ThingMembers contains=ThingMember1,ThingMember2
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4654
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4655 As the previous example suggests, modifications to a cluster are effectively
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4656 retroactive; the membership of the cluster is checked at the last minute, so
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4657 to speak: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4658 :syntax keyword A aaa
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4659 :syntax keyword B bbb
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4660 :syntax cluster AandB contains=A
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4661 :syntax match Stuff "( aaa bbb )" contains=@AandB
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4662 :syntax cluster AandB add=B " now both keywords are matched in Stuff
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4663
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4664 This also has implications for nested clusters: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4665 :syntax keyword A aaa
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4666 :syntax keyword B bbb
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4667 :syntax cluster SmallGroup contains=B
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4668 :syntax cluster BigGroup contains=A,@SmallGroup
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4669 :syntax match Stuff "( aaa bbb )" contains=@BigGroup
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4670 :syntax cluster BigGroup remove=B " no effect, since B isn't in BigGroup
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4671 :syntax cluster SmallGroup remove=B " now bbb isn't matched within Stuff
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4672 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4673 E848
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4674 The maximum number of clusters is 9767.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4675
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4676 ==============================================================================
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4677 10. Including syntax files :syn-include E397
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4678
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4679 It is often useful for one language's syntax file to include a syntax file for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4680 a related language. Depending on the exact relationship, this can be done in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4681 two different ways:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4682
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4683 - If top-level syntax items in the included syntax file are to be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4684 allowed at the top level in the including syntax, you can simply use
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4685 the \|:runtime\| command: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4686
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4687 " In cpp.vim:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4688 :runtime! syntax/c.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4689 :unlet b:current_syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4690
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4691 < - If top-level syntax items in the included syntax file are to be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4692 contained within a region in the including syntax, you can use the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4693 ":syntax include" command:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4694
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4695 :sy[ntax] include [@{grouplist-name}] {file-name}
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4696
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4697 All syntax items declared in the included file will have the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4698 "contained" flag added. In addition, if a group list is specified,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4699 all top-level syntax items in the included file will be added to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4700 that list. >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4701
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4702 " In perl.vim:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4703 :syntax include @Pod <sfile>:p:h/pod.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4704 :syntax region perlPOD start="^=head" end="^=cut" contains=@Pod
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4705 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4706 When {file-name} is an absolute path (starts with "/", "c:", "$VAR"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4707 or "<sfile>") that file is sourced. When it is a relative path
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4708 (e.g., "syntax/pod.vim") the file is searched for in 'runtimepath'.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4709 All matching files are loaded. Using a relative path is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4710 recommended, because it allows a user to replace the included file
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4711 with their own version, without replacing the file that does the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4712 ":syn include".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4713
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4714 E847
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4715 The maximum number of includes is 999.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4716
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4717 ==============================================================================
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4718 11. Synchronizing :syn-sync E403 E404
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4719
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4720 Vim wants to be able to start redrawing in any position in the document. To
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4721 make this possible it needs to know the syntax state at the position where
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4722 redrawing starts.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4723
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4724 :sy[ntax] sync [ccomment [group-name] \| minlines={N} \| ...]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4725
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4726 There are four ways to synchronize:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4727 1. Always parse from the start of the file.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4728 \|:syn-sync-first\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4729 2. Based on C-style comments. Vim understands how C-comments work and can
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4730 figure out if the current line starts inside or outside a comment.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4731 \|:syn-sync-second\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4732 3. Jumping back a certain number of lines and start parsing there.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4733 \|:syn-sync-third\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4734 4. Searching backwards in the text for a pattern to sync on.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4735 \|:syn-sync-fourth\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4736
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4737 :syn-sync-maxlines :syn-sync-minlines
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4738 For the last three methods, the line range where the parsing can start is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4739 limited by "minlines" and "maxlines".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4740
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4741 If the "minlines={N}" argument is given, the parsing always starts at least
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4742 that many lines backwards. This can be used if the parsing may take a few
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4743 lines before it's correct, or when it's not possible to use syncing.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4744
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4745 If the "maxlines={N}" argument is given, the number of lines that are searched
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4746 for a comment or syncing pattern is restricted to N lines backwards (after
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4747 adding "minlines"). This is useful if you have few things to sync on and a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4748 slow machine. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4749 :syntax sync maxlines=500 ccomment
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4750 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4751 :syn-sync-linebreaks
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4752 When using a pattern that matches multiple lines, a change in one line may
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4753 cause a pattern to no longer match in a previous line. This means has to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4754 start above where the change was made. How many lines can be specified with
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4755 the "linebreaks" argument. For example, when a pattern may include one line
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4756 break use this: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4757 :syntax sync linebreaks=1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4758 The result is that redrawing always starts at least one line before where a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4759 change was made. The default value for "linebreaks" is zero. Usually the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4760 value for "minlines" is bigger than "linebreaks".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4761
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4762
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4763 First syncing method: :syn-sync-first
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4764 >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4765 :syntax sync fromstart
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4766
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4767 The file will be parsed from the start. This makes syntax highlighting
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4768 accurate, but can be slow for long files. Vim caches previously parsed text,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4769 so that it's only slow when parsing the text for the first time. However,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4770 when making changes some part of the text needs to be parsed again (worst
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4771 case: to the end of the file).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4772
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4773 Using "fromstart" is equivalent to using "minlines" with a very large number.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4774
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4775
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4776 Second syncing method: :syn-sync-second :syn-sync-ccomment
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4777
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4778 For the second method, only the "ccomment" argument needs to be given.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4779 Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4780 :syntax sync ccomment
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4781
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4782 When Vim finds that the line where displaying starts is inside a C-style
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4783 comment, the last region syntax item with the group-name "Comment" will be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4784 used. This requires that there is a region with the group-name "Comment"!
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4785 An alternate group name can be specified, for example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4786 :syntax sync ccomment javaComment
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4787 This means that the last item specified with "syn region javaComment" will be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4788 used for the detected C comment region. This only works properly if that
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4789 region does have a start pattern "\/" and an end pattern "\/".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4790
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4791 The "maxlines" argument can be used to restrict the search to a number of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4792 lines. The "minlines" argument can be used to at least start a number of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4793 lines back (e.g., for when there is some construct that only takes a few
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4794 lines, but it hard to sync on).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4795
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4796 Note: Syncing on a C comment doesn't work properly when strings are used
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4797 that cross a line and contain a "*/". Since letting strings cross a line
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4798 is a bad programming habit (many compilers give a warning message), and the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4799 chance of a "*/" appearing inside a comment is very small, this restriction
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4800 is hardly ever noticed.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4801
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4802
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4803 Third syncing method: :syn-sync-third
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4804
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4805 For the third method, only the "minlines={N}" argument needs to be given.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4806 Vim will subtract {N} from the line number and start parsing there. This
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4807 means {N} extra lines need to be parsed, which makes this method a bit slower.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4808 Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4809 :syntax sync minlines=50
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4810
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4811 "lines" is equivalent to "minlines" (used by older versions).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4812
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4813
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4814 Fourth syncing method: :syn-sync-fourth
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4815
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4816 The idea is to synchronize on the end of a few specific regions, called a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4817 sync pattern. Only regions can cross lines, so when we find the end of some
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4818 region, we might be able to know in which syntax item we are. The search
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4819 starts in the line just above the one where redrawing starts. From there
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4820 the search continues backwards in the file.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4821
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4822 This works just like the non-syncing syntax items. You can use contained
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4823 matches, nextgroup, etc. But there are a few differences:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4824 - Keywords cannot be used.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4825 - The syntax items with the "sync" keyword form a completely separated group
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4826 of syntax items. You can't mix syncing groups and non-syncing groups.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4827 - The matching works backwards in the buffer (line by line), instead of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4828 forwards.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4829 - A line continuation pattern can be given. It is used to decide which group
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4830 of lines need to be searched like they were one line. This means that the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4831 search for a match with the specified items starts in the first of the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4832 consecutive lines that contain the continuation pattern.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4833 - When using "nextgroup" or "contains", this only works within one line (or
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4834 group of continued lines).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4835 - When using a region, it must start and end in the same line (or group of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4836 continued lines). Otherwise the end is assumed to be at the end of the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4837 line (or group of continued lines).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4838 - When a match with a sync pattern is found, the rest of the line (or group of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4839 continued lines) is searched for another match. The last match is used.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4840 This is used when a line can contain both the start end the end of a region
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4841 (e.g., in a C-comment like /* this /, the last "/" is used).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4842
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4843 There are two ways how a match with a sync pattern can be used:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4844 1. Parsing for highlighting starts where redrawing starts (and where the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4845 search for the sync pattern started). The syntax group that is expected
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4846 to be valid there must be specified. This works well when the regions
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4847 that cross lines cannot contain other regions.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4848 2. Parsing for highlighting continues just after the match. The syntax group
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4849 that is expected to be present just after the match must be specified.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4850 This can be used when the previous method doesn't work well. It's much
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4851 slower, because more text needs to be parsed.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4852 Both types of sync patterns can be used at the same time.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4853
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4854 Besides the sync patterns, other matches and regions can be specified, to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4855 avoid finding unwanted matches.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4856
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4857 [The reason that the sync patterns are given separately, is that mostly the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4858 search for the sync point can be much simpler than figuring out the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4859 highlighting. The reduced number of patterns means it will go (much)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4860 faster.]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4861
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4862 syn-sync-grouphere E393 E394
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4863 :syntax sync match {sync-group-name} grouphere {group-name} "pattern" ..
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4864
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4865 Define a match that is used for syncing. {group-name} is the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4866 name of a syntax group that follows just after the match. Parsing
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4867 of the text for highlighting starts just after the match. A region
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4868 must exist for this {group-name}. The first one defined will be used.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4869 "NONE" can be used for when there is no syntax group after the match.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4870
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4871 syn-sync-groupthere
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4872 :syntax sync match {sync-group-name} groupthere {group-name} "pattern" ..
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4873
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4874 Like "grouphere", but {group-name} is the name of a syntax group that
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4875 is to be used at the start of the line where searching for the sync
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4876 point started. The text between the match and the start of the sync
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4877 pattern searching is assumed not to change the syntax highlighting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4878 For example, in C you could search backwards for "/" and "/". If
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4879 "/*" is found first, you know that you are inside a comment, so the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4880 "groupthere" is "cComment". If "*/" is found first, you know that you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4881 are not in a comment, so the "groupthere" is "NONE". (in practice
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4882 it's a bit more complicated, because the "/" and "/" could appear
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4883 inside a string. That's left as an exercise to the reader...).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4884
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4885 :syntax sync match ..
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4886 :syntax sync region ..
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4887
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4888 Without a "groupthere" argument. Define a region or match that is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4889 skipped while searching for a sync point.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4890
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4891 syn-sync-linecont
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4892 :syntax sync linecont {pattern}
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4893
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4894 When {pattern} matches in a line, it is considered to continue in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4895 the next line. This means that the search for a sync point will
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4896 consider the lines to be concatenated.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4897
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4898 If the "maxlines={N}" argument is given too, the number of lines that are
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4899 searched for a match is restricted to N. This is useful if you have very
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4900 few things to sync on and a slow machine. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4901 :syntax sync maxlines=100
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4902
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4903 You can clear all sync settings with: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4904 :syntax sync clear
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4905
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4906 You can clear specific sync patterns with: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4907 :syntax sync clear {sync-group-name} ..
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4908
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4909 ==============================================================================
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4910 12. Listing syntax items :syntax :sy :syn :syn-list
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4911
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4912 This command lists all the syntax items: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4913
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4914 :sy[ntax] [list]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4915
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4916 To show the syntax items for one syntax group: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4917
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4918 :sy[ntax] list {group-name}
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4919
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4920 To list the syntax groups in one cluster: E392 >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4921
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4922 :sy[ntax] list @{cluster-name}
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4923
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4924 See above for other arguments for the ":syntax" command.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4925
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4926 Note that the ":syntax" command can be abbreviated to ":sy", although ":syn"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4927 is mostly used, because it looks better.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4928
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4929 ==============================================================================
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4930 13. Colorschemes color-schemes
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4931
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4932 In the next section you can find information about individual highlight groups
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4933 and how to specify colors for them. Most likely you want to just select a set
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4934 of colors by using the `:colorscheme` command, for example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4935
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4936 colorscheme pablo
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4937 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4938 :colo :colorscheme E185
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4939 :colo[rscheme] Output the name of the currently active color scheme.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4940 This is basically the same as >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4941 :echo g:colors_name
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4942 < In case g:colors_name has not been defined :colo will
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4943 output "default". When compiled without the \|+eval\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4944 feature it will output "unknown".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4945
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4946 :colo[rscheme] {name} Load color scheme {name}. This searches 'runtimepath'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4947 for the file "colors/{name}.vim". The first one that
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4948 is found is loaded.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4949 Also searches all plugins in 'packpath', first below
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4950 "start" and then under "opt".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4951
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4952 Doesn't work recursively, thus you can't use
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4953 ":colorscheme" in a color scheme script.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4954
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4955 You have two options for customizing a color scheme. For changing the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4956 appearance of specific colors, you can redefine a color name before loading
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4957 the scheme. The desert scheme uses the khaki color for the cursor. To use a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4958 darker variation of the same color: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4959
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4960 let v:colornames['khaki'] = '#bdb76b'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4961 colorscheme desert
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4962 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4963 For further customization, such as changing \|:highlight-link\| associations,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4964 use another name, e.g. "~/.vim/colors/mine.vim", and use `:runtime` to load
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4965 the original color scheme: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4966 runtime colors/evening.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4967 hi Statement ctermfg=Blue guifg=Blue
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4968
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4969 Before the color scheme will be loaded all default color list scripts
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4970 (`colors/lists/default.vim`) will be executed and then the \|ColorSchemePre\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4971 autocommand event is triggered. After the color scheme has been loaded the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4972 \|ColorScheme\| autocommand event is triggered.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4973
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4974 colorscheme-override
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4975 If a color scheme is almost right, you can add modifications on top of it by
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4976 using the \|ColorScheme\| autocommand. For example, to remove the background
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4977 color (can make it transparent in some terminals): >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4978 augroup my_colorschemes
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4979 au!
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4980 au Colorscheme pablo hi Normal ctermbg=NONE
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4981 augroup END
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4982
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4983 Change a couple more colors: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4984 augroup my_colorschemes
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4985 au!
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4986 au Colorscheme pablo hi Normal ctermbg=NONE
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4987 \ \| highlight Special ctermfg=63
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4988 \ \| highlight Identifier ctermfg=44
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4989 augroup END
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4990
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4991 If you make a lot of changes it might be better to copy the distributed
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4992 colorscheme to your home directory and change it: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4993 :!cp $VIMRUNTIME/colors/pablo.vim ~/.vim/colors
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4994 :edit ~/.vim/colors/pablo.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4995
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4996 With Vim 9.0 the collection of color schemes was updated and made work in many
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4997 different terminals. One change was to often define the Normal highlight
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4998 group to make sure the colors work well. In case you prefer the old version,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	4999 you can find them here:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5000 https://github.com/vim/colorschemes/blob/master/legacy_colors/
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5001
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5002 For info about writing a color scheme file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5003 :edit $VIMRUNTIME/colors/README.txt
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5004
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5005
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5006 ==============================================================================
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5007 14. Highlight command :highlight :hi E28 E411 E415
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5008
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5009 There are three types of highlight groups:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5010 - The ones used for specific languages. For these the name starts with the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5011 name of the language. Many of these don't have any attributes, but are
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5012 linked to a group of the second type.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5013 - The ones used for all syntax languages.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5014 - The ones used for the 'highlight' option.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5015 hitest.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5016 You can see all the groups currently active with this command: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5017 :so $VIMRUNTIME/syntax/hitest.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5018 This will open a new window containing all highlight group names, displayed
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5019 in their own color.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5020
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5021 :hi[ghlight] List all the current highlight groups that have
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5022 attributes set.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5023
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5024 :hi[ghlight] {group-name}
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5025 List one highlight group.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5026
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5027 highlight-clear :hi-clear
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5028 :hi[ghlight] clear Reset all highlighting to the defaults. Removes all
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5029 highlighting for groups added by the user.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5030 Uses the current value of 'background' to decide which
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5031 default colors to use.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5032 If there was a default link, restore it. \|:hi-link\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5033
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5034 :hi[ghlight] clear {group-name}
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5035 :hi[ghlight] {group-name} NONE
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5036 Disable the highlighting for one highlight group. It
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5037 is _not_ set back to the default colors.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5038
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5039 :hi[ghlight] [default] {group-name} {key}={arg} ..
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5040 Add a highlight group, or change the highlighting for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5041 an existing group. If a given color name is not
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5042 recognized, each `colors/lists/default.vim` found on
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5043 \|'runtimepath'\| will be loaded.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5044 See \|highlight-args\| for the {key}={arg} arguments.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5045 See \|:highlight-default\| for the optional [default]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5046 argument.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5047
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5048 Normally a highlight group is added once when starting up. This sets the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5049 default values for the highlighting. After that, you can use additional
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5050 highlight commands to change the arguments that you want to set to non-default
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5051 values. The value "NONE" can be used to switch the value off or go back to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5052 the default value.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5053
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5054 A simple way to change colors is with the \|:colorscheme\| command. This loads
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5055 a file with ":highlight" commands such as this: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5056
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5057 :hi Comment gui=bold
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5058
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5059 Note that all settings that are not included remain the same, only the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5060 specified field is used, and settings are merged with previous ones. So, the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5061 result is like this single command has been used: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5062 :hi Comment term=bold ctermfg=Cyan guifg=#80a0ff gui=bold
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5063 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5064 :highlight-verbose
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5065 When listing a highlight group and 'verbose' is non-zero, the listing will
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5066 also tell where it was last set. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5067 :verbose hi Comment
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5068 < Comment xxx term=bold ctermfg=4 guifg=Blue ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5069 Last set from /home/mool/vim/vim7/runtime/syntax/syncolor.vim ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5070
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5071 When ":hi clear" is used then the script where this command is used will be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5072 mentioned for the default values. See \|:verbose-cmd\| for more information.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5073
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5074 highlight-args E416 E417 E423
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5075 There are three types of terminals for highlighting:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5076 term a normal terminal (vt100, xterm)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5077 cterm a color terminal (MS-Windows console, color-xterm, these have the "Co"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5078 termcap entry)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5079 gui the GUI
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5080
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5081 For each type the highlighting can be given. This makes it possible to use
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5082 the same syntax file on all terminals, and use the optimal highlighting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5083
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5084 1. highlight arguments for normal terminals
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5085
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5086 bold underline undercurl
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5087 underdouble underdotted
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5088 underdashed inverse italic
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5089 standout nocombine strikethrough
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5090 term={attr-list} attr-list highlight-term E418
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5091 attr-list is a comma-separated list (without spaces) of the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5092 following items (in any order):
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5093 bold
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5094 underline
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5095 undercurl not always available
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5096 underdouble not always available
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5097 underdotted not always available
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5098 underdashed not always available
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5099 strikethrough not always available
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5100 reverse
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5101 inverse same as reverse
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5102 italic
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5103 standout
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5104 nocombine override attributes instead of combining them
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5105 NONE no attributes used (used to reset it)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5106
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5107 Note that "bold" can be used here and by using a bold font. They
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5108 have the same effect.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5109 underline-codes
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5110 "undercurl" is a curly underline. When "undercurl" is not possible
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5111 then "underline" is used. In general "undercurl" and "strikethrough"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5112 are only available in the GUI and some terminals. The color is set
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5113 with \|highlight-guisp\| or \|highlight-ctermul\|. You can try these
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5114 termcap entries to make undercurl work in a terminal: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5115 let &t_Cs = "\e[4:3m"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5116 let &t_Ce = "\e[4:0m"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5117
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5118 < "underdouble" is a double underline, "underdotted" is a dotted
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5119 underline and "underdashed" is a dashed underline. These are only
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5120 supported by some terminals. If your terminal supports them you may
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5121 have to specify the codes like this: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5122 let &t_Us = "\e[4:2m"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5123 let &t_ds = "\e[4:4m"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5124 let &t_Ds = "\e[4:5m"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5125 < They are reset with \|t_Ce\|, the same as curly underline (undercurl).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5126 When t_Us, t_ds or t_Ds is not set then underline will be used as a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5127 fallback.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5128
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5129
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5130 start={term-list} highlight-start E422
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5131 stop={term-list} term-list highlight-stop
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5132 These lists of terminal codes can be used to get
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5133 non-standard attributes on a terminal.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5134
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5135 The escape sequence specified with the "start" argument
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5136 is written before the characters in the highlighted
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5137 area. It can be anything that you want to send to the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5138 terminal to highlight this area. The escape sequence
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5139 specified with the "stop" argument is written after the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5140 highlighted area. This should undo the "start" argument.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5141 Otherwise the screen will look messed up.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5142
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5143 The {term-list} can have two forms:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5144
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5145 1. A string with escape sequences.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5146 This is any string of characters, except that it can't start with
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5147 "t_" and blanks are not allowed. The <> notation is recognized
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5148 here, so you can use things like "<Esc>" and "<Space>". Example:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5149 start=<Esc>[27h;<Esc>[<Space>r;
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5150
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5151 2. A list of terminal codes.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5152 Each terminal code has the form "t_xx", where "xx" is the name of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5153 the termcap entry. The codes have to be separated with commas.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5154 White space is not allowed. Example:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5155 start=t_C1,t_BL
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5156 The terminal codes must exist for this to work.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5157
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5158
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5159 2. highlight arguments for color terminals
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5160
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5161 cterm={attr-list} highlight-cterm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5162 See above for the description of {attr-list} \|attr-list\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5163 The "cterm" argument is likely to be different from "term", when
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5164 colors are used. For example, in a normal terminal comments could
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5165 be underlined, in a color terminal they can be made Blue.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5166 Note: Some terminals (e.g., DOS console) can't mix these attributes
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5167 with coloring. To be portable, use only one of "cterm=" OR "ctermfg="
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5168 OR "ctermbg=".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5169
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5170 ctermfg={color-nr} highlight-ctermfg E421
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5171 ctermbg={color-nr} highlight-ctermbg
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5172 ctermul={color-nr} highlight-ctermul
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5173 These give the foreground (ctermfg), background (ctermbg) and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5174 underline (ctermul) color to use in the terminal.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5175
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5176 The {color-nr} argument is a color number. Its range is zero to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5177 (not including) the number given by the termcap entry "Co".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5178 The actual color with this number depends on the type of terminal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5179 and its settings. Sometimes the color also depends on the settings of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5180 "cterm". For example, on some systems "cterm=bold ctermfg=3" gives
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5181 another color, on others you just get color 3.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5182
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5183 For an xterm this depends on your resources, and is a bit
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5184 unpredictable. See your xterm documentation for the defaults. The
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5185 colors for a color-xterm can be changed from the .Xdefaults file.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5186 Unfortunately this means that it's not possible to get the same colors
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5187 for each user. See \|xterm-color\| for info about color xterms.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5188 tmux
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5189 When using tmux you may want to use this in the tmux config: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5190 # tmux colors
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5191 set -s default-terminal "tmux-256color"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5192 set -as terminal-overrides ",*-256color:Tc"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5193 < More info at:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5194 https://github.com/tmux/tmux/wiki/FAQ#how-do-i-use-a-256-colour-terminal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5195 https://github.com/tmux/tmux/wiki/FAQ#how-do-i-use-rgb-colour
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5196
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5197 The MS-Windows standard colors are fixed (in a console window), so
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5198 these have been used for the names. But the meaning of color names in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5199 X11 are fixed, so these color settings have been used, to make the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5200 highlighting settings portable (complicated, isn't it?). The
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5201 following names are recognized, with the color number used:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5202
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5203 cterm-colors
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5204 NR-16 NR-8 COLOR NAME ~
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5205 0 0 Black
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5206 1 4 DarkBlue
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5207 2 2 DarkGreen
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5208 3 6 DarkCyan
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5209 4 1 DarkRed
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5210 5 5 DarkMagenta
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5211 6 3 Brown, DarkYellow
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5212 7 7 LightGray, LightGrey, Gray, Grey
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5213 8 0* DarkGray, DarkGrey
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5214 9 4* Blue, LightBlue
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5215 10 2* Green, LightGreen
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5216 11 6* Cyan, LightCyan
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5217 12 1* Red, LightRed
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5218 13 5* Magenta, LightMagenta
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5219 14 3* Yellow, LightYellow
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5220 15 7* White
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5221
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5222 The number under "NR-16" is used for 16-color terminals ('t_Co'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5223 greater than or equal to 16). The number under "NR-8" is used for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5224 8-color terminals ('t_Co' less than 16). The '*' indicates that the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5225 bold attribute is set for ctermfg. In many 8-color terminals (e.g.,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5226 "linux"), this causes the bright colors to appear. This doesn't work
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5227 for background colors! Without the '*' the bold attribute is removed.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5228 If you want to set the bold attribute in a different way, put a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5229 "cterm=" argument AFTER the "ctermfg=" or "ctermbg=" argument. Or use
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5230 a number instead of a color name.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5231
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5232 The case of the color names is ignored.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5233 Note that for 16 color ansi style terminals (including xterms), the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5234 numbers in the NR-8 column is used. Here '*' means 'add 8' so that
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5235 Blue is 12, DarkGray is 8 etc.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5236
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5237 Note that for some color terminals these names may result in the wrong
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5238 colors!
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5239
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5240 You can also use "NONE" to remove the color.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5241
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5242 :hi-normal-cterm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5243 When setting the "ctermfg" or "ctermbg" colors for the Normal group,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5244 these will become the colors used for the non-highlighted text.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5245 Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5246 :highlight Normal ctermfg=grey ctermbg=darkblue
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5247 < When setting the "ctermbg" color for the Normal group, the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5248 'background' option will be adjusted automatically, under the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5249 condition that the color is recognized and 'background' was not set
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5250 explicitly. This causes the highlight groups that depend on
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5251 'background' to change! This means you should set the colors for
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5252 Normal first, before setting other colors.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5253 When a color scheme is being used, changing 'background' causes it to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5254 be reloaded, which may reset all colors (including Normal). First
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5255 delete the "g:colors_name" variable when you don't want this.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5256
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5257 When you have set "ctermfg" or "ctermbg" for the Normal group, Vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5258 needs to reset the color when exiting. This is done with the "op"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5259 termcap entry \|t_op\|. If this doesn't work correctly, try setting the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5260 't_op' option in your .vimrc.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5261 E419 E420 E453
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5262 When Vim knows the normal foreground, background and underline colors,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5263 "fg", "bg" and "ul" can be used as color names. This only works after
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5264 setting the colors for the Normal group and for the MS-Windows
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5265 console. Example, for reverse video: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5266 :highlight Visual ctermfg=bg ctermbg=fg
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5267 < Note that the colors are used that are valid at the moment this
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5268 command is given. If the Normal group colors are changed later, the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5269 "fg" and "bg" colors will not be adjusted.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5270
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5271
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5272 3. highlight arguments for the GUI
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5273
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5274 gui={attr-list} highlight-gui
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5275 These give the attributes to use in the GUI mode.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5276 See \|attr-list\| for a description.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5277 Note that "bold" can be used here and by using a bold font. They
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5278 have the same effect.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5279 Note that the attributes are ignored for the "Normal" group.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5280
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5281 font={font-name} highlight-font
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5282 font-name is the name of a font, as it is used on the system Vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5283 runs on. For X11 this is a complicated name, for example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5284 font=-misc-fixed-bold-r-normal--14-130-75-75-c-70-iso8859-1
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5285 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5286 The font-name "NONE" can be used to revert to the default font.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5287 When setting the font for the "Normal" group, this becomes the default
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5288 font (until the 'guifont' option is changed; the last one set is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5289 used).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5290 The following only works with Motif, not with other GUIs:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5291 When setting the font for the "Menu" group, the menus will be changed.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5292 When setting the font for the "Tooltip" group, the tooltips will be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5293 changed.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5294 All fonts used, except for Menu and Tooltip, should be of the same
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5295 character size as the default font! Otherwise redrawing problems will
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5296 occur.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5297 To use a font name with an embedded space or other special character,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5298 put it in single quotes. The single quote cannot be used then.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5299 Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5300 :hi comment font='Monospace 10'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5301
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5302 guifg={color-name} highlight-guifg
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5303 guibg={color-name} highlight-guibg
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5304 guisp={color-name} highlight-guisp
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5305 These give the foreground (guifg), background (guibg) and special
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5306 (guisp) color to use in the GUI. "guisp" is used for undercurl and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5307 strikethrough.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5308 There are a few special names:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5309 NONE no color (transparent) E1361
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5310 bg use normal background color
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5311 background use normal background color
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5312 fg use normal foreground color
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5313 foreground use normal foreground color
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5314 To use a color name with an embedded space or other special character,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5315 put it in single quotes. The single quote cannot be used then.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5316 Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5317 :hi comment guifg='salmon pink'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5318 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5319 gui-colors
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5320 Suggested color names (these are available on most systems):
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5321 Red LightRed DarkRed
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5322 Green LightGreen DarkGreen SeaGreen
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5323 Blue LightBlue DarkBlue SlateBlue
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5324 Cyan LightCyan DarkCyan
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5325 Magenta LightMagenta DarkMagenta
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5326 Yellow LightYellow Brown DarkYellow
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5327 Gray LightGray DarkGray
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5328 Black White
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5329 Orange Purple Violet
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5330
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5331 In the Win32 GUI version, additional system colors are available. See
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5332 \|win32-colors\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5333
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5334 You can also specify a color by its Red, Green and Blue values.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5335 The format is "#rrggbb", where
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5336 "rr" is the Red value
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5337 "gg" is the Green value
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5338 "bb" is the Blue value
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5339 All values are hexadecimal, range from "00" to "ff". Examples: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5340 :highlight Comment guifg=#11f0c3 guibg=#ff00ff
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5341 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5342 If you are authoring a color scheme and use the same hexadecimal value
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5343 repeatedly, you can define a name for it in \|v:colornames\|. For
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5344 example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5345
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5346 # provide a default value for this color but allow the user to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5347 # override it.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5348 :call extend(v:colornames, {'alt_turquoise': '#11f0c3'}, 'keep')
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5349 :highlight Comment guifg=alt_turquoise guibg=magenta
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5350 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5351 If you are using a color scheme that relies on named colors and you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5352 would like to adjust the precise appearance of those colors, you can
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5353 do so by overriding the values in \|v:colornames\| prior to loading the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5354 scheme: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5355
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5356 let v:colornames['alt_turquoise'] = '#22f0d3'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5357 colorscheme alt
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5358 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5359 If you want to develop a color list that can be relied on by others,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5360 it is best to prefix your color names. By convention these color lists
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5361 are placed in the colors/lists directory. You can see an example in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5362 '$VIMRUNTIME/colors/lists/csscolors.vim'. This list would be sourced
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5363 by a color scheme using: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5364
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5365 :runtime colors/lists/csscolors.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5366 :highlight Comment guifg=css_turquoise
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5367 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5368
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5369 highlight-groups highlight-default
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5370 These are the default highlighting groups. These groups are used by the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5371 'highlight' option default. Note that the highlighting depends on the value
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5372 of 'background'. You can see the current settings with the ":highlight"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5373 command.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5374 When possible the name is highlighted in the used colors. If this makes it
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5375 unreadable use Visual selection.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5376
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5377 hl-ColorColumn
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5378 ColorColumn Used for the columns set with 'colorcolumn'.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5379 hl-Conceal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5380 Conceal Placeholder characters substituted for concealed
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5381 text (see 'conceallevel').
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5382 hl-Cursor hl-lCursor
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5383 Cursor Character under the cursor.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5384 lCursor Character under the cursor when \|language-mapping\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5385 is used (see 'guicursor').
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5386 hl-CursorIM
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5387 CursorIM Like Cursor, but used when in IME mode. \|CursorIM\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5388 hl-CursorColumn
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5389 CursorColumn Screen column that the cursor is in when 'cursorcolumn' is set.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5390 hl-CursorLine
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5391 CursorLine Screen line that the cursor is in when 'cursorline' is set.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5392 hl-Directory
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5393 Directory Directory names (and other special names in listings).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5394 hl-DiffAdd
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5395 DiffAdd Diff mode: Added line. \|diff.txt\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5396 hl-DiffChange
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5397 DiffChange Diff mode: Changed line. \|diff.txt\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5398 hl-DiffDelete
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5399 DiffDelete Diff mode: Deleted line. \|diff.txt\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5400 hl-DiffText
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5401 DiffText Diff mode: Changed text within a changed line. \|diff.txt\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5402 hl-EndOfBuffer
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5403 EndOfBuffer Filler lines (~) after the last line in the buffer.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5404 By default, this is highlighted like \|hl-NonText\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5405 hl-ErrorMsg
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5406 ErrorMsg Error messages on the command line.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5407 hl-VertSplit
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5408 VertSplit Column separating vertically split windows.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5409 hl-Folded
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5410 Folded Line used for closed folds.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5411 hl-FoldColumn
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5412 FoldColumn 'foldcolumn'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5413 hl-SignColumn
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5414 SignColumn Column where \|signs\| are displayed.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5415 hl-IncSearch
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5416 IncSearch 'incsearch' highlighting; also used for the text replaced with
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5417 ":s///c".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5418 hl-LineNr
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5419 LineNr Line number for ":number" and ":#" commands, and when 'number'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5420 or 'relativenumber' option is set.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5421 hl-LineNrAbove
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5422 LineNrAbove Line number for when the 'relativenumber'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5423 option is set, above the cursor line.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5424 hl-LineNrBelow
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5425 LineNrBelow Line number for when the 'relativenumber'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5426 option is set, below the cursor line.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5427 hl-CursorLineNr
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5428 CursorLineNr Like LineNr when 'cursorline' is set and 'cursorlineopt'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5429 contains "number" or is "both", for the cursor line.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5430 hl-CursorLineFold
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5431 CursorLineFold Like FoldColumn when 'cursorline' is set for the cursor line.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5432 hl-CursorLineSign
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5433 CursorLineSign Like SignColumn when 'cursorline' is set for the cursor line.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5434 hl-MatchParen
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5435 MatchParen Character under the cursor or just before it, if it
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5436 is a paired bracket, and its match. \|pi_paren.txt\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5437 hl-MessageWindow
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5438 MessageWindow Messages popup window used by `:echowindow`. If not defined
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5439 \|hl-WarningMsg\| is used.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5440 hl-ModeMsg
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5441 ModeMsg 'showmode' message (e.g., "-- INSERT --").
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5442 hl-MoreMsg
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5443 MoreMsg \|more-prompt\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5444 hl-NonText
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5445 NonText '@' at the end of the window, "<<<" at the start of the window
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5446 for 'smoothscroll', characters from 'showbreak' and other
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5447 characters that do not really exist in the text, such as the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5448 ">" displayed when a double-wide character doesn't fit at the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5449 end of the line.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5450 hl-Normal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5451 Normal Normal text.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5452 hl-Pmenu
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5453 Pmenu Popup menu: Normal item.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5454 hl-PmenuSel
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5455 PmenuSel Popup menu: Selected item.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5456 hl-PmenuKind
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5457 PmenuKind Popup menu: Normal item "kind".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5458 hl-PmenuKindSel
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5459 PmenuKindSel Popup menu: Selected item "kind".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5460 hl-PmenuExtra
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5461 PmenuExtra Popup menu: Normal item "extra text".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5462 hl-PmenuExtraSel
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5463 PmenuExtraSel Popup menu: Selected item "extra text".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5464 hl-PmenuSbar
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5465 PmenuSbar Popup menu: Scrollbar.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5466 hl-PmenuThumb
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5467 PmenuThumb Popup menu: Thumb of the scrollbar.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5468 hl-PopupNotification
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5469 PopupNotification
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5470 Popup window created with \|popup_notification()\|. If not
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5471 defined \|hl-WarningMsg\| is used.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5472 hl-Question
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5473 Question \|hit-enter\| prompt and yes/no questions.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5474 hl-QuickFixLine
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5475 QuickFixLine Current \|quickfix\| item in the quickfix window.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5476 hl-Search
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5477 Search Last search pattern highlighting (see 'hlsearch').
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5478 Also used for similar items that need to stand out.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5479 hl-CurSearch
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5480 CurSearch Current match for the last search pattern (see 'hlsearch').
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5481 Note: This is correct after a search, but may get outdated if
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5482 changes are made or the screen is redrawn.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5483 hl-SpecialKey
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5484 SpecialKey Meta and special keys listed with ":map", also for text used
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5485 to show unprintable characters in the text, 'listchars'.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5486 Generally: Text that is displayed differently from what it
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5487 really is.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5488 hl-SpellBad
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5489 SpellBad Word that is not recognized by the spellchecker. \|spell\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5490 This will be combined with the highlighting used otherwise.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5491 hl-SpellCap
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5492 SpellCap Word that should start with a capital. \|spell\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5493 This will be combined with the highlighting used otherwise.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5494 hl-SpellLocal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5495 SpellLocal Word that is recognized by the spellchecker as one that is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5496 used in another region. \|spell\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5497 This will be combined with the highlighting used otherwise.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5498 hl-SpellRare
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5499 SpellRare Word that is recognized by the spellchecker as one that is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5500 hardly ever used. \|spell\|
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5501 This will be combined with the highlighting used otherwise.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5502 hl-StatusLine
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5503 StatusLine Status line of current window.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5504 hl-StatusLineNC
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5505 StatusLineNC status lines of not-current windows
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5506 Note: If this is equal to "StatusLine", Vim will use "^^^" in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5507 the status line of the current window.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5508 hl-StatusLineTerm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5509 StatusLineTerm Status line of current window, if it is a \|terminal\| window.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5510 hl-StatusLineTermNC
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5511 StatusLineTermNC Status lines of not-current windows that is a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5512 \|terminal\| window.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5513 hl-TabLine
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5514 TabLine Tab pages line, not active tab page label.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5515 hl-TabLineFill
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5516 TabLineFill Tab pages line, where there are no labels.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5517 hl-TabLineSel
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5518 TabLineSel Tab pages line, active tab page label.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5519 hl-Terminal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5520 Terminal \|terminal\| window (see \|terminal-size-color\|).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5521 hl-Title
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5522 Title Titles for output from ":set all", ":autocmd" etc.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5523 hl-Visual
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5524 Visual Visual mode selection.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5525 hl-VisualNOS
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5526 VisualNOS Visual mode selection when vim is "Not Owning the Selection".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5527 Only X11 Gui's \|gui-x11\| and \|xterm-clipboard\| supports this.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5528 hl-WarningMsg
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5529 WarningMsg Warning messages.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5530 hl-WildMenu
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5531 WildMenu Current match in 'wildmenu' completion.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5532
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5533 hl-User1 hl-User1..9 hl-User9
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5534 The 'statusline' syntax allows the use of 9 different highlights in the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5535 statusline and ruler (via 'rulerformat'). The names are User1 to User9.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5536
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5537 For the GUI you can use the following groups to set the colors for the menu,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5538 scrollbars and tooltips. They don't have defaults. This doesn't work for the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5539 Win32 GUI. Only three highlight arguments have any effect here: font, guibg,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5540 and guifg.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5541
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5542 hl-Menu
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5543 Menu Current font, background and foreground colors of the menus.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5544 Also used for the toolbar.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5545 Applicable highlight arguments: font, guibg, guifg.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5546
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5547 NOTE: For Motif the font argument actually
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5548 specifies a fontset at all times, no matter if 'guifontset' is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5549 empty, and as such it is tied to the current \|:language\| when
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5550 set.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5551
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5552 hl-Scrollbar
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5553 Scrollbar Current background and foreground of the main window's
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5554 scrollbars.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5555 Applicable highlight arguments: guibg, guifg.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5556
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5557 hl-Tooltip
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5558 Tooltip Current font, background and foreground of the tooltips.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5559 Applicable highlight arguments: font, guibg, guifg.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5560
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5561 NOTE: For Motif the font argument actually
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5562 specifies a fontset at all times, no matter if 'guifontset' is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5563 empty, and as such it is tied to the current \|:language\| when
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5564 set.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5565
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5566 ==============================================================================
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5567 15. Linking groups :hi-link :highlight-link E412 E413
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5568
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5569 When you want to use the same highlighting for several syntax groups, you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5570 can do this more easily by linking the groups into one common highlight
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5571 group, and give the color attributes only for that group.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5572
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5573 To set a link:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5574
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5575 :hi[ghlight][!] [default] link {from-group} {to-group}
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5576
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5577 To remove a link:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5578
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5579 :hi[ghlight][!] [default] link {from-group} NONE
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5580
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5581 Notes: E414
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5582 - If the {from-group} and/or {to-group} doesn't exist, it is created. You
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5583 don't get an error message for a non-existing group.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5584 - As soon as you use a ":highlight" command for a linked group, the link is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5585 removed.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5586 - If there are already highlight settings for the {from-group}, the link is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5587 not made, unless the '!' is given. For a ":highlight link" command in a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5588 sourced file, you don't get an error message. This can be used to skip
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5589 links for groups that already have settings.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5590
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5591 :hi-default :highlight-default
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5592 The [default] argument is used for setting the default highlighting for a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5593 group. If highlighting has already been specified for the group the command
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5594 will be ignored. Also when there is an existing link.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5595
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5596 Using [default] is especially useful to overrule the highlighting of a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5597 specific syntax file. For example, the C syntax file contains: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5598 :highlight default link cComment Comment
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5599 If you like Question highlighting for C comments, put this in your vimrc file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5600 :highlight link cComment Question
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5601 Without the "default" in the C syntax file, the highlighting would be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5602 overruled when the syntax file is loaded.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5603
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5604 To have a link survive `:highlight clear`, which is useful if you have
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5605 highlighting for a specific filetype and you want to keep it when selecting
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5606 another color scheme, put a command like this in the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5607 "after/syntax/{filetype}.vim" file: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5608 highlight! default link cComment Question
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5609
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5610 ==============================================================================
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5611 16. Cleaning up :syn-clear E391
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5612
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5613 If you want to clear the syntax stuff for the current buffer, you can use this
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5614 command: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5615 :syntax clear
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5616
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5617 This command should be used when you want to switch off syntax highlighting,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5618 or when you want to switch to using another syntax. It's normally not needed
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5619 in a syntax file itself, because syntax is cleared by the autocommands that
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5620 load the syntax file.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5621 The command also deletes the "b:current_syntax" variable, since no syntax is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5622 loaded after this command.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5623
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5624 To clean up specific syntax groups for the current buffer: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5625 :syntax clear {group-name} ..
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5626 This removes all patterns and keywords for {group-name}.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5627
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5628 To clean up specific syntax group lists for the current buffer: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5629 :syntax clear @{grouplist-name} ..
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5630 This sets {grouplist-name}'s contents to an empty list.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5631
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5632 :syntax-off :syn-off
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5633 If you want to disable syntax highlighting for all buffers, you need to remove
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5634 the autocommands that load the syntax files: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5635 :syntax off
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5636
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5637 What this command actually does, is executing the command >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5638 :source $VIMRUNTIME/syntax/nosyntax.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5639 See the "nosyntax.vim" file for details. Note that for this to work
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5640 $VIMRUNTIME must be valid. See \|$VIMRUNTIME\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5641
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5642 :syntax-reset :syn-reset
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5643 If you have changed the colors and messed them up, use this command to get the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5644 defaults back: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5645
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5646 :syntax reset
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5647
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5648 It is a bit of a wrong name, since it does not reset any syntax items, it only
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5649 affects the highlighting.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5650
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5651 This doesn't change the colors for the 'highlight' option.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5652
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5653 Note that the syntax colors that you set in your vimrc file will also be reset
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5654 back to their Vim default.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5655 Note that if you are using a color scheme, the colors defined by the color
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5656 scheme for syntax highlighting will be lost.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5657
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5658 What this actually does is: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5659
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5660 let g:syntax_cmd = "reset"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5661 runtime! syntax/syncolor.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5662
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5663 Note that this uses the 'runtimepath' option.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5664
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5665 syncolor
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5666 If you want to use different colors for syntax highlighting, you can add a Vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5667 script file to set these colors. Put this file in a directory in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5668 'runtimepath' which comes after $VIMRUNTIME, so that your settings overrule
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5669 the default colors. This way these colors will be used after the ":syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5670 reset" command.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5671
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5672 For Unix you can use the file ~/.vim/after/syntax/syncolor.vim. Example: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5673
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5674 if &background == "light"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5675 highlight comment ctermfg=darkgreen guifg=darkgreen
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5676 else
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5677 highlight comment ctermfg=green guifg=green
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5678 endif
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5679 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5680 E679
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5681 Do make sure this syncolor.vim script does not use a "syntax on", set the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5682 'background' option or uses a "colorscheme" command, because it results in an
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5683 endless loop.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5684
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5685 Note that when a color scheme is used, there might be some confusion whether
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5686 your defined colors are to be used or the colors from the scheme. This
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5687 depends on the color scheme file. See \|:colorscheme\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5688
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5689 syntax_cmd
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5690 The "syntax_cmd" variable is set to one of these values when the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5691 syntax/syncolor.vim files are loaded:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5692 "on" `:syntax on` command. Highlight colors are overruled but
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5693 links are kept
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5694 "enable" `:syntax enable` command. Only define colors for groups that
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5695 don't have highlighting yet. Use `:highlight default` .
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5696 "reset" `:syntax reset` command or loading a color scheme. Define all
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5697 the colors.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5698 "skip" Don't define colors. Used to skip the default settings when a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5699 syncolor.vim file earlier in 'runtimepath' has already set
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5700 them.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5701
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5702 ==============================================================================
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5703 17. Highlighting tags tag-highlight
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5704
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5705 If you want to highlight all the tags in your file, you can use the following
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5706 mappings.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5707
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5708 <F11> -- Generate tags.vim file, and highlight tags.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5709 <F12> -- Just highlight tags based on existing tags.vim file.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5710 >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5711 :map <F11> :sp tags<CR>:%s/^$[^ :]:$\=$[^ ]$.*/syntax keyword Tag \2/<CR>:wq! tags.vim<CR>/^<CR><F12>
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5712 :map <F12> :so tags.vim<CR>
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5713
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5714 WARNING: The longer the tags file, the slower this will be, and the more
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5715 memory Vim will consume.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5716
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5717 Only highlighting typedefs, unions and structs can be done too. For this you
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5718 must use Universal Ctags (found at https://ctags.io) or Exuberant ctags (found
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5719 at http://ctags.sf.net).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5720
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5721 Put these lines in your Makefile:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5722
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5723 # Make a highlight file for types. Requires Universal/Exuberant ctags and awk
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5724 types: types.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5725 types.vim: *.[ch]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5726 ctags --c-kinds=gstu -o- *.[ch] \|\
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5727 awk 'BEGIN{printf("syntax keyword Type\t")}\
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5728 {printf("%s ", $$1)}END{print ""}' > $@
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5729
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5730 And put these lines in your .vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5731
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5732 " load the types.vim highlighting file, if it exists
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5733 autocmd BufRead,BufNewFile *.[ch] let fname = expand('<afile>:p:h') .. '/types.vim'
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5734 autocmd BufRead,BufNewFile *.[ch] if filereadable(fname)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5735 autocmd BufRead,BufNewFile *.[ch] exe 'so ' .. fname
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5736 autocmd BufRead,BufNewFile *.[ch] endif
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5737
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5738 ==============================================================================
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5739 18. Window-local syntax :ownsyntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5740
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5741 Normally all windows on a buffer share the same syntax settings. It is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5742 possible, however, to set a particular window on a file to have its own
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5743 private syntax setting. A possible example would be to edit LaTeX source
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5744 with conventional highlighting in one window, while seeing the same source
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5745 highlighted differently (so as to hide control sequences and indicate bold,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5746 italic etc regions) in another. The 'scrollbind' option is useful here.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5747
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5748 To set the current window to have the syntax "foo", separately from all other
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5749 windows on the buffer: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5750 :ownsyntax foo
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5751 < w:current_syntax
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5752 This will set the "w:current_syntax" variable to "foo". The value of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5753 "b:current_syntax" does not change. This is implemented by saving and
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5754 restoring "b:current_syntax", since the syntax files do set
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5755 "b:current_syntax". The value set by the syntax file is assigned to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5756 "w:current_syntax".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5757 Note: This resets the 'spell', 'spellcapcheck' and 'spellfile' options.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5758
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5759 Once a window has its own syntax, syntax commands executed from other windows
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5760 on the same buffer (including :syntax clear) have no effect. Conversely,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5761 syntax commands executed from that window do not affect other windows on the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5762 same buffer.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5763
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5764 A window with its own syntax reverts to normal behavior when another buffer
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5765 is loaded into that window or the file is reloaded.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5766 When splitting the window, the new window will use the original syntax.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5767
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5768 ==============================================================================
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5769 19. Color xterms xterm-color color-xterm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5770
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5771 Most color xterms have only eight colors. If you don't get colors with the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5772 default setup, it should work with these lines in your .vimrc: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5773 :if &term =~ "xterm"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5774 : if has("terminfo")
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5775 : set t_Co=8
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5776 : set t_Sf=<Esc>[3%p1%dm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5777 : set t_Sb=<Esc>[4%p1%dm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5778 : else
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5779 : set t_Co=8
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5780 : set t_Sf=<Esc>[3%dm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5781 : set t_Sb=<Esc>[4%dm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5782 : endif
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5783 :endif
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5784 < [<Esc> is a real escape, type CTRL-V <Esc>]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5785
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5786 You might want to change the first "if" to match the name of your terminal,
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5787 e.g. "dtterm" instead of "xterm".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5788
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5789 Note: Do these settings BEFORE doing ":syntax on". Otherwise the colors may
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5790 be wrong.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5791 xiterm rxvt
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5792 The above settings have been mentioned to work for xiterm and rxvt too.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5793 But for using 16 colors in an rxvt these should work with terminfo: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5794 :set t_AB=<Esc>[%?%p1%{8}%<%t25;%p1%{40}%+%e5;%p1%{32}%+%;%dm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5795 :set t_AF=<Esc>[%?%p1%{8}%<%t22;%p1%{30}%+%e1;%p1%{22}%+%;%dm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5796 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5797 colortest.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5798 To test your color setup, a file has been included in the Vim distribution.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5799 To use it, execute this command: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5800 :runtime syntax/colortest.vim
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5801
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5802 Some versions of xterm (and other terminals, like the Linux console) can
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5803 output lighter foreground colors, even though the number of colors is defined
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5804 at 8. Therefore Vim sets the "cterm=bold" attribute for light foreground
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5805 colors, when 't_Co' is 8.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5806
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5807 xfree-xterm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5808 To get 16 colors or more, get the newest xterm version (which should be
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5809 included with XFree86 3.3 and later). You can also find the latest version
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5810 at: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5811 http://invisible-island.net/xterm/xterm.html
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5812 Here is a good way to configure it. This uses 88 colors and enables the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5813 termcap-query feature, which allows Vim to ask the xterm how many colors it
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5814 supports. >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5815 ./configure --disable-bold-color --enable-88-color --enable-tcap-query
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5816 If you only get 8 colors, check the xterm compilation settings.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5817 (Also see \|UTF8-xterm\| for using this xterm with UTF-8 character encoding).
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5818
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5819 This xterm should work with these lines in your .vimrc (for 16 colors): >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5820 :if has("terminfo")
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5821 : set t_Co=16
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5822 : set t_AB=<Esc>[%?%p1%{8}%<%t%p1%{40}%+%e%p1%{92}%+%;%dm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5823 : set t_AF=<Esc>[%?%p1%{8}%<%t%p1%{30}%+%e%p1%{82}%+%;%dm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5824 :else
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5825 : set t_Co=16
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5826 : set t_Sf=<Esc>[3%dm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5827 : set t_Sb=<Esc>[4%dm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5828 :endif
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5829 < [<Esc> is a real escape, type CTRL-V <Esc>]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5830
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5831 Without \|+terminfo\|, Vim will recognize these settings, and automatically
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5832 translate cterm colors of 8 and above to "<Esc>[9%dm" and "<Esc>[10%dm".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5833 Colors above 16 are also translated automatically.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5834
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5835 For 256 colors this has been reported to work: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5836
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5837 :set t_AB=<Esc>[48;5;%dm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5838 :set t_AF=<Esc>[38;5;%dm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5839
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5840 Or just set the TERM environment variable to "xterm-color" or "xterm-16color"
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5841 and try if that works.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5842
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5843 You probably want to use these X resources (in your ~/.Xdefaults file):
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5844 XTerm*color0: #000000
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5845 XTerm*color1: #c00000
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5846 XTerm*color2: #008000
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5847 XTerm*color3: #808000
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5848 XTerm*color4: #0000c0
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5849 XTerm*color5: #c000c0
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5850 XTerm*color6: #008080
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5851 XTerm*color7: #c0c0c0
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5852 XTerm*color8: #808080
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5853 XTerm*color9: #ff6060
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5854 XTerm*color10: #00ff00
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5855 XTerm*color11: #ffff00
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5856 XTerm*color12: #8080ff
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5857 XTerm*color13: #ff40ff
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5858 XTerm*color14: #00ffff
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5859 XTerm*color15: #ffffff
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5860 Xterm*cursorColor: Black
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5861
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5862 [Note: The cursorColor is required to work around a bug, which changes the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5863 cursor color to the color of the last drawn text. This has been fixed by a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5864 newer version of xterm, but not everybody is using it yet.]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5865
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5866 To get these right away, reload the .Xdefaults file to the X Option database
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5867 Manager (you only need to do this when you just changed the .Xdefaults file): >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5868 xrdb -merge ~/.Xdefaults
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5869 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5870 xterm-blink xterm-blinking-cursor
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5871 To make the cursor blink in an xterm, see tools/blink.c. Or use Thomas
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5872 Dickey's xterm above patchlevel 107 (see above for where to get it), with
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5873 these resources:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5874 XTerm*cursorBlink: on
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5875 XTerm*cursorOnTime: 400
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5876 XTerm*cursorOffTime: 250
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5877 XTerm*cursorColor: White
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5878
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5879 hpterm-color
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5880 These settings work (more or less) for an hpterm, which only supports 8
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5881 foreground colors: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5882 :if has("terminfo")
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5883 : set t_Co=8
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5884 : set t_Sf=<Esc>[&v%p1%dS
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5885 : set t_Sb=<Esc>[&v7S
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5886 :else
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5887 : set t_Co=8
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5888 : set t_Sf=<Esc>[&v%dS
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5889 : set t_Sb=<Esc>[&v7S
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5890 :endif
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5891 < [<Esc> is a real escape, type CTRL-V <Esc>]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5892
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5893 Eterm enlightened-terminal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5894 These settings have been reported to work for the Enlightened terminal
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5895 emulator, or Eterm. They might work for all xterm-like terminals that use the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5896 bold attribute to get bright colors. Add an ":if" like above when needed. >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5897 :set t_Co=16
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5898 :set t_AF=^[[%?%p1%{8}%<%t3%p1%d%e%p1%{22}%+%d;1%;m
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5899 :set t_AB=^[[%?%p1%{8}%<%t4%p1%d%e%p1%{32}%+%d;1%;m
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5900 <
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5901 TTpro-telnet
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5902 These settings should work for TTpro telnet. Tera Term Pro is a freeware /
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5903 open-source program for MS-Windows. >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5904 set t_Co=16
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5905 set t_AB=^[[%?%p1%{8}%<%t%p1%{40}%+%e%p1%{32}%+5;%;%dm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5906 set t_AF=^[[%?%p1%{8}%<%t%p1%{30}%+%e%p1%{22}%+1;%;%dm
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5907 Also make sure TTpro's Setup / Window / Full Color is enabled, and make sure
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5908 that Setup / Font / Enable Bold is NOT enabled.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5909 (info provided by John Love-Jensen <eljay@Adobe.COM>)
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5910
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5911
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5912 ==============================================================================
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5913 20. When syntax is slow :syntime
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5914
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5915 This is aimed at authors of a syntax file.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5916
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5917 If your syntax causes redrawing to be slow, here are a few hints on making it
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5918 faster. To see slowness switch on some features that usually interfere, such
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5919 as 'relativenumber' and \|folding\|.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5920
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5921 Note: This is only available when compiled with the \|+profile\| feature.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5922 You many need to build Vim with "huge" features.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5923
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5924 To find out what patterns are consuming most time, get an overview with this
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5925 sequence: >
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5926 :syntime on
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5927 [ redraw the text at least once with CTRL-L ]
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5928 :syntime report
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5929
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5930 This will display a list of syntax patterns that were used, sorted by the time
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5931 it took to match them against the text.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5932
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5933 :syntime on Start measuring syntax times. This will add some
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5934 overhead to compute the time spent on syntax pattern
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5935 matching.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5936
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5937 :syntime off Stop measuring syntax times.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5938
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5939 :syntime clear Set all the counters to zero, restart measuring.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5940
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5941 :syntime report Show the syntax items used since ":syntime on" in the
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5942 current window. Use a wider display to see more of
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5943 the output.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5944
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5945 The list is sorted by total time. The columns are:
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5946 TOTAL Total time in seconds spent on
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5947 matching this pattern.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5948 COUNT Number of times the pattern was used.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5949 MATCH Number of times the pattern actually
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5950 matched
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5951 SLOWEST The longest time for one try.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5952 AVERAGE The average time for one try.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5953 NAME Name of the syntax item. Note that
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5954 this is not unique.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5955 PATTERN The pattern being used.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5956
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5957 Pattern matching gets slow when it has to try many alternatives. Try to
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5958 include as much literal text as possible to reduce the number of ways a
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5959 pattern does NOT match.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5960
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5961 When using the "\@<=" and "\@<!" items, add a maximum size to avoid trying at
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5962 all positions in the current and previous line. For example, if the item is
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5963 literal text specify the size of that text (in bytes):
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5964
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5965 "<\@<=span" Matches "span" in "<span". This tries matching with "<" in
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5966 many places.
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5967 "<\@1<=span" Matches the same, but only tries one byte before "span".
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5968
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5969
448aef880252 normalize line endings Christian Brabandt <cb@256bit.org> parents: 32449 diff changeset	5970 vim:tw=78:sw=4:ts=8:noet:ft=help:norl:

Mercurial > vim

annotate runtime/doc/syntax.txt @ 32669:448aef880252