blob: 2cbbd288b2e1e2a55b505f2af45c2bd39640c3c1 [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 Moolenaarad4187e2017-03-06 21:45:20 +01004" Last Change: 2017 Mar 06
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
Bram Moolenaar251e1912011-06-19 05:09:16 +020013 wincmd w
Bram Moolenaar071d4272004-06-13 20:20:40 +000014 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
Bram Moolenaar251e1912011-06-19 05:09:16 +020029 let lnum = search("^[^\t]", 'bWcn')
Bram Moolenaar071d4272004-06-13 20:20:40 +000030 let line = getline(lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +000031
32 " <CR> on a "set" line executes the option line
33 if match(line, "^ \tset ") >= 0
34
35 " For a local option: go to the previous window
36 " If this is a help window, go to the window below it
37 let thiswin = winnr()
38 let local = <SID>Find(lnum)
39 if local >= 0
40 exe line
41 call <SID>Update(lnum, line, local, thiswin)
42 endif
43
44 " <CR> on a "option" line shows help for that option
45 elseif match(line, "^[a-z]") >= 0
46 let name = substitute(line, '\([^\t]*\).*', '\1', "")
47 exe "help '" . name . "'"
48
49 " <CR> on an index line jumps to the group
50 elseif match(line, '^ \=[0-9]') >= 0
51 exe "norm! /" . line . "\<CR>zt"
52 endif
53endfun
54
55" function to be called when <Space> is hit in the option-window
56fun! <SID>Space()
57
58 let lnum = line(".")
59 let line = getline(lnum)
60
61 " <Space> on a "set" line refreshes the option line
62 if match(line, "^ \tset ") >= 0
63
64 " For a local option: go to the previous window
65 " If this is a help window, go to the window below it
66 let thiswin = winnr()
67 let local = <SID>Find(lnum)
68 if local >= 0
69 call <SID>Update(lnum, line, local, thiswin)
70 endif
71
72 endif
73endfun
74
75" find the window in which the option applies
76" returns 0 for global option, 1 for local option, -1 for error
77fun! <SID>Find(lnum)
78 if getline(a:lnum - 1) =~ "(local to"
79 let local = 1
80 let thiswin = winnr()
Bram Moolenaar251e1912011-06-19 05:09:16 +020081 wincmd p
Bram Moolenaar071d4272004-06-13 20:20:40 +000082 if exists("b:current_syntax") && b:current_syntax == "help"
Bram Moolenaar251e1912011-06-19 05:09:16 +020083 wincmd j
Bram Moolenaar071d4272004-06-13 20:20:40 +000084 if winnr() == thiswin
Bram Moolenaar251e1912011-06-19 05:09:16 +020085 wincmd j
Bram Moolenaar071d4272004-06-13 20:20:40 +000086 endif
87 endif
88 else
89 let local = 0
90 endif
91 if local && (winnr() == thiswin || (exists("b:current_syntax")
92 \ && b:current_syntax == "help"))
93 echo "Don't know in which window"
94 let local = -1
95 endif
96 return local
97endfun
98
99" Update a "set" line in the option window
100fun! <SID>Update(lnum, line, local, thiswin)
101 " get the new value of the option and update the option window line
102 if match(a:line, "=") >= 0
103 let name = substitute(a:line, '^ \tset \([^=]*\)=.*', '\1', "")
104 else
105 let name = substitute(a:line, '^ \tset \(no\)\=\([a-z]*\).*', '\2', "")
106 endif
107 if name == "pt" && &pt =~ "\x80"
108 let val = <SID>PTvalue()
109 else
Bram Moolenaar251e1912011-06-19 05:09:16 +0200110 let val = escape(eval('&' . name), " \t\\\"|")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000111 endif
112 if a:local
Bram Moolenaar251e1912011-06-19 05:09:16 +0200113 exe a:thiswin . "wincmd w"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000114 endif
115 if match(a:line, "=") >= 0 || (val != "0" && val != "1")
116 call setline(a:lnum, " \tset " . name . "=" . val)
117 else
118 if val
119 call setline(a:lnum, " \tset " . name . "\tno" . name)
120 else
121 call setline(a:lnum, " \tset no" . name . "\t" . name)
122 endif
123 endif
124 set nomodified
125endfun
126
127" Reset 'title' and 'icon' to make it work faster.
128let s:old_title = &title
129let s:old_icon = &icon
130let s:old_sc = &sc
131let s:old_ru = &ru
132set notitle noicon nosc noru
133
134" If the current window is a help window, try finding a non-help window.
135" Relies on syntax highlighting to be switched on.
136let s:thiswin = winnr()
137while exists("b:current_syntax") && b:current_syntax == "help"
Bram Moolenaar251e1912011-06-19 05:09:16 +0200138 wincmd w
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139 if s:thiswin == winnr()
140 break
141 endif
142endwhile
143
144" Open the window
145new option-window
Bram Moolenaar251e1912011-06-19 05:09:16 +0200146setlocal ts=15 tw=0 noro buftype=nofile
Bram Moolenaar071d4272004-06-13 20:20:40 +0000147
148" Insert help and a "set" command for each option.
149call append(0, '" Each "set" line shows the current value of an option (on the left).')
150call append(1, '" Hit <CR> on a "set" line to execute it.')
151call append(2, '" A boolean option will be toggled.')
Bram Moolenaar2f3b5102014-11-19 18:54:17 +0100152call append(3, '" For other options you can edit the value before hitting <CR>.')
Bram Moolenaar071d4272004-06-13 20:20:40 +0000153call append(4, '" Hit <CR> on a help line to open a help window on this option.')
154call append(5, '" Hit <CR> on an index line to jump there.')
155call append(6, '" Hit <Space> on a "set" line to refresh it.')
156
157" These functions are called often below. Keep them fast!
158
159" Init a local binary option
160fun! <SID>BinOptionL(name)
Bram Moolenaar251e1912011-06-19 05:09:16 +0200161 let val = getwinvar(winnr('#'), '&' . a:name)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000162 call append("$", substitute(substitute(" \tset " . val . a:name . "\t" .
163 \!val . a:name, "0", "no", ""), "1", "", ""))
164endfun
165
166" Init a global binary option
167fun! <SID>BinOptionG(name, val)
168 call append("$", substitute(substitute(" \tset " . a:val . a:name . "\t" .
169 \!a:val . a:name, "0", "no", ""), "1", "", ""))
170endfun
171
172" Init a local string option
173fun! <SID>OptionL(name)
Bram Moolenaar251e1912011-06-19 05:09:16 +0200174 let val = escape(getwinvar(winnr('#'), '&' . a:name), " \t\\\"|")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000175 call append("$", " \tset " . a:name . "=" . val)
176endfun
177
178" Init a global string option
179fun! <SID>OptionG(name, val)
Bram Moolenaar251e1912011-06-19 05:09:16 +0200180 call append("$", " \tset " . a:name . "=" . escape(a:val, " \t\\\"|"))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000181endfun
182
183let s:idx = 1
184let s:lnum = line("$")
185call append("$", "")
186
187fun! <SID>Header(text)
188 let line = s:idx . " " . a:text
189 if s:idx < 10
190 let line = " " . line
191 endif
192 call append("$", "")
193 call append("$", line)
194 call append("$", "")
195 call append(s:lnum, line)
196 let s:idx = s:idx + 1
197 let s:lnum = s:lnum + 1
198endfun
199
200" Get the value of 'pastetoggle'. It could be a special key.
201fun! <SID>PTvalue()
202 redir @a
203 silent set pt
204 redir END
205 return substitute(@a, '[^=]*=\(.*\)', '\1', "")
206endfun
207
208" Restore the previous value of 'cpoptions' here, it's used below.
209let &cpo = s:cpo_save
210
211" List of all options, organized by function.
212" The text should be sufficient to know what the option is used for.
213
214call <SID>Header("important")
215call append("$", "compatible\tbehave very Vi compatible (not advisable)")
216call <SID>BinOptionG("cp", &cp)
217call append("$", "cpoptions\tlist of flags to specify Vi compatibility")
218call <SID>OptionG("cpo", &cpo)
219call append("$", "insertmode\tuse Insert mode as the default mode")
220call <SID>BinOptionG("im", &im)
221call append("$", "paste\tpaste mode, insert typed text literally")
222call <SID>BinOptionG("paste", &paste)
223call append("$", "pastetoggle\tkey sequence to toggle paste mode")
224if &pt =~ "\x80"
225 call append("$", " \tset pt=" . <SID>PTvalue())
226else
227 call <SID>OptionG("pt", &pt)
228endif
229call append("$", "runtimepath\tlist of directories used for runtime files and plugins")
230call <SID>OptionG("rtp", &rtp)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +0100231call append("$", "packpath\tlist of directories used for plugin packages")
232call <SID>OptionG("pp", &pp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000233call append("$", "helpfile\tname of the main help file")
234call <SID>OptionG("hf", &hf)
235
236
237call <SID>Header("moving around, searching and patterns")
238call append("$", "whichwrap\tlist of flags specifying which commands wrap to another line")
239call append("$", "\t(local to window)")
240call <SID>OptionL("ww")
241call append("$", "startofline\tmany jump commands move the cursor to the first non-blank")
242call append("$", "\tcharacter of a line")
243call <SID>BinOptionG("sol", &sol)
244call append("$", "paragraphs\tnroff macro names that separate paragraphs")
245call <SID>OptionG("para", &para)
246call append("$", "sections\tnroff macro names that separate sections")
247call <SID>OptionG("sect", &sect)
248call append("$", "path\tlist of directory names used for file searching")
249call append("$", "\t(global or local to buffer)")
250call <SID>OptionG("pa", &pa)
251call append("$", "cdpath\tlist of directory names used for :cd")
252call <SID>OptionG("cd", &cd)
Bram Moolenaarfa9a3702010-07-24 15:48:31 +0200253if exists("+autochdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000254 call append("$", "autochdir\tchange to directory of file in buffer")
255 call <SID>BinOptionG("acd", &acd)
256endif
257call append("$", "wrapscan\tsearch commands wrap around the end of the buffer")
258call <SID>BinOptionG("ws", &ws)
259call append("$", "incsearch\tshow match for partly typed search command")
260call <SID>BinOptionG("is", &is)
261call append("$", "magic\tchange the way backslashes are used in search patterns")
262call <SID>BinOptionG("magic", &magic)
Bram Moolenaare6ae6222013-05-21 21:01:10 +0200263call append("$", "regexpengine\tselect the default regexp engine used")
264call <SID>OptionG("re", &re)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000265call append("$", "ignorecase\tignore case when using a search pattern")
266call <SID>BinOptionG("ic", &ic)
267call append("$", "smartcase\toverride 'ignorecase' when pattern has upper case characters")
268call <SID>BinOptionG("scs", &scs)
Bram Moolenaar1deee622010-07-24 20:35:12 +0200269call append("$", "casemap\twhat method to use for changing case of letters")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270call <SID>OptionG("cmp", &cmp)
Bram Moolenaar52b4b552005-03-07 23:00:57 +0000271call append("$", "maxmempattern\tmaximum amount of memory in Kbyte used for pattern matching")
272call append("$", " \tset mmp=" . &mmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000273call append("$", "define\tpattern for a macro definition line")
274call append("$", "\t(global or local to buffer)")
275call <SID>OptionG("def", &def)
276if has("find_in_path")
277 call append("$", "include\tpattern for an include-file line")
278 call append("$", "\t(local to buffer)")
279 call <SID>OptionL("inc")
280 call append("$", "includeexpr\texpression used to transform an include line to a file name")
281 call append("$", "\t(local to buffer)")
282 call <SID>OptionL("inex")
283endif
284
285
286call <SID>Header("tags")
287call append("$", "tagbsearch\tuse binary searching in tags files")
288call <SID>BinOptionG("tbs", &tbs)
289call append("$", "taglength\tnumber of significant characters in a tag name or zero")
290call append("$", " \tset tl=" . &tl)
291call append("$", "tags\tlist of file names to search for tags")
292call append("$", "\t(global or local to buffer)")
293call <SID>OptionG("tag", &tag)
Bram Moolenaar0f6562e2015-11-24 18:48:14 +0100294call append("$", "tagcase\thow to handle case when searching in tags files:")
295call append("$", "\t\"followic\" to follow 'ignorecase', \"ignore\" or \"match\"")
296call append("$", "\t(global or local to buffer)")
297call <SID>OptionG("tc", &tc)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000298call append("$", "tagrelative\tfile names in a tags file are relative to the tags file")
299call <SID>BinOptionG("tr", &tr)
300call append("$", "tagstack\ta :tag command will use the tagstack")
301call <SID>BinOptionG("tgst", &tgst)
302call append("$", "showfulltag\twhen completing tags in Insert mode show more info")
303call <SID>BinOptionG("sft", &sft)
304if has("cscope")
305 call append("$", "cscopeprg\tcommand for executing cscope")
306 call <SID>OptionG("csprg", &csprg)
307 call append("$", "cscopetag\tuse cscope for tag commands")
308 call <SID>BinOptionG("cst", &cst)
309 call append("$", "cscopetagorder\t0 or 1; the order in which \":cstag\" performs a search")
310 call append("$", " \tset csto=" . &csto)
311 call append("$", "cscopeverbose\tgive messages when adding a cscope database")
312 call <SID>BinOptionG("csverb", &csverb)
313 call append("$", "cscopepathcomp\thow many components of the path to show")
314 call append("$", " \tset cspc=" . &cspc)
Bram Moolenaar1deee622010-07-24 20:35:12 +0200315 call append("$", "cscopequickfix\twhen to open a quickfix window for cscope")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 call <SID>OptionG("csqf", &csqf)
Bram Moolenaar251e1912011-06-19 05:09:16 +0200317 call append("$", "cscoperelative\tfile names in a cscope file are relative to that file")
318 call <SID>BinOptionG("csre", &csre)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319endif
320
321
322call <SID>Header("displaying text")
323call append("$", "scroll\tnumber of lines to scroll for CTRL-U and CTRL-D")
324call append("$", "\t(local to window)")
325call <SID>OptionL("scr")
326call append("$", "scrolloff\tnumber of screen lines to show around the cursor")
327call append("$", " \tset so=" . &so)
328call append("$", "wrap\tlong lines wrap")
329call <SID>BinOptionG("wrap", &wrap)
330call append("$", "linebreak\twrap long lines at a character in 'breakat'")
331call append("$", "\t(local to window)")
332call <SID>BinOptionL("lbr")
Bram Moolenaar597a4222014-06-25 14:39:50 +0200333call append("$", "breakindent\tpreserve indentation in wrapped text")
334call append("$", "\t(local to window)")
335call <SID>BinOptionL("bri")
336call append("$", "breakindentopt\tadjust breakindent behaviour")
337call append("$", "\t(local to window)")
338call <SID>OptionL("briopt")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000339call append("$", "breakat\twhich characters might cause a line break")
340call <SID>OptionG("brk", &brk)
341call append("$", "showbreak\tstring to put before wrapped screen lines")
342call <SID>OptionG("sbr", &sbr)
343call append("$", "sidescroll\tminimal number of columns to scroll horizontally")
344call append("$", " \tset ss=" . &ss)
345call append("$", "sidescrolloff\tminimal number of columns to keep left and right of the cursor")
346call append("$", " \tset siso=" . &siso)
347call append("$", "display\tinclude \"lastline\" to show the last line even if it doesn't fit")
348call append("$", "\tinclude \"uhex\" to show unprintable characters as a hex number")
349call <SID>OptionG("dy", &dy)
350call append("$", "fillchars\tcharacters to use for the status line, folds and filler lines")
351call <SID>OptionG("fcs", &fcs)
352call append("$", "cmdheight\tnumber of lines used for the command-line")
353call append("$", " \tset ch=" . &ch)
354call append("$", "columns\twidth of the display")
355call append("$", " \tset co=" . &co)
356call append("$", "lines\tnumber of lines in the display")
357call append("$", " \tset lines=" . &lines)
Bram Moolenaar1b20d3d2010-07-24 20:44:02 +0200358call append("$", "window\tnumber of lines to scroll for CTRL-F and CTRL-B")
359call append("$", " \tset window=" . &window)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000360call append("$", "lazyredraw\tdon't redraw while executing macros")
361call <SID>BinOptionG("lz", &lz)
Bram Moolenaar63ce8c02008-06-04 12:29:14 +0000362if has("reltime")
363 call append("$", "redrawtime\ttimeout for 'hlsearch' and :match highlighting in msec")
364 call append("$", " \tset rdt=" . &rdt)
365endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000366call append("$", "writedelay\tdelay in msec for each char written to the display")
367call append("$", "\t(for debugging)")
368call append("$", " \tset wd=" . &wd)
369call append("$", "list\tshow <Tab> as ^I and end-of-line as $")
370call append("$", "\t(local to window)")
371call <SID>BinOptionL("list")
372call append("$", "listchars\tlist of strings used for list mode")
373call <SID>OptionG("lcs", &lcs)
374call append("$", "number\tshow the line number for each line")
375call append("$", "\t(local to window)")
376call <SID>BinOptionL("nu")
Bram Moolenaar64486672010-05-16 15:46:46 +0200377call append("$", "relativenumber\tshow the relative line number for each line")
378call append("$", "\t(local to window)")
379call <SID>BinOptionL("rnu")
Bram Moolenaar592e0a22004-07-03 16:05:59 +0000380if has("linebreak")
381 call append("$", "numberwidth\tnumber of columns to use for the line number")
382 call append("$", "\t(local to window)")
383 call <SID>OptionL("nuw")
384endif
Bram Moolenaar860cae12010-06-05 23:22:07 +0200385if has("conceal")
Bram Moolenaarfa9a3702010-07-24 15:48:31 +0200386 call append("$", "conceallevel\tcontrols whether concealable text is hidden")
Bram Moolenaar860cae12010-06-05 23:22:07 +0200387 call append("$", "\t(local to window)")
Bram Moolenaarfa9a3702010-07-24 15:48:31 +0200388 call <SID>OptionL("cole")
Bram Moolenaar4f99eae2010-07-24 15:56:43 +0200389 call append("$", "concealcursor\tmodes in which text in the cursor line can be concealed")
Bram Moolenaarfa9a3702010-07-24 15:48:31 +0200390 call append("$", "\t(local to window)")
391 call <SID>OptionL("cocu")
Bram Moolenaar860cae12010-06-05 23:22:07 +0200392endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000393
394
Bram Moolenaar7887d882005-07-01 22:33:52 +0000395call <SID>Header("syntax, highlighting and spelling")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000396call append("$", "background\t\"dark\" or \"light\"; the background color brightness")
397call <SID>OptionG("bg", &bg)
398if has("autocmd")
399 call append("$", "filetype\ttype of file; triggers the FileType event when set")
400 call append("$", "\t(local to buffer)")
401 call <SID>OptionL("ft")
402endif
403if has("syntax")
404 call append("$", "syntax\tname of syntax highlighting used")
405 call append("$", "\t(local to buffer)")
406 call <SID>OptionL("syn")
Bram Moolenaar9ff70112005-07-11 22:29:03 +0000407 call append("$", "synmaxcol\tmaximum column to look for syntax items")
408 call append("$", "\t(local to buffer)")
409 call <SID>OptionL("smc")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000410endif
411call append("$", "highlight\twhich highlighting to use for various occasions")
412call <SID>OptionG("hl", &hl)
413call append("$", "hlsearch\thighlight all matches for the last used search pattern")
414call <SID>BinOptionG("hls", &hls)
Bram Moolenaar8a24b792016-04-30 16:13:10 +0200415if has("termguicolors")
Bram Moolenaar8e3d1b62016-04-30 15:17:19 +0200416 call append("$", "termguicolors\tuse GUI colors for the terminal")
Bram Moolenaar868cfc12016-04-30 16:49:58 +0200417 call <SID>BinOptionG("tgc", &tgc)
Bram Moolenaar8e3d1b62016-04-30 15:17:19 +0200418endif
Bram Moolenaar7887d882005-07-01 22:33:52 +0000419if has("syntax")
Bram Moolenaarf71a3db2006-03-12 21:50:18 +0000420 call append("$", "cursorcolumn\thighlight the screen column of the cursor")
421 call append("$", "\t(local to window)")
422 call <SID>BinOptionL("cuc")
423 call append("$", "cursorline\thighlight the screen line of the cursor")
424 call append("$", "\t(local to window)")
425 call <SID>BinOptionL("cul")
Bram Moolenaar607cc1e2010-07-18 18:47:44 +0200426 call append("$", "colorcolumn\tcolumns to highlight")
427 call append("$", "\t(local to window)")
428 call <SID>OptionL("cc")
Bram Moolenaar7887d882005-07-01 22:33:52 +0000429 call append("$", "spell\thighlight spelling mistakes")
430 call append("$", "\t(local to window)")
431 call <SID>BinOptionL("spell")
432 call append("$", "spelllang\tlist of accepted languages")
433 call append("$", "\t(local to buffer)")
434 call <SID>OptionL("spl")
435 call append("$", "spellfile\tfile that \"zg\" adds good words to")
436 call append("$", "\t(local to buffer)")
437 call <SID>OptionL("spf")
Bram Moolenaar551f84f2005-07-06 22:29:20 +0000438 call append("$", "spellcapcheck\tpattern to locate the end of a sentence")
439 call append("$", "\t(local to buffer)")
440 call <SID>OptionL("spc")
Bram Moolenaar7887d882005-07-01 22:33:52 +0000441 call append("$", "spellsuggest\tmethods used to suggest corrections")
442 call <SID>OptionG("sps", &sps)
Bram Moolenaarac6e65f2005-08-29 22:25:38 +0000443 call append("$", "mkspellmem\tamount of memory used by :mkspell before compressing")
444 call <SID>OptionG("msm", &msm)
Bram Moolenaar7887d882005-07-01 22:33:52 +0000445endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446
447
448call <SID>Header("multiple windows")
449call append("$", "laststatus\t0, 1 or 2; when to use a status line for the last window")
450call append("$", " \tset ls=" . &ls)
451if has("statusline")
452 call append("$", "statusline\talternate format to be used for a status line")
453 call <SID>OptionG("stl", &stl)
454endif
455call append("$", "equalalways\tmake all windows the same size when adding/removing windows")
456call <SID>BinOptionG("ea", &ea)
457if has("vertsplit")
458 call append("$", "eadirection\tin which direction 'equalalways' works: \"ver\", \"hor\" or \"both\"")
459 call <SID>OptionG("ead", &ead)
460endif
461call append("$", "winheight\tminimal number of lines used for the current window")
462call append("$", " \tset wh=" . &wh)
463call append("$", "winminheight\tminimal number of lines used for any window")
464call append("$", " \tset wmh=" . &wmh)
465call append("$", "winfixheight\tkeep the height of the window")
466call append("$", "\t(local to window)")
467call <SID>BinOptionL("wfh")
468if has("vertsplit")
Bram Moolenaarbe4d5062006-03-18 21:30:13 +0000469call append("$", "winfixwidth\tkeep the width of the window")
470call append("$", "\t(local to window)")
471call <SID>BinOptionL("wfw")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000472 call append("$", "winwidth\tminimal number of columns used for the current window")
473 call append("$", " \tset wiw=" . &wiw)
474 call append("$", "winminwidth\tminimal number of columns used for any window")
475 call append("$", " \tset wmw=" . &wmw)
476endif
477call append("$", "helpheight\tinitial height of the help window")
478call append("$", " \tset hh=" . &hh)
479if has("quickfix")
480 call append("$", "previewheight\tdefault height for the preview window")
481 call append("$", " \tset pvh=" . &pvh)
482 call append("$", "previewwindow\tidentifies the preview window")
483 call append("$", "\t(local to window)")
484 call <SID>BinOptionL("pvw")
485endif
486call append("$", "hidden\tdon't unload a buffer when no longer shown in a window")
487call <SID>BinOptionG("hid", &hid)
488call append("$", "switchbuf\t\"useopen\" and/or \"split\"; which window to use when jumping")
489call append("$", "\tto a buffer")
490call <SID>OptionG("swb", &swb)
491call append("$", "splitbelow\ta new window is put below the current one")
492call <SID>BinOptionG("sb", &sb)
493if has("vertsplit")
494 call append("$", "splitright\ta new window is put right of the current one")
495 call <SID>BinOptionG("spr", &spr)
496endif
497if has("scrollbind")
498 call append("$", "scrollbind\tthis window scrolls together with other bound windows")
499 call append("$", "\t(local to window)")
500 call <SID>BinOptionL("scb")
501 call append("$", "scrollopt\t\"ver\", \"hor\" and/or \"jump\"; list of options for 'scrollbind'")
502 call <SID>OptionG("sbo", &sbo)
503endif
Bram Moolenaarb2c03502010-07-02 20:20:09 +0200504if has("cursorbind")
505 call append("$", "cursorbind\tthis window's cursor moves together with other bound windows")
506 call append("$", "\t(local to window)")
507 call <SID>BinOptionL("crb")
508endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000509
510
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000511call <SID>Header("multiple tab pages")
512call append("$", "showtabline\t0, 1 or 2; when to use a tab pages line")
513call append("$", " \tset stal=" . &stal)
514call append("$", "tabpagemax\tmaximum number of tab pages to open for -p and \"tab all\"")
515call append("$", " \tset tpm=" . &tpm)
516call append("$", "tabline\tcustom tab pages line")
517call <SID>OptionG("tal", &tal)
Bram Moolenaarf9393ef2006-04-24 19:47:27 +0000518if has("gui")
519 call append("$", "guitablabel\tcustom tab page label for the GUI")
520 call <SID>OptionG("gtl", &gtl)
521 call append("$", "guitabtooltip\tcustom tab page tooltip for the GUI")
522 call <SID>OptionG("gtt", &gtt)
523endif
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000524
525
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526call <SID>Header("terminal")
527call append("$", "term\tname of the used terminal")
528call <SID>OptionG("term", &term)
529call append("$", "ttytype\talias for 'term'")
530call <SID>OptionG("tty", &tty)
531call append("$", "ttybuiltin\tcheck built-in termcaps first")
532call <SID>BinOptionG("tbi", &tbi)
533call append("$", "ttyfast\tterminal connection is fast")
534call <SID>BinOptionG("tf", &tf)
535call append("$", "weirdinvert\tterminal that requires extra redrawing")
536call <SID>BinOptionG("wiv", &wiv)
537call append("$", "esckeys\trecognize keys that start with <Esc> in Insert mode")
538call <SID>BinOptionG("ek", &ek)
539call append("$", "scrolljump\tminimal number of lines to scroll at a time")
540call append("$", " \tset sj=" . &sj)
541call append("$", "ttyscroll\tmaximum number of lines to use scrolling instead of redrawing")
542call append("$", " \tset tsl=" . &tsl)
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200543if has("gui") || has("win32")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000544 call append("$", "guicursor\tspecifies what the cursor looks like in different modes")
545 call <SID>OptionG("gcr", &gcr)
546endif
547if has("title")
548 let &title = s:old_title
549 call append("$", "title\tshow info in the window title")
550 call <SID>BinOptionG("title", &title)
551 set notitle
552 call append("$", "titlelen\tpercentage of 'columns' used for the window title")
553 call append("$", " \tset titlelen=" . &titlelen)
554 call append("$", "titlestring\twhen not empty, string to be used for the window title")
555 call <SID>OptionG("titlestring", &titlestring)
556 call append("$", "titleold\tstring to restore the title to when exiting Vim")
557 call <SID>OptionG("titleold", &titleold)
558 let &icon = s:old_icon
559 call append("$", "icon\tset the text of the icon for this window")
560 call <SID>BinOptionG("icon", &icon)
561 set noicon
562 call append("$", "iconstring\twhen not empty, text for the icon of this window")
563 call <SID>OptionG("iconstring", &iconstring)
564endif
565if has("win32")
566 call append("$", "restorescreen\trestore the screen contents when exiting Vim")
567 call <SID>BinOptionG("rs", &rs)
568endif
569
570
571call <SID>Header("using the mouse")
572call append("$", "mouse\tlist of flags for using the mouse")
573call <SID>OptionG("mouse", &mouse)
574if has("gui")
575 call append("$", "mousefocus\tthe window with the mouse pointer becomes the current one")
576 call <SID>BinOptionG("mousef", &mousef)
577 call append("$", "mousehide\thide the mouse pointer while typing")
578 call <SID>BinOptionG("mh", &mh)
579endif
580call append("$", "mousemodel\t\"extend\", \"popup\" or \"popup_setpos\"; what the right")
581call append("$", "\tmouse button is used for")
582call <SID>OptionG("mousem", &mousem)
583call append("$", "mousetime\tmaximum time in msec to recognize a double-click")
584call append("$", " \tset mouset=" . &mouset)
585call append("$", "ttymouse\t\"xterm\", \"xterm2\", \"dec\" or \"netterm\"; type of mouse")
586call <SID>OptionG("ttym", &ttym)
587if has("mouseshape")
588 call append("$", "mouseshape\twhat the mouse pointer looks like in different modes")
589 call <SID>OptionG("mouses", &mouses)
590endif
591
592
593if has("gui")
594 call <SID>Header("GUI")
595 call append("$", "guifont\tlist of font names to be used in the GUI")
596 call <SID>OptionG("gfn", &gfn)
597 if has("xfontset")
598 call append("$", "guifontset\tpair of fonts to be used, for multibyte editing")
599 call <SID>OptionG("gfs", &gfs)
600 endif
601 call append("$", "guifontwide\tlist of font names to be used for double-wide characters")
602 call <SID>OptionG("gfw", &gfw)
603 if has("mac")
604 call append("$", "antialias\tuse smooth, antialiased fonts")
605 call <SID>BinOptionG("anti", &anti)
606 endif
607 call append("$", "guioptions\tlist of flags that specify how the GUI works")
608 call <SID>OptionG("go", &go)
609 if has("gui_gtk")
610 call append("$", "toolbar\t\"icons\", \"text\" and/or \"tooltips\"; how to show the toolbar")
611 call <SID>OptionG("tb", &tb)
612 if has("gui_gtk2")
Bram Moolenaar1deee622010-07-24 20:35:12 +0200613 call append("$", "toolbariconsize\tsize of toolbar icons")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000614 call <SID>OptionG("tbis", &tbis)
615 endif
616 call append("$", "guiheadroom\troom (in pixels) left above/below the window")
617 call append("$", " \tset ghr=" . &ghr)
618 endif
Bram Moolenaarfb539272014-08-22 19:21:47 +0200619 if has("directx")
620 call append("$", "renderoptions\toptions for text rendering")
621 call <SID>OptionG("rop", &rop)
622 endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000623 call append("$", "guipty\tuse a pseudo-tty for I/O to external commands")
624 call <SID>BinOptionG("guipty", &guipty)
625 if has("browse")
626 call append("$", "browsedir\t\"last\", \"buffer\" or \"current\": which directory used for the file browser")
627 call <SID>OptionG("bsdir", &bsdir)
628 endif
629 if has("multi_lang")
630 call append("$", "langmenu\tlanguage to be used for the menus")
631 call <SID>OptionG("langmenu", &lm)
632 endif
633 call append("$", "menuitems\tmaximum number of items in one menu")
634 call append("$", " \tset mis=" . &mis)
635 if has("winaltkeys")
636 call append("$", "winaltkeys\t\"no\", \"yes\" or \"menu\"; how to use the ALT key")
637 call <SID>OptionG("wak", &wak)
638 endif
639 call append("$", "linespace\tnumber of pixel lines to use between characters")
640 call append("$", " \tset lsp=" . &lsp)
641 if has("balloon_eval")
642 call append("$", "balloondelay\tdelay in milliseconds before a balloon may pop up")
643 call append("$", " \tset bdlay=" . &bdlay)
Bram Moolenaar52b4b552005-03-07 23:00:57 +0000644 call append("$", "ballooneval\twhether the balloon evaluation is to be used")
645 call <SID>BinOptionG("beval", &beval)
646 if has("eval")
647 call append("$", "balloonexpr\texpression to show in balloon eval")
648 call append("$", " \tset bexpr=" . &bexpr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649 endif
650 endif
Bram Moolenaard5ab34b2007-05-05 17:15:44 +0000651 if exists("+macatsui")
Bram Moolenaarf9393ef2006-04-24 19:47:27 +0000652 call append("$", "macatsui\tuse ATSUI text drawing; disable to avoid display problems")
653 call <SID>OptionG("macatsui", &macatsui)
654 endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000655endif
656
657if has("printer")
658 call <SID>Header("printing")
Bram Moolenaar8299df92004-07-10 09:47:34 +0000659 call append("$", "printoptions\tlist of items that control the format of :hardcopy output")
660 call <SID>OptionG("popt", &popt)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661 call append("$", "printdevice\tname of the printer to be used for :hardcopy")
662 call <SID>OptionG("pdev", &pdev)
Bram Moolenaar8299df92004-07-10 09:47:34 +0000663 if has("postscript")
664 call append("$", "printexpr\texpression used to print the PostScript file for :hardcopy")
665 call <SID>OptionG("pexpr", &pexpr)
666 endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000667 call append("$", "printfont\tname of the font to be used for :hardcopy")
668 call <SID>OptionG("pfn", &pfn)
669 call append("$", "printheader\tformat of the header used for :hardcopy")
670 call <SID>OptionG("pheader", &pheader)
Bram Moolenaar8299df92004-07-10 09:47:34 +0000671 if has("postscript")
672 call append("$", "printencoding\tencoding used to print the PostScript file for :hardcopy")
673 call <SID>OptionG("penc", &penc)
674 endif
675 if has("multi_byte")
676 call append("$", "printmbcharset\tthe CJK character set to be used for CJK output from :hardcopy")
677 call <SID>OptionG("pmbcs", &pmbcs)
678 call append("$", "printmbfont\tlist of font names to be used for CJK output from :hardcopy")
679 call <SID>OptionG("pmbfn", &pmbfn)
680 endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681endif
682
683call <SID>Header("messages and info")
684call append("$", "terse\tadd 's' flag in 'shortmess' (don't show search message)")
685call <SID>BinOptionG("terse", &terse)
686call append("$", "shortmess\tlist of flags to make messages shorter")
687call <SID>OptionG("shm", &shm)
688call append("$", "showcmd\tshow (partial) command keys in the status line")
689let &sc = s:old_sc
690call <SID>BinOptionG("sc", &sc)
691set nosc
692call append("$", "showmode\tdisplay the current mode in the status line")
693call <SID>BinOptionG("smd", &smd)
694call append("$", "ruler\tshow cursor position below each window")
695let &ru = s:old_ru
696call <SID>BinOptionG("ru", &ru)
697set noru
698if has("statusline")
699 call append("$", "rulerformat\talternate format to be used for the ruler")
700 call <SID>OptionG("ruf", &ruf)
701endif
702call append("$", "report\tthreshold for reporting number of changed lines")
703call append("$", " \tset report=" . &report)
704call append("$", "verbose\tthe higher the more messages are given")
705call append("$", " \tset vbs=" . &vbs)
Bram Moolenaar7887d882005-07-01 22:33:52 +0000706call append("$", "verbosefile\tfile to write messages in")
707call <SID>OptionG("vfile", &vfile)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708call append("$", "more\tpause listings when the screen is full")
709call <SID>BinOptionG("more", &more)
710if has("dialog_con") || has("dialog_gui")
711 call append("$", "confirm\tstart a dialog when a command fails")
712 call <SID>BinOptionG("cf", &cf)
713endif
714call append("$", "errorbells\tring the bell for error messages")
715call <SID>BinOptionG("eb", &eb)
716call append("$", "visualbell\tuse a visual bell instead of beeping")
717call <SID>BinOptionG("vb", &vb)
Bram Moolenaarf9132812015-07-21 19:19:13 +0200718call append("$", "belloff\tdo not ring the bell for these reasons")
Bram Moolenaardd1616e2015-07-22 22:22:59 +0200719call <SID>OptionG("belloff", &belloff)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720if has("multi_lang")
721 call append("$", "helplang\tlist of preferred languages for finding help")
722 call <SID>OptionG("hlg", &hlg)
723endif
724
725
726call <SID>Header("selecting text")
727call append("$", "selection\t\"old\", \"inclusive\" or \"exclusive\"; how selecting text behaves")
728call <SID>OptionG("sel", &sel)
729call append("$", "selectmode\t\"mouse\", \"key\" and/or \"cmd\"; when to start Select mode")
730call append("$", "\tinstead of Visual mode")
731call <SID>OptionG("slm", &slm)
732if has("clipboard")
733 call append("$", "clipboard\t\"unnamed\" to use the * register like unnamed register")
734 call append("$", "\t\"autoselect\" to always put selected text on the clipboard")
735 call <SID>OptionG("cb", &cb)
736endif
737call append("$", "keymodel\t\"startsel\" and/or \"stopsel\"; what special keys can do")
738call <SID>OptionG("km", &km)
739
740
741call <SID>Header("editing text")
742call append("$", "undolevels\tmaximum number of changes that can be undone")
Bram Moolenaar7d76c802014-10-15 22:51:52 +0200743call append("$", "\t(global or local to buffer)")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000744call append("$", " \tset ul=" . &ul)
Bram Moolenaar4694a172016-04-21 14:05:23 +0200745call append("$", "undofile\tautomatically save and restore undo history")
746call <SID>BinOptionG("udf", &udf)
747call append("$", "undodir\tlist of directories for undo files")
748call <SID>OptionG("udir", &udir)
Bram Moolenaar59f931e2010-07-24 20:27:03 +0200749call append("$", "undoreload\tmaximum number lines to save for undo on a buffer reload")
750call append("$", " \tset ur=" . &ur)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000751call append("$", "modified\tchanges have been made and not written to a file")
752call append("$", "\t(local to buffer)")
753call <SID>BinOptionL("mod")
754call append("$", "readonly\tbuffer is not to be written")
755call append("$", "\t(local to buffer)")
756call <SID>BinOptionL("ro")
757call append("$", "modifiable\tchanges to the text are not possible")
758call append("$", "\t(local to buffer)")
759call <SID>BinOptionL("ma")
760call append("$", "textwidth\tline length above which to break a line")
761call append("$", "\t(local to buffer)")
762call <SID>OptionL("tw")
763call append("$", "wrapmargin\tmargin from the right in which to break a line")
764call append("$", "\t(local to buffer)")
765call <SID>OptionL("wm")
766call append("$", "backspace\tspecifies what <BS>, CTRL-W, etc. can do in Insert mode")
767call append("$", " \tset bs=" . &bs)
768call append("$", "comments\tdefinition of what comment lines look like")
769call append("$", "\t(local to buffer)")
770call <SID>OptionL("com")
771call append("$", "formatoptions\tlist of flags that tell how automatic formatting works")
772call append("$", "\t(local to buffer)")
773call <SID>OptionL("fo")
Bram Moolenaar86b68352004-12-27 21:59:20 +0000774call append("$", "formatlistpat\tpattern to recognize a numbered list")
775call append("$", "\t(local to buffer)")
776call <SID>OptionL("flp")
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000777if has("eval")
778 call append("$", "formatexpr\texpression used for \"gq\" to format lines")
779 call append("$", "\t(local to buffer)")
780 call <SID>OptionL("fex")
781endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782if has("insert_expand")
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000783 call append("$", "complete\tspecifies how Insert mode completion works for CTRL-N and CTRL-P")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784 call append("$", "\t(local to buffer)")
785 call <SID>OptionL("cpt")
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000786 call append("$", "completeopt\twhether to use a popup menu for Insert mode completion")
787 call <SID>OptionG("cot", &cot)
Bram Moolenaard3667a22006-03-16 21:35:52 +0000788 call append("$", "pumheight\tmaximum height of the popup menu")
789 call <SID>OptionG("ph", &ph)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000790 call append("$", "completefunc\tuser defined function for Insert mode completion")
791 call append("$", "\t(local to buffer)")
792 call <SID>OptionL("cfu")
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000793 call append("$", "omnifunc\tfunction for filetype-specific Insert mode completion")
Bram Moolenaare344bea2005-09-01 20:46:49 +0000794 call append("$", "\t(local to buffer)")
795 call <SID>OptionL("ofu")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796 call append("$", "dictionary\tlist of dictionary files for keyword completion")
797 call append("$", "\t(global or local to buffer)")
798 call <SID>OptionG("dict", &dict)
799 call append("$", "thesaurus\tlist of thesaurus files for keyword completion")
800 call append("$", "\t(global or local to buffer)")
801 call <SID>OptionG("tsr", &tsr)
802endif
803call append("$", "infercase\tadjust case of a keyword completion match")
804call append("$", "\t(local to buffer)")
805call <SID>BinOptionL("inf")
806if has("digraphs")
Bram Moolenaar2b7db932016-01-07 16:52:10 +0100807 call append("$", "digraph\tenable entering digraphs with c1 <BS> c2")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000808 call <SID>BinOptionG("dg", &dg)
809endif
810call append("$", "tildeop\tthe \"~\" command behaves like an operator")
811call <SID>BinOptionG("top", &top)
Bram Moolenaar4770d092006-01-12 23:22:24 +0000812call append("$", "operatorfunc\tfunction called for the\"g@\" operator")
813call <SID>OptionG("opfunc", &opfunc)
Bram Moolenaar1deee622010-07-24 20:35:12 +0200814call append("$", "showmatch\twhen inserting a bracket, briefly jump to its match")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815call <SID>BinOptionG("sm", &sm)
816call append("$", "matchtime\ttenth of a second to show a match for 'showmatch'")
817call append("$", " \tset mat=" . &mat)
818call append("$", "matchpairs\tlist of pairs that match for the \"%\" command")
819call append("$", "\t(local to buffer)")
820call <SID>OptionL("mps")
821call append("$", "joinspaces\tuse two spaces after '.' when joining a line")
822call <SID>BinOptionG("js", &js)
823call append("$", "nrformats\t\"alpha\", \"octal\" and/or \"hex\"; number formats recognized for")
824call append("$", "\tCTRL-A and CTRL-X commands")
825call append("$", "\t(local to buffer)")
826call <SID>OptionL("nf")
827
828
829call <SID>Header("tabs and indenting")
830call append("$", "tabstop\tnumber of spaces a <Tab> in the text stands for")
831call append("$", "\t(local to buffer)")
832call <SID>OptionL("ts")
833call append("$", "shiftwidth\tnumber of spaces used for each step of (auto)indent")
834call append("$", "\t(local to buffer)")
835call <SID>OptionL("sw")
836call append("$", "smarttab\ta <Tab> in an indent inserts 'shiftwidth' spaces")
837call <SID>BinOptionG("sta", &sta)
838call append("$", "softtabstop\tif non-zero, number of spaces to insert for a <Tab>")
839call append("$", "\t(local to buffer)")
840call <SID>OptionL("sts")
841call append("$", "shiftround\tround to 'shiftwidth' for \"<<\" and \">>\"")
842call <SID>BinOptionG("sr", &sr)
843call append("$", "expandtab\texpand <Tab> to spaces in Insert mode")
844call append("$", "\t(local to buffer)")
845call <SID>BinOptionL("et")
846call append("$", "autoindent\tautomatically set the indent of a new line")
847call append("$", "\t(local to buffer)")
848call <SID>BinOptionL("ai")
849if has("smartindent")
850 call append("$", "smartindent\tdo clever autoindenting")
851 call append("$", "\t(local to buffer)")
852 call <SID>BinOptionL("si")
853endif
854if has("cindent")
855 call append("$", "cindent\tenable specific indenting for C code")
856 call append("$", "\t(local to buffer)")
857 call <SID>BinOptionL("cin")
858 call append("$", "cinoptions\toptions for C-indenting")
859 call append("$", "\t(local to buffer)")
860 call <SID>OptionL("cino")
861 call append("$", "cinkeys\tkeys that trigger C-indenting in Insert mode")
862 call append("$", "\t(local to buffer)")
863 call <SID>OptionL("cink")
864 call append("$", "cinwords\tlist of words that cause more C-indent")
865 call append("$", "\t(local to buffer)")
866 call <SID>OptionL("cinw")
867 call append("$", "indentexpr\texpression used to obtain the indent of a line")
868 call append("$", "\t(local to buffer)")
869 call <SID>OptionL("inde")
870 call append("$", "indentkeys\tkeys that trigger indenting with 'indentexpr' in Insert mode")
871 call append("$", "\t(local to buffer)")
872 call <SID>OptionL("indk")
873endif
Bram Moolenaar1deee622010-07-24 20:35:12 +0200874call append("$", "copyindent\tcopy whitespace for indenting from previous line")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000875call append("$", "\t(local to buffer)")
876call <SID>BinOptionL("ci")
Bram Moolenaar1deee622010-07-24 20:35:12 +0200877call append("$", "preserveindent\tpreserve kind of whitespace when changing indent")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878call append("$", "\t(local to buffer)")
879call <SID>BinOptionL("pi")
880if has("lispindent")
881 call append("$", "lisp\tenable lisp mode")
882 call append("$", "\t(local to buffer)")
883 call <SID>BinOptionL("lisp")
884 call append("$", "lispwords\twords that change how lisp indenting works")
Bram Moolenaare7a88a82014-04-01 12:26:46 +0200885 call <SID>OptionL("lw")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000886endif
887
888
889if has("folding")
890 call <SID>Header("folding")
891 call append("$", "foldenable\tset to display all folds open")
892 call append("$", "\t(local to window)")
893 call <SID>BinOptionL("fen")
894 call append("$", "foldlevel\tfolds with a level higher than this number will be closed")
895 call append("$", "\t(local to window)")
896 call <SID>OptionL("fdl")
897 call append("$", "foldlevelstart\tvalue for 'foldlevel' when starting to edit a file")
898 call append("$", " \tset fdls=" . &fdls)
899 call append("$", "foldcolumn\twidth of the column used to indicate folds")
900 call append("$", "\t(local to window)")
901 call <SID>OptionL("fdc")
902 call append("$", "foldtext\texpression used to display the text of a closed fold")
903 call append("$", "\t(local to window)")
904 call <SID>OptionL("fdt")
905 call append("$", "foldclose\tset to \"all\" to close a fold when the cursor leaves it")
906 call <SID>OptionG("fcl", &fcl)
907 call append("$", "foldopen\tspecifies for which commands a fold will be opened")
908 call <SID>OptionG("fdo", &fdo)
909 call append("$", "foldminlines\tminimum number of screen lines for a fold to be closed")
910 call append("$", "\t(local to window)")
911 call <SID>OptionL("fml")
912 call append("$", "commentstring\ttemplate for comments; used to put the marker in")
913 call <SID>OptionL("cms")
914 call append("$", "foldmethod\tfolding type: \"manual\", \"indent\", \"expr\", \"marker\" or \"syntax\"")
915 call append("$", "\t(local to window)")
916 call <SID>OptionL("fdm")
917 call append("$", "foldexpr\texpression used when 'foldmethod' is \"expr\"")
918 call append("$", "\t(local to window)")
919 call <SID>OptionL("fde")
920 call append("$", "foldignore\tused to ignore lines when 'foldmethod' is \"indent\"")
921 call append("$", "\t(local to window)")
922 call <SID>OptionL("fdi")
923 call append("$", "foldmarker\tmarkers used when 'foldmethod' is \"marker\"")
924 call append("$", "\t(local to window)")
925 call <SID>OptionL("fmr")
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +0100926 call append("$", "foldnestmax\tmaximum fold depth for when 'foldmethod' is \"indent\" or \"syntax\"")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927 call append("$", "\t(local to window)")
928 call <SID>OptionL("fdn")
929endif
930
931
932if has("diff")
933 call <SID>Header("diff mode")
934 call append("$", "diff\tuse diff mode for the current window")
935 call append("$", "\t(local to window)")
936 call <SID>BinOptionL("diff")
937 call append("$", "diffopt\toptions for using diff mode")
938 call <SID>OptionG("dip", &dip)
939 call append("$", "diffexpr\texpression used to obtain a diff file")
940 call <SID>OptionG("dex", &dex)
941 call append("$", "patchexpr\texpression used to patch a file")
942 call <SID>OptionG("pex", &pex)
943endif
944
945
946call <SID>Header("mapping")
947call append("$", "maxmapdepth\tmaximum depth of mapping")
948call append("$", " \tset mmd=" . &mmd)
949call append("$", "remap\trecognize mappings in mapped keys")
950call <SID>BinOptionG("remap", &remap)
951call append("$", "timeout\tallow timing out halfway into a mapping")
952call <SID>BinOptionG("to", &to)
953call append("$", "ttimeout\tallow timing out halfway into a key code")
954call <SID>BinOptionG("ttimeout", &ttimeout)
955call append("$", "timeoutlen\ttime in msec for 'timeout'")
956call append("$", " \tset tm=" . &tm)
957call append("$", "ttimeoutlen\ttime in msec for 'ttimeout'")
958call append("$", " \tset ttm=" . &ttm)
959
960
961call <SID>Header("reading and writing files")
962call append("$", "modeline\tenable using settings from modelines when reading a file")
963call append("$", "\t(local to buffer)")
964call <SID>BinOptionL("ml")
965call append("$", "modelines\tnumber of lines to check for modelines")
966call append("$", " \tset mls=" . &mls)
967call append("$", "binary\tbinary file editing")
968call append("$", "\t(local to buffer)")
969call <SID>BinOptionL("bin")
970call append("$", "endofline\tlast line in the file has an end-of-line")
971call append("$", "\t(local to buffer)")
972call <SID>BinOptionL("eol")
Bram Moolenaarf9132812015-07-21 19:19:13 +0200973call append("$", "fixendofline\tfixes missing end-of-line at end of text file")
Bram Moolenaar34d72d42015-07-17 14:18:08 +0200974call append("$", "\t(local to buffer)")
975call <SID>BinOptionL("fixeol")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000976if has("multi_byte")
Bram Moolenaar1deee622010-07-24 20:35:12 +0200977 call append("$", "bomb\tprepend a Byte Order Mark to the file")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978 call append("$", "\t(local to buffer)")
979 call <SID>BinOptionL("bomb")
980endif
981call append("$", "fileformat\tend-of-line format: \"dos\", \"unix\" or \"mac\"")
982call append("$", "\t(local to buffer)")
983call <SID>OptionL("ff")
984call append("$", "fileformats\tlist of file formats to look for when editing a file")
985call <SID>OptionG("ffs", &ffs)
986call append("$", "textmode\tobsolete, use 'fileformat'")
987call append("$", "\t(local to buffer)")
988call <SID>BinOptionL("tx")
989call append("$", "textauto\tobsolete, use 'fileformats'")
990call <SID>BinOptionG("ta", &ta)
991call append("$", "write\twriting files is allowed")
992call <SID>BinOptionG("write", &write)
993call append("$", "writebackup\twrite a backup file before overwriting a file")
994call <SID>BinOptionG("wb", &wb)
995call append("$", "backup\tkeep a backup after overwriting a file")
996call <SID>BinOptionG("bk", &bk)
997call append("$", "backupskip\tpatterns that specify for which files a backup is not made")
998call append("$", " \tset bsk=" . &bsk)
999call append("$", "backupcopy\twhether to make the backup as a copy or rename the existing file")
Bram Moolenaar7d76c802014-10-15 22:51:52 +02001000call append("$", "\t(global or local to buffer)")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001001call append("$", " \tset bkc=" . &bkc)
1002call append("$", "backupdir\tlist of directories to put backup files in")
1003call <SID>OptionG("bdir", &bdir)
1004call append("$", "backupext\tfile name extension for the backup file")
1005call <SID>OptionG("bex", &bex)
1006call append("$", "autowrite\tautomatically write a file when leaving a modified buffer")
1007call <SID>BinOptionG("aw", &aw)
1008call append("$", "autowriteall\tas 'autowrite', but works with more commands")
1009call <SID>BinOptionG("awa", &awa)
1010call append("$", "writeany\talways write without asking for confirmation")
1011call <SID>BinOptionG("wa", &wa)
1012call append("$", "autoread\tautomatically read a file when it was modified outside of Vim")
1013call append("$", "\t(global or local to buffer)")
1014call <SID>BinOptionG("ar", &ar)
1015call append("$", "patchmode\tkeep oldest version of a file; specifies file name extension")
1016call <SID>OptionG("pm", &pm)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001017call append("$", "fsync\tforcibly sync the file to disk after writing it")
1018call <SID>BinOptionG("fs", &fs)
Bram Moolenaara06ecab2016-07-16 14:47:36 +02001019call append("$", "shortname\tuse 8.3 file names")
1020call append("$", "\t(local to buffer)")
1021call <SID>BinOptionL("sn")
Bram Moolenaar365bdf72010-07-24 20:57:44 +02001022call append("$", "cryptmethod\tencryption method for file writing: zip or blowfish")
Bram Moolenaarb702c842010-05-18 22:28:22 +02001023call append("$", "\t(local to buffer)")
1024call <SID>OptionL("cm")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001025
1026
1027call <SID>Header("the swap file")
1028call append("$", "directory\tlist of directories for the swap file")
1029call <SID>OptionG("dir", &dir)
1030call append("$", "swapfile\tuse a swap file for this buffer")
1031call append("$", "\t(local to buffer)")
1032call <SID>BinOptionL("swf")
1033call append("$", "swapsync\t\"sync\", \"fsync\" or empty; how to flush a swap file to disk")
1034call <SID>OptionG("sws", &sws)
1035call append("$", "updatecount\tnumber of characters typed to cause a swap file update")
1036call append("$", " \tset uc=" . &uc)
1037call append("$", "updatetime\ttime in msec after which the swap file will be updated")
1038call append("$", " \tset ut=" . &ut)
1039call append("$", "maxmem\tmaximum amount of memory in Kbyte used for one buffer")
1040call append("$", " \tset mm=" . &mm)
1041call append("$", "maxmemtot\tmaximum amount of memory in Kbyte used for all buffers")
1042call append("$", " \tset mmt=" . &mmt)
1043
1044
1045call <SID>Header("command line editing")
1046call append("$", "history\thow many command lines are remembered ")
1047call append("$", " \tset hi=" . &hi)
1048call append("$", "wildchar\tkey that triggers command-line expansion")
1049call append("$", " \tset wc=" . &wc)
1050call append("$", "wildcharm\tlike 'wildchar' but can also be used in a mapping")
1051call append("$", " \tset wcm=" . &wcm)
1052call append("$", "wildmode\tspecifies how command line completion works")
1053call <SID>OptionG("wim", &wim)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00001054if has("wildoptions")
1055 call append("$", "wildoptions\tempty or \"tagfile\" to list file name of matching tags")
1056 call <SID>OptionG("wop", &wop)
1057endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058call append("$", "suffixes\tlist of file name extensions that have a lower priority")
1059call <SID>OptionG("su", &su)
1060if has("file_in_path")
1061 call append("$", "suffixesadd\tlist of file name extensions added when searching for a file")
1062 call append("$", "\t(local to buffer)")
1063 call <SID>OptionL("sua")
1064endif
1065if has("wildignore")
1066 call append("$", "wildignore\tlist of patterns to ignore files for file name completion")
1067 call <SID>OptionG("wig", &wig)
1068endif
Bram Moolenaar91fc43d2013-04-05 15:41:05 +02001069call append("$", "fileignorecase\tignore case when using file names")
1070call <SID>BinOptionG("fic", &fic)
Bram Moolenaar81af9252010-12-10 20:35:50 +01001071call append("$", "wildignorecase\tignore case when completing file names")
1072call <SID>BinOptionG("wic", &wic)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073if has("wildmenu")
1074 call append("$", "wildmenu\tcommand-line completion shows a list of matches")
1075 call <SID>BinOptionG("wmnu", &wmnu)
1076endif
1077if has("vertsplit")
1078 call append("$", "cedit\tkey used to open the command-line window")
1079 call <SID>OptionG("cedit", &cedit)
1080 call append("$", "cmdwinheight\theight of the command-line window")
1081 call <SID>OptionG("cwh", &cwh)
1082endif
1083
1084
1085call <SID>Header("executing external commands")
1086call append("$", "shell\tname of the shell program used for external commands")
1087call <SID>OptionG("sh", &sh)
1088if has("amiga")
1089 call append("$", "shelltype\twhen to use the shell or directly execute a command")
1090 call append("$", " \tset st=" . &st)
1091endif
1092call append("$", "shellquote\tcharacter(s) to enclose a shell command in")
1093call <SID>OptionG("shq", &shq)
1094call append("$", "shellxquote\tlike 'shellquote' but include the redirection")
1095call <SID>OptionG("sxq", &sxq)
Bram Moolenaardb7207e2012-02-22 17:30:19 +01001096call append("$", "shellxescape\tcharacters to escape when 'shellxquote' is (")
1097call <SID>OptionG("sxe", &sxe)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001098call append("$", "shellcmdflag\targument for 'shell' to execute a command")
1099call <SID>OptionG("shcf", &shcf)
1100call append("$", "shellredir\tused to redirect command output to a file")
1101call <SID>OptionG("srr", &srr)
Bram Moolenaar551f84f2005-07-06 22:29:20 +00001102call append("$", "shelltemp\tuse a temp file for shell commands instead of using a pipe")
1103call <SID>BinOptionG("stmp", &stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001104call append("$", "equalprg\tprogram used for \"=\" command")
1105call append("$", "\t(global or local to buffer)")
1106call <SID>OptionG("ep", &ep)
1107call append("$", "formatprg\tprogram used to format lines with \"gq\" command")
1108call <SID>OptionG("fp", &fp)
1109call append("$", "keywordprg\tprogram used for the \"K\" command")
1110call <SID>OptionG("kp", &kp)
1111call append("$", "warn\twarn when using a shell command and a buffer has changes")
1112call <SID>BinOptionG("warn", &warn)
1113
1114
1115if has("quickfix")
1116 call <SID>Header("running make and jumping to errors")
1117 call append("$", "errorfile\tname of the file that contains error messages")
1118 call <SID>OptionG("ef", &ef)
1119 call append("$", "errorformat\tlist of formats for error messages")
1120 call append("$", "\t(global or local to buffer)")
1121 call <SID>OptionG("efm", &efm)
1122 call append("$", "makeprg\tprogram used for the \":make\" command")
1123 call append("$", "\t(global or local to buffer)")
1124 call <SID>OptionG("mp", &mp)
1125 call append("$", "shellpipe\tstring used to put the output of \":make\" in the error file")
1126 call <SID>OptionG("sp", &sp)
1127 call append("$", "makeef\tname of the errorfile for the 'makeprg' command")
1128 call <SID>OptionG("mef", &mef)
1129 call append("$", "grepprg\tprogram used for the \":grep\" command")
1130 call append("$", "\t(global or local to buffer)")
1131 call <SID>OptionG("gp", &gp)
1132 call append("$", "grepformat\tlist of formats for output of 'grepprg'")
1133 call <SID>OptionG("gfm", &gfm)
Bram Moolenaarad4187e2017-03-06 21:45:20 +01001134 call append("$", "makeencoding\tencoding of the \":make\" and \":grep\" output")
1135 call append("$", "\t(global or local to buffer)")
1136 call <SID>OptionG("menc", &menc)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001137endif
1138
1139
Bram Moolenaara06ecab2016-07-16 14:47:36 +02001140if has("win32") || has("osfiletype")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001141 call <SID>Header("system specific")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142 if has("osfiletype")
1143 call append("$", "osfiletype\tOS-specific information about the type of file")
1144 call append("$", "\t(local to buffer)")
1145 call <SID>OptionL("oft")
1146 endif
Bram Moolenaara06ecab2016-07-16 14:47:36 +02001147 if has("win32")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001148 call append("$", "shellslash\tuse forward slashes in file names; for Unix-like shells")
1149 call <SID>BinOptionG("ssl", &ssl)
1150 endif
1151endif
1152
1153
1154call <SID>Header("language specific")
1155call append("$", "isfname\tspecifies the characters in a file name")
1156call <SID>OptionG("isf", &isf)
1157call append("$", "isident\tspecifies the characters in an identifier")
1158call <SID>OptionG("isi", &isi)
1159call append("$", "iskeyword\tspecifies the characters in a keyword")
1160call append("$", "\t(local to buffer)")
1161call <SID>OptionL("isk")
1162call append("$", "isprint\tspecifies printable characters")
1163call <SID>OptionG("isp", &isp)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001164if has("textobjects")
1165 call append("$", "quoteescape\tspecifies escape characters in a string")
1166 call append("$", "\t(local to buffer)")
1167 call <SID>OptionL("qe")
1168endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001169if has("rightleft")
1170 call append("$", "rightleft\tdisplay the buffer right-to-left")
1171 call append("$", "\t(local to window)")
1172 call <SID>BinOptionL("rl")
Bram Moolenaar1deee622010-07-24 20:35:12 +02001173 call append("$", "rightleftcmd\twhen to edit the command-line right-to-left")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001174 call append("$", "\t(local to window)")
1175 call <SID>OptionL("rlc")
Bram Moolenaar1deee622010-07-24 20:35:12 +02001176 call append("$", "revins\tinsert characters backwards")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001177 call <SID>BinOptionG("ri", &ri)
Bram Moolenaar1deee622010-07-24 20:35:12 +02001178 call append("$", "allowrevins\tallow CTRL-_ in Insert and Command-line mode to toggle 'revins'")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179 call <SID>BinOptionG("ari", &ari)
1180 call append("$", "aleph\tthe ASCII code for the first letter of the Hebrew alphabet")
1181 call append("$", " \tset al=" . &al)
1182 call append("$", "hkmap\tuse Hebrew keyboard mapping")
1183 call <SID>BinOptionG("hk", &hk)
1184 call append("$", "hkmapp\tuse phonetic Hebrew keyboard mapping")
1185 call <SID>BinOptionG("hkp", &hkp)
1186endif
1187if has("farsi")
1188 call append("$", "altkeymap\tuse Farsi as the second language when 'revins' is set")
1189 call <SID>BinOptionG("akm", &akm)
1190 call append("$", "fkmap\tuse Farsi keyboard mapping")
1191 call <SID>BinOptionG("fk", &fk)
1192endif
1193if has("arabic")
Bram Moolenaar1deee622010-07-24 20:35:12 +02001194 call append("$", "arabic\tprepare for editing Arabic text")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001195 call append("$", "\t(local to window)")
1196 call <SID>BinOptionL("arab")
Bram Moolenaar1deee622010-07-24 20:35:12 +02001197 call append("$", "arabicshape\tperform shaping of Arabic characters")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198 call <SID>BinOptionG("arshape", &arshape)
Bram Moolenaar1deee622010-07-24 20:35:12 +02001199 call append("$", "termbidi\tterminal will perform bidi handling")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001200 call <SID>BinOptionG("tbidi", &tbidi)
1201endif
1202if has("keymap")
Bram Moolenaar2b7db932016-01-07 16:52:10 +01001203 call append("$", "keymap\tname of a keyboard mapping")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204 call <SID>OptionL("kmp")
1205endif
1206if has("langmap")
Bram Moolenaar2f3b5102014-11-19 18:54:17 +01001207 call append("$", "langmap\tlist of characters that are translated in Normal mode")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001208 call <SID>OptionG("lmap", &lmap)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02001209 call append("$", "langremap\tapply 'langmap' to mapped characters")
1210 call <SID>BinOptionG("lrm", &lrm)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001211endif
1212if has("xim")
1213 call append("$", "imdisable\twhen set never use IM; overrules following IM options")
1214 call <SID>BinOptionG("imd", &imd)
1215endif
1216call append("$", "iminsert\tin Insert mode: 1: use :lmap; 2: use IM; 0: neither")
1217call append("$", "\t(local to window)")
1218call <SID>OptionL("imi")
1219call append("$", "imsearch\tentering a search pattern: 1: use :lmap; 2: use IM; 0: neither")
1220call append("$", "\t(local to window)")
1221call <SID>OptionL("ims")
1222if has("xim")
1223 call append("$", "imcmdline\twhen set always use IM when starting to edit a command line")
1224 call <SID>BinOptionG("imc", &imc)
Bram Moolenaar14b69452013-06-29 23:05:20 +02001225 call append("$", "imstatusfunc\tfunction to obtain IME status")
1226 call <SID>OptionG("imsf", &imsf)
1227 call append("$", "imactivatefunc\tfunction to enable/disable IME")
1228 call <SID>OptionG("imaf", &imaf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001229endif
1230
1231
1232if has("multi_byte")
1233 call <SID>Header("multi-byte characters")
1234 call append("$", "encoding\tcharacter encoding used in Vim: \"latin1\", \"utf-8\"")
1235 call append("$", "\t\"euc-jp\", \"big5\", etc.")
1236 call <SID>OptionG("enc", &enc)
1237 call append("$", "fileencoding\tcharacter encoding for the current file")
1238 call append("$", "\t(local to buffer)")
1239 call <SID>OptionL("fenc")
1240 call append("$", "fileencodings\tautomatically detected character encodings")
1241 call <SID>OptionG("fencs", &fencs)
1242 call append("$", "termencoding\tcharacter encoding used by the terminal")
1243 call <SID>OptionG("tenc", &tenc)
1244 call append("$", "charconvert\texpression used for character encoding conversion")
1245 call <SID>OptionG("ccv", &ccv)
Bram Moolenaar1deee622010-07-24 20:35:12 +02001246 call append("$", "delcombine\tdelete combining (composing) characters on their own")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001247 call <SID>BinOptionG("deco", &deco)
Bram Moolenaar1deee622010-07-24 20:35:12 +02001248 call append("$", "maxcombine\tmaximum number of combining (composing) characters displayed")
Bram Moolenaar4e427192006-03-10 21:34:27 +00001249 call <SID>OptionG("mco", &mco)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250 if has("xim") && has("gui_gtk")
1251 call append("$", "imactivatekey\tkey that activates the X input method")
1252 call <SID>OptionG("imak", &imak)
1253 endif
Bram Moolenaar1deee622010-07-24 20:35:12 +02001254 call append("$", "ambiwidth\twidth of ambiguous width characters")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255 call <SID>OptionG("ambw", &ambw)
Bram Moolenaar3848e002016-03-19 18:42:29 +01001256 call append("$", "emoji\temoji characters are full width")
1257 call <SID>BinOptionG("emo", &emo)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258endif
1259
1260
1261call <SID>Header("various")
1262if has("virtualedit")
1263 call append("$", "virtualedit\twhen to use virtual editing: \"block\", \"insert\" and/or \"all\"")
1264 call <SID>OptionG("ve", &ve)
1265endif
1266if has("autocmd")
1267 call append("$", "eventignore\tlist of autocommand events which are to be ignored")
1268 call <SID>OptionG("ei", &ei)
1269endif
1270call append("$", "loadplugins\tload plugin scripts when starting up")
1271call <SID>BinOptionG("lpl", &lpl)
1272call append("$", "exrc\tenable reading .vimrc/.exrc/.gvimrc in the current directory")
1273call <SID>BinOptionG("ex", &ex)
1274call append("$", "secure\tsafer working with script files in the current directory")
1275call <SID>BinOptionG("secure", &secure)
1276call append("$", "gdefault\tuse the 'g' flag for \":substitute\"")
1277call <SID>BinOptionG("gd", &gd)
1278call append("$", "edcompatible\t'g' and 'c' flags of \":substitute\" toggle")
1279call <SID>BinOptionG("ed", &ed)
Bram Moolenaard5ab34b2007-05-05 17:15:44 +00001280if exists("+opendevice")
1281 call append("$", "opendevice\tallow reading/writing devices")
1282 call <SID>BinOptionG("odev", &odev)
1283endif
1284if exists("+maxfuncdepth")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285 call append("$", "maxfuncdepth\tmaximum depth of function calls")
1286 call append("$", " \tset mfd=" . &mfd)
Bram Moolenaard5ab34b2007-05-05 17:15:44 +00001287endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001288if has("mksession")
1289 call append("$", "sessionoptions\tlist of words that specifies what to put in a session file")
1290 call <SID>OptionG("ssop", &ssop)
1291 call append("$", "viewoptions\tlist of words that specifies what to save for :mkview")
1292 call <SID>OptionG("vop", &vop)
1293 call append("$", "viewdir\tdirectory where to store files with :mkview")
1294 call <SID>OptionG("vdir", &vdir)
1295endif
1296if has("viminfo")
1297 call append("$", "viminfo\tlist that specifies what to write in the viminfo file")
1298 call <SID>OptionG("vi", &vi)
1299endif
1300if has("quickfix")
1301 call append("$", "bufhidden\twhat happens with a buffer when it's no longer in a window")
1302 call append("$", "\t(local to buffer)")
1303 call <SID>OptionL("bh")
1304 call append("$", "buftype\t\"\", \"nofile\", \"nowrite\" or \"quickfix\": type of buffer")
1305 call append("$", "\t(local to buffer)")
1306 call <SID>OptionL("bt")
1307endif
1308call append("$", "buflisted\twhether the buffer shows up in the buffer list")
1309call append("$", "\t(local to buffer)")
1310call <SID>BinOptionL("bl")
1311call append("$", "debug\tset to \"msg\" to see all error messages")
1312call append("$", " \tset debug=" . &debug)
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02001313if has("signs")
1314 call append("$", "signcolumn\twhether to show the signcolumn")
1315 call append("$", "\t(local to window)")
1316 call <SID>OptionL("scl")
1317endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001318if has("mzscheme")
1319 call append("$", "mzquantum\tinterval in milliseconds between polls for MzScheme threads")
1320 call append("$", " \tset mzq=" . &mzq)
1321endif
Bram Moolenaard4ece232015-11-10 19:48:14 +01001322if exists("&luadll")
1323 call append("$", "luadll\tname of the Lua dynamic library")
1324 call <SID>OptionG("luadll", &luadll)
1325endif
1326if exists("&perldll")
1327 call append("$", "perldll\tname of the Perl dynamic library")
1328 call <SID>OptionG("perldll", &perldll)
1329endif
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01001330if has('pythonx')
1331 call append("$", "pyxversion\twhether to use Python 2 or 3")
1332 call append("$", " \tset pyx=" . &wd)
1333endif
Bram Moolenaard4ece232015-11-10 19:48:14 +01001334if exists("&pythondll")
1335 call append("$", "pythondll\tname of the Python 2 dynamic library")
1336 call <SID>OptionG("pythondll", &pythondll)
1337endif
1338if exists("&pythonthreedll")
1339 call append("$", "pythonthreedll\tname of the Python 3 dynamic library")
1340 call <SID>OptionG("pythonthreedll", &pythonthreedll)
1341endif
Bram Moolenaara93f9752015-11-10 20:45:09 +01001342if exists("&rubydll")
1343 call append("$", "rubydll\tname of the Ruby dynamic library")
1344 call <SID>OptionG("rubydll", &rubydll)
1345endif
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01001346if exists("&tcldll")
1347 call append("$", "tcldll\tname of the Tcl dynamic library")
1348 call <SID>OptionG("tcldll", &tcldll)
1349endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350
1351set cpo&vim
1352
1353" go to first line
13541
1355
1356" reset 'modified', so that ":q" can be used to close the window
1357setlocal nomodified
1358
1359if has("syntax")
1360 " Use Vim highlighting, with some additional stuff
1361 setlocal ft=vim
1362 syn match optwinHeader "^ \=[0-9].*"
1363 syn match optwinName "^[a-z]*\t" nextgroup=optwinComment
1364 syn match optwinComment ".*" contained
1365 syn match optwinComment "^\t.*"
1366 if !exists("did_optwin_syntax_inits")
1367 let did_optwin_syntax_inits = 1
1368 hi link optwinHeader Title
1369 hi link optwinName Identifier
1370 hi link optwinComment Comment
1371 endif
1372endif
1373
1374" Install autocommands to enable mappings in option-window
1375noremap <silent> <buffer> <CR> <C-\><C-N>:call <SID>CR()<CR>
1376inoremap <silent> <buffer> <CR> <Esc>:call <SID>CR()<CR>
1377noremap <silent> <buffer> <Space> :call <SID>Space()<CR>
1378
1379" Make the buffer be deleted when the window is closed.
1380setlocal buftype=nofile bufhidden=delete noswapfile
1381
1382augroup optwin
1383 au! BufUnload,BufHidden option-window nested
1384 \ call <SID>unload() | delfun <SID>unload
1385augroup END
1386
1387fun! <SID>unload()
1388 delfun <SID>CR
1389 delfun <SID>Space
1390 delfun <SID>Find
1391 delfun <SID>Update
1392 delfun <SID>OptionL
1393 delfun <SID>OptionG
1394 delfun <SID>BinOptionL
1395 delfun <SID>BinOptionG
1396 delfun <SID>Header
1397 au! optwin
1398endfun
1399
1400" Restore the previous value of 'title' and 'icon'.
1401let &title = s:old_title
1402let &icon = s:old_icon
1403let &ru = s:old_ru
1404let &sc = s:old_sc
1405let &cpo = s:cpo_save
1406unlet s:old_title s:old_icon s:old_ru s:old_sc s:cpo_save s:idx s:lnum
Bram Moolenaar251e1912011-06-19 05:09:16 +02001407
1408" vim: ts=8 sw=2 sts=2