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