1" These commands create the option window. 2" 3" Maintainer: Bram Moolenaar <[email protected]> 4" Last Change: 2015 Nov 10 5 6" If there already is an option window, jump to that one. 7if bufwinnr("option-window") > 0 8 let s:thiswin = winnr() 9 while 1 10 if @% == "option-window" 11 finish 12 endif 13 wincmd w 14 if s:thiswin == winnr() 15 break 16 endif 17 endwhile 18endif 19 20" Make sure the '<' flag is not included in 'cpoptions', otherwise <CR> would 21" not be recognized. See ":help 'cpoptions'". 22let s:cpo_save = &cpo 23set cpo&vim 24 25" function to be called when <CR> is hit in the option-window 26fun! <SID>CR() 27 28 " If on a continued comment line, go back to the first comment line 29 let lnum = search("^[^\t]", 'bWcn') 30 let line = getline(lnum) 31 32 " <CR> on a "set" line executes the option line 33 if match(line, "^ \tset ") >= 0 34 35 " For a local option: go to the previous window 36 " If this is a help window, go to the window below it 37 let thiswin = winnr() 38 let local = <SID>Find(lnum) 39 if local >= 0 40 exe line 41 call <SID>Update(lnum, line, local, thiswin) 42 endif 43 44 " <CR> on a "option" line shows help for that option 45 elseif match(line, "^[a-z]") >= 0 46 let name = substitute(line, '\([^\t]*\).*', '\1', "") 47 exe "help '" . name . "'" 48 49 " <CR> on an index line jumps to the group 50 elseif match(line, '^ \=[0-9]') >= 0 51 exe "norm! /" . line . "\<CR>zt" 52 endif 53endfun 54 55" function to be called when <Space> is hit in the option-window 56fun! <SID>Space() 57 58 let lnum = line(".") 59 let line = getline(lnum) 60 61 " <Space> on a "set" line refreshes the option line 62 if match(line, "^ \tset ") >= 0 63 64 " For a local option: go to the previous window 65 " If this is a help window, go to the window below it 66 let thiswin = winnr() 67 let local = <SID>Find(lnum) 68 if local >= 0 69 call <SID>Update(lnum, line, local, thiswin) 70 endif 71 72 endif 73endfun 74 75" find the window in which the option applies 76" returns 0 for global option, 1 for local option, -1 for error 77fun! <SID>Find(lnum) 78 if getline(a:lnum - 1) =~ "(local to" 79 let local = 1 80 let thiswin = winnr() 81 wincmd p 82 if exists("b:current_syntax") && b:current_syntax == "help" 83 wincmd j 84 if winnr() == thiswin 85 wincmd j 86 endif 87 endif 88 else 89 let local = 0 90 endif 91 if local && (winnr() == thiswin || (exists("b:current_syntax") 92 \ && b:current_syntax == "help")) 93 echo "Don't know in which window" 94 let local = -1 95 endif 96 return local 97endfun 98 99" Update a "set" line in the option window 100fun! <SID>Update(lnum, line, local, thiswin) 101 " get the new value of the option and update the option window line 102 if match(a:line, "=") >= 0 103 let name = substitute(a:line, '^ \tset \([^=]*\)=.*', '\1', "") 104 else 105 let name = substitute(a:line, '^ \tset \(no\)\=\([a-z]*\).*', '\2', "") 106 endif 107 if name == "pt" && &pt =~ "\x80" 108 let val = <SID>PTvalue() 109 else 110 let val = escape(eval('&' . name), " \t\\\"|") 111 endif 112 if a:local 113 exe a:thiswin . "wincmd w" 114 endif 115 if match(a:line, "=") >= 0 || (val != "0" && val != "1") 116 call setline(a:lnum, " \tset " . name . "=" . val) 117 else 118 if val 119 call setline(a:lnum, " \tset " . name . "\tno" . name) 120 else 121 call setline(a:lnum, " \tset no" . name . "\t" . name) 122 endif 123 endif 124 set nomodified 125endfun 126 127" Reset 'title' and 'icon' to make it work faster. 128let s:old_title = &title 129let s:old_icon = &icon 130let s:old_sc = &sc 131let s:old_ru = &ru 132set notitle noicon nosc noru 133 134" If the current window is a help window, try finding a non-help window. 135" Relies on syntax highlighting to be switched on. 136let s:thiswin = winnr() 137while exists("b:current_syntax") && b:current_syntax == "help" 138 wincmd w 139 if s:thiswin == winnr() 140 break 141 endif 142endwhile 143 144" Open the window 145new option-window 146setlocal ts=15 tw=0 noro buftype=nofile 147 148" Insert help and a "set" command for each option. 149call append(0, '" Each "set" line shows the current value of an option (on the left).') 150call append(1, '" Hit <CR> on a "set" line to execute it.') 151call append(2, '" A boolean option will be toggled.') 152call append(3, '" For other options you can edit the value before hitting <CR>.') 153call append(4, '" Hit <CR> on a help line to open a help window on this option.') 154call append(5, '" Hit <CR> on an index line to jump there.') 155call append(6, '" Hit <Space> on a "set" line to refresh it.') 156 157" These functions are called often below. Keep them fast! 158 159" Init a local binary option 160fun! <SID>BinOptionL(name) 161 let val = getwinvar(winnr('#'), '&' . a:name) 162 call append("$", substitute(substitute(" \tset " . val . a:name . "\t" . 163 \!val . a:name, "0", "no", ""), "1", "", "")) 164endfun 165 166" Init a global binary option 167fun! <SID>BinOptionG(name, val) 168 call append("$", substitute(substitute(" \tset " . a:val . a:name . "\t" . 169 \!a:val . a:name, "0", "no", ""), "1", "", "")) 170endfun 171 172" Init a local string option 173fun! <SID>OptionL(name) 174 let val = escape(getwinvar(winnr('#'), '&' . a:name), " \t\\\"|") 175 call append("$", " \tset " . a:name . "=" . val) 176endfun 177 178" Init a global string option 179fun! <SID>OptionG(name, val) 180 call append("$", " \tset " . a:name . "=" . escape(a:val, " \t\\\"|")) 181endfun 182 183let s:idx = 1 184let s:lnum = line("$") 185call append("$", "") 186 187fun! <SID>Header(text) 188 let line = s:idx . " " . a:text 189 if s:idx < 10 190 let line = " " . line 191 endif 192 call append("$", "") 193 call append("$", line) 194 call append("$", "") 195 call append(s:lnum, line) 196 let s:idx = s:idx + 1 197 let s:lnum = s:lnum + 1 198endfun 199 200" Get the value of 'pastetoggle'. It could be a special key. 201fun! <SID>PTvalue() 202 redir @a 203 silent set pt 204 redir END 205 return substitute(@a, '[^=]*=\(.*\)', '\1', "") 206endfun 207 208" Restore the previous value of 'cpoptions' here, it's used below. 209let &cpo = s:cpo_save 210 211" List of all options, organized by function. 212" The text should be sufficient to know what the option is used for. 213 214call <SID>Header("important") 215call append("$", "compatible\tbehave very Vi compatible (not advisable)") 216call <SID>BinOptionG("cp", &cp) 217call append("$", "cpoptions\tlist of flags to specify Vi compatibility") 218call <SID>OptionG("cpo", &cpo) 219call append("$", "insertmode\tuse Insert mode as the default mode") 220call <SID>BinOptionG("im", &im) 221call append("$", "paste\tpaste mode, insert typed text literally") 222call <SID>BinOptionG("paste", &paste) 223call append("$", "pastetoggle\tkey sequence to toggle paste mode") 224if &pt =~ "\x80" 225 call append("$", " \tset pt=" . <SID>PTvalue()) 226else 227 call <SID>OptionG("pt", &pt) 228endif 229call append("$", "runtimepath\tlist of directories used for runtime files and plugins") 230call <SID>OptionG("rtp", &rtp) 231call append("$", "helpfile\tname of the main help file") 232call <SID>OptionG("hf", &hf) 233 234 235call <SID>Header("moving around, searching and patterns") 236call append("$", "whichwrap\tlist of flags specifying which commands wrap to another line") 237call append("$", "\t(local to window)") 238call <SID>OptionL("ww") 239call append("$", "startofline\tmany jump commands move the cursor to the first non-blank") 240call append("$", "\tcharacter of a line") 241call <SID>BinOptionG("sol", &sol) 242call append("$", "paragraphs\tnroff macro names that separate paragraphs") 243call <SID>OptionG("para", ¶) 244call append("$", "sections\tnroff macro names that separate sections") 245call <SID>OptionG("sect", §) 246call append("$", "path\tlist of directory names used for file searching") 247call append("$", "\t(global or local to buffer)") 248call <SID>OptionG("pa", &pa) 249call append("$", "cdpath\tlist of directory names used for :cd") 250call <SID>OptionG("cd", &cd) 251if exists("+autochdir") 252 call append("$", "autochdir\tchange to directory of file in buffer") 253 call <SID>BinOptionG("acd", &acd) 254endif 255call append("$", "wrapscan\tsearch commands wrap around the end of the buffer") 256call <SID>BinOptionG("ws", &ws) 257call append("$", "incsearch\tshow match for partly typed search command") 258call <SID>BinOptionG("is", &is) 259call append("$", "magic\tchange the way backslashes are used in search patterns") 260call <SID>BinOptionG("magic", &magic) 261call append("$", "regexpengine\tselect the default regexp engine used") 262call <SID>OptionG("re", &re) 263call append("$", "ignorecase\tignore case when using a search pattern") 264call <SID>BinOptionG("ic", &ic) 265call append("$", "smartcase\toverride 'ignorecase' when pattern has upper case characters") 266call <SID>BinOptionG("scs", &scs) 267call append("$", "casemap\twhat method to use for changing case of letters") 268call <SID>OptionG("cmp", &cmp) 269call append("$", "maxmempattern\tmaximum amount of memory in Kbyte used for pattern matching") 270call append("$", " \tset mmp=" . &mmp) 271call append("$", "define\tpattern for a macro definition line") 272call append("$", "\t(global or local to buffer)") 273call <SID>OptionG("def", &def) 274if has("find_in_path") 275 call append("$", "include\tpattern for an include-file line") 276 call append("$", "\t(local to buffer)") 277 call <SID>OptionL("inc") 278 call append("$", "includeexpr\texpression used to transform an include line to a file name") 279 call append("$", "\t(local to buffer)") 280 call <SID>OptionL("inex") 281endif 282 283 284call <SID>Header("tags") 285call append("$", "tagbsearch\tuse binary searching in tags files") 286call <SID>BinOptionG("tbs", &tbs) 287call append("$", "taglength\tnumber of significant characters in a tag name or zero") 288call append("$", " \tset tl=" . &tl) 289call append("$", "tags\tlist of file names to search for tags") 290call append("$", "\t(global or local to buffer)") 291call <SID>OptionG("tag", &tag) 292call append("$", "tagcase\thow to handle case when searching in tags files:") 293call append("$", "\t\"followic\" to follow 'ignorecase', \"ignore\" or \"match\"") 294call append("$", "\t(global or local to buffer)") 295call <SID>OptionG("tc", &tc) 296call append("$", "tagrelative\tfile names in a tags file are relative to the tags file") 297call <SID>BinOptionG("tr", &tr) 298call append("$", "tagstack\ta :tag command will use the tagstack") 299call <SID>BinOptionG("tgst", &tgst) 300call append("$", "showfulltag\twhen completing tags in Insert mode show more info") 301call <SID>BinOptionG("sft", &sft) 302if has("cscope") 303 call append("$", "cscopeprg\tcommand for executing cscope") 304 call <SID>OptionG("csprg", &csprg) 305 call append("$", "cscopetag\tuse cscope for tag commands") 306 call <SID>BinOptionG("cst", &cst) 307 call append("$", "cscopetagorder\t0 or 1; the order in which \":cstag\" performs a search") 308 call append("$", " \tset csto=" . &csto) 309 call append("$", "cscopeverbose\tgive messages when adding a cscope database") 310 call <SID>BinOptionG("csverb", &csverb) 311 call append("$", "cscopepathcomp\thow many components of the path to show") 312 call append("$", " \tset cspc=" . &cspc) 313 call append("$", "cscopequickfix\twhen to open a quickfix window for cscope") 314 call <SID>OptionG("csqf", &csqf) 315 call append("$", "cscoperelative\tfile names in a cscope file are relative to that file") 316 call <SID>BinOptionG("csre", &csre) 317endif 318 319 320call <SID>Header("displaying text") 321call append("$", "scroll\tnumber of lines to scroll for CTRL-U and CTRL-D") 322call append("$", "\t(local to window)") 323call <SID>OptionL("scr") 324call append("$", "scrolloff\tnumber of screen lines to show around the cursor") 325call append("$", " \tset so=" . &so) 326call append("$", "wrap\tlong lines wrap") 327call <SID>BinOptionG("wrap", &wrap) 328call append("$", "linebreak\twrap long lines at a character in 'breakat'") 329call append("$", "\t(local to window)") 330call <SID>BinOptionL("lbr") 331call append("$", "breakindent\tpreserve indentation in wrapped text") 332call append("$", "\t(local to window)") 333call <SID>BinOptionL("bri") 334call append("$", "breakindentopt\tadjust breakindent behaviour") 335call append("$", "\t(local to window)") 336call <SID>OptionL("briopt") 337call append("$", "breakat\twhich characters might cause a line break") 338call <SID>OptionG("brk", &brk) 339call append("$", "showbreak\tstring to put before wrapped screen lines") 340call <SID>OptionG("sbr", &sbr) 341call append("$", "sidescroll\tminimal number of columns to scroll horizontally") 342call append("$", " \tset ss=" . &ss) 343call append("$", "sidescrolloff\tminimal number of columns to keep left and right of the cursor") 344call append("$", " \tset siso=" . &siso) 345call append("$", "display\tinclude \"lastline\" to show the last line even if it doesn't fit") 346call append("$", "\tinclude \"uhex\" to show unprintable characters as a hex number") 347call <SID>OptionG("dy", &dy) 348call append("$", "fillchars\tcharacters to use for the status line, folds and filler lines") 349call <SID>OptionG("fcs", &fcs) 350call append("$", "cmdheight\tnumber of lines used for the command-line") 351call append("$", " \tset ch=" . &ch) 352call append("$", "columns\twidth of the display") 353call append("$", " \tset co=" . &co) 354call append("$", "lines\tnumber of lines in the display") 355call append("$", " \tset lines=" . &lines) 356call append("$", "window\tnumber of lines to scroll for CTRL-F and CTRL-B") 357call append("$", " \tset window=" . &window) 358call append("$", "lazyredraw\tdon't redraw while executing macros") 359call <SID>BinOptionG("lz", &lz) 360if has("reltime") 361 call append("$", "redrawtime\ttimeout for 'hlsearch' and :match highlighting in msec") 362 call append("$", " \tset rdt=" . &rdt) 363endif 364call append("$", "writedelay\tdelay in msec for each char written to the display") 365call append("$", "\t(for debugging)") 366call append("$", " \tset wd=" . &wd) 367call append("$", "list\tshow <Tab> as ^I and end-of-line as $") 368call append("$", "\t(local to window)") 369call <SID>BinOptionL("list") 370call append("$", "listchars\tlist of strings used for list mode") 371call <SID>OptionG("lcs", &lcs) 372call append("$", "number\tshow the line number for each line") 373call append("$", "\t(local to window)") 374call <SID>BinOptionL("nu") 375call append("$", "relativenumber\tshow the relative line number for each line") 376call append("$", "\t(local to window)") 377call <SID>BinOptionL("rnu") 378if has("linebreak") 379 call append("$", "numberwidth\tnumber of columns to use for the line number") 380 call append("$", "\t(local to window)") 381 call <SID>OptionL("nuw") 382endif 383if has("conceal") 384 call append("$", "conceallevel\tcontrols whether concealable text is hidden") 385 call append("$", "\t(local to window)") 386 call <SID>OptionL("cole") 387 call append("$", "concealcursor\tmodes in which text in the cursor line can be concealed") 388 call append("$", "\t(local to window)") 389 call <SID>OptionL("cocu") 390endif 391 392 393call <SID>Header("syntax, highlighting and spelling") 394call append("$", "background\t\"dark\" or \"light\"; the background color brightness") 395call <SID>OptionG("bg", &bg) 396if has("autocmd") 397 call append("$", "filetype\ttype of file; triggers the FileType event when set") 398 call append("$", "\t(local to buffer)") 399 call <SID>OptionL("ft") 400endif 401if has("syntax") 402 call append("$", "syntax\tname of syntax highlighting used") 403 call append("$", "\t(local to buffer)") 404 call <SID>OptionL("syn") 405 call append("$", "synmaxcol\tmaximum column to look for syntax items") 406 call append("$", "\t(local to buffer)") 407 call <SID>OptionL("smc") 408endif 409call append("$", "highlight\twhich highlighting to use for various occasions") 410call <SID>OptionG("hl", &hl) 411call append("$", "hlsearch\thighlight all matches for the last used search pattern") 412call <SID>BinOptionG("hls", &hls) 413if has("syntax") 414 call append("$", "cursorcolumn\thighlight the screen column of the cursor") 415 call append("$", "\t(local to window)") 416 call <SID>BinOptionL("cuc") 417 call append("$", "cursorline\thighlight the screen line of the cursor") 418 call append("$", "\t(local to window)") 419 call <SID>BinOptionL("cul") 420 call append("$", "colorcolumn\tcolumns to highlight") 421 call append("$", "\t(local to window)") 422 call <SID>OptionL("cc") 423 call append("$", "spell\thighlight spelling mistakes") 424 call append("$", "\t(local to window)") 425 call <SID>BinOptionL("spell") 426 call append("$", "spelllang\tlist of accepted languages") 427 call append("$", "\t(local to buffer)") 428 call <SID>OptionL("spl") 429 call append("$", "spellfile\tfile that \"zg\" adds good words to") 430 call append("$", "\t(local to buffer)") 431 call <SID>OptionL("spf") 432 call append("$", "spellcapcheck\tpattern to locate the end of a sentence") 433 call append("$", "\t(local to buffer)") 434 call <SID>OptionL("spc") 435 call append("$", "spellsuggest\tmethods used to suggest corrections") 436 call <SID>OptionG("sps", &sps) 437 call append("$", "mkspellmem\tamount of memory used by :mkspell before compressing") 438 call <SID>OptionG("msm", &msm) 439endif 440 441 442call <SID>Header("multiple windows") 443call append("$", "laststatus\t0, 1 or 2; when to use a status line for the last window") 444call append("$", " \tset ls=" . &ls) 445if has("statusline") 446 call append("$", "statusline\talternate format to be used for a status line") 447 call <SID>OptionG("stl", &stl) 448endif 449call append("$", "equalalways\tmake all windows the same size when adding/removing windows") 450call <SID>BinOptionG("ea", &ea) 451if has("vertsplit") 452 call append("$", "eadirection\tin which direction 'equalalways' works: \"ver\", \"hor\" or \"both\"") 453 call <SID>OptionG("ead", &ead) 454endif 455call append("$", "winheight\tminimal number of lines used for the current window") 456call append("$", " \tset wh=" . &wh) 457call append("$", "winminheight\tminimal number of lines used for any window") 458call append("$", " \tset wmh=" . &wmh) 459call append("$", "winfixheight\tkeep the height of the window") 460call append("$", "\t(local to window)") 461call <SID>BinOptionL("wfh") 462if has("vertsplit") 463call append("$", "winfixwidth\tkeep the width of the window") 464call append("$", "\t(local to window)") 465call <SID>BinOptionL("wfw") 466 call append("$", "winwidth\tminimal number of columns used for the current window") 467 call append("$", " \tset wiw=" . &wiw) 468 call append("$", "winminwidth\tminimal number of columns used for any window") 469 call append("$", " \tset wmw=" . &wmw) 470endif 471call append("$", "helpheight\tinitial height of the help window") 472call append("$", " \tset hh=" . &hh) 473if has("quickfix") 474 call append("$", "previewheight\tdefault height for the preview window") 475 call append("$", " \tset pvh=" . &pvh) 476 call append("$", "previewwindow\tidentifies the preview window") 477 call append("$", "\t(local to window)") 478 call <SID>BinOptionL("pvw") 479endif 480call append("$", "hidden\tdon't unload a buffer when no longer shown in a window") 481call <SID>BinOptionG("hid", &hid) 482call append("$", "switchbuf\t\"useopen\" and/or \"split\"; which window to use when jumping") 483call append("$", "\tto a buffer") 484call <SID>OptionG("swb", &swb) 485call append("$", "splitbelow\ta new window is put below the current one") 486call <SID>BinOptionG("sb", &sb) 487if has("vertsplit") 488 call append("$", "splitright\ta new window is put right of the current one") 489 call <SID>BinOptionG("spr", &spr) 490endif 491if has("scrollbind") 492 call append("$", "scrollbind\tthis window scrolls together with other bound windows") 493 call append("$", "\t(local to window)") 494 call <SID>BinOptionL("scb") 495 call append("$", "scrollopt\t\"ver\", \"hor\" and/or \"jump\"; list of options for 'scrollbind'") 496 call <SID>OptionG("sbo", &sbo) 497endif 498if has("cursorbind") 499 call append("$", "cursorbind\tthis window's cursor moves together with other bound windows") 500 call append("$", "\t(local to window)") 501 call <SID>BinOptionL("crb") 502endif 503 504 505call <SID>Header("multiple tab pages") 506call append("$", "showtabline\t0, 1 or 2; when to use a tab pages line") 507call append("$", " \tset stal=" . &stal) 508call append("$", "tabpagemax\tmaximum number of tab pages to open for -p and \"tab all\"") 509call append("$", " \tset tpm=" . &tpm) 510call append("$", "tabline\tcustom tab pages line") 511call <SID>OptionG("tal", &tal) 512if has("gui") 513 call append("$", "guitablabel\tcustom tab page label for the GUI") 514 call <SID>OptionG("gtl", >l) 515 call append("$", "guitabtooltip\tcustom tab page tooltip for the GUI") 516 call <SID>OptionG("gtt", >t) 517endif 518 519 520call <SID>Header("terminal") 521call append("$", "term\tname of the used terminal") 522call <SID>OptionG("term", &term) 523call append("$", "ttytype\talias for 'term'") 524call <SID>OptionG("tty", &tty) 525call append("$", "ttybuiltin\tcheck built-in termcaps first") 526call <SID>BinOptionG("tbi", &tbi) 527call append("$", "ttyfast\tterminal connection is fast") 528call <SID>BinOptionG("tf", &tf) 529call append("$", "weirdinvert\tterminal that requires extra redrawing") 530call <SID>BinOptionG("wiv", &wiv) 531call append("$", "esckeys\trecognize keys that start with <Esc> in Insert mode") 532call <SID>BinOptionG("ek", &ek) 533call append("$", "scrolljump\tminimal number of lines to scroll at a time") 534call append("$", " \tset sj=" . &sj) 535call append("$", "ttyscroll\tmaximum number of lines to use scrolling instead of redrawing") 536call append("$", " \tset tsl=" . &tsl) 537if has("gui") || has("msdos") || has("win32") 538 call append("$", "guicursor\tspecifies what the cursor looks like in different modes") 539 call <SID>OptionG("gcr", &gcr) 540endif 541if has("title") 542 let &title = s:old_title 543 call append("$", "title\tshow info in the window title") 544 call <SID>BinOptionG("title", &title) 545 set notitle 546 call append("$", "titlelen\tpercentage of 'columns' used for the window title") 547 call append("$", " \tset titlelen=" . &titlelen) 548 call append("$", "titlestring\twhen not empty, string to be used for the window title") 549 call <SID>OptionG("titlestring", &titlestring) 550 call append("$", "titleold\tstring to restore the title to when exiting Vim") 551 call <SID>OptionG("titleold", &titleold) 552 let &icon = s:old_icon 553 call append("$", "icon\tset the text of the icon for this window") 554 call <SID>BinOptionG("icon", &icon) 555 set noicon 556 call append("$", "iconstring\twhen not empty, text for the icon of this window") 557 call <SID>OptionG("iconstring", &iconstring) 558endif 559if has("win32") 560 call append("$", "restorescreen\trestore the screen contents when exiting Vim") 561 call <SID>BinOptionG("rs", &rs) 562endif 563 564 565call <SID>Header("using the mouse") 566call append("$", "mouse\tlist of flags for using the mouse") 567call <SID>OptionG("mouse", &mouse) 568if has("gui") 569 call append("$", "mousefocus\tthe window with the mouse pointer becomes the current one") 570 call <SID>BinOptionG("mousef", &mousef) 571 call append("$", "mousehide\thide the mouse pointer while typing") 572 call <SID>BinOptionG("mh", &mh) 573endif 574call append("$", "mousemodel\t\"extend\", \"popup\" or \"popup_setpos\"; what the right") 575call append("$", "\tmouse button is used for") 576call <SID>OptionG("mousem", &mousem) 577call append("$", "mousetime\tmaximum time in msec to recognize a double-click") 578call append("$", " \tset mouset=" . &mouset) 579call append("$", "ttymouse\t\"xterm\", \"xterm2\", \"dec\" or \"netterm\"; type of mouse") 580call <SID>OptionG("ttym", &ttym) 581if has("mouseshape") 582 call append("$", "mouseshape\twhat the mouse pointer looks like in different modes") 583 call <SID>OptionG("mouses", &mouses) 584endif 585 586 587if has("gui") 588 call <SID>Header("GUI") 589 call append("$", "guifont\tlist of font names to be used in the GUI") 590 call <SID>OptionG("gfn", &gfn) 591 if has("xfontset") 592 call append("$", "guifontset\tpair of fonts to be used, for multibyte editing") 593 call <SID>OptionG("gfs", &gfs) 594 endif 595 call append("$", "guifontwide\tlist of font names to be used for double-wide characters") 596 call <SID>OptionG("gfw", &gfw) 597 if has("mac") 598 call append("$", "antialias\tuse smooth, antialiased fonts") 599 call <SID>BinOptionG("anti", &anti) 600 endif 601 call append("$", "guioptions\tlist of flags that specify how the GUI works") 602 call <SID>OptionG("go", &go) 603 if has("gui_gtk") 604 call append("$", "toolbar\t\"icons\", \"text\" and/or \"tooltips\"; how to show the toolbar") 605 call <SID>OptionG("tb", &tb) 606 if has("gui_gtk2") 607 call append("$", "toolbariconsize\tsize of toolbar icons") 608 call <SID>OptionG("tbis", &tbis) 609 endif 610 call append("$", "guiheadroom\troom (in pixels) left above/below the window") 611 call append("$", " \tset ghr=" . &ghr) 612 endif 613 if has("directx") 614 call append("$", "renderoptions\toptions for text rendering") 615 call <SID>OptionG("rop", &rop) 616 endif 617 call append("$", "guipty\tuse a pseudo-tty for I/O to external commands") 618 call <SID>BinOptionG("guipty", &guipty) 619 if has("browse") 620 call append("$", "browsedir\t\"last\", \"buffer\" or \"current\": which directory used for the file browser") 621 call <SID>OptionG("bsdir", &bsdir) 622 endif 623 if has("multi_lang") 624 call append("$", "langmenu\tlanguage to be used for the menus") 625 call <SID>OptionG("langmenu", &lm) 626 endif 627 call append("$", "menuitems\tmaximum number of items in one menu") 628 call append("$", " \tset mis=" . &mis) 629 if has("winaltkeys") 630 call append("$", "winaltkeys\t\"no\", \"yes\" or \"menu\"; how to use the ALT key") 631 call <SID>OptionG("wak", &wak) 632 endif 633 call append("$", "linespace\tnumber of pixel lines to use between characters") 634 call append("$", " \tset lsp=" . &lsp) 635 if has("balloon_eval") 636 call append("$", "balloondelay\tdelay in milliseconds before a balloon may pop up") 637 call append("$", " \tset bdlay=" . &bdlay) 638 call append("$", "ballooneval\twhether the balloon evaluation is to be used") 639 call <SID>BinOptionG("beval", &beval) 640 if has("eval") 641 call append("$", "balloonexpr\texpression to show in balloon eval") 642 call append("$", " \tset bexpr=" . &bexpr) 643 endif 644 endif 645 if exists("+macatsui") 646 call append("$", "macatsui\tuse ATSUI text drawing; disable to avoid display problems") 647 call <SID>OptionG("macatsui", &macatsui) 648 endif 649endif 650 651if has("printer") 652 call <SID>Header("printing") 653 call append("$", "printoptions\tlist of items that control the format of :hardcopy output") 654 call <SID>OptionG("popt", &popt) 655 call append("$", "printdevice\tname of the printer to be used for :hardcopy") 656 call <SID>OptionG("pdev", &pdev) 657 if has("postscript") 658 call append("$", "printexpr\texpression used to print the PostScript file for :hardcopy") 659 call <SID>OptionG("pexpr", &pexpr) 660 endif 661 call append("$", "printfont\tname of the font to be used for :hardcopy") 662 call <SID>OptionG("pfn", &pfn) 663 call append("$", "printheader\tformat of the header used for :hardcopy") 664 call <SID>OptionG("pheader", &pheader) 665 if has("postscript") 666 call append("$", "printencoding\tencoding used to print the PostScript file for :hardcopy") 667 call <SID>OptionG("penc", &penc) 668 endif 669 if has("multi_byte") 670 call append("$", "printmbcharset\tthe CJK character set to be used for CJK output from :hardcopy") 671 call <SID>OptionG("pmbcs", &pmbcs) 672 call append("$", "printmbfont\tlist of font names to be used for CJK output from :hardcopy") 673 call <SID>OptionG("pmbfn", &pmbfn) 674 endif 675endif 676 677call <SID>Header("messages and info") 678call append("$", "terse\tadd 's' flag in 'shortmess' (don't show search message)") 679call <SID>BinOptionG("terse", &terse) 680call append("$", "shortmess\tlist of flags to make messages shorter") 681call <SID>OptionG("shm", &shm) 682call append("$", "showcmd\tshow (partial) command keys in the status line") 683let &sc = s:old_sc 684call <SID>BinOptionG("sc", &sc) 685set nosc 686call append("$", "showmode\tdisplay the current mode in the status line") 687call <SID>BinOptionG("smd", &smd) 688call append("$", "ruler\tshow cursor position below each window") 689let &ru = s:old_ru 690call <SID>BinOptionG("ru", &ru) 691set noru 692if has("statusline") 693 call append("$", "rulerformat\talternate format to be used for the ruler") 694 call <SID>OptionG("ruf", &ruf) 695endif 696call append("$", "report\tthreshold for reporting number of changed lines") 697call append("$", " \tset report=" . &report) 698call append("$", "verbose\tthe higher the more messages are given") 699call append("$", " \tset vbs=" . &vbs) 700call append("$", "verbosefile\tfile to write messages in") 701call <SID>OptionG("vfile", &vfile) 702call append("$", "more\tpause listings when the screen is full") 703call <SID>BinOptionG("more", &more) 704if has("dialog_con") || has("dialog_gui") 705 call append("$", "confirm\tstart a dialog when a command fails") 706 call <SID>BinOptionG("cf", &cf) 707endif 708call append("$", "errorbells\tring the bell for error messages") 709call <SID>BinOptionG("eb", &eb) 710call append("$", "visualbell\tuse a visual bell instead of beeping") 711call <SID>BinOptionG("vb", &vb) 712call append("$", "belloff\tdo not ring the bell for these reasons") 713call <SID>OptionG("belloff", &belloff) 714if has("multi_lang") 715 call append("$", "helplang\tlist of preferred languages for finding help") 716 call <SID>OptionG("hlg", &hlg) 717endif 718 719 720call <SID>Header("selecting text") 721call append("$", "selection\t\"old\", \"inclusive\" or \"exclusive\"; how selecting text behaves") 722call <SID>OptionG("sel", &sel) 723call append("$", "selectmode\t\"mouse\", \"key\" and/or \"cmd\"; when to start Select mode") 724call append("$", "\tinstead of Visual mode") 725call <SID>OptionG("slm", &slm) 726if has("clipboard") 727 call append("$", "clipboard\t\"unnamed\" to use the * register like unnamed register") 728 call append("$", "\t\"autoselect\" to always put selected text on the clipboard") 729 call <SID>OptionG("cb", &cb) 730endif 731call append("$", "keymodel\t\"startsel\" and/or \"stopsel\"; what special keys can do") 732call <SID>OptionG("km", &km) 733 734 735call <SID>Header("editing text") 736call append("$", "undolevels\tmaximum number of changes that can be undone") 737call append("$", "\t(global or local to buffer)") 738call append("$", " \tset ul=" . &ul) 739call append("$", "undoreload\tmaximum number lines to save for undo on a buffer reload") 740call append("$", " \tset ur=" . &ur) 741call append("$", "modified\tchanges have been made and not written to a file") 742call append("$", "\t(local to buffer)") 743call <SID>BinOptionL("mod") 744call append("$", "readonly\tbuffer is not to be written") 745call append("$", "\t(local to buffer)") 746call <SID>BinOptionL("ro") 747call append("$", "modifiable\tchanges to the text are not possible") 748call append("$", "\t(local to buffer)") 749call <SID>BinOptionL("ma") 750call append("$", "textwidth\tline length above which to break a line") 751call append("$", "\t(local to buffer)") 752call <SID>OptionL("tw") 753call append("$", "wrapmargin\tmargin from the right in which to break a line") 754call append("$", "\t(local to buffer)") 755call <SID>OptionL("wm") 756call append("$", "backspace\tspecifies what <BS>, CTRL-W, etc. can do in Insert mode") 757call append("$", " \tset bs=" . &bs) 758call append("$", "comments\tdefinition of what comment lines look like") 759call append("$", "\t(local to buffer)") 760call <SID>OptionL("com") 761call append("$", "formatoptions\tlist of flags that tell how automatic formatting works") 762call append("$", "\t(local to buffer)") 763call <SID>OptionL("fo") 764call append("$", "formatlistpat\tpattern to recognize a numbered list") 765call append("$", "\t(local to buffer)") 766call <SID>OptionL("flp") 767if has("eval") 768 call append("$", "formatexpr\texpression used for \"gq\" to format lines") 769 call append("$", "\t(local to buffer)") 770 call <SID>OptionL("fex") 771endif 772if has("insert_expand") 773 call append("$", "complete\tspecifies how Insert mode completion works for CTRL-N and CTRL-P") 774 call append("$", "\t(local to buffer)") 775 call <SID>OptionL("cpt") 776 call append("$", "completeopt\twhether to use a popup menu for Insert mode completion") 777 call <SID>OptionG("cot", &cot) 778 call append("$", "pumheight\tmaximum height of the popup menu") 779 call <SID>OptionG("ph", &ph) 780 call append("$", "completefunc\tuser defined function for Insert mode completion") 781 call append("$", "\t(local to buffer)") 782 call <SID>OptionL("cfu") 783 call append("$", "omnifunc\tfunction for filetype-specific Insert mode completion") 784 call append("$", "\t(local to buffer)") 785 call <SID>OptionL("ofu") 786 call append("$", "dictionary\tlist of dictionary files for keyword completion") 787 call append("$", "\t(global or local to buffer)") 788 call <SID>OptionG("dict", &dict) 789 call append("$", "thesaurus\tlist of thesaurus files for keyword completion") 790 call append("$", "\t(global or local to buffer)") 791 call <SID>OptionG("tsr", &tsr) 792endif 793call append("$", "infercase\tadjust case of a keyword completion match") 794call append("$", "\t(local to buffer)") 795call <SID>BinOptionL("inf") 796if has("digraphs") 797 call append("$", "digraph\tenable entering digraps with c1 <BS> c2") 798 call <SID>BinOptionG("dg", &dg) 799endif 800call append("$", "tildeop\tthe \"~\" command behaves like an operator") 801call <SID>BinOptionG("top", &top) 802call append("$", "operatorfunc\tfunction called for the\"g@\" operator") 803call <SID>OptionG("opfunc", &opfunc) 804call append("$", "showmatch\twhen inserting a bracket, briefly jump to its match") 805call <SID>BinOptionG("sm", &sm) 806call append("$", "matchtime\ttenth of a second to show a match for 'showmatch'") 807call append("$", " \tset mat=" . &mat) 808call append("$", "matchpairs\tlist of pairs that match for the \"%\" command") 809call append("$", "\t(local to buffer)") 810call <SID>OptionL("mps") 811call append("$", "joinspaces\tuse two spaces after '.' when joining a line") 812call <SID>BinOptionG("js", &js) 813call append("$", "nrformats\t\"alpha\", \"octal\" and/or \"hex\"; number formats recognized for") 814call append("$", "\tCTRL-A and CTRL-X commands") 815call append("$", "\t(local to buffer)") 816call <SID>OptionL("nf") 817 818 819call <SID>Header("tabs and indenting") 820call append("$", "tabstop\tnumber of spaces a <Tab> in the text stands for") 821call append("$", "\t(local to buffer)") 822call <SID>OptionL("ts") 823call append("$", "shiftwidth\tnumber of spaces used for each step of (auto)indent") 824call append("$", "\t(local to buffer)") 825call <SID>OptionL("sw") 826call append("$", "smarttab\ta <Tab> in an indent inserts 'shiftwidth' spaces") 827call <SID>BinOptionG("sta", &sta) 828call append("$", "softtabstop\tif non-zero, number of spaces to insert for a <Tab>") 829call append("$", "\t(local to buffer)") 830call <SID>OptionL("sts") 831call append("$", "shiftround\tround to 'shiftwidth' for \"<<\" and \">>\"") 832call <SID>BinOptionG("sr", &sr) 833call append("$", "expandtab\texpand <Tab> to spaces in Insert mode") 834call append("$", "\t(local to buffer)") 835call <SID>BinOptionL("et") 836call append("$", "autoindent\tautomatically set the indent of a new line") 837call append("$", "\t(local to buffer)") 838call <SID>BinOptionL("ai") 839if has("smartindent") 840 call append("$", "smartindent\tdo clever autoindenting") 841 call append("$", "\t(local to buffer)") 842 call <SID>BinOptionL("si") 843endif 844if has("cindent") 845 call append("$", "cindent\tenable specific indenting for C code") 846 call append("$", "\t(local to buffer)") 847 call <SID>BinOptionL("cin") 848 call append("$", "cinoptions\toptions for C-indenting") 849 call append("$", "\t(local to buffer)") 850 call <SID>OptionL("cino") 851 call append("$", "cinkeys\tkeys that trigger C-indenting in Insert mode") 852 call append("$", "\t(local to buffer)") 853 call <SID>OptionL("cink") 854 call append("$", "cinwords\tlist of words that cause more C-indent") 855 call append("$", "\t(local to buffer)") 856 call <SID>OptionL("cinw") 857 call append("$", "indentexpr\texpression used to obtain the indent of a line") 858 call append("$", "\t(local to buffer)") 859 call <SID>OptionL("inde") 860 call append("$", "indentkeys\tkeys that trigger indenting with 'indentexpr' in Insert mode") 861 call append("$", "\t(local to buffer)") 862 call <SID>OptionL("indk") 863endif 864call append("$", "copyindent\tcopy whitespace for indenting from previous line") 865call append("$", "\t(local to buffer)") 866call <SID>BinOptionL("ci") 867call append("$", "preserveindent\tpreserve kind of whitespace when changing indent") 868call append("$", "\t(local to buffer)") 869call <SID>BinOptionL("pi") 870if has("lispindent") 871 call append("$", "lisp\tenable lisp mode") 872 call append("$", "\t(local to buffer)") 873 call <SID>BinOptionL("lisp") 874 call append("$", "lispwords\twords that change how lisp indenting works") 875 call <SID>OptionL("lw") 876endif 877 878 879if has("folding") 880 call <SID>Header("folding") 881 call append("$", "foldenable\tset to display all folds open") 882 call append("$", "\t(local to window)") 883 call <SID>BinOptionL("fen") 884 call append("$", "foldlevel\tfolds with a level higher than this number will be closed") 885 call append("$", "\t(local to window)") 886 call <SID>OptionL("fdl") 887 call append("$", "foldlevelstart\tvalue for 'foldlevel' when starting to edit a file") 888 call append("$", " \tset fdls=" . &fdls) 889 call append("$", "foldcolumn\twidth of the column used to indicate folds") 890 call append("$", "\t(local to window)") 891 call <SID>OptionL("fdc") 892 call append("$", "foldtext\texpression used to display the text of a closed fold") 893 call append("$", "\t(local to window)") 894 call <SID>OptionL("fdt") 895 call append("$", "foldclose\tset to \"all\" to close a fold when the cursor leaves it") 896 call <SID>OptionG("fcl", &fcl) 897 call append("$", "foldopen\tspecifies for which commands a fold will be opened") 898 call <SID>OptionG("fdo", &fdo) 899 call append("$", "foldminlines\tminimum number of screen lines for a fold to be closed") 900 call append("$", "\t(local to window)") 901 call <SID>OptionL("fml") 902 call append("$", "commentstring\ttemplate for comments; used to put the marker in") 903 call <SID>OptionL("cms") 904 call append("$", "foldmethod\tfolding type: \"manual\", \"indent\", \"expr\", \"marker\" or \"syntax\"") 905 call append("$", "\t(local to window)") 906 call <SID>OptionL("fdm") 907 call append("$", "foldexpr\texpression used when 'foldmethod' is \"expr\"") 908 call append("$", "\t(local to window)") 909 call <SID>OptionL("fde") 910 call append("$", "foldignore\tused to ignore lines when 'foldmethod' is \"indent\"") 911 call append("$", "\t(local to window)") 912 call <SID>OptionL("fdi") 913 call append("$", "foldmarker\tmarkers used when 'foldmethod' is \"marker\"") 914 call append("$", "\t(local to window)") 915 call <SID>OptionL("fmr") 916 call append("$", "foldnestmax\tmaximum fold depth for when 'foldmethod is \"indent\" or \"syntax\"") 917 call append("$", "\t(local to window)") 918 call <SID>OptionL("fdn") 919endif 920 921 922if has("diff") 923 call <SID>Header("diff mode") 924 call append("$", "diff\tuse diff mode for the current window") 925 call append("$", "\t(local to window)") 926 call <SID>BinOptionL("diff") 927 call append("$", "diffopt\toptions for using diff mode") 928 call <SID>OptionG("dip", &dip) 929 call append("$", "diffexpr\texpression used to obtain a diff file") 930 call <SID>OptionG("dex", &dex) 931 call append("$", "patchexpr\texpression used to patch a file") 932 call <SID>OptionG("pex", &pex) 933endif 934 935 936call <SID>Header("mapping") 937call append("$", "maxmapdepth\tmaximum depth of mapping") 938call append("$", " \tset mmd=" . &mmd) 939call append("$", "remap\trecognize mappings in mapped keys") 940call <SID>BinOptionG("remap", &remap) 941call append("$", "timeout\tallow timing out halfway into a mapping") 942call <SID>BinOptionG("to", &to) 943call append("$", "ttimeout\tallow timing out halfway into a key code") 944call <SID>BinOptionG("ttimeout", &ttimeout) 945call append("$", "timeoutlen\ttime in msec for 'timeout'") 946call append("$", " \tset tm=" . &tm) 947call append("$", "ttimeoutlen\ttime in msec for 'ttimeout'") 948call append("$", " \tset ttm=" . &ttm) 949 950 951call <SID>Header("reading and writing files") 952call append("$", "modeline\tenable using settings from modelines when reading a file") 953call append("$", "\t(local to buffer)") 954call <SID>BinOptionL("ml") 955call append("$", "modelines\tnumber of lines to check for modelines") 956call append("$", " \tset mls=" . &mls) 957call append("$", "binary\tbinary file editing") 958call append("$", "\t(local to buffer)") 959call <SID>BinOptionL("bin") 960call append("$", "endofline\tlast line in the file has an end-of-line") 961call append("$", "\t(local to buffer)") 962call <SID>BinOptionL("eol") 963call append("$", "fixendofline\tfixes missing end-of-line at end of text file") 964call append("$", "\t(local to buffer)") 965call <SID>BinOptionL("fixeol") 966if has("multi_byte") 967 call append("$", "bomb\tprepend a Byte Order Mark to the file") 968 call append("$", "\t(local to buffer)") 969 call <SID>BinOptionL("bomb") 970endif 971call append("$", "fileformat\tend-of-line format: \"dos\", \"unix\" or \"mac\"") 972call append("$", "\t(local to buffer)") 973call <SID>OptionL("ff") 974call append("$", "fileformats\tlist of file formats to look for when editing a file") 975call <SID>OptionG("ffs", &ffs) 976call append("$", "textmode\tobsolete, use 'fileformat'") 977call append("$", "\t(local to buffer)") 978call <SID>BinOptionL("tx") 979call append("$", "textauto\tobsolete, use 'fileformats'") 980call <SID>BinOptionG("ta", &ta) 981call append("$", "write\twriting files is allowed") 982call <SID>BinOptionG("write", &write) 983call append("$", "writebackup\twrite a backup file before overwriting a file") 984call <SID>BinOptionG("wb", &wb) 985call append("$", "backup\tkeep a backup after overwriting a file") 986call <SID>BinOptionG("bk", &bk) 987call append("$", "backupskip\tpatterns that specify for which files a backup is not made") 988call append("$", " \tset bsk=" . &bsk) 989call append("$", "backupcopy\twhether to make the backup as a copy or rename the existing file") 990call append("$", "\t(global or local to buffer)") 991call append("$", " \tset bkc=" . &bkc) 992call append("$", "backupdir\tlist of directories to put backup files in") 993call <SID>OptionG("bdir", &bdir) 994call append("$", "backupext\tfile name extension for the backup file") 995call <SID>OptionG("bex", &bex) 996call append("$", "autowrite\tautomatically write a file when leaving a modified buffer") 997call <SID>BinOptionG("aw", &aw) 998call append("$", "autowriteall\tas 'autowrite', but works with more commands") 999call <SID>BinOptionG("awa", &awa) 1000call append("$", "writeany\talways write without asking for confirmation") 1001call <SID>BinOptionG("wa", &wa) 1002call append("$", "autoread\tautomatically read a file when it was modified outside of Vim") 1003call append("$", "\t(global or local to buffer)") 1004call <SID>BinOptionG("ar", &ar) 1005call append("$", "patchmode\tkeep oldest version of a file; specifies file name extension") 1006call <SID>OptionG("pm", &pm) 1007call append("$", "fsync\tforcibly sync the file to disk after writing it") 1008call <SID>BinOptionG("fs", &fs) 1009if !has("msdos") 1010 call append("$", "shortname\tuse 8.3 file names") 1011 call append("$", "\t(local to buffer)") 1012 call <SID>BinOptionL("sn") 1013endif 1014call append("$", "cryptmethod\tencryption method for file writing: zip or blowfish") 1015call append("$", "\t(local to buffer)") 1016call <SID>OptionL("cm") 1017 1018 1019call <SID>Header("the swap file") 1020call append("$", "directory\tlist of directories for the swap file") 1021call <SID>OptionG("dir", &dir) 1022call append("$", "swapfile\tuse a swap file for this buffer") 1023call append("$", "\t(local to buffer)") 1024call <SID>BinOptionL("swf") 1025call append("$", "swapsync\t\"sync\", \"fsync\" or empty; how to flush a swap file to disk") 1026call <SID>OptionG("sws", &sws) 1027call append("$", "updatecount\tnumber of characters typed to cause a swap file update") 1028call append("$", " \tset uc=" . &uc) 1029call append("$", "updatetime\ttime in msec after which the swap file will be updated") 1030call append("$", " \tset ut=" . &ut) 1031call append("$", "maxmem\tmaximum amount of memory in Kbyte used for one buffer") 1032call append("$", " \tset mm=" . &mm) 1033call append("$", "maxmemtot\tmaximum amount of memory in Kbyte used for all buffers") 1034call append("$", " \tset mmt=" . &mmt) 1035 1036 1037call <SID>Header("command line editing") 1038call append("$", "history\thow many command lines are remembered ") 1039call append("$", " \tset hi=" . &hi) 1040call append("$", "wildchar\tkey that triggers command-line expansion") 1041call append("$", " \tset wc=" . &wc) 1042call append("$", "wildcharm\tlike 'wildchar' but can also be used in a mapping") 1043call append("$", " \tset wcm=" . &wcm) 1044call append("$", "wildmode\tspecifies how command line completion works") 1045call <SID>OptionG("wim", &wim) 1046if has("wildoptions") 1047 call append("$", "wildoptions\tempty or \"tagfile\" to list file name of matching tags") 1048 call <SID>OptionG("wop", &wop) 1049endif 1050call append("$", "suffixes\tlist of file name extensions that have a lower priority") 1051call <SID>OptionG("su", &su) 1052if has("file_in_path") 1053 call append("$", "suffixesadd\tlist of file name extensions added when searching for a file") 1054 call append("$", "\t(local to buffer)") 1055 call <SID>OptionL("sua") 1056endif 1057if has("wildignore") 1058 call append("$", "wildignore\tlist of patterns to ignore files for file name completion") 1059 call <SID>OptionG("wig", &wig) 1060endif 1061call append("$", "fileignorecase\tignore case when using file names") 1062call <SID>BinOptionG("fic", &fic) 1063call append("$", "wildignorecase\tignore case when completing file names") 1064call <SID>BinOptionG("wic", &wic) 1065if has("wildmenu") 1066 call append("$", "wildmenu\tcommand-line completion shows a list of matches") 1067 call <SID>BinOptionG("wmnu", &wmnu) 1068endif 1069if has("vertsplit") 1070 call append("$", "cedit\tkey used to open the command-line window") 1071 call <SID>OptionG("cedit", &cedit) 1072 call append("$", "cmdwinheight\theight of the command-line window") 1073 call <SID>OptionG("cwh", &cwh) 1074endif 1075call append("$", "undofile\tautomatically save and restore undo history") 1076call <SID>BinOptionG("udf", &udf) 1077call append("$", "undodir\tlist of directories for undo files") 1078call <SID>OptionG("udir", &udir) 1079 1080 1081call <SID>Header("executing external commands") 1082call append("$", "shell\tname of the shell program used for external commands") 1083call <SID>OptionG("sh", &sh) 1084if has("amiga") 1085 call append("$", "shelltype\twhen to use the shell or directly execute a command") 1086 call append("$", " \tset st=" . &st) 1087endif 1088call append("$", "shellquote\tcharacter(s) to enclose a shell command in") 1089call <SID>OptionG("shq", &shq) 1090call append("$", "shellxquote\tlike 'shellquote' but include the redirection") 1091call <SID>OptionG("sxq", &sxq) 1092call append("$", "shellxescape\tcharacters to escape when 'shellxquote' is (") 1093call <SID>OptionG("sxe", &sxe) 1094call append("$", "shellcmdflag\targument for 'shell' to execute a command") 1095call <SID>OptionG("shcf", &shcf) 1096call append("$", "shellredir\tused to redirect command output to a file") 1097call <SID>OptionG("srr", &srr) 1098call append("$", "shelltemp\tuse a temp file for shell commands instead of using a pipe") 1099call <SID>BinOptionG("stmp", &stmp) 1100call append("$", "equalprg\tprogram used for \"=\" command") 1101call append("$", "\t(global or local to buffer)") 1102call <SID>OptionG("ep", &ep) 1103call append("$", "formatprg\tprogram used to format lines with \"gq\" command") 1104call <SID>OptionG("fp", &fp) 1105call append("$", "keywordprg\tprogram used for the \"K\" command") 1106call <SID>OptionG("kp", &kp) 1107call append("$", "warn\twarn when using a shell command and a buffer has changes") 1108call <SID>BinOptionG("warn", &warn) 1109 1110 1111if has("quickfix") 1112 call <SID>Header("running make and jumping to errors") 1113 call append("$", "errorfile\tname of the file that contains error messages") 1114 call <SID>OptionG("ef", &ef) 1115 call append("$", "errorformat\tlist of formats for error messages") 1116 call append("$", "\t(global or local to buffer)") 1117 call <SID>OptionG("efm", &efm) 1118 call append("$", "makeprg\tprogram used for the \":make\" command") 1119 call append("$", "\t(global or local to buffer)") 1120 call <SID>OptionG("mp", &mp) 1121 call append("$", "shellpipe\tstring used to put the output of \":make\" in the error file") 1122 call <SID>OptionG("sp", &sp) 1123 call append("$", "makeef\tname of the errorfile for the 'makeprg' command") 1124 call <SID>OptionG("mef", &mef) 1125 call append("$", "grepprg\tprogram used for the \":grep\" command") 1126 call append("$", "\t(global or local to buffer)") 1127 call <SID>OptionG("gp", &gp) 1128 call append("$", "grepformat\tlist of formats for output of 'grepprg'") 1129 call <SID>OptionG("gfm", &gfm) 1130endif 1131 1132 1133if has("msdos") || has("os2") || has("win16") || has("win32") || has("osfiletype") 1134 call <SID>Header("system specific") 1135 if has("msdos") 1136 call append("$", "bioskey\tcall the BIOS to get a keyoard character") 1137 call <SID>BinOptionG("biosk", &biosk) 1138 call append("$", "conskey\tuse direct console I/O to get a keyboard character") 1139 call <SID>BinOptionG("consk", &consk) 1140 endif 1141 if has("osfiletype") 1142 call append("$", "osfiletype\tOS-specific information about the type of file") 1143 call append("$", "\t(local to buffer)") 1144 call <SID>OptionL("oft") 1145 endif 1146 if has("msdos") || has("os2") || has("win16") || has("win32") 1147 call append("$", "shellslash\tuse forward slashes in file names; for Unix-like shells") 1148 call <SID>BinOptionG("ssl", &ssl) 1149 endif 1150endif 1151 1152 1153call <SID>Header("language specific") 1154call append("$", "isfname\tspecifies the characters in a file name") 1155call <SID>OptionG("isf", &isf) 1156call append("$", "isident\tspecifies the characters in an identifier") 1157call <SID>OptionG("isi", &isi) 1158call append("$", "iskeyword\tspecifies the characters in a keyword") 1159call append("$", "\t(local to buffer)") 1160call <SID>OptionL("isk") 1161call append("$", "isprint\tspecifies printable characters") 1162call <SID>OptionG("isp", &isp) 1163if has("textobjects") 1164 call append("$", "quoteescape\tspecifies escape characters in a string") 1165 call append("$", "\t(local to buffer)") 1166 call <SID>OptionL("qe") 1167endif 1168if has("rightleft") 1169 call append("$", "rightleft\tdisplay the buffer right-to-left") 1170 call append("$", "\t(local to window)") 1171 call <SID>BinOptionL("rl") 1172 call append("$", "rightleftcmd\twhen to edit the command-line right-to-left") 1173 call append("$", "\t(local to window)") 1174 call <SID>OptionL("rlc") 1175 call append("$", "revins\tinsert characters backwards") 1176 call <SID>BinOptionG("ri", &ri) 1177 call append("$", "allowrevins\tallow CTRL-_ in Insert and Command-line mode to toggle 'revins'") 1178 call <SID>BinOptionG("ari", &ari) 1179 call append("$", "aleph\tthe ASCII code for the first letter of the Hebrew alphabet") 1180 call append("$", " \tset al=" . &al) 1181 call append("$", "hkmap\tuse Hebrew keyboard mapping") 1182 call <SID>BinOptionG("hk", &hk) 1183 call append("$", "hkmapp\tuse phonetic Hebrew keyboard mapping") 1184 call <SID>BinOptionG("hkp", &hkp) 1185endif 1186if has("farsi") 1187 call append("$", "altkeymap\tuse Farsi as the second language when 'revins' is set") 1188 call <SID>BinOptionG("akm", &akm) 1189 call append("$", "fkmap\tuse Farsi keyboard mapping") 1190 call <SID>BinOptionG("fk", &fk) 1191endif 1192if has("arabic") 1193 call append("$", "arabic\tprepare for editing Arabic text") 1194 call append("$", "\t(local to window)") 1195 call <SID>BinOptionL("arab") 1196 call append("$", "arabicshape\tperform shaping of Arabic characters") 1197 call <SID>BinOptionG("arshape", &arshape) 1198 call append("$", "termbidi\tterminal will perform bidi handling") 1199 call <SID>BinOptionG("tbidi", &tbidi) 1200endif 1201if has("keymap") 1202 call append("$", "keymap\tname of a keyboard mappping") 1203 call <SID>OptionL("kmp") 1204endif 1205if has("langmap") 1206 call append("$", "langmap\tlist of characters that are translated in Normal mode") 1207 call <SID>OptionG("lmap", &lmap) 1208 call append("$", "langnoremap\tdon't apply 'langmap' to mapped characters") 1209 call <SID>BinOptionG("lnr", &lnr) 1210endif 1211if has("xim") 1212 call append("$", "imdisable\twhen set never use IM; overrules following IM options") 1213 call <SID>BinOptionG("imd", &imd) 1214endif 1215call append("$", "iminsert\tin Insert mode: 1: use :lmap; 2: use IM; 0: neither") 1216call append("$", "\t(local to window)") 1217call <SID>OptionL("imi") 1218call append("$", "imsearch\tentering a search pattern: 1: use :lmap; 2: use IM; 0: neither") 1219call append("$", "\t(local to window)") 1220call <SID>OptionL("ims") 1221if has("xim") 1222 call append("$", "imcmdline\twhen set always use IM when starting to edit a command line") 1223 call <SID>BinOptionG("imc", &imc) 1224 call append("$", "imstatusfunc\tfunction to obtain IME status") 1225 call <SID>OptionG("imsf", &imsf) 1226 call append("$", "imactivatefunc\tfunction to enable/disable IME") 1227 call <SID>OptionG("imaf", &imaf) 1228endif 1229 1230 1231if has("multi_byte") 1232 call <SID>Header("multi-byte characters") 1233 call append("$", "encoding\tcharacter encoding used in Vim: \"latin1\", \"utf-8\"") 1234 call append("$", "\t\"euc-jp\", \"big5\", etc.") 1235 call <SID>OptionG("enc", &enc) 1236 call append("$", "fileencoding\tcharacter encoding for the current file") 1237 call append("$", "\t(local to buffer)") 1238 call <SID>OptionL("fenc") 1239 call append("$", "fileencodings\tautomatically detected character encodings") 1240 call <SID>OptionG("fencs", &fencs) 1241 call append("$", "termencoding\tcharacter encoding used by the terminal") 1242 call <SID>OptionG("tenc", &tenc) 1243 call append("$", "charconvert\texpression used for character encoding conversion") 1244 call <SID>OptionG("ccv", &ccv) 1245 call append("$", "delcombine\tdelete combining (composing) characters on their own") 1246 call <SID>BinOptionG("deco", &deco) 1247 call append("$", "maxcombine\tmaximum number of combining (composing) characters displayed") 1248 call <SID>OptionG("mco", &mco) 1249 if has("xim") && has("gui_gtk") 1250 call append("$", "imactivatekey\tkey that activates the X input method") 1251 call <SID>OptionG("imak", &imak) 1252 endif 1253 call append("$", "ambiwidth\twidth of ambiguous width characters") 1254 call <SID>OptionG("ambw", &ambw) 1255endif 1256 1257 1258call <SID>Header("various") 1259if has("virtualedit") 1260 call append("$", "virtualedit\twhen to use virtual editing: \"block\", \"insert\" and/or \"all\"") 1261 call <SID>OptionG("ve", &ve) 1262endif 1263if has("autocmd") 1264 call append("$", "eventignore\tlist of autocommand events which are to be ignored") 1265 call <SID>OptionG("ei", &ei) 1266endif 1267call append("$", "loadplugins\tload plugin scripts when starting up") 1268call <SID>BinOptionG("lpl", &lpl) 1269call append("$", "exrc\tenable reading .vimrc/.exrc/.gvimrc in the current directory") 1270call <SID>BinOptionG("ex", &ex) 1271call append("$", "secure\tsafer working with script files in the current directory") 1272call <SID>BinOptionG("secure", &secure) 1273call append("$", "gdefault\tuse the 'g' flag for \":substitute\"") 1274call <SID>BinOptionG("gd", &gd) 1275call append("$", "edcompatible\t'g' and 'c' flags of \":substitute\" toggle") 1276call <SID>BinOptionG("ed", &ed) 1277if exists("+opendevice") 1278 call append("$", "opendevice\tallow reading/writing devices") 1279 call <SID>BinOptionG("odev", &odev) 1280endif 1281if exists("+maxfuncdepth") 1282 call append("$", "maxfuncdepth\tmaximum depth of function calls") 1283 call append("$", " \tset mfd=" . &mfd) 1284endif 1285if has("mksession") 1286 call append("$", "sessionoptions\tlist of words that specifies what to put in a session file") 1287 call <SID>OptionG("ssop", &ssop) 1288 call append("$", "viewoptions\tlist of words that specifies what to save for :mkview") 1289 call <SID>OptionG("vop", &vop) 1290 call append("$", "viewdir\tdirectory where to store files with :mkview") 1291 call <SID>OptionG("vdir", &vdir) 1292endif 1293if has("viminfo") 1294 call append("$", "viminfo\tlist that specifies what to write in the viminfo file") 1295 call <SID>OptionG("vi", &vi) 1296endif 1297if has("quickfix") 1298 call append("$", "bufhidden\twhat happens with a buffer when it's no longer in a window") 1299 call append("$", "\t(local to buffer)") 1300 call <SID>OptionL("bh") 1301 call append("$", "buftype\t\"\", \"nofile\", \"nowrite\" or \"quickfix\": type of buffer") 1302 call append("$", "\t(local to buffer)") 1303 call <SID>OptionL("bt") 1304endif 1305call append("$", "buflisted\twhether the buffer shows up in the buffer list") 1306call append("$", "\t(local to buffer)") 1307call <SID>BinOptionL("bl") 1308call append("$", "debug\tset to \"msg\" to see all error messages") 1309call append("$", " \tset debug=" . &debug) 1310if has("mzscheme") 1311 call append("$", "mzquantum\tinterval in milliseconds between polls for MzScheme threads") 1312 call append("$", " \tset mzq=" . &mzq) 1313endif 1314if exists("&luadll") 1315 call append("$", "luadll\tname of the Lua dynamic library") 1316 call <SID>OptionG("luadll", &luadll) 1317endif 1318if exists("&perldll") 1319 call append("$", "perldll\tname of the Perl dynamic library") 1320 call <SID>OptionG("perldll", &perldll) 1321endif 1322if exists("&pythondll") 1323 call append("$", "pythondll\tname of the Python 2 dynamic library") 1324 call <SID>OptionG("pythondll", &pythondll) 1325endif 1326if exists("&pythonthreedll") 1327 call append("$", "pythonthreedll\tname of the Python 3 dynamic library") 1328 call <SID>OptionG("pythonthreedll", &pythonthreedll) 1329endif 1330if exists("&rubydll") 1331 call append("$", "rubydll\tname of the Ruby dynamic library") 1332 call <SID>OptionG("rubydll", &rubydll) 1333endif 1334 1335set cpo&vim 1336 1337" go to first line 13381 1339 1340" reset 'modified', so that ":q" can be used to close the window 1341setlocal nomodified 1342 1343if has("syntax") 1344 " Use Vim highlighting, with some additional stuff 1345 setlocal ft=vim 1346 syn match optwinHeader "^ \=[0-9].*" 1347 syn match optwinName "^[a-z]*\t" nextgroup=optwinComment 1348 syn match optwinComment ".*" contained 1349 syn match optwinComment "^\t.*" 1350 if !exists("did_optwin_syntax_inits") 1351 let did_optwin_syntax_inits = 1 1352 hi link optwinHeader Title 1353 hi link optwinName Identifier 1354 hi link optwinComment Comment 1355 endif 1356endif 1357 1358" Install autocommands to enable mappings in option-window 1359noremap <silent> <buffer> <CR> <C-\><C-N>:call <SID>CR()<CR> 1360inoremap <silent> <buffer> <CR> <Esc>:call <SID>CR()<CR> 1361noremap <silent> <buffer> <Space> :call <SID>Space()<CR> 1362 1363" Make the buffer be deleted when the window is closed. 1364setlocal buftype=nofile bufhidden=delete noswapfile 1365 1366augroup optwin 1367 au! BufUnload,BufHidden option-window nested 1368 \ call <SID>unload() | delfun <SID>unload 1369augroup END 1370 1371fun! <SID>unload() 1372 delfun <SID>CR 1373 delfun <SID>Space 1374 delfun <SID>Find 1375 delfun <SID>Update 1376 delfun <SID>OptionL 1377 delfun <SID>OptionG 1378 delfun <SID>BinOptionL 1379 delfun <SID>BinOptionG 1380 delfun <SID>Header 1381 au! optwin 1382endfun 1383 1384" Restore the previous value of 'title' and 'icon'. 1385let &title = s:old_title 1386let &icon = s:old_icon 1387let &ru = s:old_ru 1388let &sc = s:old_sc 1389let &cpo = s:cpo_save 1390unlet s:old_title s:old_icon s:old_ru s:old_sc s:cpo_save s:idx s:lnum 1391 1392" vim: ts=8 sw=2 sts=2 1393