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