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