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