vim-55/runtime/optwin.vim

6 " If there already is an option window, jump to that one.
25 " function to be called when <CR> is hit in the option-window
28   " If on a continued comment line, go back to the first comment line
39     " For a local option: go to the previous window
40     " If this is a help window, go to the window below it
53   " <CR> on an index line jumps to the group
59 " function to be called when <Space> is hit in the option-window
68     " For a local option: go to the previous window
69     " If this is a help window, go to the window below it
82     if getline(a:lnum - 1) =~ "(local to"
131 " Reset 'title' and 'icon' to make it work faster.
139 " Relies on syntax highlighting to be switched on.
154 call append(1, '" Hit <CR> on a "set" line to execute it.')
157 call append(4, '" Hit <CR> on a help line to open a help window on this option.')
158 call append(5, '" Hit <CR> on an index line to jump there.')
159 call append(6, '" Hit <Space> on a "set" line to refresh it.')
221 " The text should be sufficient to know what the option is used for.
226 call append("$", "cpoptions\tlist of flags to specify Vi compatibility")
232 call append("$", "pastetoggle\tkey sequence to toggle paste mode")
245 call append("$", "whichwrap\tlist of flags specifying which commands wrap to another line")
246 call append("$", "\t(local to window)")
248 call append("$", "startofline\tmany jump commands move the cursor to the first non-blank")
256 call append("$", "\t(global or local to buffer)")
261   call append("$", "autochdir\tchange to directory of file in buffer")
274 call append("$", "casemap\twhat method to use for changing case of letters")
279 call append("$", "\t(global or local to buffer)")
283   call append("$", "\t(local to buffer)")
285   call append("$", "includeexpr\texpression used to transform an include line to a file name")
286   call append("$", "\t(local to buffer)")
296 call append("$", "tags\tlist of file names to search for tags")
297 call append("$", "\t(global or local to buffer)")
299 call append("$", "tagrelative\tfile names in a tags file are relative to the tags file")
314   call append("$", "cscopepathcomp\thow many components of the path to show")
316   call append("$", "cscopequickfix\twhen to open a quickfix window for cscope")
322 call append("$", "scroll\tnumber of lines to scroll for CTRL-U and CTRL-D")
323 call append("$", "\t(local to window)")
325 call append("$", "scrolloff\tnumber of screen lines to show around the cursor")
330 call append("$", "\t(local to window)")
334 call append("$", "showbreak\tstring to put before wrapped screen lines")
336 call append("$", "sidescroll\tminimal number of columns to scroll horizontally")
338 call append("$", "sidescrolloff\tminimal number of columns to keep left and right of the cursor")
340 call append("$", "display\tinclude \"lastline\" to show the last line even if it doesn't fit")
341 call append("$", "\tinclude \"uhex\" to show unprintable characters as a hex number")
343 call append("$", "fillchars\tcharacters to use for the status line, folds and filler lines")
351 call append("$", "window\tnumber of lines to scroll for CTRL-F and CTRL-B")
359 call append("$", "writedelay\tdelay in msec for each char written to the display")
363 call append("$", "\t(local to window)")
368 call append("$", "\t(local to window)")
371 call append("$", "\t(local to window)")
374   call append("$", "numberwidth\tnumber of columns to use for the line number")
375   call append("$", "\t(local to window)")
380   call append("$", "\t(local to window)")
383   call append("$", "\t(local to window)")
393   call append("$", "\t(local to buffer)")
398   call append("$", "\t(local to buffer)")
400   call append("$", "synmaxcol\tmaximum column to look for syntax items")
401   call append("$", "\t(local to buffer)")
404 call append("$", "highlight\twhich highlighting to use for various occasions")
410   call append("$", "\t(local to window)")
413   call append("$", "\t(local to window)")
415   call append("$", "colorcolumn\tcolumns to highlight")
416   call append("$", "\t(local to window)")
419   call append("$", "\t(local to window)")
422   call append("$", "\t(local to buffer)")
424   call append("$", "spellfile\tfile that \"zg\" adds good words to")
425   call append("$", "\t(local to buffer)")
427   call append("$", "spellcapcheck\tpattern to locate the end of a sentence")
428   call append("$", "\t(local to buffer)")
430   call append("$", "spellsuggest\tmethods used to suggest corrections")
438 call append("$", "laststatus\t0, 1 or 2; when to use a status line for the last window")
441   call append("$", "statusline\talternate format to be used for a status line")
455 call append("$", "\t(local to window)")
459 call append("$", "\t(local to window)")
472   call append("$", "\t(local to window)")
477 call append("$", "switchbuf\t\"useopen\" and/or \"split\"; which window to use when jumping")
488   call append("$", "\t(local to window)")
495   call append("$", "\t(local to window)")
501 call append("$", "showtabline\t0, 1 or 2; when to use a tab pages line")
503 call append("$", "tabpagemax\tmaximum number of tab pages to open for -p and \"tab all\"")
528 call append("$", "scrolljump\tminimal number of lines to scroll at a time")
530 call append("$", "ttyscroll\tmaximum number of lines to use scrolling instead of redrawing")
543   call append("$", "titlestring\twhen not empty, string to be used for the window title")
545   call append("$", "titleold\tstring to restore the title to when exiting Vim")
572 call append("$", "mousetime\tmaximum time in msec to recognize a double-click")
584   call append("$", "guifont\tlist of font names to be used in the GUI")
587     call append("$", "guifontset\tpair of fonts to be used, for multibyte editing")
590   call append("$", "guifontwide\tlist of font names to be used for double-wide characters")
599     call append("$", "toolbar\t\"icons\", \"text\" and/or \"tooltips\"; how to show the toolbar")
608   call append("$", "guipty\tuse a pseudo-tty for I/O to external commands")
615     call append("$", "langmenu\tlanguage to be used for the menus")
616     call <SID>OptionG("langmenu", &lm)
621     call append("$", "winaltkeys\t\"no\", \"yes\" or \"menu\"; how to use the ALT key")
624   call append("$", "linespace\tnumber of pixel lines to use between characters")
629     call append("$", "ballooneval\twhether the balloon evaluation is to be used")
632       call append("$", "balloonexpr\texpression to show in balloon eval")
637     call append("$", "macatsui\tuse ATSUI text drawing; disable to avoid display problems")
646   call append("$", "printdevice\tname of the printer to be used for :hardcopy")
649     call append("$", "printexpr\texpression used to print the PostScript file for :hardcopy")
652   call append("$", "printfont\tname of the font to be used for :hardcopy")
657     call append("$", "printencoding\tencoding used to print the PostScript file for :hardcopy")
661     call append("$", "printmbcharset\tthe CJK character set to be used for CJK output from :hardcopy")
663     call append("$", "printmbfont\tlist of font names to be used for CJK output from :hardcopy")
671 call append("$", "shortmess\tlist of flags to make messages shorter")
684   call append("$", "rulerformat\talternate format to be used for the ruler")
691 call append("$", "verbosefile\tfile to write messages in")
712 call append("$", "selectmode\t\"mouse\", \"key\" and/or \"cmd\"; when to start Select mode")
716   call append("$", "clipboard\t\"unnamed\" to use the * register like unnamed register")
717   call append("$", "\t\"autoselect\" to always put selected text on the clipboard")
727 call append("$", "undoreload\tmaximum number lines to save for undo on a buffer reload")
729 call append("$", "modified\tchanges have been made and not written to a file")
730 call append("$", "\t(local to buffer)")
732 call append("$", "readonly\tbuffer is not to be written")
733 call append("$", "\t(local to buffer)")
735 call append("$", "modifiable\tchanges to the text are not possible")
736 call append("$", "\t(local to buffer)")
738 call append("$", "textwidth\tline length above which to break a line")
739 call append("$", "\t(local to buffer)")
741 call append("$", "wrapmargin\tmargin from the right in which to break a line")
742 call append("$", "\t(local to buffer)")
747 call append("$", "\t(local to buffer)")
750 call append("$", "\t(local to buffer)")
752 call append("$", "formatlistpat\tpattern to recognize a numbered list")
753 call append("$", "\t(local to buffer)")
756   call append("$", "formatexpr\texpression used for \"gq\" to format lines")
757   call append("$", "\t(local to buffer)")
762   call append("$", "\t(local to buffer)")
764   call append("$", "completeopt\twhether to use a popup menu for Insert mode completion")
769   call append("$", "\t(local to buffer)")
772   call append("$", "\t(local to buffer)")
775   call append("$", "\t(global or local to buffer)")
778   call append("$", "\t(global or local to buffer)")
782 call append("$", "\t(local to buffer)")
792 call append("$", "showmatch\twhen inserting a bracket, briefly jump to its match")
794 call append("$", "matchtime\ttenth of a second to show a match for 'showmatch'")
797 call append("$", "\t(local to buffer)")
803 call append("$", "\t(local to buffer)")
809 call append("$", "\t(local to buffer)")
812 call append("$", "\t(local to buffer)")
816 call append("$", "softtabstop\tif non-zero, number of spaces to insert for a <Tab>")
817 call append("$", "\t(local to buffer)")
819 call append("$", "shiftround\tround to 'shiftwidth' for \"<<\" and \">>\"")
821 call append("$", "expandtab\texpand <Tab> to spaces in Insert mode")
822 call append("$", "\t(local to buffer)")
825 call append("$", "\t(local to buffer)")
829   call append("$", "\t(local to buffer)")
834   call append("$", "\t(local to buffer)")
837   call append("$", "\t(local to buffer)")
840   call append("$", "\t(local to buffer)")
843   call append("$", "\t(local to buffer)")
845   call append("$", "indentexpr\texpression used to obtain the indent of a line")
846   call append("$", "\t(local to buffer)")
849   call append("$", "\t(local to buffer)")
853 call append("$", "\t(local to buffer)")
856 call append("$", "\t(local to buffer)")
860   call append("$", "\t(local to buffer)")
869   call append("$", "foldenable\tset to display all folds open")
870   call append("$", "\t(local to window)")
873   call append("$", "\t(local to window)")
875   call append("$", "foldlevelstart\tvalue for 'foldlevel' when starting to edit a file")
877   call append("$", "foldcolumn\twidth of the column used to indicate folds")
878   call append("$", "\t(local to window)")
880   call append("$", "foldtext\texpression used to display the text of a closed fold")
881   call append("$", "\t(local to window)")
883   call append("$", "foldclose\tset to \"all\" to close a fold when the cursor leaves it")
887   call append("$", "foldminlines\tminimum number of screen lines for a fold to be closed")
888   call append("$", "\t(local to window)")
890   call append("$", "commentstring\ttemplate for comments; used to put the marker in")
893   call append("$", "\t(local to window)")
896   call append("$", "\t(local to window)")
898   call append("$", "foldignore\tused to ignore lines when 'foldmethod' is \"indent\"")
899   call append("$", "\t(local to window)")
902   call append("$", "\t(local to window)")
905   call append("$", "\t(local to window)")
913   call append("$", "\t(local to window)")
917   call append("$", "diffexpr\texpression used to obtain a diff file")
919   call append("$", "patchexpr\texpression used to patch a file")
930 call <SID>BinOptionG("to", &to)
941 call append("$", "\t(local to buffer)")
943 call append("$", "modelines\tnumber of lines to check for modelines")
946 call append("$", "\t(local to buffer)")
949 call append("$", "\t(local to buffer)")
952   call append("$", "bomb\tprepend a Byte Order Mark to the file")
953   call append("$", "\t(local to buffer)")
957 call append("$", "\t(local to buffer)")
959 call append("$", "fileformats\tlist of file formats to look for when editing a file")
962 call append("$", "\t(local to buffer)")
974 call append("$", "backupcopy\twhether to make the backup as a copy or rename the existing file")
976 call append("$", "backupdir\tlist of directories to put backup files in")
987 call append("$", "\t(global or local to buffer)")
991 call append("$", "fsync\tforcibly sync the file to disk after writing it")
995   call append("$", "\t(local to buffer)")
999 call append("$", "\t(local to buffer)")
1007 call append("$", "\t(local to buffer)")
1009 call append("$", "swapsync\t\"sync\", \"fsync\" or empty; how to flush a swap file to disk")
1011 call append("$", "updatecount\tnumber of characters typed to cause a swap file update")
1031   call append("$", "wildoptions\tempty or \"tagfile\" to list file name of matching tags")
1038   call append("$", "\t(local to buffer)")
1042   call append("$", "wildignore\tlist of patterns to ignore files for file name completion")
1050   call append("$", "cedit\tkey used to open the command-line window")
1065   call append("$", "shelltype\twhen to use the shell or directly execute a command")
1068 call append("$", "shellquote\tcharacter(s) to enclose a shell command in")
1072 call append("$", "shellcmdflag\targument for 'shell' to execute a command")
1074 call append("$", "shellredir\tused to redirect command output to a file")
1079 call append("$", "\t(global or local to buffer)")
1081 call append("$", "formatprg\tprogram used to format lines with \"gq\" command")
1090   call <SID>Header("running make and jumping to errors")
1094   call append("$", "\t(global or local to buffer)")
1097   call append("$", "\t(global or local to buffer)")
1099   call append("$", "shellpipe\tstring used to put the output of \":make\" in the error file")
1104   call append("$", "\t(global or local to buffer)")
1114     call append("$", "bioskey\tcall the BIOS to get a keyoard character")
1116     call append("$", "conskey\tuse direct console I/O to get a keyboard character")
1121     call append("$", "\t(local to buffer)")
1137 call append("$", "\t(local to buffer)")
1143   call append("$", "\t(local to buffer)")
1147   call append("$", "rightleft\tdisplay the buffer right-to-left")
1148   call append("$", "\t(local to window)")
1150   call append("$", "rightleftcmd\twhen to edit the command-line right-to-left")
1151   call append("$", "\t(local to window)")
1155   call append("$", "allowrevins\tallow CTRL-_ in Insert and Command-line mode to toggle 'revins'")
1172   call append("$", "\t(local to window)")
1192 call append("$", "\t(local to window)")
1195 call append("$", "\t(local to window)")
1198   call append("$", "imcmdline\twhen set always use IM when starting to edit a command line")
1209   call append("$", "\t(local to buffer)")
1232   call append("$", "virtualedit\twhen to use virtual editing: \"block\", \"insert\" and/or \"all\"")
1236   call append("$", "eventignore\tlist of autocommand events which are to be ignored")
1258   call append("$", "sessionoptions\tlist of words that specifies what to put in a session file")
1260   call append("$", "viewoptions\tlist of words that specifies what to save for :mkview")
1262   call append("$", "viewdir\tdirectory where to store files with :mkview")
1266   call append("$", "viminfo\tlist that specifies what to write in the viminfo file")
1271   call append("$", "\t(local to buffer)")
1274   call append("$", "\t(local to buffer)")
1278 call append("$", "\t(local to buffer)")
1280 call append("$", "debug\tset to \"msg\" to see all error messages")
1289 " go to first line
1292 " reset 'modified', so that ":q" can be used to close the window
1310 " Install autocommands to enable mappings in option-window