Mercurial > vim

comparison runtime/doc/options.txt @ 819:23f82b5d2814 v7.0c10

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
updated for version 7.0c10
author vimboss
date Wed, 05 Apr 2006 20:41:53 +0000
parents 1f929f3ca806
children 8dd456c1e283
comparison
equal deleted inserted replaced
818:1f929f3ca806 819:23f82b5d2814
1 *options.txt* For Vim version 7.0c. Last change: 2006 Mar 29 1 *options.txt* For Vim version 7.0c. Last change: 2006 Apr 05
2 2
3 3
4 VIM REFERENCE MANUAL by Bram Moolenaar 4 VIM REFERENCE MANUAL by Bram Moolenaar
5 5
6 6
682 open a file, switch buffers, delete a buffer or open/close a window. 682 open a file, switch buffers, delete a buffer or open/close a window.
683 It will change to the directory containing the file which was opened 683 It will change to the directory containing the file which was opened
684 or selected. 684 or selected.
685 This option is provided for backward compatibility with the Vim 685 This option is provided for backward compatibility with the Vim
686 released with Sun ONE Studio 4 Enterprise Edition. 686 released with Sun ONE Studio 4 Enterprise Edition.
687 Note: When this option is on some plugins may not work. The directory 687 Note: When this option is on some plugins may not work.
688 browser sets if off.
689 688
690 *'arabic'* *'arab'* *'noarabic'* *'noarab'* 689 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
691 'arabic' 'arab' boolean (default off) 690 'arabic' 'arab' boolean (default off)
692 local to window 691 local to window
693 {not in Vi} 692 {not in Vi}
1486 A template for a comment. The "%s" in the value is replaced with the 1485 A template for a comment. The "%s" in the value is replaced with the
1487 comment text. Currently only used to add markers for folding, see 1486 comment text. Currently only used to add markers for folding, see
1488 |fold-marker|. 1487 |fold-marker|.
1489 1488
1490 *'compatible'* *'cp'* *'nocompatible'* *'nocp'* 1489 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
1491 'compatible' 'cp' boolean (default on, off when a .vimrc or .gvimrc file 1490 'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1492 is found) 1491 file is found)
1493 global 1492 global
1494 {not in Vi} 1493 {not in Vi}
1495 This option has the effect of making Vim either more Vi-compatible, or 1494 This option has the effect of making Vim either more Vi-compatible, or
1496 make Vim behave in a more useful way. 1495 make Vim behave in a more useful way.
1497 This is a special kind of option, because when it's set or reset, 1496 This is a special kind of option, because when it's set or reset,
1502 very start. 1501 very start.
1503 By default this option is on and the Vi defaults are used for the 1502 By default this option is on and the Vi defaults are used for the
1504 options. This default was chosen for those people who want to use Vim 1503 options. This default was chosen for those people who want to use Vim
1505 just like Vi, and don't even (want to) know about the 'compatible' 1504 just like Vi, and don't even (want to) know about the 'compatible'
1506 option. 1505 option.
1507 When a ".vimrc" or ".gvimrc" file is found while Vim is starting up, 1506 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
1508 this option is switched off, and all options that have not been 1507 this option is switched off, and all options that have not been
1509 modified will be set to the Vim defaults. Effectively, this means 1508 modified will be set to the Vim defaults. Effectively, this means
1510 that when a ".vimrc" or ".gvimrc" file exists, Vim will use the Vim 1509 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
1511 defaults, otherwise it will use the Vi defaults. (Note: This doesn't 1510 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
1512 happen for the system-wide vimrc or gvimrc file). Also see 1511 happen for the system-wide vimrc or gvimrc file). Also see
1513 |compatible-default| and |posix-compliance|. 1512 |compatible-default| and |posix-compliance|.
1514 You can also set this option with the "-C" argument, and reset it with 1513 You can also set this option with the "-C" argument, and reset it with
1515 "-N". See |-C| and |-N|. 1514 "-N". See |-C| and |-N|.
2717 Example: > 2716 Example: >
2718 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:- 2717 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2719 < This is similar to the default, except that these characters will also 2718 < This is similar to the default, except that these characters will also
2720 be used when there is highlighting. 2719 be used when there is highlighting.
2721 2720
2721 for "stl" and "stlnc" only single-byte values are supported.
2722
2722 The highlighting used for these items: 2723 The highlighting used for these items:
2723 item highlight group ~ 2724 item highlight group ~
2724 stl:c StatusLine |hl-StatusLine| 2725 stl:c StatusLine |hl-StatusLine|
2725 stlnc:c StatusLineNC |hl-StatusLineNC| 2726 stlnc:c StatusLineNC |hl-StatusLineNC|
2726 vert:c VertSplit |hl-VertSplit| 2727 vert:c VertSplit |hl-VertSplit|
2892 mark jumping to a mark: "'m", CTRL-O, etc. 2893 mark jumping to a mark: "'m", CTRL-O, etc.
2893 percent "%" 2894 percent "%"
2894 quickfix ":cn", ":crew", ":make", etc. 2895 quickfix ":cn", ":crew", ":make", etc.
2895 search search for a pattern: "/", "n", "*", "gd", etc. 2896 search search for a pattern: "/", "n", "*", "gd", etc.
2896 (not for a search pattern in a ":" command) 2897 (not for a search pattern in a ":" command)
2898 Also for |[s| and |]s|.
2897 tag jumping to a tag: ":ta", CTRL-T, etc. 2899 tag jumping to a tag: ":ta", CTRL-T, etc.
2898 undo undo or redo: "u" and CTRL-R 2900 undo undo or redo: "u" and CTRL-R
2899 When the command is part of a mapping this option is not used. Add 2901 When the command is part of a mapping this option is not used. Add
2900 the |zv| command to the mapping to get the same effect. 2902 the |zv| command to the mapping to get the same effect.
2901 When a movement command is used for an operator (e.g., "dl" or "y%") 2903 When a movement command is used for an operator (e.g., "dl" or "y%")
3330 where it was started. Use this for programs that wait for the 3332 where it was started. Use this for programs that wait for the
3331 editor to finish (e.g., an e-mail program). Alternatively you 3333 editor to finish (e.g., an e-mail program). Alternatively you
3332 can use "gvim -f" or ":gui -f" to start the GUI in the 3334 can use "gvim -f" or ":gui -f" to start the GUI in the
3333 foreground. |gui-fork| 3335 foreground. |gui-fork|
3334 Note: Set this option in the vimrc file. The forking may have 3336 Note: Set this option in the vimrc file. The forking may have
3335 happened already when the gvimrc file is read. 3337 happened already when the |gvimrc| file is read.
3336 3338
3337 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper 3339 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3338 corner of the window. It's black&white on non-GTK, because of 3340 corner of the window. It's black&white on non-GTK, because of
3339 limitations of X11. For a color icon, see |X11-icon|. 3341 limitations of X11. For a color icon, see |X11-icon|.
3340 3342
3341 'm' Menu bar is present. 3343 'm' Menu bar is present.
3342 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note 3344 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
3343 that this flag must be added in the .vimrc file, before 3345 that this flag must be added in the .vimrc file, before
3344 switching on syntax or filetype recognition (when the .gvimrc 3346 switching on syntax or filetype recognition (when the |gvimrc|
3345 file is sourced the system menu has already been loaded; the 3347 file is sourced the system menu has already been loaded; the
3346 ":syntax on" and ":filetype on" commands load the menu too). 3348 ":syntax on" and ":filetype on" commands load the menu too).
3347 'g' Grey menu items: Make menu items that are not active grey. If 3349 'g' Grey menu items: Make menu items that are not active grey. If
3348 'g' is not included inactive menu items are not shown at all. 3350 'g' is not included inactive menu items are not shown at all.
3349 Exception: Athena will always use grey menu items. 3351 Exception: Athena will always use grey menu items.
3372 a horizontal layout is preferred, but when it doesn't fit a 3374 a horizontal layout is preferred, but when it doesn't fit a
3373 vertical layout is used anyway. 3375 vertical layout is used anyway.
3374 'p' Use Pointer callbacks for X11 GUI. This is required for some 3376 'p' Use Pointer callbacks for X11 GUI. This is required for some
3375 window managers. If the cursor is not blinking or hollow at 3377 window managers. If the cursor is not blinking or hollow at
3376 the right moment, try adding this flag. This must be done 3378 the right moment, try adding this flag. This must be done
3377 before starting the GUI. Set it in your gvimrc. Adding or 3379 before starting the GUI. Set it in your |gvimrc|. Adding or
3378 removing it after the GUI has started has no effect. 3380 removing it after the GUI has started has no effect.
3379 'F' Add a footer. Only for Motif. See |gui-footer|. 3381 'F' Add a footer. Only for Motif. See |gui-footer|.
3380 3382
3381 *'guipty'* *'noguipty'* 3383 *'guipty'* *'noguipty'*
3382 'guipty' boolean (default on) 3384 'guipty' boolean (default on)
3467 *'highlight'* *'hl'* 3469 *'highlight'* *'hl'*
3468 'highlight' 'hl' string (default (as a single string): 3470 'highlight' 'hl' string (default (as a single string):
3469 "8:SpecialKey,@:NonText,d:Directory, 3471 "8:SpecialKey,@:NonText,d:Directory,
3470 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg, 3472 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3471 M:ModeMsg,n:LineNr,r:Question, 3473 M:ModeMsg,n:LineNr,r:Question,
3472 s:StatusLine,S:StatusLineNC,c:VertSplit 3474 s:StatusLine,S:StatusLineNC,c:VertSplit,
3473 t:Title,v:Visual,w:WarningMsg,W:WildMenu, 3475 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3474 f:Folded,F:FoldColumn,A:DiffAdd, 3476 f:Folded,F:FoldColumn,A:DiffAdd,
3475 C:DiffChange,D:DiffDelete,T:DiffText, 3477 C:DiffChange,D:DiffDelete,T:DiffText,
3476 >:SignColumn,B:SpellBad,P:SpellCap, 3478 >:SignColumn,B:SpellBad,P:SpellCap,
3477 R:SpellRare,L:SpellLocal, 3479 R:SpellRare,L:SpellLocal,
3558 highlighting comes back. 3560 highlighting comes back.
3559 When the search pattern can match an end-of-line, Vim will try to 3561 When the search pattern can match an end-of-line, Vim will try to
3560 highlight all of the matched text. However, this depends on where the 3562 highlight all of the matched text. However, this depends on where the
3561 search starts. This will be the first line in the window or the first 3563 search starts. This will be the first line in the window or the first
3562 line below a closed fold. A match in a previous line which is not 3564 line below a closed fold. A match in a previous line which is not
3563 drawn may not continue in an newly drawn line. 3565 drawn may not continue in a newly drawn line.
3564 NOTE: This option is reset when 'compatible' is set. 3566 NOTE: This option is reset when 'compatible' is set.
3565 3567
3566 *'history'* *'hi'* 3568 *'history'* *'hi'*
3567 'history' 'hi' number (Vim default: 20, Vi default: 0) 3569 'history' 'hi' number (Vim default: 20, Vi default: 0)
3568 global 3570 global
4263 nbsp:c Character to show for a non-breakable space (character 4265 nbsp:c Character to show for a non-breakable space (character
4264 0xA0, 160). Left blank when omitted. 4266 0xA0, 160). Left blank when omitted.
4265 4267
4266 The characters ':' and ',' should not be used. UTF-8 characters can 4268 The characters ':' and ',' should not be used. UTF-8 characters can
4267 be used when 'encoding' is "utf-8", otherwise only printable 4269 be used when 'encoding' is "utf-8", otherwise only printable
4268 characters are allowed. 4270 characters are allowed. All characters must be single width.
4269 4271
4270 Examples: > 4272 Examples: >
4271 :set lcs=tab:>-,trail:- 4273 :set lcs=tab:>-,trail:-
4272 :set lcs=tab:>-,eol:<,nbsp:% 4274 :set lcs=tab:>-,eol:<,nbsp:%
4273 :set lcs=extends:>,precedes:< 4275 :set lcs=extends:>,precedes:<
5367 2. When "jump" is included, the other windows are 5369 2. When "jump" is included, the other windows are
5368 scrolled to keep the same relative offset. When 5370 scrolled to keep the same relative offset. When
5369 going back to the other window, it still uses the 5371 going back to the other window, it still uses the
5370 same relative offset. 5372 same relative offset.
5371 Also see |scroll-binding|. 5373 Also see |scroll-binding|.
5374 When 'diff' mode is active there always is vertical scroll binding,
5375 even when "ver" isn't there.
5372 5376
5373 *'sections'* *'sect'* 5377 *'sections'* *'sect'*
5374 'sections' 'sect' string (default "SHNHH HUnhsh") 5378 'sections' 'sect' string (default "SHNHH HUnhsh")
5375 global 5379 global
5376 Specifies the nroff macros that separate sections. These are pairs of 5380 Specifies the nroff macros that separate sections. These are pairs of
5967 *E765* 5971 *E765*
5968 It may also be a comma separated list of names. A count before the 5972 It may also be a comma separated list of names. A count before the
5969 |zg| and |zw| commands can be used to access each. This allows using 5973 |zg| and |zw| commands can be used to access each. This allows using
5970 a personal word list file and a project word list file. 5974 a personal word list file and a project word list file.
5971 When a word is added while this option is empty Vim will set it for 5975 When a word is added while this option is empty Vim will set it for
5972 you: Using the first "spell" directory in 'runtimepath' that is 5976 you: Using the first directory in 'runtimepath' that is writable. If
5973 writable and the first language name that appears in 'spelllang', 5977 there is no "spell" directory yet it will be created. For the file
5978 name the first language name that appears in 'spelllang' is used,
5974 ignoring the region. 5979 ignoring the region.
5975 The resulting ".spl" file will be used for spell checking, it does not 5980 The resulting ".spl" file will be used for spell checking, it does not
5976 have to appear in 'spelllang'. 5981 have to appear in 'spelllang'.
5977 Normally one file is used for all regions, but you can add the region 5982 Normally one file is used for all regions, but you can add the region
5978 name if you want to. However, it will then only be used when 5983 name if you want to. However, it will then only be used when