annotate runtime/doc/filetype.txt @ 23047:29c5f168c6fd

Update runtime files Commit: https://github.com/vim/vim/commit/23515b4ef7580af8b9d3b964a558ab2007cacda5 Author: Bram Moolenaar <Bram@vim.org> Date: Sun Nov 29 14:36:24 2020 +0100 Update runtime files
author Bram Moolenaar <Bram@vim.org>
date Sun, 29 Nov 2020 14:45:04 +0100
parents a3bb84cd0f59
children 96206643bd9f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
22441
a3bb84cd0f59 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21825
diff changeset
1 *filetype.txt* For Vim version 8.2. Last change: 2020 Sep 28
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4 VIM REFERENCE MANUAL by Bram Moolenaar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7 Filetypes *filetype* *file-type*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9 1. Filetypes |filetypes|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10 2. Filetype plugin |filetype-plugins|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11 3. Docs for the default filetype plugins. |ftplugin-docs|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
13 Also see |autocmd.txt|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
14
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
15
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
16 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
17 1. Filetypes *filetypes* *file-types*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
18
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
19 Vim can detect the type of file that is edited. This is done by checking the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
20 file name and sometimes by inspecting the contents of the file for specific
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
21 text.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
22
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
23 *:filetype* *:filet*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
24 To enable file type detection, use this command in your vimrc: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
25 :filetype on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
26 Each time a new or existing file is edited, Vim will try to recognize the type
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
27 of the file and set the 'filetype' option. This will trigger the FileType
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
28 event, which can be used to set the syntax highlighting, set options, etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
29
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
30 NOTE: Filetypes and 'compatible' don't work together well, since being Vi
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
31 compatible means options are global. Resetting 'compatible' is recommended,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
32 if you didn't do that already.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
33
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34 Detail: The ":filetype on" command will load one of these files:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35 Amiga $VIMRUNTIME/filetype.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
36 Mac $VIMRUNTIME:filetype.vim
18972
130acb903dbe Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 18879
diff changeset
37 MS-Windows $VIMRUNTIME\filetype.vim
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
38 Unix $VIMRUNTIME/filetype.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
39 VMS $VIMRUNTIME/filetype.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
40 This file is a Vim script that defines autocommands for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
41 BufNewFile and BufRead events. If the file type is not found by the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
42 name, the file $VIMRUNTIME/scripts.vim is used to detect it from the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
43 contents of the file.
12756
3b26420fc639 Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents: 11262
diff changeset
44 When the GUI is running or will start soon, the |menu.vim| script is
1125
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
45 also sourced. See |'go-M'| about avoiding that.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
46
501
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
47 To add your own file types, see |new-filetype| below. To search for help on a
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
48 filetype prepend "ft-" and optionally append "-syntax", "-indent" or
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
49 "-plugin". For example: >
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
50 :help ft-vim-indent
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
51 :help ft-vim-syntax
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
52 :help ft-man-plugin
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
53
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
54 If the file type is not detected automatically, or it finds the wrong type,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
55 you can either set the 'filetype' option manually, or add a modeline to your
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1624
diff changeset
56 file. Example, for an IDL file use the command: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
57 :set filetype=idl
501
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
58
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
59 or add this |modeline| to the file:
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
60 /* vim: set filetype=idl : */ ~
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
61
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
62 *:filetype-plugin-on*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
63 You can enable loading the plugin files for specific file types with: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
64 :filetype plugin on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
65 If filetype detection was not switched on yet, it will be as well.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
66 This actually loads the file "ftplugin.vim" in 'runtimepath'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
67 The result is that when a file is edited its plugin file is loaded (if there
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
68 is one for the detected filetype). |filetype-plugin|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
69
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
70 *:filetype-plugin-off*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
71 You can disable it again with: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
72 :filetype plugin off
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
73 The filetype detection is not switched off then. But if you do switch off
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
74 filetype detection, the plugins will not be loaded either.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
75 This actually loads the file "ftplugof.vim" in 'runtimepath'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
76
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
77 *:filetype-indent-on*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
78 You can enable loading the indent file for specific file types with: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
79 :filetype indent on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
80 If filetype detection was not switched on yet, it will be as well.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
81 This actually loads the file "indent.vim" in 'runtimepath'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
82 The result is that when a file is edited its indent file is loaded (if there
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
83 is one for the detected filetype). |indent-expression|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
84
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
85 *:filetype-indent-off*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
86 You can disable it again with: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
87 :filetype indent off
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
88 The filetype detection is not switched off then. But if you do switch off
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
89 filetype detection, the indent files will not be loaded either.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
90 This actually loads the file "indoff.vim" in 'runtimepath'.
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 10
diff changeset
91 This disables auto-indenting for files you will open. It will keep working in
cc049b00ee70 updated for version 7.0014
vimboss
parents: 10
diff changeset
92 already opened files. Reset 'autoindent', 'cindent', 'smartindent' and/or
cc049b00ee70 updated for version 7.0014
vimboss
parents: 10
diff changeset
93 'indentexpr' to disable indenting in an opened file.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
94
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
95 *:filetype-off*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
96 To disable file type detection, use this command: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
97 :filetype off
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
98 This will keep the flags for "plugin" and "indent", but since no file types
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
99 are being detected, they won't work until the next ":filetype on".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
100
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
101
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
102 Overview: *:filetype-overview*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
103
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
104 command detection plugin indent ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
105 :filetype on on unchanged unchanged
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
106 :filetype off off unchanged unchanged
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
107 :filetype plugin on on on unchanged
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
108 :filetype plugin off unchanged off unchanged
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
109 :filetype indent on on unchanged on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
110 :filetype indent off unchanged unchanged off
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
111 :filetype plugin indent on on on on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
112 :filetype plugin indent off unchanged off off
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
113
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
114 To see the current status, type: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
115 :filetype
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
116 The output looks something like this: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
117 filetype detection:ON plugin:ON indent:OFF
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
118
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
119 The file types are also used for syntax highlighting. If the ":syntax on"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
120 command is used, the file type detection is installed too. There is no need
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
121 to do ":filetype on" after ":syntax on".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
122
1624
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
123 To disable one of the file types, add a line in your filetype file, see
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
124 |remove-filetype|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
125
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
126 *filetype-detect*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
127 To detect the file type again: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
128 :filetype detect
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
129 Use this if you started with an empty file and typed text that makes it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
130 possible to detect the file type. For example, when you entered this in a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
131 shell script: "#!/bin/csh".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
132 When filetype detection was off, it will be enabled first, like the "on"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
133 argument was used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
134
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
135 *filetype-overrule*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
136 When the same extension is used for two filetypes, Vim tries to guess what
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
137 kind of file it is. This doesn't always work. A number of global variables
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
138 can be used to overrule the filetype used for certain extensions:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
139
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
140 file name variable ~
501
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
141 *.asa g:filetype_asa |ft-aspvbs-syntax| |ft-aspperl-syntax|
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
142 *.asp g:filetype_asp |ft-aspvbs-syntax| |ft-aspperl-syntax|
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
143 *.asm g:asmsyntax |ft-asm-syntax|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
144 *.prg g:filetype_prg
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
145 *.pl g:filetype_pl
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
146 *.inc g:filetype_inc
501
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
147 *.w g:filetype_w |ft-cweb-syntax|
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
148 *.i g:filetype_i |ft-progress-syntax|
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
149 *.p g:filetype_p |ft-pascal-syntax|
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
150 *.sh g:bash_is_sh |ft-sh-syntax|
798
95dac6af3b3a updated for version 7.0232
vimboss
parents: 720
diff changeset
151 *.tex g:tex_flavor |ft-tex-plugin|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
152
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
153 *filetype-ignore*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
154 To avoid that certain files are being inspected, the g:ft_ignore_pat variable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
155 is used. The default value is set like this: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
156 :let g:ft_ignore_pat = '\.\(Z\|gz\|bz2\|zip\|tgz\)$'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
157 This means that the contents of compressed files are not inspected.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
158
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
159 *new-filetype*
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 10
diff changeset
160 If a file type that you want to use is not detected yet, there are four ways
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 7
diff changeset
161 to add it. In any way, it's better not to modify the $VIMRUNTIME/filetype.vim
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
162 file. It will be overwritten when installing a new version of Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
163
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
164 A. If you want to overrule all default file type checks.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
165 This works by writing one file for each filetype. The disadvantage is that
21825
0db0640e16e0 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 19116
diff changeset
166 there can be many files. The advantage is that you can simply drop this
0db0640e16e0 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 19116
diff changeset
167 file in the right directory to make it work.
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 10
diff changeset
168 *ftdetect*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
169 1. Create your user runtime directory. You would normally use the first
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
170 item of the 'runtimepath' option. Then create the directory "ftdetect"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
171 inside it. Example for Unix: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
172 :!mkdir ~/.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
173 :!mkdir ~/.vim/ftdetect
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
174 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
175 2. Create a file that contains an autocommand to detect the file type.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
176 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
177 au BufRead,BufNewFile *.mine set filetype=mine
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
178 < Note that there is no "augroup" command, this has already been done
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
179 when sourcing your file. You could also use the pattern "*" and then
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
180 check the contents of the file to recognize it.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
181 Write this file as "mine.vim" in the "ftdetect" directory in your user
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
182 runtime directory. For example, for Unix: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
183 :w ~/.vim/ftdetect/mine.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
184
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
185 < 3. To use the new filetype detection you must restart Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
186
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
187 The files in the "ftdetect" directory are used after all the default
530
339999b511a0 updated for version 7.0148
vimboss
parents: 501
diff changeset
188 checks, thus they can overrule a previously detected file type. But you
339999b511a0 updated for version 7.0148
vimboss
parents: 501
diff changeset
189 can also use |:setfiletype| to keep a previously detected filetype.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
190
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
191 B. If you want to detect your file after the default file type checks.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
192
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
193 This works like A above, but instead of setting 'filetype' unconditionally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
194 use ":setfiletype". This will only set 'filetype' if no file type was
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
195 detected yet. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
196 au BufRead,BufNewFile *.txt setfiletype text
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
197 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
198 You can also use the already detected file type in your command. For
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
199 example, to use the file type "mypascal" when "pascal" has been detected: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
200 au BufRead,BufNewFile * if &ft == 'pascal' | set ft=mypascal
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
201 | endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
202
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
203 C. If your file type can be detected by the file name.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
204 1. Create your user runtime directory. You would normally use the first
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
205 item of the 'runtimepath' option. Example for Unix: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
206 :!mkdir ~/.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
207 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
208 2. Create a file that contains autocommands to detect the file type.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
209 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
210 " my filetype file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
211 if exists("did_load_filetypes")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
212 finish
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
213 endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
214 augroup filetypedetect
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
215 au! BufRead,BufNewFile *.mine setfiletype mine
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
216 au! BufRead,BufNewFile *.xyz setfiletype drawing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
217 augroup END
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
218 < Write this file as "filetype.vim" in your user runtime directory. For
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
219 example, for Unix: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
220 :w ~/.vim/filetype.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
221
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
222 < 3. To use the new filetype detection you must restart Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
223
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
224 Your filetype.vim will be sourced before the default FileType autocommands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
225 have been installed. Your autocommands will match first, and the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
226 ":setfiletype" command will make sure that no other autocommands will set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
227 'filetype' after this.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
228 *new-filetype-scripts*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
229 D. If your filetype can only be detected by inspecting the contents of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
230 file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
231
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
232 1. Create your user runtime directory. You would normally use the first
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
233 item of the 'runtimepath' option. Example for Unix: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
234 :!mkdir ~/.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
235 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
236 2. Create a vim script file for doing this. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
237 if did_filetype() " filetype already set..
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
238 finish " ..don't do these checks
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
239 endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
240 if getline(1) =~ '^#!.*\<mine\>'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
241 setfiletype mine
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
242 elseif getline(1) =~? '\<drawing\>'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
243 setfiletype drawing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
244 endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
245 < See $VIMRUNTIME/scripts.vim for more examples.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
246 Write this file as "scripts.vim" in your user runtime directory. For
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
247 example, for Unix: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
248 :w ~/.vim/scripts.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
249 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
250 3. The detection will work right away, no need to restart Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
251
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
252 Your scripts.vim is loaded before the default checks for file types, which
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
253 means that your rules override the default rules in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
254 $VIMRUNTIME/scripts.vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
255
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
256 *remove-filetype*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
257 If a file type is detected that is wrong for you, install a filetype.vim or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
258 scripts.vim to catch it (see above). You can set 'filetype' to a non-existing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
259 name to avoid that it will be set later anyway: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
260 :set filetype=ignored
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
261
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
262 If you are setting up a system with many users, and you don't want each user
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
263 to add/remove the same filetypes, consider writing the filetype.vim and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
264 scripts.vim files in a runtime directory that is used for everybody. Check
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
265 the 'runtimepath' for a directory to use. If there isn't one, set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
266 'runtimepath' in the |system-vimrc|. Be careful to keep the default
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
267 directories!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
268
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
269
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
270 *autocmd-osfiletypes*
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
271 NOTE: this code is currently disabled, as the RISC OS implementation was
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
272 removed. In the future this will use the 'filetype' option.
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
273
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
274 On operating systems which support storing a file type with the file, you can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
275 specify that an autocommand should only be executed if the file is of a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
276 certain type.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
277
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
278 The actual type checking depends on which platform you are running Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
279 on; see your system's documentation for details.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
280
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
281 To use osfiletype checking in an autocommand you should put a list of types to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
282 match in angle brackets in place of a pattern, like this: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
283
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
284 :au BufRead *.html,<&faf;HTML> runtime! syntax/html.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
285
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
286 This will match:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
287
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1624
diff changeset
288 - Any file whose name ends in ".html"
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1624
diff changeset
289 - Any file whose type is "&faf" or "HTML", where the meaning of these types
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
290 depends on which version of Vim you are using.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
291 Unknown types are considered NOT to match.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
292
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
293 You can also specify a type and a pattern at the same time (in which case they
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
294 must both match): >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
295
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
296 :au BufRead <&fff>diff*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
297
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1624
diff changeset
298 This will match files of type "&fff" whose names start with "diff".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
299
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
300
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
301 *plugin-details*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
302 The "plugin" directory can be in any of the directories in the 'runtimepath'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
303 option. All of these directories will be searched for plugins and they are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
304 all loaded. For example, if this command: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
305
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
306 set runtimepath
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
307
1125
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
308 produces this output:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
309
19116
9b7f90e56753 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 18972
diff changeset
310 runtimepath=/etc/vim,~/.vim,/usr/local/share/vim/vim82 ~
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
311
1125
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
312 then Vim will load all plugins in these directories and below:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
313
1125
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
314 /etc/vim/plugin/ ~
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
315 ~/.vim/plugin/ ~
19116
9b7f90e56753 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 18972
diff changeset
316 /usr/local/share/vim/vim82/plugin/ ~
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
317
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
318 Note that the last one is the value of $VIMRUNTIME which has been expanded.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
319
13735
a62eeee5f116 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
320 Note that when using a plugin manager or |packages| many directories will be
14249
4543777545a3 Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
321 added to 'runtimepath'. These plugins each require their own directory, don't
4543777545a3 Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
322 put them directly in ~/.vim/plugin.
13735
a62eeee5f116 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
323
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
324 What if it looks like your plugin is not being loaded? You can find out what
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
325 happens when Vim starts up by using the |-V| argument: >
1125
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
326
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
327 vim -V2
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
328
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
329 You will see a lot of messages, in between them is a remark about loading the
1125
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
330 plugins. It starts with:
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
331
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
332 Searching for "plugin/**/*.vim" in ~
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
333
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
334 There you can see where Vim looks for your plugin scripts.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
335
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
336 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
337 2. Filetype plugin *filetype-plugins*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
338
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
339 When loading filetype plugins has been enabled |:filetype-plugin-on|, options
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
340 will be set and mappings defined. These are all local to the buffer, they
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
341 will not be used for other files.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
342
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
343 Defining mappings for a filetype may get in the way of the mappings you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
344 define yourself. There are a few ways to avoid this:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
345 1. Set the "maplocalleader" variable to the key sequence you want the mappings
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
346 to start with. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
347 :let maplocalleader = ","
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
348 < All mappings will then start with a comma instead of the default, which
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
349 is a backslash. Also see |<LocalLeader>|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
350
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
351 2. Define your own mapping. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
352 :map ,p <Plug>MailQuote
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
353 < You need to check the description of the plugin file below for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
354 functionality it offers and the string to map to.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
355 You need to define your own mapping before the plugin is loaded (before
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
356 editing a file of that type). The plugin will then skip installing the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
357 default mapping.
11262
214f228718cf Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11229
diff changeset
358 *no_mail_maps*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
359 3. Disable defining mappings for a specific filetype by setting a variable,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
360 which contains the name of the filetype. For the "mail" filetype this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
361 would be: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
362 :let no_mail_maps = 1
11262
214f228718cf Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11229
diff changeset
363 < *no_plugin_maps*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
364 4. Disable defining mappings for all filetypes by setting a variable: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
365 :let no_plugin_maps = 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
366 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
367
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
368 *ftplugin-overrule*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
369 If a global filetype plugin does not do exactly what you want, there are three
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
370 ways to change this:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
371
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
372 1. Add a few settings.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
373 You must create a new filetype plugin in a directory early in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
374 'runtimepath'. For Unix, for example you could use this file: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
375 vim ~/.vim/ftplugin/fortran.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
376 < You can set those settings and mappings that you would like to add. Note
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
377 that the global plugin will be loaded after this, it may overrule the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
378 settings that you do here. If this is the case, you need to use one of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
379 following two methods.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
380
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
381 2. Make a copy of the plugin and change it.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
382 You must put the copy in a directory early in 'runtimepath'. For Unix, for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
383 example, you could do this: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
384 cp $VIMRUNTIME/ftplugin/fortran.vim ~/.vim/ftplugin/fortran.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
385 < Then you can edit the copied file to your liking. Since the b:did_ftplugin
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
386 variable will be set, the global plugin will not be loaded.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
387 A disadvantage of this method is that when the distributed plugin gets
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
388 improved, you will have to copy and modify it again.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
389
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
390 3. Overrule the settings after loading the global plugin.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
391 You must create a new filetype plugin in a directory from the end of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
392 'runtimepath'. For Unix, for example, you could use this file: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
393 vim ~/.vim/after/ftplugin/fortran.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
394 < In this file you can change just those settings that you want to change.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
395
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
396 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
397 3. Docs for the default filetype plugins. *ftplugin-docs*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
398
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
399
22441
a3bb84cd0f59 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21825
diff changeset
400 AWK *ft-awk-plugin*
a3bb84cd0f59 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21825
diff changeset
401
a3bb84cd0f59 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21825
diff changeset
402 Support for features specific to GNU Awk, like @include, can be enabled by
a3bb84cd0f59 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21825
diff changeset
403 setting: >
a3bb84cd0f59 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21825
diff changeset
404 let g:awk_is_gawk = 1
a3bb84cd0f59 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21825
diff changeset
405
a3bb84cd0f59 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21825
diff changeset
406
501
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
407 CHANGELOG *ft-changelog-plugin*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
408
237
73354c21f1e4 updated for version 7.0066
vimboss
parents: 22
diff changeset
409 Allows for easy entrance of Changelog entries in Changelog files. There are
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
410 some commands, mappings, and variables worth exploring:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
411
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
412 Options:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
413 'comments' is made empty to not mess up formatting.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
414 'textwidth' is set to 78, which is standard.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
415 'formatoptions' the 't' flag is added to wrap when inserting text.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
416
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
417 Commands:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
418 NewChangelogEntry Adds a new Changelog entry in an intelligent fashion
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
419 (see below).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
420
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
421 Local mappings:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
422 <Leader>o Starts a new Changelog entry in an equally intelligent
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
423 fashion (see below).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
424
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
425 Global mappings:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
426 NOTE: The global mappings are accessed by sourcing the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
427 ftplugin/changelog.vim file first, e.g. with >
497
73f10d8124f4 updated for version 7.0136
vimboss
parents: 237
diff changeset
428 runtime ftplugin/changelog.vim
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
429 < in your |.vimrc|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
430 <Leader>o Switches to the ChangeLog buffer opened for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
431 current directory, or opens it in a new buffer if it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
432 exists in the current directory. Then it does the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
433 same as the local <Leader>o described above.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
434
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
435 Variables:
1226
a49d06539452 updated for version 7.1b
vimboss
parents: 1125
diff changeset
436 g:changelog_timeformat Deprecated; use g:changelog_dateformat instead.
a49d06539452 updated for version 7.1b
vimboss
parents: 1125
diff changeset
437 g:changelog_dateformat The date (and time) format used in ChangeLog entries.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
438 The format accepted is the same as for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
439 |strftime()| function.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
440 The default is "%Y-%m-%d" which is the standard format
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
441 for many ChangeLog layouts.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
442 g:changelog_username The name and email address of the user.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
443 The default is deduced from environment variables and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
444 system files. It searches /etc/passwd for the comment
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
445 part of the current user, which informally contains
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
446 the real name of the user up to the first separating
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
447 comma. then it checks the $NAME environment variable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
448 and finally runs `whoami` and `hostname` to build an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
449 email address. The final form is >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
450 Full Name <user@host>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
451 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
452 g:changelog_new_date_format
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
453 The format to use when creating a new date-entry.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
454 The following table describes special tokens in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
455 string:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
456 %% insert a single '%' character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
457 %d insert the date from above
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
458 %u insert the user from above
5568
2f856c7c1d43 Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 5294
diff changeset
459 %p insert result of b:changelog_entry_prefix
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
460 %c where to position cursor when done
5568
2f856c7c1d43 Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 5294
diff changeset
461 The default is "%d %u\n\n\t* %p%c\n\n", which produces
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
462 something like (| is where cursor will be, unless at
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
463 the start of the line where it denotes the beginning
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
464 of the line) >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
465 |2003-01-14 Full Name <user@host>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
466 |
5568
2f856c7c1d43 Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 5294
diff changeset
467 | * prefix|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
468 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
469 g:changelog_new_entry_format
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
470 The format used when creating a new entry.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
471 The following table describes special tokens in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
472 string:
5568
2f856c7c1d43 Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 5294
diff changeset
473 %p insert result of b:changelog_entry_prefix
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
474 %c where to position cursor when done
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
475 The default is "\t*%c", which produces something
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
476 similar to >
5568
2f856c7c1d43 Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 5294
diff changeset
477 | * prefix|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
478 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
479 g:changelog_date_entry_search
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
480 The search pattern to use when searching for a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
481 date-entry.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
482 The same tokens that can be used for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
483 g:changelog_new_date_format can be used here as well.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
484 The default is '^\s*%d\_s*%u' which finds lines
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
485 matching the form >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
486 |2003-01-14 Full Name <user@host>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
487 < and some similar formats.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
488
1226
a49d06539452 updated for version 7.1b
vimboss
parents: 1125
diff changeset
489 g:changelog_date_end_entry_search
a49d06539452 updated for version 7.1b
vimboss
parents: 1125
diff changeset
490 The search pattern to use when searching for the end
a49d06539452 updated for version 7.1b
vimboss
parents: 1125
diff changeset
491 of a date-entry.
a49d06539452 updated for version 7.1b
vimboss
parents: 1125
diff changeset
492 The same tokens that can be used for
a49d06539452 updated for version 7.1b
vimboss
parents: 1125
diff changeset
493 g:changelog_new_date_format can be used here as well.
a49d06539452 updated for version 7.1b
vimboss
parents: 1125
diff changeset
494 The default is '^\s*$' which finds lines that contain
a49d06539452 updated for version 7.1b
vimboss
parents: 1125
diff changeset
495 only whitespace or are completely empty.
a49d06539452 updated for version 7.1b
vimboss
parents: 1125
diff changeset
496
1698
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
497 b:changelog_name *b:changelog_name*
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
498 Name of the ChangeLog file to look for.
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
499 The default is 'ChangeLog'.
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
500
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
501 b:changelog_path
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
502 Path of the ChangeLog to use for the current buffer.
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
503 The default is empty, thus looking for a file named
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
504 |b:changelog_name| in the same directory as the
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
505 current buffer. If not found, the parent directory of
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
506 the current buffer is searched. This continues
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
507 recursively until a file is found or there are no more
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
508 parent directories to search.
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
509
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
510 b:changelog_entry_prefix
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
511 Name of a function to call to generate a prefix to a
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
512 new entry. This function takes no arguments and
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
513 should return a string containing the prefix.
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
514 Returning an empty prefix is fine.
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
515 The default generates the shortest path between the
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
516 ChangeLog's pathname and the current buffers pathname.
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
517 In the future, it will also be possible to use other
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
518 variable contexts for this variable, for example, g:.
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
519
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
520 The Changelog entries are inserted where they add the least amount of text.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
521 After figuring out the current date and user, the file is searched for an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
522 entry beginning with the current date and user and if found adds another item
237
73354c21f1e4 updated for version 7.0066
vimboss
parents: 22
diff changeset
523 under it. If not found, a new entry and item is prepended to the beginning of
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
524 the Changelog.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
525
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
526
501
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
527 FORTRAN *ft-fortran-plugin*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
528
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
529 Options:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
530 'expandtab' is switched on to avoid tabs as required by the Fortran
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
531 standards unless the user has set fortran_have_tabs in .vimrc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
532 'textwidth' is set to 72 for fixed source format as required by the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
533 Fortran standards and to 80 for free source format.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
534 'formatoptions' is set to break code and comment lines and to preserve long
237
73354c21f1e4 updated for version 7.0066
vimboss
parents: 22
diff changeset
535 lines. You can format comments with |gq|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
536 For further discussion of fortran_have_tabs and the method used for the
501
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
537 detection of source format see |ft-fortran-syntax|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
538
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
539
1624
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
540 GIT COMMIT *ft-gitcommit-plugin*
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
541
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
542 One command, :DiffGitCached, is provided to show a diff of the current commit
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
543 in the preview window. It is equivalent to calling "git diff --cached" plus
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
544 any arguments given to the command.
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
545
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
546
501
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
547 MAIL *ft-mail-plugin*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
548
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
549 Options:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
550 'modeline' is switched off to avoid the danger of trojan horses, and to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
551 avoid that a Subject line with "Vim:" in it will cause an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
552 error message.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
553 'textwidth' is set to 72. This is often recommended for e-mail.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
554 'formatoptions' is set to break text lines and to repeat the comment leader
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
555 in new lines, so that a leading ">" for quotes is repeated.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
556 You can also format quoted text with |gq|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
557
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
558 Local mappings:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
559 <LocalLeader>q or \\MailQuote
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
560 Quotes the text selected in Visual mode, or from the cursor position
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
561 to the end of the file in Normal mode. This means "> " is inserted in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
562 each line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
563
7315
444efa5f5015 commit https://github.com/vim/vim/commit/2c5e8e80eacf491d4f266983f534a77776c7ae83
Christian Brabandt <cb@256bit.org>
parents: 7272
diff changeset
564 MAN *ft-man-plugin* *:Man* *man.vim*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
565
23047
29c5f168c6fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 22441
diff changeset
566 This plugin displays a manual page in a nice way. See |find-manpage| in the
29c5f168c6fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 22441
diff changeset
567 user manual for more information.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
568
23047
29c5f168c6fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 22441
diff changeset
569 To start using the |:Man| command before any manual page has been loaded,
29c5f168c6fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 22441
diff changeset
570 source this script from your startup |vimrc| file: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
571 runtime ftplugin/man.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
572
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
573 Options:
23047
29c5f168c6fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 22441
diff changeset
574 'iskeyword' The '.' character is added to support the use of CTRL-] on the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
575 manual page name.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
576
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
577 Commands:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
578 Man {name} Display the manual page for {name} in a window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
579 Man {number} {name}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
580 Display the manual page for {name} in a section {number}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
581
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
582 Global mapping:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
583 <Leader>K Displays the manual page for the word under the cursor.
23047
29c5f168c6fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 22441
diff changeset
584 <Plug>ManPreGetPage
29c5f168c6fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 22441
diff changeset
585 idem, allows for using a mapping: >
29c5f168c6fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 22441
diff changeset
586 nmap <F1> <Plug>ManPreGetPage
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
587
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
588 Local mappings:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
589 CTRL-] Jump to the manual page for the word under the cursor.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
590 CTRL-T Jump back to the previous manual page.
23047
29c5f168c6fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 22441
diff changeset
591 q Same as the |:quit| command.
7272
17333ebd2bbd commit https://github.com/vim/vim/commit/d042dc825c9b97dacd84d4728f88300da4d5b6b9
Christian Brabandt <cb@256bit.org>
parents: 5568
diff changeset
592
9344
33c1b85d408c commit https://github.com/vim/vim/commit/802a0d902fca423acb15f835d7b09183883d79a0
Christian Brabandt <cb@256bit.org>
parents: 9116
diff changeset
593 To use a vertical split instead of horizontal: >
33c1b85d408c commit https://github.com/vim/vim/commit/802a0d902fca423acb15f835d7b09183883d79a0
Christian Brabandt <cb@256bit.org>
parents: 9116
diff changeset
594 let g:ft_man_open_mode = 'vert'
33c1b85d408c commit https://github.com/vim/vim/commit/802a0d902fca423acb15f835d7b09183883d79a0
Christian Brabandt <cb@256bit.org>
parents: 9116
diff changeset
595 To use a new tab: >
33c1b85d408c commit https://github.com/vim/vim/commit/802a0d902fca423acb15f835d7b09183883d79a0
Christian Brabandt <cb@256bit.org>
parents: 9116
diff changeset
596 let g:ft_man_open_mode = 'tab'
33c1b85d408c commit https://github.com/vim/vim/commit/802a0d902fca423acb15f835d7b09183883d79a0
Christian Brabandt <cb@256bit.org>
parents: 9116
diff changeset
597
23047
29c5f168c6fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 22441
diff changeset
598 To enable |folding|, use this: >
29c5f168c6fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 22441
diff changeset
599 let g:ft_man_folding_enable = 1
29c5f168c6fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 22441
diff changeset
600 If you do not like the default folding, use an |autocommand| to add your desired
7384
aea5ebf352c4 commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents: 7315
diff changeset
601 folding style instead. For example: >
23047
29c5f168c6fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 22441
diff changeset
602 autocmd FileType man setlocal foldmethod=indent foldenable
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
603
18186
03b854983b14 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 17433
diff changeset
604 If you would like :Man {number} {name} to behave like man {number} {name} by
03b854983b14 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 17433
diff changeset
605 not running man {name} if no page is found, then use this: >
03b854983b14 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 17433
diff changeset
606 let g:ft_man_no_sect_fallback = 1
03b854983b14 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 17433
diff changeset
607
9116
bc38030aec7d commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb
Christian Brabandt <cb@256bit.org>
parents: 9041
diff changeset
608 You may also want to set 'keywordprg' to make the |K| command open a manual
bc38030aec7d commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb
Christian Brabandt <cb@256bit.org>
parents: 9041
diff changeset
609 page in a Vim window: >
bc38030aec7d commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb
Christian Brabandt <cb@256bit.org>
parents: 9041
diff changeset
610 set keywordprg=:Man
bc38030aec7d commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb
Christian Brabandt <cb@256bit.org>
parents: 9041
diff changeset
611
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
612
9041
34c45ee4210d commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents: 7384
diff changeset
613 MANPAGER *manpager.vim*
34c45ee4210d commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents: 7384
diff changeset
614
23047
29c5f168c6fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 22441
diff changeset
615 The |:Man| command allows you to turn Vim into a manpager (that syntax highlights
9041
34c45ee4210d commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents: 7384
diff changeset
616 manpages and follows linked manpages on hitting CTRL-]).
34c45ee4210d commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents: 7384
diff changeset
617
12826
f690da1b3c04 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
618 For bash,zsh,ksh or dash, add to the config file (.bashrc,.zshrc, ...)
9041
34c45ee4210d commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents: 7384
diff changeset
619
13231
167a030448fa Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13051
diff changeset
620 export MANPAGER="vim -M +MANPAGER -"
9041
34c45ee4210d commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents: 7384
diff changeset
621
12826
f690da1b3c04 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
622 For (t)csh, add to the config file
f690da1b3c04 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
623
13231
167a030448fa Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13051
diff changeset
624 setenv MANPAGER "vim -M +MANPAGER -"
12826
f690da1b3c04 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
625
f690da1b3c04 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
626 For fish, add to the config file
f690da1b3c04 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
627
13231
167a030448fa Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13051
diff changeset
628 set -x MANPAGER "vim -M +MANPAGER -"
9041
34c45ee4210d commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents: 7384
diff changeset
629
1624
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
630 PDF *ft-pdf-plugin*
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
631
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
632 Two maps, <C-]> and <C-T>, are provided to simulate a tag stack for navigating
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
633 the PDF. The following are treated as tags:
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
634
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
635 - The byte offset after "startxref" to the xref table
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
636 - The byte offset after the /Prev key in the trailer to an earlier xref table
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
637 - A line of the form "0123456789 00000 n" in the xref table
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
638 - An object reference like "1 0 R" anywhere in the PDF
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
639
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
640 These maps can be disabled with >
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
641 :let g:no_pdf_maps = 1
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
642 <
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
643
10186
a5ef9968638c commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
644 PYTHON *ft-python-plugin* *PEP8*
a5ef9968638c commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
645
a5ef9968638c commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
646 By default the following options are set, in accordance with PEP8: >
a5ef9968638c commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
647
a5ef9968638c commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
648 setlocal expandtab shiftwidth=4 softtabstop=4 tabstop=8
a5ef9968638c commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
649
14637
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
650 To disable this behavior, set the following variable in your vimrc: >
13231
167a030448fa Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13051
diff changeset
651
10186
a5ef9968638c commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
652 let g:python_recommended_style = 0
a5ef9968638c commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
653
a5ef9968638c commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
654
17433
ca8e754bdd53 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
655 QF QUICKFIX *qf.vim* *ft-qf-plugin*
ca8e754bdd53 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
656
ca8e754bdd53 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
657 The "qf" filetype is used for the quickfix window, see |quickfix-window|.
ca8e754bdd53 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
658
ca8e754bdd53 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
659 The quickfix filetype plugin includes configuration for displaying the command
ca8e754bdd53 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
660 that produced the quickfix list in the |status-line|. To disable this setting,
ca8e754bdd53 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
661 configure as follows: >
ca8e754bdd53 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
662 :let g:qf_disable_statusline = 1
ca8e754bdd53 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
663
ca8e754bdd53 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
664
14637
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
665 R MARKDOWN *ft-rmd-plugin*
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
666
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
667 By default ftplugin/html.vim is not sourced. If you want it sourced, add to
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
668 your |vimrc|: >
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
669 let rmd_include_html = 1
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
670
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
671 The 'formatexpr' option is set dynamically with different values for R code
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
672 and for Markdown code. If you prefer that 'formatexpr' is not set, add to your
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
673 |vimrc|: >
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
674 let rmd_dynamic_comments = 0
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
675
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
676
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
677 R RESTRUCTURED TEXT *ft-rrst-plugin*
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
678
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
679 The 'formatexpr' option is set dynamically with different values for R code
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
680 and for ReStructured text. If you prefer that 'formatexpr' is not set, add to
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
681 your |vimrc|: >
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
682 let rrst_dynamic_comments = 0
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
683
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
684
15878
314694a2e74a Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14637
diff changeset
685 RESTRUCTUREDTEXT *ft-rst-plugin*
314694a2e74a Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14637
diff changeset
686
314694a2e74a Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14637
diff changeset
687 The following formatting setting are optionally available: >
314694a2e74a Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14637
diff changeset
688 setlocal expandtab shiftwidth=3 softtabstop=3 tabstop=8
314694a2e74a Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14637
diff changeset
689
314694a2e74a Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14637
diff changeset
690 To enable this behavior, set the following variable in your vimrc: >
314694a2e74a Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14637
diff changeset
691 let g:rst_style = 1
314694a2e74a Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14637
diff changeset
692
314694a2e74a Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14637
diff changeset
693
501
ce2181d14aa0 updated for version 7.0139
vimboss
parents: 497
diff changeset
694 RPM SPEC *ft-spec-plugin*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
695
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
696 Since the text for this plugin is rather long it has been put in a separate
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
697 file: |pi_spec.txt|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
698
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
699
11229
146a1e213b60 Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents: 10548
diff changeset
700 RUST *ft-rust*
146a1e213b60 Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents: 10548
diff changeset
701
146a1e213b60 Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents: 10548
diff changeset
702 Since the text for this plugin is rather long it has been put in a separate
146a1e213b60 Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents: 10548
diff changeset
703 file: |ft_rust.txt|.
146a1e213b60 Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents: 10548
diff changeset
704
146a1e213b60 Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents: 10548
diff changeset
705
720
e180933b876a updated for version 7.0219
vimboss
parents: 530
diff changeset
706 SQL *ft-sql*
e180933b876a updated for version 7.0219
vimboss
parents: 530
diff changeset
707
e180933b876a updated for version 7.0219
vimboss
parents: 530
diff changeset
708 Since the text for this plugin is rather long it has been put in a separate
1624
18ee39301b82 updated for version 7.2a
vimboss
parents: 1278
diff changeset
709 file: |ft_sql.txt|.
720
e180933b876a updated for version 7.0219
vimboss
parents: 530
diff changeset
710
e180933b876a updated for version 7.0219
vimboss
parents: 530
diff changeset
711
4681
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2908
diff changeset
712 TEX *ft-tex-plugin* *g:tex_flavor*
798
95dac6af3b3a updated for version 7.0232
vimboss
parents: 720
diff changeset
713
95dac6af3b3a updated for version 7.0232
vimboss
parents: 720
diff changeset
714 If the first line of a *.tex file has the form >
95dac6af3b3a updated for version 7.0232
vimboss
parents: 720
diff changeset
715 %&<format>
95dac6af3b3a updated for version 7.0232
vimboss
parents: 720
diff changeset
716 then this determined the file type: plaintex (for plain TeX), context (for
95dac6af3b3a updated for version 7.0232
vimboss
parents: 720
diff changeset
717 ConTeXt), or tex (for LaTeX). Otherwise, the file is searched for keywords to
800
d8f905020502 updated for version 7.0b
vimboss
parents: 798
diff changeset
718 choose context or tex. If no keywords are found, it defaults to plaintex.
d8f905020502 updated for version 7.0b
vimboss
parents: 798
diff changeset
719 You can change the default by defining the variable g:tex_flavor to the format
851
e73f2978bd40 updated for version 7.0f04
vimboss
parents: 842
diff changeset
720 (not the file type) you use most. Use one of these: >
e73f2978bd40 updated for version 7.0f04
vimboss
parents: 842
diff changeset
721 let g:tex_flavor = "plain"
e73f2978bd40 updated for version 7.0f04
vimboss
parents: 842
diff changeset
722 let g:tex_flavor = "context"
e73f2978bd40 updated for version 7.0f04
vimboss
parents: 842
diff changeset
723 let g:tex_flavor = "latex"
e73f2978bd40 updated for version 7.0f04
vimboss
parents: 842
diff changeset
724 Currently no other formats are recognized.
798
95dac6af3b3a updated for version 7.0232
vimboss
parents: 720
diff changeset
725
95dac6af3b3a updated for version 7.0232
vimboss
parents: 720
diff changeset
726
13051
a6d3e2081544 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
727 VIM *ft-vim-plugin*
a6d3e2081544 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
728
a6d3e2081544 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
729 The Vim filetype plugin defines mappings to move to the start and end of
a6d3e2081544 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
730 functions with [[ and ]]. Move around comments with ]" and [".
a6d3e2081544 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
731
a6d3e2081544 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
732 The mappings can be disabled with: >
a6d3e2081544 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
733 let g:no_vim_maps = 1
a6d3e2081544 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
734
a6d3e2081544 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
735
a6d3e2081544 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
736 ZIMBU *ft-zimbu-plugin*
a6d3e2081544 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
737
a6d3e2081544 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
738 The Zimbu filetype plugin defines mappings to move to the start and end of
a6d3e2081544 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
739 functions with [[ and ]].
a6d3e2081544 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
740
a6d3e2081544 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
741 The mappings can be disabled with: >
a6d3e2081544 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
742 let g:no_zimbu_maps = 1
a6d3e2081544 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
743 <
a6d3e2081544 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
744
a6d3e2081544 Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12826
diff changeset
745
14421
2f7e67dd088c Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14249
diff changeset
746 vim:tw=78:ts=8:noet:ft=help:norl: