| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1 | This directory contains Vim scripts for syntax highlighting. |
| 2 | |
| 3 | These scripts are not for a language, but are used by Vim itself: |
| 4 | |
| 5 | syntax.vim Used for the ":syntax on" command. Uses synload.vim. |
| 6 | |
| 7 | manual.vim Used for the ":syntax manual" command. Uses synload.vim. |
| 8 | |
| 9 | synload.vim Contains autocommands to load a language file when a certain |
| 10 | file name (extension) is used. And sets up the Syntax menu |
| 11 | for the GUI. |
| 12 | |
| 13 | nosyntax.vim Used for the ":syntax off" command. Undo the loading of |
| 14 | synload.vim. |
| 15 | |
| Bram Moolenaar | e1f3fd1 | 2022-08-15 18:51:32 +0100 | [diff] [blame] | 16 | The "shared" directory contains generated files and what is used by more than |
| 17 | one syntax. |
| 18 | |
| Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 19 | |
| 20 | A few special files: |
| 21 | |
| 22 | 2html.vim Converts any highlighted file to HTML (GUI only). |
| 23 | colortest.vim Check for color names and actual color on screen. |
| 24 | hitest.vim View the current highlight settings. |
| 25 | whitespace.vim View Tabs and Spaces. |
| 26 | |
| 27 | |
| 28 | If you want to write a syntax file, read the docs at ":help usr_44.txt". |
| 29 | |
| 30 | If you make a new syntax file which would be useful for others, please send it |
| 31 | to Bram@vim.org. Include instructions for detecting the file type for this |
| 32 | language, by file name extension or by checking a few lines in the file. |
| 33 | And please write the file in a portable way, see ":help 44.12". |
| 34 | |
| 35 | If you have remarks about an existing file, send them to the maintainer of |
| 36 | that file. Only when you get no response send a message to Bram@vim.org. |
| 37 | |
| 38 | If you are the maintainer of a syntax file and make improvements, send the new |
| 39 | version to Bram@vim.org. |
| 40 | |
| 41 | For further info see ":help syntax" in Vim. |