comparison runtime/doc/syntax.txt @ 501:ce2181d14aa0 v7.0139

updated for version 7.0139
author vimboss
date Tue, 30 Aug 2005 21:55:26 +0000
parents f012c4ed8c38
children a7ae7e043e43
comparison
equal deleted inserted replaced
500:4772a5e3f9fa 501:ce2181d14aa0
1 *syntax.txt* For Vim version 7.0aa. Last change: 2005 Aug 14 1 *syntax.txt* For Vim version 7.0aa. Last change: 2005 Aug 30
2 2
3 3
4 VIM REFERENCE MANUAL by Bram Moolenaar 4 VIM REFERENCE MANUAL by Bram Moolenaar
5 5
6 6
452 Here is an example how to run the script over all .c and .h files from a 452 Here is an example how to run the script over all .c and .h files from a
453 Unix shell: > 453 Unix shell: >
454 for f in *.[ch]; do gvim -f +"syn on" +"run! syntax/2html.vim" +"wq" +"q" $f; done 454 for f in *.[ch]; do gvim -f +"syn on" +"run! syntax/2html.vim" +"wq" +"q" $f; done
455 < 455 <
456 456
457 ABEL *abel.vim* *abel-syntax* 457 ABEL *abel.vim* *ft-abel-syntax*
458 458
459 ABEL highlighting provides some user-defined options. To enable them, assign 459 ABEL highlighting provides some user-defined options. To enable them, assign
460 any value to the respective variable. Example: > 460 any value to the respective variable. Example: >
461 :let abel_obsolete_ok=1 461 :let abel_obsolete_ok=1
462 To disable them use ":unlet". Example: > 462 To disable them use ":unlet". Example: >
465 Variable Highlight ~ 465 Variable Highlight ~
466 abel_obsolete_ok obsolete keywords are statements, not errors 466 abel_obsolete_ok obsolete keywords are statements, not errors
467 abel_cpp_comments_illegal do not interpret '//' as inline comment leader 467 abel_cpp_comments_illegal do not interpret '//' as inline comment leader
468 468
469 469
470 ADA *ada.vim* *ada-syntax* 470 ADA *ada.vim* *ft-ada-syntax*
471 471
472 This mode is designed for the 1995 edition of Ada ("Ada95"), which 472 This mode is designed for the 1995 edition of Ada ("Ada95"), which
473 includes support for objected-programming, protected types, and so on. 473 includes support for objected-programming, protected types, and so on.
474 It handles code written for the original Ada language 474 It handles code written for the original Ada language
475 ("Ada83" or "Ada87") as well, though Ada83 code which uses Ada95-only 475 ("Ada83" or "Ada87") as well, though Ada83 code which uses Ada95-only
513 513
514 Even on a slow (90Mhz) PC this mode works quickly, but if you find 514 Even on a slow (90Mhz) PC this mode works quickly, but if you find
515 the performance unacceptable, turn on ada_withuse_ordinary. 515 the performance unacceptable, turn on ada_withuse_ordinary.
516 516
517 517
518 ANT *ant.vim* *ant-syntax* 518 ANT *ant.vim* *ft-ant-syntax*
519 519
520 The ant syntax file provides syntax highlighting for javascript and python 520 The ant syntax file provides syntax highlighting for javascript and python
521 by default. Syntax highlighting for other script languages can be installed 521 by default. Syntax highlighting for other script languages can be installed
522 by the function AntSyntaxScript(), which takes the tag name as first argument 522 by the function AntSyntaxScript(), which takes the tag name as first argument
523 and the script syntax file name as second argument. Example: > 523 and the script syntax file name as second argument. Example: >
531 ]]></script> 531 ]]></script>
532 532
533 See |mysyntaxfile-add| for installing script languages permanently. 533 See |mysyntaxfile-add| for installing script languages permanently.
534 534
535 535
536 APACHE *apache.vim* *apache-syntax* 536 APACHE *apache.vim* *ft-apache-syntax*
537 537
538 The apache syntax file provides syntax highlighting depending on Apache HTTP 538 The apache syntax file provides syntax highlighting depending on Apache HTTP
539 server version, by default for 1.3.x. Set "apache_version" to Apache version 539 server version, by default for 1.3.x. Set "apache_version" to Apache version
540 (as a string) to get highlighting for another version. Example: > 540 (as a string) to get highlighting for another version. Example: >
541 541
542 :let apache_version = "2.0" 542 :let apache_version = "2.0"
543 < 543 <
544 544
545 *asm.vim* *asmh8300.vim* *nasm.vim* *masm.vim* *asm68k* 545 *asm.vim* *asmh8300.vim* *nasm.vim* *masm.vim* *asm68k*
546 ASSEMBLY *asm-syntax* *asmh8300-syntax* *nasm-syntax* *masm-syntax* 546 ASSEMBLY *ft-asm-syntax* *ft-asmh8300-syntax* *ft-nasm-syntax*
547 *asm68k-syntax* *fasm.vim* 547 *ft-masm-syntax* *ft-asm68k-syntax* *fasm.vim*
548 548
549 Files matching "*.i" could be Progress or Assembly. If the automatic detection 549 Files matching "*.i" could be Progress or Assembly. If the automatic detection
550 doesn't work for you, or you don't edit Progress at all, use this in your 550 doesn't work for you, or you don't edit Progress at all, use this in your
551 startup vimrc: > 551 startup vimrc: >
552 :let filetype_i = "asm" 552 :let filetype_i = "asm"
596 (parser dependent; not recommended) 596 (parser dependent; not recommended)
597 nasm_ctx_outside_macro contexts outside macro not as Error 597 nasm_ctx_outside_macro contexts outside macro not as Error
598 nasm_no_warn potentially risky syntax not as ToDo 598 nasm_no_warn potentially risky syntax not as ToDo
599 599
600 600
601 ASPPERL and ASPVBS *aspperl-syntax* *aspvbs-syntax* 601 ASPPERL and ASPVBS *ft-aspperl-syntax* *ft-aspvbs-syntax*
602 602
603 *.asp and *.asa files could be either Perl or Visual Basic script. Since it's 603 *.asp and *.asa files could be either Perl or Visual Basic script. Since it's
604 hard to detect this you can set two global variables to tell Vim what you are 604 hard to detect this you can set two global variables to tell Vim what you are
605 using. For Perl script use: > 605 using. For Perl script use: >
606 :let g:filetype_asa = "aspperl" 606 :let g:filetype_asa = "aspperl"
608 For Visual Basic use: > 608 For Visual Basic use: >
609 :let g:filetype_asa = "aspvbs" 609 :let g:filetype_asa = "aspvbs"
610 :let g:filetype_asp = "aspvbs" 610 :let g:filetype_asp = "aspvbs"
611 611
612 612
613 BASIC *basic.vim* *vb.vim* *basic-syntax* *vb-syntax* 613 BASIC *basic.vim* *vb.vim* *ft-basic-syntax* *ft-vb-syntax*
614 614
615 Both Visual Basic and "normal" basic use the extension ".bas". To detect 615 Both Visual Basic and "normal" basic use the extension ".bas". To detect
616 which one should be used, Vim checks for the string "VB_Name" in the first 616 which one should be used, Vim checks for the string "VB_Name" in the first
617 five lines of the file. If it is not found, filetype will be "basic", 617 five lines of the file. If it is not found, filetype will be "basic",
618 otherwise "vb". Files with the ".frm" extension will always be seen as Visual 618 otherwise "vb". Files with the ".frm" extension will always be seen as Visual
619 Basic. 619 Basic.
620 620
621 621
622 C *c.vim* *c-syntax* 622 C *c.vim* *ft-c-syntax*
623 623
624 A few things in C highlighting are optional. To enable them assign any value 624 A few things in C highlighting are optional. To enable them assign any value
625 to the respective variable. Example: > 625 to the respective variable. Example: >
626 :let c_comment_strings=1 626 :let c_comment_strings=1
627 To disable them use ":unlet". Example: > 627 To disable them use ":unlet". Example: >
684 ~/.vim/after/syntax/c.vim. > 684 ~/.vim/after/syntax/c.vim. >
685 syn region myFold start="{" end="}" transparent fold 685 syn region myFold start="{" end="}" transparent fold
686 syn sync fromstart 686 syn sync fromstart
687 set foldmethod=syntax 687 set foldmethod=syntax
688 688
689 CH *ch.vim* *ch-syntax* 689 CH *ch.vim* *ft-ch-syntax*
690 690
691 C/C++ interpreter. Ch has similar syntax highlighting to C and builds upon 691 C/C++ interpreter. Ch has similar syntax highlighting to C and builds upon
692 the C syntax file. See |c.vim| for all the settings that are available for C. 692 the C syntax file. See |c.vim| for all the settings that are available for C.
693 693
694 By setting a variable you can tell Vim to use Ch syntax for *.h files, instead 694 By setting a variable you can tell Vim to use Ch syntax for *.h files, instead
695 of C or C++: > 695 of C or C++: >
696 :let ch_syntax_for_h = 1 696 :let ch_syntax_for_h = 1
697 697
698 698
699 CHILL *chill.vim* *chill-syntax* 699 CHILL *chill.vim* *ft-chill-syntax*
700 700
701 Chill syntax highlighting is similar to C. See |c.vim| for all the settings 701 Chill syntax highlighting is similar to C. See |c.vim| for all the settings
702 that are available. Additionally there is: 702 that are available. Additionally there is:
703 703
704 chill_space_errors like c_space_errors 704 chill_space_errors like c_space_errors
705 chill_comment_string like c_comment_strings 705 chill_comment_string like c_comment_strings
706 chill_minlines like c_minlines 706 chill_minlines like c_minlines
707 707
708 708
709 CHANGELOG *changelog.vim* *changelog-syntax* 709 CHANGELOG *changelog.vim* *ft-changelog-syntax*
710 710
711 ChangeLog supports highlighting spaces at the start of a line. 711 ChangeLog supports highlighting spaces at the start of a line.
712 If you do not like this, add following line to your .vimrc: > 712 If you do not like this, add following line to your .vimrc: >
713 let g:changelog_spacing_errors = 0 713 let g:changelog_spacing_errors = 0
714 This works the next time you edit a changelog file. You can also use 714 This works the next time you edit a changelog file. You can also use
720 Or to avoid the highlighting: > 720 Or to avoid the highlighting: >
721 :hi link ChangelogError NONE 721 :hi link ChangelogError NONE
722 This works immediately. 722 This works immediately.
723 723
724 724
725 COBOL *cobol.vim* *cobol-syntax* 725 COBOL *cobol.vim* *ft-cobol-syntax*
726 726
727 COBOL highlighting has different needs for legacy code than it does for fresh 727 COBOL highlighting has different needs for legacy code than it does for fresh
728 development. This is due to differences in what is being done (maintenance 728 development. This is due to differences in what is being done (maintenance
729 versus development) and other factors. To enable legacy code highlighting, 729 versus development) and other factors. To enable legacy code highlighting,
730 add this line to your .vimrc: > 730 add this line to your .vimrc: >
731 :let cobol_legacy_code = 1 731 :let cobol_legacy_code = 1
732 To disable it again, use this: > 732 To disable it again, use this: >
733 :unlet cobol_legacy_code 733 :unlet cobol_legacy_code
734 734
735 735
736 COLD FUSION *coldfusion.vim* *coldfusion-syntax* 736 COLD FUSION *coldfusion.vim* *ft-coldfusion-syntax*
737 737
738 The ColdFusion has its own version of HTML comments. To turn on ColdFusion 738 The ColdFusion has its own version of HTML comments. To turn on ColdFusion
739 comment highlighting, add the following line to your startup file: > 739 comment highlighting, add the following line to your startup file: >
740 740
741 :let html_wrong_comments = 1 741 :let html_wrong_comments = 1
742 742
743 The ColdFusion syntax file is based on the HTML syntax file. 743 The ColdFusion syntax file is based on the HTML syntax file.
744 744
745 745
746 CSH *csh.vim* *csh-syntax* 746 CSH *csh.vim* *ft-csh-syntax*
747 747
748 This covers the shell named "csh". Note that on some systems tcsh is actually 748 This covers the shell named "csh". Note that on some systems tcsh is actually
749 used. 749 used.
750 750
751 Detecting whether a file is csh or tcsh is notoriously hard. Some systems 751 Detecting whether a file is csh or tcsh is notoriously hard. Some systems
764 will be classified as tcsh, UNLESS the "filetype_csh" variable exists. If the 764 will be classified as tcsh, UNLESS the "filetype_csh" variable exists. If the
765 "filetype_csh" variable exists, the filetype will be set to the value of the 765 "filetype_csh" variable exists, the filetype will be set to the value of the
766 variable. 766 variable.
767 767
768 768
769 CYNLIB *cynlib.vim* *cynlib-syntax* 769 CYNLIB *cynlib.vim* *ft-cynlib-syntax*
770 770
771 Cynlib files are C++ files that use the Cynlib class library to enable 771 Cynlib files are C++ files that use the Cynlib class library to enable
772 hardware modelling and simulation using C++. Typically Cynlib files have a .cc 772 hardware modelling and simulation using C++. Typically Cynlib files have a .cc
773 or a .cpp extension, which makes it very difficult to distinguish them from a 773 or a .cpp extension, which makes it very difficult to distinguish them from a
774 normal C++ file. Thus, to enable Cynlib highlighting for .cc files, add this 774 normal C++ file. Thus, to enable Cynlib highlighting for .cc files, add this
784 784
785 :unlet cynlib_cyntax_for_cc 785 :unlet cynlib_cyntax_for_cc
786 :unlet cynlib_cyntax_for_cpp 786 :unlet cynlib_cyntax_for_cpp
787 < 787 <
788 788
789 CWEB *cweb.vim* *cweb-syntax* 789 CWEB *cweb.vim* *ft-cweb-syntax*
790 790
791 Files matching "*.w" could be Progress or cweb. If the automatic detection 791 Files matching "*.w" could be Progress or cweb. If the automatic detection
792 doesn't work for you, or you don't edit Progress at all, use this in your 792 doesn't work for you, or you don't edit Progress at all, use this in your
793 startup vimrc: > 793 startup vimrc: >
794 :let filetype_w = "cweb" 794 :let filetype_w = "cweb"
795 795
796 796
797 DESKTOP *desktop.vim* *desktop-syntax* 797 DESKTOP *desktop.vim* *ft-desktop-syntax*
798 798
799 Primary goal of this syntax file is to highlight .desktop and .directory files 799 Primary goal of this syntax file is to highlight .desktop and .directory files
800 according to freedesktop.org standard: http://pdx.freedesktop.org/Standards/ 800 according to freedesktop.org standard: http://pdx.freedesktop.org/Standards/
801 But actually almost none implements this standard fully. Thus it will 801 But actually almost none implements this standard fully. Thus it will
802 highlight all Unix ini files. But you can force strict highlighting according 802 highlight all Unix ini files. But you can force strict highlighting according
803 to standard by placing this in your vimrc file: > 803 to standard by placing this in your vimrc file: >
804 :let enforce_freedesktop_standard = 1 804 :let enforce_freedesktop_standard = 1
805 805
806 806
807 DIRCOLORS *dircolors.vim* *dircolors-syntax* 807 DIRCOLORS *dircolors.vim* *ft-dircolors-syntax*
808 808
809 The dircolors utility highlighting definition has one option. It exists to 809 The dircolors utility highlighting definition has one option. It exists to
810 provide compatibility with the Slackware GNU/Linux distributions version of 810 provide compatibility with the Slackware GNU/Linux distributions version of
811 the command. It adds a few keywords that are generally ignored by most 811 the command. It adds a few keywords that are generally ignored by most
812 versions. On Slackware systems, however, the utility accepts the keywords and 812 versions. On Slackware systems, however, the utility accepts the keywords and
813 uses them for processing. To enable the Slackware keywords add the following 813 uses them for processing. To enable the Slackware keywords add the following
814 line to your startup file: > 814 line to your startup file: >
815 let dircolors_is_slackware = 1 815 let dircolors_is_slackware = 1
816 816
817 817
818 DOCBOOK *docbk.vim* *docbk-syntax* *docbook* 818 DOCBOOK *docbk.vim* *ft-docbk-syntax* *docbook*
819 DOCBOOK XML *docbkxml.vim* *docbkxml-syntax* 819 DOCBOOK XML *docbkxml.vim* *ft-docbkxml-syntax*
820 DOCBOOK SGML *docbksgml.vim* *docbksgml-syntax* 820 DOCBOOK SGML *docbksgml.vim* *ft-docbksgml-syntax*
821 821
822 There are two types of DocBook files: SGML and XML. To specify what type you 822 There are two types of DocBook files: SGML and XML. To specify what type you
823 are using the "b:docbk_type" variable should be set. Vim does this for you 823 are using the "b:docbk_type" variable should be set. Vim does this for you
824 automatically if it can recognize the type. When Vim can't guess it the type 824 automatically if it can recognize the type. When Vim can't guess it the type
825 defaults to XML. 825 defaults to XML.
832 :set filetype=docbksgml 832 :set filetype=docbksgml
833 or: > 833 or: >
834 :set filetype=docbkxml 834 :set filetype=docbkxml
835 835
836 836
837 DOSBATCH *dosbatch.vim* *dosbatch-syntax* 837 DOSBATCH *dosbatch.vim* *ft-dosbatch-syntax*
838 838
839 There is one option with highlighting DOS batch files. This covers new 839 There is one option with highlighting DOS batch files. This covers new
840 extensions to the Command Interpreter introduced with Windows 2000 and 840 extensions to the Command Interpreter introduced with Windows 2000 and
841 is controlled by the variable dosbatch_cmdextversion. For Windows NT 841 is controlled by the variable dosbatch_cmdextversion. For Windows NT
842 this should have the value 1, and for Windows 2000 it should be 2. 842 this should have the value 1, and for Windows 2000 it should be 2.
855 855
856 If this variable is undefined or zero, btm syntax is selected. 856 If this variable is undefined or zero, btm syntax is selected.
857 857
858 858
859 859
860 DTD *dtd.vim* *dtd-syntax* 860 DTD *dtd.vim* *ft-dtd-syntax*
861 861
862 The DTD syntax highlighting is case sensitive by default. To disable 862 The DTD syntax highlighting is case sensitive by default. To disable
863 case-sensitive highlighting, add the following line to your startup file: > 863 case-sensitive highlighting, add the following line to your startup file: >
864 864
865 :let dtd_ignore_case=1 865 :let dtd_ignore_case=1
879 :let dtd_no_param_entities=1 879 :let dtd_no_param_entities=1
880 880
881 The DTD syntax file is also included by xml.vim to highlight included dtd's. 881 The DTD syntax file is also included by xml.vim to highlight included dtd's.
882 882
883 883
884 EIFFEL *eiffel.vim* *eiffel-syntax* 884 EIFFEL *eiffel.vim* *ft-eiffel-syntax*
885 885
886 While Eiffel is not case-sensitive, its style guidelines are, and the 886 While Eiffel is not case-sensitive, its style guidelines are, and the
887 syntax highlighting file encourages their use. This also allows to 887 syntax highlighting file encourages their use. This also allows to
888 highlight class names differently. If you want to disable case-sensitive 888 highlight class names differently. If you want to disable case-sensitive
889 highlighting, add the following line to your startup file: > 889 highlighting, add the following line to your startup file: >
922 :let eiffel_hex_constants=1 922 :let eiffel_hex_constants=1
923 923
924 to your startup file. 924 to your startup file.
925 925
926 926
927 ERLANG *erlang.vim* *erlang-syntax* 927 ERLANG *erlang.vim* *ft-erlang-syntax*
928 928
929 The erlang highlighting supports Erlang (ERicsson LANGuage). 929 The erlang highlighting supports Erlang (ERicsson LANGuage).
930 Erlang is case sensitive and default extension is ".erl". 930 Erlang is case sensitive and default extension is ".erl".
931 931
932 If you want to disable keywords highlighting, put in your .vimrc: > 932 If you want to disable keywords highlighting, put in your .vimrc: >
937 If you want to disable special characters highlighting, put in 937 If you want to disable special characters highlighting, put in
938 your .vimrc: > 938 your .vimrc: >
939 :let erlang_characters = 1 939 :let erlang_characters = 1
940 940
941 941
942 FORM *form.vim* *form-syntax* 942 FORM *form.vim* *ft-form-syntax*
943 943
944 The coloring scheme for syntax elements in the FORM file uses the default 944 The coloring scheme for syntax elements in the FORM file uses the default
945 modes Conditional, Number, Statement, Comment, PreProc, Type, and String, 945 modes Conditional, Number, Statement, Comment, PreProc, Type, and String,
946 following the language specifications in 'Symbolic Manipulation with FORM'' by 946 following the language specifications in 'Symbolic Manipulation with FORM'' by
947 J.A.M. Vermaseren, CAN, Netherlands, 1991. 947 J.A.M. Vermaseren, CAN, Netherlands, 1991.
971 The enhanced mode also takes advantage of additional color features for a dark 971 The enhanced mode also takes advantage of additional color features for a dark
972 gvim display. Here, statements are colored LightYellow instead of Yellow, and 972 gvim display. Here, statements are colored LightYellow instead of Yellow, and
973 conditionals are LightBlue for better distinction. 973 conditionals are LightBlue for better distinction.
974 974
975 975
976 FORTRAN *fortran.vim* *fortran-syntax* 976 FORTRAN *fortran.vim* *ft-fortran-syntax*
977 977
978 Default highlighting and dialect ~ 978 Default highlighting and dialect ~
979 Highlighting appropriate for f95 (Fortran 95) is used by default. This choice 979 Highlighting appropriate for f95 (Fortran 95) is used by default. This choice
980 should be appropriate for most users most of the time because Fortran 95 is a 980 should be appropriate for most users most of the time because Fortran 95 is a
981 superset of Fortran 90 and almost a superset of Fortran 77. 981 superset of Fortran 90 and almost a superset of Fortran 77.
1112 Limitations ~ 1112 Limitations ~
1113 Parenthesis checking does not catch too few closing parentheses. Hollerith 1113 Parenthesis checking does not catch too few closing parentheses. Hollerith
1114 strings are not recognized. Some keywords may be highlighted incorrectly 1114 strings are not recognized. Some keywords may be highlighted incorrectly
1115 because Fortran90 has no reserved words. 1115 because Fortran90 has no reserved words.
1116 1116
1117 For further information related to fortran, see |fortran-indent| and 1117 For further information related to fortran, see |ft-fortran-indent| and
1118 |fortran-plugin|. 1118 |ft-fortran-plugin|.
1119 1119
1120 1120
1121 FVWM CONFIGURATION FILES *fvwm.vim* *fvwm-syntax* 1121 FVWM CONFIGURATION FILES *fvwm.vim* *ft-fvwm-syntax*
1122 1122
1123 In order for Vim to recognize Fvwm configuration files that do not match 1123 In order for Vim to recognize Fvwm configuration files that do not match
1124 the patterns *fvwmrc* or *fvwm2rc* , you must put additional patterns 1124 the patterns *fvwmrc* or *fvwm2rc* , you must put additional patterns
1125 appropriate to your system in your myfiletypes.vim file. For these 1125 appropriate to your system in your myfiletypes.vim file. For these
1126 patterns, you must set the variable "b:fvwm_version" to the major version 1126 patterns, you must set the variable "b:fvwm_version" to the major version
1140 :let rgb_file = "/usr/X11/lib/X11/rgb.txt" 1140 :let rgb_file = "/usr/X11/lib/X11/rgb.txt"
1141 1141
1142 to your .vimrc file. 1142 to your .vimrc file.
1143 1143
1144 1144
1145 GSP *gsp.vim* 1145 GSP *gsp.vim* *ft-gsp-syntax*
1146 1146
1147 The default coloring style for GSP pages is defined by |html.vim|, and 1147 The default coloring style for GSP pages is defined by |html.vim|, and
1148 the coloring for java code (within java tags or inline between backticks) 1148 the coloring for java code (within java tags or inline between backticks)
1149 is defined by |java.vim|. The following HTML groups defined in |html.vim| 1149 is defined by |java.vim|. The following HTML groups defined in |html.vim|
1150 are redefined to incorporate and highlight inline java code: 1150 are redefined to incorporate and highlight inline java code:
1163 1163
1164 The backticks for inline java are highlighted according to the htmlError 1164 The backticks for inline java are highlighted according to the htmlError
1165 group to make them easier to see. 1165 group to make them easier to see.
1166 1166
1167 1167
1168 GROFF *groff.vim* *groff-syntax* 1168 GROFF *groff.vim* *ft-groff-syntax*
1169 1169
1170 The groff syntax file is a wrapper for |nroff.vim|, see the notes 1170 The groff syntax file is a wrapper for |nroff.vim|, see the notes
1171 under that heading for examples of use and configuration. The purpose 1171 under that heading for examples of use and configuration. The purpose
1172 of this wrapper is to set up groff syntax extensions by setting the 1172 of this wrapper is to set up groff syntax extensions by setting the
1173 filetype from a |modeline| or in a personal filetype definitions file 1173 filetype from a |modeline| or in a personal filetype definitions file
1174 (see |filetype.txt|). 1174 (see |filetype.txt|).
1175 1175
1176 1176
1177 HASKELL *haskell.vim* *lhaskell.vim* *haskell-syntax* 1177 HASKELL *haskell.vim* *lhaskell.vim* *ft-haskell-syntax*
1178 1178
1179 The Haskell syntax files support plain Haskell code as well as literate 1179 The Haskell syntax files support plain Haskell code as well as literate
1180 Haskell code, the latter in both Bird style and TeX style. The Haskell 1180 Haskell code, the latter in both Bird style and TeX style. The Haskell
1181 syntax highlighting will also highlight C preprocessor directives. 1181 syntax highlighting will also highlight C preprocessor directives.
1182 1182
1216 will force TeX highlighting for a particular buffer. It has to be 1216 will force TeX highlighting for a particular buffer. It has to be
1217 set before turning syntax highlighting on for the buffer or 1217 set before turning syntax highlighting on for the buffer or
1218 loading a file. 1218 loading a file.
1219 1219
1220 1220
1221 HTML *html.vim* *html-syntax* 1221 HTML *html.vim* *ft-html-syntax*
1222 1222
1223 The coloring scheme for tags in the HTML file works as follows. 1223 The coloring scheme for tags in the HTML file works as follows.
1224 1224
1225 The <> of opening tags are colored differently than the </> of a closing tag. 1225 The <> of opening tags are colored differently than the </> of a closing tag.
1226 This is on purpose! For opening tags the 'Function' color is used, while for 1226 This is on purpose! For opening tags the 'Function' color is used, while for
1289 1289
1290 Now you just need to make sure that you add all regions that contain 1290 Now you just need to make sure that you add all regions that contain
1291 the preprocessor language to the cluster htmlPreproc. 1291 the preprocessor language to the cluster htmlPreproc.
1292 1292
1293 1293
1294 HTML/OS (by Aestiva) *htmlos.vim* *htmlos-syntax* 1294 HTML/OS (by Aestiva) *htmlos.vim* *ft-htmlos-syntax*
1295 1295
1296 The coloring scheme for HTML/OS works as follows: 1296 The coloring scheme for HTML/OS works as follows:
1297 1297
1298 Functions and variable names are the same color by default, because VIM 1298 Functions and variable names are the same color by default, because VIM
1299 doesn't specify different colors for Functions and Identifiers. To change 1299 doesn't specify different colors for Functions and Identifiers. To change
1310 1310
1311 Lastly, it should be noted that the opening and closing characters to begin a 1311 Lastly, it should be noted that the opening and closing characters to begin a
1312 block of HTML/OS code can either be << or [[ and >> or ]], respectively. 1312 block of HTML/OS code can either be << or [[ and >> or ]], respectively.
1313 1313
1314 1314
1315 IA64 *ia64.vim* *intel-itanium* *ia64-syntax* 1315 IA64 *ia64.vim* *intel-itanium* *ft-ia64-syntax*
1316 1316
1317 Highlighting for the Intel Itanium 64 assembly language. See |asm.vim| for 1317 Highlighting for the Intel Itanium 64 assembly language. See |asm.vim| for
1318 how to recognize this filetype. 1318 how to recognize this filetype.
1319 1319
1320 To have *.inc files be recognized as IA64, add this to your .vimrc file: > 1320 To have *.inc files be recognized as IA64, add this to your .vimrc file: >
1321 :let g:filetype_inc = "ia64" 1321 :let g:filetype_inc = "ia64"
1322 1322
1323 1323
1324 INFORM *inform.vim* *inform-syntax* 1324 INFORM *inform.vim* *ft-inform-syntax*
1325 1325
1326 Inform highlighting includes symbols provided by the Inform Library, as 1326 Inform highlighting includes symbols provided by the Inform Library, as
1327 most programs make extensive use of it. If do not wish Library symbols 1327 most programs make extensive use of it. If do not wish Library symbols
1328 to be highlighted add this to your vim startup: > 1328 to be highlighted add this to your vim startup: >
1329 :let inform_highlight_simple=1 1329 :let inform_highlight_simple=1
1348 Inform development environment, you may with to add this to your 1348 Inform development environment, you may with to add this to your
1349 startup sequence: > 1349 startup sequence: >
1350 :let inform_highlight_old=1 1350 :let inform_highlight_old=1
1351 1351
1352 1352
1353 JAVA *java.vim* *java-syntax* 1353 JAVA *java.vim* *ft-java-syntax*
1354 1354
1355 The java.vim syntax highlighting file offers several options: 1355 The java.vim syntax highlighting file offers several options:
1356 1356
1357 In Java 1.0.2 it was never possible to have braces inside parens, so this was 1357 In Java 1.0.2 it was never possible to have braces inside parens, so this was
1358 flagged as an error. Since Java 1.1 this is possible (with anonymous 1358 flagged as an error. Since Java 1.1 this is possible (with anonymous
1441 This will make the syntax synchronization start 50 lines before the first 1441 This will make the syntax synchronization start 50 lines before the first
1442 displayed line. The default value is 10. The disadvantage of using a larger 1442 displayed line. The default value is 10. The disadvantage of using a larger
1443 number is that redrawing can become slow. 1443 number is that redrawing can become slow.
1444 1444
1445 1445
1446 LACE *lace.vim* *lace-syntax* 1446 LACE *lace.vim* *ft-lace-syntax*
1447 1447
1448 Lace (Language for Assembly of Classes in Eiffel) is case insensitive, but the 1448 Lace (Language for Assembly of Classes in Eiffel) is case insensitive, but the
1449 style guide lines are not. If you prefer case insensitive highlighting, just 1449 style guide lines are not. If you prefer case insensitive highlighting, just
1450 define the vim variable 'lace_case_insensitive' in your startup file: > 1450 define the vim variable 'lace_case_insensitive' in your startup file: >
1451 :let lace_case_insensitive=1 1451 :let lace_case_insensitive=1
1452 1452
1453 1453
1454 LEX *lex.vim* *lex-syntax* 1454 LEX *lex.vim* *ft-lex-syntax*
1455 1455
1456 Lex uses brute-force synchronizing as the "^%%$" section delimiter 1456 Lex uses brute-force synchronizing as the "^%%$" section delimiter
1457 gives no clue as to what section follows. Consequently, the value for > 1457 gives no clue as to what section follows. Consequently, the value for >
1458 :syn sync minlines=300 1458 :syn sync minlines=300
1459 may be changed by the user if s/he is experiencing synchronization 1459 may be changed by the user if s/he is experiencing synchronization
1460 difficulties (such as may happen with large lex files). 1460 difficulties (such as may happen with large lex files).
1461 1461
1462 1462
1463 LITE *lite.vim* *lite-syntax* 1463 LITE *lite.vim* *ft-lite-syntax*
1464 1464
1465 There are two options for the lite syntax highlighting. 1465 There are two options for the lite syntax highlighting.
1466 1466
1467 If you like SQL syntax highlighting inside Strings, use this: > 1467 If you like SQL syntax highlighting inside Strings, use this: >
1468 1468
1472 set "lite_minlines" to the value you desire. Example: > 1472 set "lite_minlines" to the value you desire. Example: >
1473 1473
1474 :let lite_minlines = 200 1474 :let lite_minlines = 200
1475 1475
1476 1476
1477 LPC *lpc.vim* *lpc-syntax* 1477 LPC *lpc.vim* *ft-lpc-syntax*
1478 1478
1479 LPC stands for a simple, memory-efficient language: Lars Pensj| C. The 1479 LPC stands for a simple, memory-efficient language: Lars Pensj| C. The
1480 file name of LPC is usually *.c. Recognizing these files as LPC would bother 1480 file name of LPC is usually *.c. Recognizing these files as LPC would bother
1481 users writing only C programs. If you want to use LPC syntax in Vim, you 1481 users writing only C programs. If you want to use LPC syntax in Vim, you
1482 should set a variable in your .vimrc file: > 1482 should set a variable in your .vimrc file: >
1513 For uLPC series of LPC: 1513 For uLPC series of LPC:
1514 uLPC has been developed to Pike, so you should use Pike syntax 1514 uLPC has been developed to Pike, so you should use Pike syntax
1515 instead, and the name of your source file should be *.pike 1515 instead, and the name of your source file should be *.pike
1516 1516
1517 1517
1518 LUA *lua.vim* *lua-syntax* 1518 LUA *lua.vim* *ft-lua-syntax*
1519 1519
1520 This syntax file may be used for Lua 4.0 and Lua 5.0 (default). If you are 1520 This syntax file may be used for Lua 4.0 and Lua 5.0 (default). If you are
1521 programming in Lua 4.0, use this: > 1521 programming in Lua 4.0, use this: >
1522 1522
1523 :let lua_version = 4 1523 :let lua_version = 4
1524 1524
1525 If lua_version variable doesn't exist, it is set to 5. 1525 If lua_version variable doesn't exist, it is set to 5.
1526 1526
1527 1527
1528 MAIL *mail.vim* 1528 MAIL *mail.vim* *ft-mail.vim*
1529 1529
1530 Vim highlights all the standard elements of an email (headers, signatures, 1530 Vim highlights all the standard elements of an email (headers, signatures,
1531 quoted text and URLs / email addresses). In keeping with standard conventions, 1531 quoted text and URLs / email addresses). In keeping with standard conventions,
1532 signatures begin in a line containing only "--" followed optionally by 1532 signatures begin in a line containing only "--" followed optionally by
1533 whitespaces and end with a newline. 1533 whitespaces and end with a newline.
1541 with short headers, you can change this to a smaller value: > 1541 with short headers, you can change this to a smaller value: >
1542 1542
1543 :let mail_minlines = 30 1543 :let mail_minlines = 30
1544 1544
1545 1545
1546 MAKE *make.vim* *make-syntax* 1546 MAKE *make.vim* *ft-make-syntax*
1547 1547
1548 In makefiles, commands are usually highlighted to make it easy for you to spot 1548 In makefiles, commands are usually highlighted to make it easy for you to spot
1549 errors. However, this may be too much coloring for you. You can turn this 1549 errors. However, this may be too much coloring for you. You can turn this
1550 feature off by using: > 1550 feature off by using: >
1551 1551
1552 :let make_no_commands = 1 1552 :let make_no_commands = 1
1553 1553
1554 1554
1555 MAPLE *maple.vim* *maple-syntax* 1555 MAPLE *maple.vim* *ft-maple-syntax*
1556 1556
1557 Maple V, by Waterloo Maple Inc, supports symbolic algebra. The language 1557 Maple V, by Waterloo Maple Inc, supports symbolic algebra. The language
1558 supports many packages of functions which are selectively loaded by the user. 1558 supports many packages of functions which are selectively loaded by the user.
1559 The standard set of packages' functions as supplied in Maple V release 4 may be 1559 The standard set of packages' functions as supplied in Maple V release 4 may be
1560 highlighted at the user's discretion. Users may place in their .vimrc file: > 1560 highlighted at the user's discretion. Users may place in their .vimrc file: >
1575 mv_combstruct mv_liesymm mv_plots mv_tensor 1575 mv_combstruct mv_liesymm mv_plots mv_tensor
1576 mv_difforms mv_linalg mv_plottools mv_totorder 1576 mv_difforms mv_linalg mv_plottools mv_totorder
1577 mv_finance mv_logic mv_powseries 1577 mv_finance mv_logic mv_powseries
1578 1578
1579 1579
1580 MATHEMATICA *mma.vim* *mma-syntax* *mathematica-syntax* 1580 MATHEMATICA *mma.vim* *ft-mma-syntax* *ft-mathematica-syntax*
1581 1581
1582 Empty *.m files will automatically be presumed to be Matlab files unless you 1582 Empty *.m files will automatically be presumed to be Matlab files unless you
1583 have the following in your .vimrc: > 1583 have the following in your .vimrc: >
1584 1584
1585 let filetype_m = "mma" 1585 let filetype_m = "mma"
1586 1586
1587 1587
1588 MOO *moo.vim* *moo-syntax* 1588 MOO *moo.vim* *ft-moo-syntax*
1589 1589
1590 If you use C-style comments inside expressions and find it mangles your 1590 If you use C-style comments inside expressions and find it mangles your
1591 highlighting, you may want to use extended (slow!) matches for C-style 1591 highlighting, you may want to use extended (slow!) matches for C-style
1592 comments: > 1592 comments: >
1593 1593
1619 An example of adding sprintf() to the list of known builtin functions: > 1619 An example of adding sprintf() to the list of known builtin functions: >
1620 1620
1621 :syn keyword mooKnownBuiltinFunction sprintf contained 1621 :syn keyword mooKnownBuiltinFunction sprintf contained
1622 1622
1623 1623
1624 MSQL *msql.vim* *msql-syntax* 1624 MSQL *msql.vim* *ft-msql-syntax*
1625 1625
1626 There are two options for the msql syntax highlighting. 1626 There are two options for the msql syntax highlighting.
1627 1627
1628 If you like SQL syntax highlighting inside Strings, use this: > 1628 If you like SQL syntax highlighting inside Strings, use this: >
1629 1629
1633 set "msql_minlines" to the value you desire. Example: > 1633 set "msql_minlines" to the value you desire. Example: >
1634 1634
1635 :let msql_minlines = 200 1635 :let msql_minlines = 200
1636 1636
1637 1637
1638 NCF *ncf.vim* *ncf-syntax* 1638 NCF *ncf.vim* *ft-ncf-syntax*
1639 1639
1640 There is one option for NCF syntax highlighting. 1640 There is one option for NCF syntax highlighting.
1641 1641
1642 If you want to have unrecognized (by ncf.vim) statements highlighted as 1642 If you want to have unrecognized (by ncf.vim) statements highlighted as
1643 errors, use this: > 1643 errors, use this: >
1645 :let ncf_highlight_unknowns = 1 1645 :let ncf_highlight_unknowns = 1
1646 1646
1647 If you don't want to highlight these errors, leave it unset. 1647 If you don't want to highlight these errors, leave it unset.
1648 1648
1649 1649
1650 NROFF *nroff.vim* *nroff-syntax* 1650 NROFF *nroff.vim* *ft-nroff-syntax*
1651 1651
1652 The nroff syntax file works with AT&T n/troff out of the box. You need to 1652 The nroff syntax file works with AT&T n/troff out of the box. You need to
1653 activate the GNU groff extra features included in the syntax file before you 1653 activate the GNU groff extra features included in the syntax file before you
1654 can use them. 1654 can use them.
1655 1655
1716 1716
1717 Finally, there is a |groff.vim| syntax file that can be used for enabling 1717 Finally, there is a |groff.vim| syntax file that can be used for enabling
1718 groff syntax highlighting either on a file basis or globally by default. 1718 groff syntax highlighting either on a file basis or globally by default.
1719 1719
1720 1720
1721 OCAML *ocaml.vim* *ocaml-syntax* 1721 OCAML *ocaml.vim* *ft-ocaml-syntax*
1722 1722
1723 The OCaml syntax file handles files having the following prefixes: .ml, 1723 The OCaml syntax file handles files having the following prefixes: .ml,
1724 .mli, .mll and .mly. By setting the following variable > 1724 .mli, .mll and .mly. By setting the following variable >
1725 1725
1726 :let ocaml_revised = 1 1726 :let ocaml_revised = 1
1732 1732
1733 prevents highlighting of "end" as error, which is useful when sources 1733 prevents highlighting of "end" as error, which is useful when sources
1734 contain very long structures that Vim does not synchronize anymore. 1734 contain very long structures that Vim does not synchronize anymore.
1735 1735
1736 1736
1737 PAPP *papp.vim* *papp-syntax* 1737 PAPP *papp.vim* *ft-papp-syntax*
1738 1738
1739 The PApp syntax file handles .papp files and, to a lesser extend, .pxml 1739 The PApp syntax file handles .papp files and, to a lesser extend, .pxml
1740 and .pxsl files which are all a mixture of perl/xml/html/other using xml 1740 and .pxsl files which are all a mixture of perl/xml/html/other using xml
1741 as the top-level file format. By default everything inside phtml or pxml 1741 as the top-level file format. By default everything inside phtml or pxml
1742 sections is treated as a string with embedded preprocessor commands. If 1742 sections is treated as a string with embedded preprocessor commands. If
1750 1750
1751 The newest version of the papp.vim syntax file can usually be found at 1751 The newest version of the papp.vim syntax file can usually be found at
1752 http://papp.plan9.de. 1752 http://papp.plan9.de.
1753 1753
1754 1754
1755 PASCAL *pascal.vim* *pascal-syntax* 1755 PASCAL *pascal.vim* *ft-pascal-syntax*
1756 1756
1757 Files matching "*.p" could be Progress or Pascal. If the automatic detection 1757 Files matching "*.p" could be Progress or Pascal. If the automatic detection
1758 doesn't work for you, or you don't edit Progress at all, use this in your 1758 doesn't work for you, or you don't edit Progress at all, use this in your
1759 startup vimrc: > 1759 startup vimrc: >
1760 1760
1804 1804
1805 :let pascal_no_tabs=1 1805 :let pascal_no_tabs=1
1806 1806
1807 1807
1808 1808
1809 PERL *perl.vim* *perl-syntax* 1809 PERL *perl.vim* *ft-perl-syntax*
1810 1810
1811 There are a number of possible options to the perl syntax highlighting. 1811 There are a number of possible options to the perl syntax highlighting.
1812 1812
1813 If you use POD files or POD segments, you might: > 1813 If you use POD files or POD segments, you might: >
1814 1814
1864 If you want to fold blocks in if statements, etc. as well set the following: > 1864 If you want to fold blocks in if statements, etc. as well set the following: >
1865 1865
1866 :let perl_fold_blocks = 1 1866 :let perl_fold_blocks = 1
1867 1867
1868 1868
1869 PHP3 and PHP4 *php.vim* *php3.vim* *php-syntax* *php3-syntax* 1869 PHP3 and PHP4 *php.vim* *php3.vim* *ft-php-syntax* *ft-php3-syntax*
1870 1870
1871 [note: previously this was called "php3", but since it now also supports php4 1871 [note: previously this was called "php3", but since it now also supports php4
1872 it has been renamed to "php"] 1872 it has been renamed to "php"]
1873 1873
1874 There are the following options for the php syntax highlighting. 1874 There are the following options for the php syntax highlighting.
1917 x = -1 to sync by search (default), 1917 x = -1 to sync by search (default),
1918 x > 0 to sync at least x lines backwards, 1918 x > 0 to sync at least x lines backwards,
1919 x = 0 to sync from start. 1919 x = 0 to sync from start.
1920 1920
1921 1921
1922 PPWIZARD *ppwiz.vim* *ppwiz-syntax* 1922 PPWIZARD *ppwiz.vim* *ft-ppwiz-syntax*
1923 1923
1924 PPWizard is a preprocessor for HTML and OS/2 INF files 1924 PPWizard is a preprocessor for HTML and OS/2 INF files
1925 1925
1926 This syntax file has the options: 1926 This syntax file has the options:
1927 1927
1939 1939
1940 - ppwiz_with_html : If the value is 1 (the default), highlight literal 1940 - ppwiz_with_html : If the value is 1 (the default), highlight literal
1941 HTML code; if 0, treat HTML code like ordinary text. 1941 HTML code; if 0, treat HTML code like ordinary text.
1942 1942
1943 1943
1944 PHTML *phtml.vim* *phtml-syntax* 1944 PHTML *phtml.vim* *ft-phtml-syntax*
1945 1945
1946 There are two options for the phtml syntax highlighting. 1946 There are two options for the phtml syntax highlighting.
1947 1947
1948 If you like SQL syntax highlighting inside Strings, use this: > 1948 If you like SQL syntax highlighting inside Strings, use this: >
1949 1949
1953 set "phtml_minlines" to the value you desire. Example: > 1953 set "phtml_minlines" to the value you desire. Example: >
1954 1954
1955 :let phtml_minlines = 200 1955 :let phtml_minlines = 200
1956 1956
1957 1957
1958 POSTSCRIPT *postscr.vim* *postscr-syntax* 1958 POSTSCRIPT *postscr.vim* *ft-postscr-syntax*
1959 1959
1960 There are several options when it comes to highlighting PostScript. 1960 There are several options when it comes to highlighting PostScript.
1961 1961
1962 First which version of the PostScript language to highlight. There are 1962 First which version of the PostScript language to highlight. There are
1963 currently three defined language versions, or levels. Level 1 is the original 1963 currently three defined language versions, or levels. Level 1 is the original
2008 postscr_andornot_binary as follows: > 2008 postscr_andornot_binary as follows: >
2009 2009
2010 :let postscr_andornot_binary=1 2010 :let postscr_andornot_binary=1
2011 < 2011 <
2012 2012
2013 *ptcap.vim* 2013 *ptcap.vim* *ft-printcap-syntax*
2014 PRINTCAP + TERMCAP *ptcap-syntax* *termcap-syntax* *printcap-syntax* 2014 PRINTCAP + TERMCAP *ft-ptcap-syntax* *ft-termcap-syntax*
2015 2015
2016 This syntax file applies to the printcap and termcap databases. 2016 This syntax file applies to the printcap and termcap databases.
2017 2017
2018 In order for Vim to recognize printcap/termcap files that do not match 2018 In order for Vim to recognize printcap/termcap files that do not match
2019 the patterns *printcap*, or *termcap*, you must put additional patterns 2019 the patterns *printcap*, or *termcap*, you must put additional patterns
2034 :let ptcap_minlines = 50 2034 :let ptcap_minlines = 50
2035 2035
2036 (The default is 20 lines.) 2036 (The default is 20 lines.)
2037 2037
2038 2038
2039 PROGRESS *progress.vim* *progress-syntax* 2039 PROGRESS *progress.vim* *ft-progress-syntax*
2040 2040
2041 Files matching "*.w" could be Progress or cweb. If the automatic detection 2041 Files matching "*.w" could be Progress or cweb. If the automatic detection
2042 doesn't work for you, or you don't edit cweb at all, use this in your 2042 doesn't work for you, or you don't edit cweb at all, use this in your
2043 startup vimrc: > 2043 startup vimrc: >
2044 :let filetype_w = "progress" 2044 :let filetype_w = "progress"
2046 Pascal. Use this if you don't use assembly and Pascal: > 2046 Pascal. Use this if you don't use assembly and Pascal: >
2047 :let filetype_i = "progress" 2047 :let filetype_i = "progress"
2048 :let filetype_p = "progress" 2048 :let filetype_p = "progress"
2049 2049
2050 2050
2051 PYTHON *python.vim* *python-syntax* 2051 PYTHON *python.vim* *ft-python-syntax*
2052 2052
2053 There are four options to control Python syntax highlighting. 2053 There are four options to control Python syntax highlighting.
2054 2054
2055 For highlighted numbers: > 2055 For highlighted numbers: >
2056 :let python_highlight_numbers = 1 2056 :let python_highlight_numbers = 1
2067 If you want all possible Python highlighting (the same as setting the 2067 If you want all possible Python highlighting (the same as setting the
2068 preceding three options): > 2068 preceding three options): >
2069 :let python_highlight_all = 1 2069 :let python_highlight_all = 1
2070 2070
2071 2071
2072 QUAKE *quake.vim* *quake-syntax* 2072 QUAKE *quake.vim* *ft-quake-syntax*
2073 2073
2074 The Quake syntax definition should work for most any FPS (First Person 2074 The Quake syntax definition should work for most any FPS (First Person
2075 Shooter) based on one of the Quake engines. However, the command names vary 2075 Shooter) based on one of the Quake engines. However, the command names vary
2076 a bit between the three games (Quake, Quake 2, and Quake 3 Arena) so the 2076 a bit between the three games (Quake, Quake 2, and Quake 3 Arena) so the
2077 syntax definition checks for the existence of three global variables to allow 2077 syntax definition checks for the existence of three global variables to allow
2089 2089
2090 Any combination of these three variables is legal, but might highlight more 2090 Any combination of these three variables is legal, but might highlight more
2091 commands than are actually available to you by the game. 2091 commands than are actually available to you by the game.
2092 2092
2093 2093
2094 READLINE *readline.vim* *readline-syntax* 2094 READLINE *readline.vim* *ft-readline-syntax*
2095 2095
2096 The readline library is primarily used by the BASH shell, which adds quite a 2096 The readline library is primarily used by the BASH shell, which adds quite a
2097 few commands and options to the ones already available. To highlight these 2097 few commands and options to the ones already available. To highlight these
2098 items as well you can add the following to your |vimrc| or just type it in the 2098 items as well you can add the following to your |vimrc| or just type it in the
2099 command line before loading a file with the readline syntax: > 2099 command line before loading a file with the readline syntax: >
2101 2101
2102 This will add highlighting for the commands that BASH (version 2.05a and 2102 This will add highlighting for the commands that BASH (version 2.05a and
2103 later, and part earlier) adds. 2103 later, and part earlier) adds.
2104 2104
2105 2105
2106 REXX *rexx.vim* *rexx-syntax* 2106 REXX *rexx.vim* *ft-rexx-syntax*
2107 2107
2108 If you notice highlighting errors while scrolling backwards, which are fixed 2108 If you notice highlighting errors while scrolling backwards, which are fixed
2109 when redrawing with CTRL-L, try setting the "rexx_minlines" internal variable 2109 when redrawing with CTRL-L, try setting the "rexx_minlines" internal variable
2110 to a larger number: > 2110 to a larger number: >
2111 :let rexx_minlines = 50 2111 :let rexx_minlines = 50
2112 This will make the syntax synchronization start 50 lines before the first 2112 This will make the syntax synchronization start 50 lines before the first
2113 displayed line. The default value is 10. The disadvantage of using a larger 2113 displayed line. The default value is 10. The disadvantage of using a larger
2114 number is that redrawing can become slow. 2114 number is that redrawing can become slow.
2115 2115
2116 2116
2117 RUBY *ruby.vim* *ruby-syntax* 2117 RUBY *ruby.vim* *ft-ruby-syntax*
2118 2118
2119 There are a few options to the Ruby syntax highlighting. 2119 There are a few options to the Ruby syntax highlighting.
2120 2120
2121 By default, the "end" keyword is colorized according to the opening statement 2121 By default, the "end" keyword is colorized according to the opening statement
2122 of the block it closes. While useful, this feature can be expensive: if you 2122 of the block it closes. While useful, this feature can be expensive: if you
2137 :let ruby_no_identifiers = 1 2137 :let ruby_no_identifiers = 1
2138 This will prevent highlighting of special identifiers like "ConstantName", 2138 This will prevent highlighting of special identifiers like "ConstantName",
2139 "$global_var", "@instance_var", "| iterator |", and ":symbol". 2139 "$global_var", "@instance_var", "| iterator |", and ":symbol".
2140 2140
2141 2141
2142 SCHEME *scheme.vim* *scheme-syntax* 2142 SCHEME *scheme.vim* *ft-scheme-syntax*
2143 2143
2144 By default only R5RS keywords are highlighted and properly indented. 2144 By default only R5RS keywords are highlighted and properly indented.
2145 2145
2146 MzScheme-specific stuff will be used if b:is_mzscheme or g:is_mzscheme 2146 MzScheme-specific stuff will be used if b:is_mzscheme or g:is_mzscheme
2147 variables are defined. 2147 variables are defined.
2148 2148
2149 Also scheme.vim supports keywords of the Chicken Scheme->C compiler. Define 2149 Also scheme.vim supports keywords of the Chicken Scheme->C compiler. Define
2150 b:is_chicken or g:is_chicken, if you need them. 2150 b:is_chicken or g:is_chicken, if you need them.
2151 2151
2152 2152
2153 SDL *sdl.vim* *sdl-syntax* 2153 SDL *sdl.vim* *ft-sdl-syntax*
2154 2154
2155 The SDL highlighting probably misses a few keywords, but SDL has so many 2155 The SDL highlighting probably misses a few keywords, but SDL has so many
2156 of them it's almost impossibly to cope. 2156 of them it's almost impossibly to cope.
2157 2157
2158 The new standard, SDL-2000, specifies that all identifiers are 2158 The new standard, SDL-2000, specifies that all identifiers are
2168 2168
2169 The indentation is probably also incomplete, but right now I am very 2169 The indentation is probably also incomplete, but right now I am very
2170 satisfied with it for my own projects. 2170 satisfied with it for my own projects.
2171 2171
2172 2172
2173 SED *sed.vim* *sed-syntax* 2173 SED *sed.vim* *ft-sed-syntax*
2174 2174
2175 To make tabs stand out from regular blanks (accomplished by using Todo 2175 To make tabs stand out from regular blanks (accomplished by using Todo
2176 highlighting on the tabs), define "highlight_sedtabs" by putting > 2176 highlighting on the tabs), define "highlight_sedtabs" by putting >
2177 2177
2178 :let highlight_sedtabs = 1 2178 :let highlight_sedtabs = 1
2191 (Transform accepts no flags.) I tolerate this bug because the 2191 (Transform accepts no flags.) I tolerate this bug because the
2192 involved commands need very complex treatment (95 patterns, one for 2192 involved commands need very complex treatment (95 patterns, one for
2193 each plausible pattern delimiter). 2193 each plausible pattern delimiter).
2194 2194
2195 2195
2196 SGML *sgml.vim* *sgml-syntax* 2196 SGML *sgml.vim* *ft-sgml-syntax*
2197 2197
2198 The coloring scheme for tags in the SGML file works as follows. 2198 The coloring scheme for tags in the SGML file works as follows.
2199 2199
2200 The <> of opening tags are colored differently than the </> of a closing tag. 2200 The <> of opening tags are colored differently than the </> of a closing tag.
2201 This is on purpose! For opening tags the 'Function' color is used, while for 2201 This is on purpose! For opening tags the 'Function' color is used, while for
2232 let sgml_no_rendering=1 2232 let sgml_no_rendering=1
2233 2233
2234 (Adapted from the html.vim help text by Claudio Fleiner <claudio@fleiner.com>) 2234 (Adapted from the html.vim help text by Claudio Fleiner <claudio@fleiner.com>)
2235 2235
2236 2236
2237 SH *sh.vim* *sh-syntax* *bash-syntax* *ksh-syntax* 2237 SH *sh.vim* *ft-sh-syntax* *ft-bash-syntax* *ft-ksh-syntax*
2238 2238
2239 This covers the "normal" Unix (Bourne) sh, bash and the Korn shell. 2239 This covers the "normal" Unix (Bourne) sh, bash and the Korn shell.
2240 2240
2241 Vim attempts to determine which shell type is in use by specifying that 2241 Vim attempts to determine which shell type is in use by specifying that
2242 various filenames are of specific types: > 2242 various filenames are of specific types: >
2283 < 2283 <
2284 The default is to use the twice sh_minlines. Set it to a smaller number to 2284 The default is to use the twice sh_minlines. Set it to a smaller number to
2285 speed up displaying. The disadvantage is that highlight errors may appear. 2285 speed up displaying. The disadvantage is that highlight errors may appear.
2286 2286
2287 2287
2288 SPEEDUP (AspenTech plant simulator) *spup.vim* *spup-syntax* 2288 SPEEDUP (AspenTech plant simulator) *spup.vim* *ft-spup-syntax*
2289 2289
2290 The Speedup syntax file has some options: 2290 The Speedup syntax file has some options:
2291 2291
2292 - strict_subsections : If this variable is defined, only keywords for 2292 - strict_subsections : If this variable is defined, only keywords for
2293 sections and subsections will be highlighted as statements but not 2293 sections and subsections will be highlighted as statements but not
2315 PRESETting variables, syncing may be critical. If your computer is 2315 PRESETting variables, syncing may be critical. If your computer is
2316 fast enough, you can increase minlines and/or maxlines near the end of 2316 fast enough, you can increase minlines and/or maxlines near the end of
2317 the syntax file. 2317 the syntax file.
2318 2318
2319 2319
2320 SQL *sql.vim* *sql-syntax* 2320 SQL *sql.vim* *ft-sql-syntax*
2321 *sqlinformix.vim* *sqlinformix-syntax* 2321 *sqlinformix.vim* *ft-sqlinformix-syntax*
2322 2322
2323 While there is an ANSI standard for SQL, most database engines add their 2323 While there is an ANSI standard for SQL, most database engines add their
2324 own custom extensions. Vim currently supports the Oracle and Informix 2324 own custom extensions. Vim currently supports the Oracle and Informix
2325 dialects of SQL. Vim assumes "*.sql" files are Oracle SQL by default. 2325 dialects of SQL. Vim assumes "*.sql" files are Oracle SQL by default.
2326 2326
2327 If you want to use the Informix dialect, put this in your startup vimrc: > 2327 If you want to use the Informix dialect, put this in your startup vimrc: >
2328 :let g:filetype_sql = "sqlinformix" 2328 :let g:filetype_sql = "sqlinformix"
2329 2329
2330 2330
2331 TCSH *tcsh.vim* *tcsh-syntax* 2331 TCSH *tcsh.vim* *ft-tcsh-syntax*
2332 2332
2333 This covers the shell named "tcsh". It is a superset of csh. See |csh.vim| 2333 This covers the shell named "tcsh". It is a superset of csh. See |csh.vim|
2334 for how the filetype is detected. 2334 for how the filetype is detected.
2335 2335
2336 Tcsh does not allow \" in strings unless the "backslash_quote" shell variable 2336 Tcsh does not allow \" in strings unless the "backslash_quote" shell variable
2348 This will make the syntax synchronization start 100 lines before the first 2348 This will make the syntax synchronization start 100 lines before the first
2349 displayed line. The default value is 15. The disadvantage of using a larger 2349 displayed line. The default value is 15. The disadvantage of using a larger
2350 number is that redrawing can become slow. 2350 number is that redrawing can become slow.
2351 2351
2352 2352
2353 TEX *tex.vim* *tex-syntax* 2353 TEX *tex.vim* *ft-tex-syntax*
2354 2354
2355 *tex-folding* 2355 *tex-folding*
2356 Want Syntax Folding? ~ 2356 Want Syntax Folding? ~
2357 2357
2358 As of version 28 of <syntax/tex.vim>, syntax-based folding of parts, chapters, 2358 As of version 28 of <syntax/tex.vim>, syntax-based folding of parts, chapters,
2423 2423
2424 Putting "let g:tex_stylish=1" into your <.vimrc> will make <syntax/tex.vim> 2424 Putting "let g:tex_stylish=1" into your <.vimrc> will make <syntax/tex.vim>
2425 always accept such use of @. 2425 always accept such use of @.
2426 2426
2427 2427
2428 TF *tf.vim* *tf-syntax* 2428 TF *tf.vim* *ft-tf-syntax*
2429 2429
2430 There is one option for the tf syntax highlighting. 2430 There is one option for the tf syntax highlighting.
2431 2431
2432 For syncing, minlines defaults to 100. If you prefer another value, you can 2432 For syncing, minlines defaults to 100. If you prefer another value, you can
2433 set "tf_minlines" to the value you desire. Example: > 2433 set "tf_minlines" to the value you desire. Example: >
2434 2434
2435 :let tf_minlines = your choice 2435 :let tf_minlines = your choice
2436 2436
2437 2437
2438 VIM *vim.vim* *vim-syntax* 2438 VIM *vim.vim* *ft-vim-syntax*
2439 2439
2440 There is a tradeoff between more accurate syntax highlighting versus 2440 There is a tradeoff between more accurate syntax highlighting versus
2441 screen updating speed. To improve accuracy, you may wish to increase 2441 screen updating speed. To improve accuracy, you may wish to increase
2442 the g:vim_minlines variable. The g:vim_maxlines variable may be used 2442 the g:vim_minlines variable. The g:vim_maxlines variable may be used
2443 to improve screen updating rates (see |:syn-sync| for more on this). 2443 to improve screen updating rates (see |:syn-sync| for more on this).
2457 g:vimembedscript == 0 Syntax highlighting for embedded 2457 g:vimembedscript == 0 Syntax highlighting for embedded
2458 scripting languages will not be 2458 scripting languages will not be
2459 loaded. 2459 loaded.
2460 2460
2461 2461
2462 XF86CONFIG *xf86conf.vim* *xf86conf-syntax* 2462 XF86CONFIG *xf86conf.vim* *ft-xf86conf-syntax*
2463 2463
2464 The syntax of XF86Config file differs in XFree86 v3.x and v4.x. Both 2464 The syntax of XF86Config file differs in XFree86 v3.x and v4.x. Both
2465 variants are supported. Automatic detection is used, but is far from perfect. 2465 variants are supported. Automatic detection is used, but is far from perfect.
2466 You may need to specify the version manually. Set the variable 2466 You may need to specify the version manually. Set the variable
2467 xf86conf_xfree86_version to 3 or 4 according to your XFree86 version in 2467 xf86conf_xfree86_version to 3 or 4 according to your XFree86 version in
2472 Note that spaces and underscores in option names are not supported. Use 2472 Note that spaces and underscores in option names are not supported. Use
2473 "SyncOnGreen" instead of "__s yn con gr_e_e_n" if you want the option name 2473 "SyncOnGreen" instead of "__s yn con gr_e_e_n" if you want the option name
2474 highlighted. 2474 highlighted.
2475 2475
2476 2476
2477 XML *xml.vim* *xml-syntax* 2477 XML *xml.vim* *ft-xml-syntax*
2478 2478
2479 Xml namespaces are highlighted by default. This can be inhibited by 2479 Xml namespaces are highlighted by default. This can be inhibited by
2480 setting a global variable: > 2480 setting a global variable: >
2481 2481
2482 :let g:xml_namespace_transparent=1 2482 :let g:xml_namespace_transparent=1
2490 2490
2491 Note: syntax folding might slow down syntax highlighting significantly, 2491 Note: syntax folding might slow down syntax highlighting significantly,
2492 especially for large files. 2492 especially for large files.
2493 2493
2494 2494
2495 X Pixmaps (XPM) *xpm.vim* *xpm-syntax* 2495 X Pixmaps (XPM) *xpm.vim* *ft-xpm-syntax*
2496 2496
2497 xpm.vim creates its syntax items dynamically based upon the contents of the 2497 xpm.vim creates its syntax items dynamically based upon the contents of the
2498 XPM file. Thus if you make changes e.g. in the color specification strings, 2498 XPM file. Thus if you make changes e.g. in the color specification strings,
2499 you have to source it again e.g. with ":set syn=xpm". 2499 you have to source it again e.g. with ":set syn=xpm".
2500 2500