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