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