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