Mercurial > vim

annotate runtime/syntax/README.txt @ 36179:e134e2d4fe29 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added tag v9.1.0739 for changeset dae96c59b506230be0539f863890c050674940f0
author Christian Brabandt <cb@256bit.org>
date Sat, 21 Sep 2024 11:45:05 +0200
parents 1b2730ece70e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1 This directory contains Vim scripts for syntax highlighting.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3 These scripts are not for a language, but are used by Vim itself:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5 syntax.vim Used for the ":syntax on" command. Uses synload.vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7 manual.vim Used for the ":syntax manual" command. Uses synload.vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9 synload.vim Contains autocommands to load a language file when a certain
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10 file name (extension) is used. And sets up the Syntax menu
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11 for the GUI.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
13 nosyntax.vim Used for the ":syntax off" command. Undo the loading of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
14 synload.vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
15
29756
2acb87ee55fc Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 7
diff changeset
16 The "shared" directory contains generated files and what is used by more than
2acb87ee55fc Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 7
diff changeset
17 one syntax.
2acb87ee55fc Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 7
diff changeset
18
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
19
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
20 A few special files:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
21
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
22 2html.vim Converts any highlighted file to HTML (GUI only).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
23 colortest.vim Check for color names and actual color on screen.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
24 hitest.vim View the current highlight settings.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
25 whitespace.vim View Tabs and Spaces.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
26
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
27
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
28 If you want to write a syntax file, read the docs at ":help usr_44.txt".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
29
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
30 If you make a new syntax file which would be useful for others, please send it
32770
4027cefc2aab Farewell to Bram and dedicate upcoming Vim 9.1 to him (#12749)
Christian Brabandt <cb@256bit.org>
parents: 29756
diff changeset
31 to the vim-dev mailing list <vim-dev@vim.org>. Include instructions for
4027cefc2aab Farewell to Bram and dedicate upcoming Vim 9.1 to him (#12749)
Christian Brabandt <cb@256bit.org>
parents: 29756
diff changeset
32 detecting the file type for this language, by file name extension or by
4027cefc2aab Farewell to Bram and dedicate upcoming Vim 9.1 to him (#12749)
Christian Brabandt <cb@256bit.org>
parents: 29756
diff changeset
33 checking a few lines in the file. And please write the file in a portable way,
4027cefc2aab Farewell to Bram and dedicate upcoming Vim 9.1 to him (#12749)
Christian Brabandt <cb@256bit.org>
parents: 29756
diff changeset
34 see ":help 44.12".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
36 If you have remarks about an existing file, send them to the maintainer of
32774
1b2730ece70e runtime: Add a few more remarks about Bram and new runtime files
Christian Brabandt <cb@256bit.org>
parents: 32770
diff changeset
37 that file. Only when you get no response send a message to the vim-dev
1b2730ece70e runtime: Add a few more remarks about Bram and new runtime files
Christian Brabandt <cb@256bit.org>
parents: 32770
diff changeset
38 mailing list: <vim-dev@vim.org>.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
39
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
40 If you are the maintainer of a syntax file and make improvements, send the new
32774
1b2730ece70e runtime: Add a few more remarks about Bram and new runtime files
Christian Brabandt <cb@256bit.org>
parents: 32770
diff changeset
41 version to the vim-dev mailing list: <vim-dev@vim.org>
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
42
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
43 For further info see ":help syntax" in Vim.