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