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