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