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