Mercurial > vim

comparison runtime/optwin.vim @ 7:3fc0f57ecb91 v7.0001

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