blob: 127232f2631c2c2f8d5b7bb2508e0f3c68d6b447 [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 Moolenaar01164a62017-11-02 22:58:42 +01004" Last Change: 2017 Oct 19
Bram Moolenaar071d4272004-06-13 20:20:40 +00005
6" If there already is an option window, jump to that one.
Bram Moolenaarab6c8582017-08-11 17:15:09 +02007let buf = bufnr('option-window')
8if buf >= 0
9 let winids = win_findbuf(buf)
10 if len(winids) > 0
11 if win_gotoid(winids[0]) == 1
Bram Moolenaar071d4272004-06-13 20:20:40 +000012 finish
13 endif
Bram Moolenaarab6c8582017-08-11 17:15:09 +020014 endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000015endif
16
17" Make sure the '<' flag is not included in 'cpoptions', otherwise <CR> would
18" not be recognized. See ":help 'cpoptions'".
19let s:cpo_save = &cpo
20set cpo&vim
21
22" function to be called when <CR> is hit in the option-window
23fun! <SID>CR()
24
25 " If on a continued comment line, go back to the first comment line
Bram Moolenaar251e1912011-06-19 05:09:16 +020026 let lnum = search("^[^\t]", 'bWcn')
Bram Moolenaar071d4272004-06-13 20:20:40 +000027 let line = getline(lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
29 " <CR> on a "set" line executes the option line
30 if match(line, "^ \tset ") >= 0
31
32 " For a local option: go to the previous window
33 " If this is a help window, go to the window below it
34 let thiswin = winnr()
35 let local = <SID>Find(lnum)
36 if local >= 0
37 exe line
38 call <SID>Update(lnum, line, local, thiswin)
39 endif
40
41 " <CR> on a "option" line shows help for that option
42 elseif match(line, "^[a-z]") >= 0
43 let name = substitute(line, '\([^\t]*\).*', '\1', "")
44 exe "help '" . name . "'"
45
46 " <CR> on an index line jumps to the group
47 elseif match(line, '^ \=[0-9]') >= 0
48 exe "norm! /" . line . "\<CR>zt"
49 endif
50endfun
51
52" function to be called when <Space> is hit in the option-window
53fun! <SID>Space()
54
55 let lnum = line(".")
56 let line = getline(lnum)
57
58 " <Space> on a "set" line refreshes the option line
59 if match(line, "^ \tset ") >= 0
60
61 " For a local option: go to the previous window
62 " If this is a help window, go to the window below it
63 let thiswin = winnr()
64 let local = <SID>Find(lnum)
65 if local >= 0
66 call <SID>Update(lnum, line, local, thiswin)
67 endif
68
69 endif
70endfun
71
72" find the window in which the option applies
73" returns 0 for global option, 1 for local option, -1 for error
74fun! <SID>Find(lnum)
75 if getline(a:lnum - 1) =~ "(local to"
76 let local = 1
77 let thiswin = winnr()
Bram Moolenaar251e1912011-06-19 05:09:16 +020078 wincmd p
Bram Moolenaar071d4272004-06-13 20:20:40 +000079 if exists("b:current_syntax") && b:current_syntax == "help"
Bram Moolenaar251e1912011-06-19 05:09:16 +020080 wincmd j
Bram Moolenaar071d4272004-06-13 20:20:40 +000081 if winnr() == thiswin
Bram Moolenaar251e1912011-06-19 05:09:16 +020082 wincmd j
Bram Moolenaar071d4272004-06-13 20:20:40 +000083 endif
84 endif
85 else
86 let local = 0
87 endif
88 if local && (winnr() == thiswin || (exists("b:current_syntax")
89 \ && b:current_syntax == "help"))
90 echo "Don't know in which window"
91 let local = -1
92 endif
93 return local
94endfun
95
96" Update a "set" line in the option window
97fun! <SID>Update(lnum, line, local, thiswin)
98 " get the new value of the option and update the option window line
99 if match(a:line, "=") >= 0
100 let name = substitute(a:line, '^ \tset \([^=]*\)=.*', '\1', "")
101 else
102 let name = substitute(a:line, '^ \tset \(no\)\=\([a-z]*\).*', '\2', "")
103 endif
104 if name == "pt" && &pt =~ "\x80"
105 let val = <SID>PTvalue()
106 else
Bram Moolenaar251e1912011-06-19 05:09:16 +0200107 let val = escape(eval('&' . name), " \t\\\"|")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000108 endif
109 if a:local
Bram Moolenaar251e1912011-06-19 05:09:16 +0200110 exe a:thiswin . "wincmd w"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000111 endif
112 if match(a:line, "=") >= 0 || (val != "0" && val != "1")
113 call setline(a:lnum, " \tset " . name . "=" . val)
114 else
115 if val
116 call setline(a:lnum, " \tset " . name . "\tno" . name)
117 else
118 call setline(a:lnum, " \tset no" . name . "\t" . name)
119 endif
120 endif
121 set nomodified
122endfun
123
124" Reset 'title' and 'icon' to make it work faster.
125let s:old_title = &title
126let s:old_icon = &icon
127let s:old_sc = &sc
128let s:old_ru = &ru
129set notitle noicon nosc noru
130
131" If the current window is a help window, try finding a non-help window.
132" Relies on syntax highlighting to be switched on.
133let s:thiswin = winnr()
134while exists("b:current_syntax") && b:current_syntax == "help"
Bram Moolenaar251e1912011-06-19 05:09:16 +0200135 wincmd w
Bram Moolenaar071d4272004-06-13 20:20:40 +0000136 if s:thiswin == winnr()
137 break
138 endif
139endwhile
140
Bram Moolenaarab6c8582017-08-11 17:15:09 +0200141" Open the window. $OPTWIN_CMD is set to "tab" for ":tab options".
142exe $OPTWIN_CMD . ' new option-window'
Bram Moolenaar251e1912011-06-19 05:09:16 +0200143setlocal ts=15 tw=0 noro buftype=nofile
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144
145" Insert help and a "set" command for each option.
146call append(0, '" Each "set" line shows the current value of an option (on the left).')
147call append(1, '" Hit <CR> on a "set" line to execute it.')
148call append(2, '" A boolean option will be toggled.')
Bram Moolenaar2f3b5102014-11-19 18:54:17 +0100149call append(3, '" For other options you can edit the value before hitting <CR>.')
Bram Moolenaar071d4272004-06-13 20:20:40 +0000150call append(4, '" Hit <CR> on a help line to open a help window on this option.')
151call append(5, '" Hit <CR> on an index line to jump there.')
152call append(6, '" Hit <Space> on a "set" line to refresh it.')
153
154" These functions are called often below. Keep them fast!
155
156" Init a local binary option
157fun! <SID>BinOptionL(name)
Bram Moolenaar251e1912011-06-19 05:09:16 +0200158 let val = getwinvar(winnr('#'), '&' . a:name)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159 call append("$", substitute(substitute(" \tset " . val . a:name . "\t" .
160 \!val . a:name, "0", "no", ""), "1", "", ""))
161endfun
162
163" Init a global binary option
164fun! <SID>BinOptionG(name, val)
165 call append("$", substitute(substitute(" \tset " . a:val . a:name . "\t" .
166 \!a:val . a:name, "0", "no", ""), "1", "", ""))
167endfun
168
169" Init a local string option
170fun! <SID>OptionL(name)
Bram Moolenaar251e1912011-06-19 05:09:16 +0200171 let val = escape(getwinvar(winnr('#'), '&' . a:name), " \t\\\"|")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000172 call append("$", " \tset " . a:name . "=" . val)
173endfun
174
175" Init a global string option
176fun! <SID>OptionG(name, val)
Bram Moolenaar251e1912011-06-19 05:09:16 +0200177 call append("$", " \tset " . a:name . "=" . escape(a:val, " \t\\\"|"))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178endfun
179
180let s:idx = 1
181let s:lnum = line("$")
182call append("$", "")
183
184fun! <SID>Header(text)
185 let line = s:idx . " " . a:text
186 if s:idx < 10
187 let line = " " . line
188 endif
189 call append("$", "")
190 call append("$", line)
191 call append("$", "")
192 call append(s:lnum, line)
193 let s:idx = s:idx + 1
194 let s:lnum = s:lnum + 1
195endfun
196
197" Get the value of 'pastetoggle'. It could be a special key.
198fun! <SID>PTvalue()
199 redir @a
200 silent set pt
201 redir END
202 return substitute(@a, '[^=]*=\(.*\)', '\1', "")
203endfun
204
205" Restore the previous value of 'cpoptions' here, it's used below.
206let &cpo = s:cpo_save
207
208" List of all options, organized by function.
209" The text should be sufficient to know what the option is used for.
210
211call <SID>Header("important")
212call append("$", "compatible\tbehave very Vi compatible (not advisable)")
213call <SID>BinOptionG("cp", &cp)
214call append("$", "cpoptions\tlist of flags to specify Vi compatibility")
215call <SID>OptionG("cpo", &cpo)
216call append("$", "insertmode\tuse Insert mode as the default mode")
217call <SID>BinOptionG("im", &im)
218call append("$", "paste\tpaste mode, insert typed text literally")
219call <SID>BinOptionG("paste", &paste)
220call append("$", "pastetoggle\tkey sequence to toggle paste mode")
221if &pt =~ "\x80"
222 call append("$", " \tset pt=" . <SID>PTvalue())
223else
224 call <SID>OptionG("pt", &pt)
225endif
226call append("$", "runtimepath\tlist of directories used for runtime files and plugins")
227call <SID>OptionG("rtp", &rtp)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +0100228call append("$", "packpath\tlist of directories used for plugin packages")
229call <SID>OptionG("pp", &pp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000230call append("$", "helpfile\tname of the main help file")
231call <SID>OptionG("hf", &hf)
232
233
234call <SID>Header("moving around, searching and patterns")
235call append("$", "whichwrap\tlist of flags specifying which commands wrap to another line")
236call append("$", "\t(local to window)")
237call <SID>OptionL("ww")
238call append("$", "startofline\tmany jump commands move the cursor to the first non-blank")
239call append("$", "\tcharacter of a line")
240call <SID>BinOptionG("sol", &sol)
241call append("$", "paragraphs\tnroff macro names that separate paragraphs")
242call <SID>OptionG("para", &para)
243call append("$", "sections\tnroff macro names that separate sections")
244call <SID>OptionG("sect", &sect)
245call append("$", "path\tlist of directory names used for file searching")
246call append("$", "\t(global or local to buffer)")
247call <SID>OptionG("pa", &pa)
248call append("$", "cdpath\tlist of directory names used for :cd")
249call <SID>OptionG("cd", &cd)
Bram Moolenaarfa9a3702010-07-24 15:48:31 +0200250if exists("+autochdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000251 call append("$", "autochdir\tchange to directory of file in buffer")
252 call <SID>BinOptionG("acd", &acd)
253endif
254call append("$", "wrapscan\tsearch commands wrap around the end of the buffer")
255call <SID>BinOptionG("ws", &ws)
256call append("$", "incsearch\tshow match for partly typed search command")
257call <SID>BinOptionG("is", &is)
258call append("$", "magic\tchange the way backslashes are used in search patterns")
259call <SID>BinOptionG("magic", &magic)
Bram Moolenaare6ae6222013-05-21 21:01:10 +0200260call append("$", "regexpengine\tselect the default regexp engine used")
261call <SID>OptionG("re", &re)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000262call append("$", "ignorecase\tignore case when using a search pattern")
263call <SID>BinOptionG("ic", &ic)
264call append("$", "smartcase\toverride 'ignorecase' when pattern has upper case characters")
265call <SID>BinOptionG("scs", &scs)
Bram Moolenaar1deee622010-07-24 20:35:12 +0200266call append("$", "casemap\twhat method to use for changing case of letters")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000267call <SID>OptionG("cmp", &cmp)
Bram Moolenaar52b4b552005-03-07 23:00:57 +0000268call append("$", "maxmempattern\tmaximum amount of memory in Kbyte used for pattern matching")
269call append("$", " \tset mmp=" . &mmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270call append("$", "define\tpattern for a macro definition line")
271call append("$", "\t(global or local to buffer)")
272call <SID>OptionG("def", &def)
273if has("find_in_path")
274 call append("$", "include\tpattern for an include-file line")
275 call append("$", "\t(local to buffer)")
276 call <SID>OptionL("inc")
277 call append("$", "includeexpr\texpression used to transform an include line to a file name")
278 call append("$", "\t(local to buffer)")
279 call <SID>OptionL("inex")
280endif
281
282
283call <SID>Header("tags")
284call append("$", "tagbsearch\tuse binary searching in tags files")
285call <SID>BinOptionG("tbs", &tbs)
286call append("$", "taglength\tnumber of significant characters in a tag name or zero")
287call append("$", " \tset tl=" . &tl)
288call append("$", "tags\tlist of file names to search for tags")
289call append("$", "\t(global or local to buffer)")
290call <SID>OptionG("tag", &tag)
Bram Moolenaar0f6562e2015-11-24 18:48:14 +0100291call append("$", "tagcase\thow to handle case when searching in tags files:")
292call append("$", "\t\"followic\" to follow 'ignorecase', \"ignore\" or \"match\"")
293call append("$", "\t(global or local to buffer)")
294call <SID>OptionG("tc", &tc)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295call append("$", "tagrelative\tfile names in a tags file are relative to the tags file")
296call <SID>BinOptionG("tr", &tr)
297call append("$", "tagstack\ta :tag command will use the tagstack")
298call <SID>BinOptionG("tgst", &tgst)
299call append("$", "showfulltag\twhen completing tags in Insert mode show more info")
300call <SID>BinOptionG("sft", &sft)
301if has("cscope")
302 call append("$", "cscopeprg\tcommand for executing cscope")
303 call <SID>OptionG("csprg", &csprg)
304 call append("$", "cscopetag\tuse cscope for tag commands")
305 call <SID>BinOptionG("cst", &cst)
306 call append("$", "cscopetagorder\t0 or 1; the order in which \":cstag\" performs a search")
307 call append("$", " \tset csto=" . &csto)
308 call append("$", "cscopeverbose\tgive messages when adding a cscope database")
309 call <SID>BinOptionG("csverb", &csverb)
310 call append("$", "cscopepathcomp\thow many components of the path to show")
311 call append("$", " \tset cspc=" . &cspc)
Bram Moolenaar1deee622010-07-24 20:35:12 +0200312 call append("$", "cscopequickfix\twhen to open a quickfix window for cscope")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000313 call <SID>OptionG("csqf", &csqf)
Bram Moolenaar251e1912011-06-19 05:09:16 +0200314 call append("$", "cscoperelative\tfile names in a cscope file are relative to that file")
315 call <SID>BinOptionG("csre", &csre)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316endif
317
318
319call <SID>Header("displaying text")
320call append("$", "scroll\tnumber of lines to scroll for CTRL-U and CTRL-D")
321call append("$", "\t(local to window)")
322call <SID>OptionL("scr")
323call append("$", "scrolloff\tnumber of screen lines to show around the cursor")
324call append("$", " \tset so=" . &so)
325call append("$", "wrap\tlong lines wrap")
326call <SID>BinOptionG("wrap", &wrap)
327call append("$", "linebreak\twrap long lines at a character in 'breakat'")
328call append("$", "\t(local to window)")
329call <SID>BinOptionL("lbr")
Bram Moolenaar597a4222014-06-25 14:39:50 +0200330call append("$", "breakindent\tpreserve indentation in wrapped text")
331call append("$", "\t(local to window)")
332call <SID>BinOptionL("bri")
333call append("$", "breakindentopt\tadjust breakindent behaviour")
334call append("$", "\t(local to window)")
335call <SID>OptionL("briopt")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000336call append("$", "breakat\twhich characters might cause a line break")
337call <SID>OptionG("brk", &brk)
338call append("$", "showbreak\tstring to put before wrapped screen lines")
339call <SID>OptionG("sbr", &sbr)
340call append("$", "sidescroll\tminimal number of columns to scroll horizontally")
341call append("$", " \tset ss=" . &ss)
342call append("$", "sidescrolloff\tminimal number of columns to keep left and right of the cursor")
343call append("$", " \tset siso=" . &siso)
344call append("$", "display\tinclude \"lastline\" to show the last line even if it doesn't fit")
345call append("$", "\tinclude \"uhex\" to show unprintable characters as a hex number")
346call <SID>OptionG("dy", &dy)
347call append("$", "fillchars\tcharacters to use for the status line, folds and filler lines")
348call <SID>OptionG("fcs", &fcs)
349call append("$", "cmdheight\tnumber of lines used for the command-line")
350call append("$", " \tset ch=" . &ch)
351call append("$", "columns\twidth of the display")
352call append("$", " \tset co=" . &co)
353call append("$", "lines\tnumber of lines in the display")
354call append("$", " \tset lines=" . &lines)
Bram Moolenaar1b20d3d2010-07-24 20:44:02 +0200355call append("$", "window\tnumber of lines to scroll for CTRL-F and CTRL-B")
356call append("$", " \tset window=" . &window)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357call append("$", "lazyredraw\tdon't redraw while executing macros")
358call <SID>BinOptionG("lz", &lz)
Bram Moolenaar63ce8c02008-06-04 12:29:14 +0000359if has("reltime")
360 call append("$", "redrawtime\ttimeout for 'hlsearch' and :match highlighting in msec")
361 call append("$", " \tset rdt=" . &rdt)
362endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363call append("$", "writedelay\tdelay in msec for each char written to the display")
364call append("$", "\t(for debugging)")
365call append("$", " \tset wd=" . &wd)
366call append("$", "list\tshow <Tab> as ^I and end-of-line as $")
367call append("$", "\t(local to window)")
368call <SID>BinOptionL("list")
369call append("$", "listchars\tlist of strings used for list mode")
370call <SID>OptionG("lcs", &lcs)
371call append("$", "number\tshow the line number for each line")
372call append("$", "\t(local to window)")
373call <SID>BinOptionL("nu")
Bram Moolenaar64486672010-05-16 15:46:46 +0200374call append("$", "relativenumber\tshow the relative line number for each line")
375call append("$", "\t(local to window)")
376call <SID>BinOptionL("rnu")
Bram Moolenaar592e0a22004-07-03 16:05:59 +0000377if has("linebreak")
378 call append("$", "numberwidth\tnumber of columns to use for the line number")
379 call append("$", "\t(local to window)")
380 call <SID>OptionL("nuw")
381endif
Bram Moolenaar860cae12010-06-05 23:22:07 +0200382if has("conceal")
Bram Moolenaarfa9a3702010-07-24 15:48:31 +0200383 call append("$", "conceallevel\tcontrols whether concealable text is hidden")
Bram Moolenaar860cae12010-06-05 23:22:07 +0200384 call append("$", "\t(local to window)")
Bram Moolenaarfa9a3702010-07-24 15:48:31 +0200385 call <SID>OptionL("cole")
Bram Moolenaar4f99eae2010-07-24 15:56:43 +0200386 call append("$", "concealcursor\tmodes in which text in the cursor line can be concealed")
Bram Moolenaarfa9a3702010-07-24 15:48:31 +0200387 call append("$", "\t(local to window)")
388 call <SID>OptionL("cocu")
Bram Moolenaar860cae12010-06-05 23:22:07 +0200389endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000390
391
Bram Moolenaar7887d882005-07-01 22:33:52 +0000392call <SID>Header("syntax, highlighting and spelling")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000393call append("$", "background\t\"dark\" or \"light\"; the background color brightness")
394call <SID>OptionG("bg", &bg)
395if has("autocmd")
396 call append("$", "filetype\ttype of file; triggers the FileType event when set")
397 call append("$", "\t(local to buffer)")
398 call <SID>OptionL("ft")
399endif
400if has("syntax")
401 call append("$", "syntax\tname of syntax highlighting used")
402 call append("$", "\t(local to buffer)")
403 call <SID>OptionL("syn")
Bram Moolenaar9ff70112005-07-11 22:29:03 +0000404 call append("$", "synmaxcol\tmaximum column to look for syntax items")
405 call append("$", "\t(local to buffer)")
406 call <SID>OptionL("smc")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000407endif
408call append("$", "highlight\twhich highlighting to use for various occasions")
409call <SID>OptionG("hl", &hl)
410call append("$", "hlsearch\thighlight all matches for the last used search pattern")
411call <SID>BinOptionG("hls", &hls)
Bram Moolenaar8a24b792016-04-30 16:13:10 +0200412if has("termguicolors")
Bram Moolenaar8e3d1b62016-04-30 15:17:19 +0200413 call append("$", "termguicolors\tuse GUI colors for the terminal")
Bram Moolenaar868cfc12016-04-30 16:49:58 +0200414 call <SID>BinOptionG("tgc", &tgc)
Bram Moolenaar8e3d1b62016-04-30 15:17:19 +0200415endif
Bram Moolenaar7887d882005-07-01 22:33:52 +0000416if has("syntax")
Bram Moolenaarf71a3db2006-03-12 21:50:18 +0000417 call append("$", "cursorcolumn\thighlight the screen column of the cursor")
418 call append("$", "\t(local to window)")
419 call <SID>BinOptionL("cuc")
420 call append("$", "cursorline\thighlight the screen line of the cursor")
421 call append("$", "\t(local to window)")
422 call <SID>BinOptionL("cul")
Bram Moolenaar607cc1e2010-07-18 18:47:44 +0200423 call append("$", "colorcolumn\tcolumns to highlight")
424 call append("$", "\t(local to window)")
425 call <SID>OptionL("cc")
Bram Moolenaar7887d882005-07-01 22:33:52 +0000426 call append("$", "spell\thighlight spelling mistakes")
427 call append("$", "\t(local to window)")
428 call <SID>BinOptionL("spell")
429 call append("$", "spelllang\tlist of accepted languages")
430 call append("$", "\t(local to buffer)")
431 call <SID>OptionL("spl")
432 call append("$", "spellfile\tfile that \"zg\" adds good words to")
433 call append("$", "\t(local to buffer)")
434 call <SID>OptionL("spf")
Bram Moolenaar551f84f2005-07-06 22:29:20 +0000435 call append("$", "spellcapcheck\tpattern to locate the end of a sentence")
436 call append("$", "\t(local to buffer)")
437 call <SID>OptionL("spc")
Bram Moolenaar7887d882005-07-01 22:33:52 +0000438 call append("$", "spellsuggest\tmethods used to suggest corrections")
439 call <SID>OptionG("sps", &sps)
Bram Moolenaarac6e65f2005-08-29 22:25:38 +0000440 call append("$", "mkspellmem\tamount of memory used by :mkspell before compressing")
441 call <SID>OptionG("msm", &msm)
Bram Moolenaar7887d882005-07-01 22:33:52 +0000442endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000443
444
445call <SID>Header("multiple windows")
446call append("$", "laststatus\t0, 1 or 2; when to use a status line for the last window")
447call append("$", " \tset ls=" . &ls)
448if has("statusline")
449 call append("$", "statusline\talternate format to be used for a status line")
450 call <SID>OptionG("stl", &stl)
451endif
452call append("$", "equalalways\tmake all windows the same size when adding/removing windows")
453call <SID>BinOptionG("ea", &ea)
454if has("vertsplit")
455 call append("$", "eadirection\tin which direction 'equalalways' works: \"ver\", \"hor\" or \"both\"")
456 call <SID>OptionG("ead", &ead)
457endif
458call append("$", "winheight\tminimal number of lines used for the current window")
459call append("$", " \tset wh=" . &wh)
460call append("$", "winminheight\tminimal number of lines used for any window")
461call append("$", " \tset wmh=" . &wmh)
462call append("$", "winfixheight\tkeep the height of the window")
463call append("$", "\t(local to window)")
464call <SID>BinOptionL("wfh")
465if has("vertsplit")
Bram Moolenaarbe4d5062006-03-18 21:30:13 +0000466call append("$", "winfixwidth\tkeep the width of the window")
467call append("$", "\t(local to window)")
468call <SID>BinOptionL("wfw")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000469 call append("$", "winwidth\tminimal number of columns used for the current window")
470 call append("$", " \tset wiw=" . &wiw)
471 call append("$", "winminwidth\tminimal number of columns used for any window")
472 call append("$", " \tset wmw=" . &wmw)
473endif
474call append("$", "helpheight\tinitial height of the help window")
475call append("$", " \tset hh=" . &hh)
476if has("quickfix")
477 call append("$", "previewheight\tdefault height for the preview window")
478 call append("$", " \tset pvh=" . &pvh)
479 call append("$", "previewwindow\tidentifies the preview window")
480 call append("$", "\t(local to window)")
481 call <SID>BinOptionL("pvw")
482endif
483call append("$", "hidden\tdon't unload a buffer when no longer shown in a window")
484call <SID>BinOptionG("hid", &hid)
485call append("$", "switchbuf\t\"useopen\" and/or \"split\"; which window to use when jumping")
486call append("$", "\tto a buffer")
487call <SID>OptionG("swb", &swb)
488call append("$", "splitbelow\ta new window is put below the current one")
489call <SID>BinOptionG("sb", &sb)
490if has("vertsplit")
491 call append("$", "splitright\ta new window is put right of the current one")
492 call <SID>BinOptionG("spr", &spr)
493endif
494if has("scrollbind")
495 call append("$", "scrollbind\tthis window scrolls together with other bound windows")
496 call append("$", "\t(local to window)")
497 call <SID>BinOptionL("scb")
498 call append("$", "scrollopt\t\"ver\", \"hor\" and/or \"jump\"; list of options for 'scrollbind'")
499 call <SID>OptionG("sbo", &sbo)
500endif
Bram Moolenaarb2c03502010-07-02 20:20:09 +0200501if has("cursorbind")
502 call append("$", "cursorbind\tthis window's cursor moves together with other bound windows")
503 call append("$", "\t(local to window)")
504 call <SID>BinOptionL("crb")
505endif
Bram Moolenaar74675a62017-07-15 13:53:23 +0200506if has("terminal")
507 call append("$", "termsize\tsize of a terminal window")
508 call append("$", "\t(local to window)")
509 call <SID>OptionL("tms")
510 call append("$", "termkey\tkey that precedes Vim commands in a terminal window")
511 call append("$", "\t(local to window)")
512 call <SID>OptionL("tk")
Bram Moolenaar0aed9a22017-08-19 23:18:02 +0200513 if exists("&winptydll")
514 call append("$", "winptydll\tname of the winpty dynamic library")
515 call <SID>OptionG("winptydll", &winptydll)
516 endif
Bram Moolenaar74675a62017-07-15 13:53:23 +0200517endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000518
519
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000520call <SID>Header("multiple tab pages")
521call append("$", "showtabline\t0, 1 or 2; when to use a tab pages line")
522call append("$", " \tset stal=" . &stal)
523call append("$", "tabpagemax\tmaximum number of tab pages to open for -p and \"tab all\"")
524call append("$", " \tset tpm=" . &tpm)
525call append("$", "tabline\tcustom tab pages line")
526call <SID>OptionG("tal", &tal)
Bram Moolenaarf9393ef2006-04-24 19:47:27 +0000527if has("gui")
528 call append("$", "guitablabel\tcustom tab page label for the GUI")
529 call <SID>OptionG("gtl", &gtl)
530 call append("$", "guitabtooltip\tcustom tab page tooltip for the GUI")
531 call <SID>OptionG("gtt", &gtt)
532endif
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000533
534
Bram Moolenaar071d4272004-06-13 20:20:40 +0000535call <SID>Header("terminal")
536call append("$", "term\tname of the used terminal")
537call <SID>OptionG("term", &term)
538call append("$", "ttytype\talias for 'term'")
539call <SID>OptionG("tty", &tty)
540call append("$", "ttybuiltin\tcheck built-in termcaps first")
541call <SID>BinOptionG("tbi", &tbi)
542call append("$", "ttyfast\tterminal connection is fast")
543call <SID>BinOptionG("tf", &tf)
544call append("$", "weirdinvert\tterminal that requires extra redrawing")
545call <SID>BinOptionG("wiv", &wiv)
546call append("$", "esckeys\trecognize keys that start with <Esc> in Insert mode")
547call <SID>BinOptionG("ek", &ek)
548call append("$", "scrolljump\tminimal number of lines to scroll at a time")
549call append("$", " \tset sj=" . &sj)
550call append("$", "ttyscroll\tmaximum number of lines to use scrolling instead of redrawing")
551call append("$", " \tset tsl=" . &tsl)
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200552if has("gui") || has("win32")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553 call append("$", "guicursor\tspecifies what the cursor looks like in different modes")
554 call <SID>OptionG("gcr", &gcr)
555endif
556if has("title")
557 let &title = s:old_title
558 call append("$", "title\tshow info in the window title")
559 call <SID>BinOptionG("title", &title)
560 set notitle
561 call append("$", "titlelen\tpercentage of 'columns' used for the window title")
562 call append("$", " \tset titlelen=" . &titlelen)
563 call append("$", "titlestring\twhen not empty, string to be used for the window title")
564 call <SID>OptionG("titlestring", &titlestring)
565 call append("$", "titleold\tstring to restore the title to when exiting Vim")
566 call <SID>OptionG("titleold", &titleold)
567 let &icon = s:old_icon
568 call append("$", "icon\tset the text of the icon for this window")
569 call <SID>BinOptionG("icon", &icon)
570 set noicon
571 call append("$", "iconstring\twhen not empty, text for the icon of this window")
572 call <SID>OptionG("iconstring", &iconstring)
573endif
574if has("win32")
575 call append("$", "restorescreen\trestore the screen contents when exiting Vim")
576 call <SID>BinOptionG("rs", &rs)
577endif
578
579
580call <SID>Header("using the mouse")
581call append("$", "mouse\tlist of flags for using the mouse")
582call <SID>OptionG("mouse", &mouse)
583if has("gui")
584 call append("$", "mousefocus\tthe window with the mouse pointer becomes the current one")
585 call <SID>BinOptionG("mousef", &mousef)
586 call append("$", "mousehide\thide the mouse pointer while typing")
587 call <SID>BinOptionG("mh", &mh)
588endif
589call append("$", "mousemodel\t\"extend\", \"popup\" or \"popup_setpos\"; what the right")
590call append("$", "\tmouse button is used for")
591call <SID>OptionG("mousem", &mousem)
592call append("$", "mousetime\tmaximum time in msec to recognize a double-click")
593call append("$", " \tset mouset=" . &mouset)
594call append("$", "ttymouse\t\"xterm\", \"xterm2\", \"dec\" or \"netterm\"; type of mouse")
595call <SID>OptionG("ttym", &ttym)
596if has("mouseshape")
597 call append("$", "mouseshape\twhat the mouse pointer looks like in different modes")
598 call <SID>OptionG("mouses", &mouses)
599endif
600
601
602if has("gui")
603 call <SID>Header("GUI")
604 call append("$", "guifont\tlist of font names to be used in the GUI")
605 call <SID>OptionG("gfn", &gfn)
606 if has("xfontset")
607 call append("$", "guifontset\tpair of fonts to be used, for multibyte editing")
608 call <SID>OptionG("gfs", &gfs)
609 endif
610 call append("$", "guifontwide\tlist of font names to be used for double-wide characters")
611 call <SID>OptionG("gfw", &gfw)
612 if has("mac")
613 call append("$", "antialias\tuse smooth, antialiased fonts")
614 call <SID>BinOptionG("anti", &anti)
615 endif
616 call append("$", "guioptions\tlist of flags that specify how the GUI works")
617 call <SID>OptionG("go", &go)
618 if has("gui_gtk")
619 call append("$", "toolbar\t\"icons\", \"text\" and/or \"tooltips\"; how to show the toolbar")
620 call <SID>OptionG("tb", &tb)
621 if has("gui_gtk2")
Bram Moolenaar1deee622010-07-24 20:35:12 +0200622 call append("$", "toolbariconsize\tsize of toolbar icons")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000623 call <SID>OptionG("tbis", &tbis)
624 endif
625 call append("$", "guiheadroom\troom (in pixels) left above/below the window")
626 call append("$", " \tset ghr=" . &ghr)
627 endif
Bram Moolenaarfb539272014-08-22 19:21:47 +0200628 if has("directx")
629 call append("$", "renderoptions\toptions for text rendering")
630 call <SID>OptionG("rop", &rop)
631 endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000632 call append("$", "guipty\tuse a pseudo-tty for I/O to external commands")
633 call <SID>BinOptionG("guipty", &guipty)
634 if has("browse")
635 call append("$", "browsedir\t\"last\", \"buffer\" or \"current\": which directory used for the file browser")
636 call <SID>OptionG("bsdir", &bsdir)
637 endif
638 if has("multi_lang")
639 call append("$", "langmenu\tlanguage to be used for the menus")
640 call <SID>OptionG("langmenu", &lm)
641 endif
642 call append("$", "menuitems\tmaximum number of items in one menu")
643 call append("$", " \tset mis=" . &mis)
644 if has("winaltkeys")
645 call append("$", "winaltkeys\t\"no\", \"yes\" or \"menu\"; how to use the ALT key")
646 call <SID>OptionG("wak", &wak)
647 endif
648 call append("$", "linespace\tnumber of pixel lines to use between characters")
649 call append("$", " \tset lsp=" . &lsp)
650 if has("balloon_eval")
651 call append("$", "balloondelay\tdelay in milliseconds before a balloon may pop up")
652 call append("$", " \tset bdlay=" . &bdlay)
Bram Moolenaar52b4b552005-03-07 23:00:57 +0000653 call append("$", "ballooneval\twhether the balloon evaluation is to be used")
654 call <SID>BinOptionG("beval", &beval)
655 if has("eval")
656 call append("$", "balloonexpr\texpression to show in balloon eval")
657 call append("$", " \tset bexpr=" . &bexpr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000658 endif
659 endif
Bram Moolenaard5ab34b2007-05-05 17:15:44 +0000660 if exists("+macatsui")
Bram Moolenaarf9393ef2006-04-24 19:47:27 +0000661 call append("$", "macatsui\tuse ATSUI text drawing; disable to avoid display problems")
662 call <SID>OptionG("macatsui", &macatsui)
663 endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000664endif
665
666if has("printer")
667 call <SID>Header("printing")
Bram Moolenaar8299df92004-07-10 09:47:34 +0000668 call append("$", "printoptions\tlist of items that control the format of :hardcopy output")
669 call <SID>OptionG("popt", &popt)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000670 call append("$", "printdevice\tname of the printer to be used for :hardcopy")
671 call <SID>OptionG("pdev", &pdev)
Bram Moolenaar8299df92004-07-10 09:47:34 +0000672 if has("postscript")
673 call append("$", "printexpr\texpression used to print the PostScript file for :hardcopy")
674 call <SID>OptionG("pexpr", &pexpr)
675 endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676 call append("$", "printfont\tname of the font to be used for :hardcopy")
677 call <SID>OptionG("pfn", &pfn)
678 call append("$", "printheader\tformat of the header used for :hardcopy")
679 call <SID>OptionG("pheader", &pheader)
Bram Moolenaar8299df92004-07-10 09:47:34 +0000680 if has("postscript")
681 call append("$", "printencoding\tencoding used to print the PostScript file for :hardcopy")
682 call <SID>OptionG("penc", &penc)
683 endif
684 if has("multi_byte")
685 call append("$", "printmbcharset\tthe CJK character set to be used for CJK output from :hardcopy")
686 call <SID>OptionG("pmbcs", &pmbcs)
687 call append("$", "printmbfont\tlist of font names to be used for CJK output from :hardcopy")
688 call <SID>OptionG("pmbfn", &pmbfn)
689 endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000690endif
691
692call <SID>Header("messages and info")
693call append("$", "terse\tadd 's' flag in 'shortmess' (don't show search message)")
694call <SID>BinOptionG("terse", &terse)
695call append("$", "shortmess\tlist of flags to make messages shorter")
696call <SID>OptionG("shm", &shm)
697call append("$", "showcmd\tshow (partial) command keys in the status line")
698let &sc = s:old_sc
699call <SID>BinOptionG("sc", &sc)
700set nosc
701call append("$", "showmode\tdisplay the current mode in the status line")
702call <SID>BinOptionG("smd", &smd)
703call append("$", "ruler\tshow cursor position below each window")
704let &ru = s:old_ru
705call <SID>BinOptionG("ru", &ru)
706set noru
707if has("statusline")
708 call append("$", "rulerformat\talternate format to be used for the ruler")
709 call <SID>OptionG("ruf", &ruf)
710endif
711call append("$", "report\tthreshold for reporting number of changed lines")
712call append("$", " \tset report=" . &report)
713call append("$", "verbose\tthe higher the more messages are given")
714call append("$", " \tset vbs=" . &vbs)
Bram Moolenaar7887d882005-07-01 22:33:52 +0000715call append("$", "verbosefile\tfile to write messages in")
716call <SID>OptionG("vfile", &vfile)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717call append("$", "more\tpause listings when the screen is full")
718call <SID>BinOptionG("more", &more)
719if has("dialog_con") || has("dialog_gui")
720 call append("$", "confirm\tstart a dialog when a command fails")
721 call <SID>BinOptionG("cf", &cf)
722endif
723call append("$", "errorbells\tring the bell for error messages")
724call <SID>BinOptionG("eb", &eb)
725call append("$", "visualbell\tuse a visual bell instead of beeping")
726call <SID>BinOptionG("vb", &vb)
Bram Moolenaarf9132812015-07-21 19:19:13 +0200727call append("$", "belloff\tdo not ring the bell for these reasons")
Bram Moolenaardd1616e2015-07-22 22:22:59 +0200728call <SID>OptionG("belloff", &belloff)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000729if has("multi_lang")
730 call append("$", "helplang\tlist of preferred languages for finding help")
731 call <SID>OptionG("hlg", &hlg)
732endif
733
734
735call <SID>Header("selecting text")
736call append("$", "selection\t\"old\", \"inclusive\" or \"exclusive\"; how selecting text behaves")
737call <SID>OptionG("sel", &sel)
738call append("$", "selectmode\t\"mouse\", \"key\" and/or \"cmd\"; when to start Select mode")
739call append("$", "\tinstead of Visual mode")
740call <SID>OptionG("slm", &slm)
741if has("clipboard")
742 call append("$", "clipboard\t\"unnamed\" to use the * register like unnamed register")
743 call append("$", "\t\"autoselect\" to always put selected text on the clipboard")
744 call <SID>OptionG("cb", &cb)
745endif
746call append("$", "keymodel\t\"startsel\" and/or \"stopsel\"; what special keys can do")
747call <SID>OptionG("km", &km)
748
749
750call <SID>Header("editing text")
751call append("$", "undolevels\tmaximum number of changes that can be undone")
Bram Moolenaar7d76c802014-10-15 22:51:52 +0200752call append("$", "\t(global or local to buffer)")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000753call append("$", " \tset ul=" . &ul)
Bram Moolenaar4694a172016-04-21 14:05:23 +0200754call append("$", "undofile\tautomatically save and restore undo history")
755call <SID>BinOptionG("udf", &udf)
756call append("$", "undodir\tlist of directories for undo files")
757call <SID>OptionG("udir", &udir)
Bram Moolenaar59f931e2010-07-24 20:27:03 +0200758call append("$", "undoreload\tmaximum number lines to save for undo on a buffer reload")
759call append("$", " \tset ur=" . &ur)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000760call append("$", "modified\tchanges have been made and not written to a file")
761call append("$", "\t(local to buffer)")
762call <SID>BinOptionL("mod")
763call append("$", "readonly\tbuffer is not to be written")
764call append("$", "\t(local to buffer)")
765call <SID>BinOptionL("ro")
766call append("$", "modifiable\tchanges to the text are not possible")
767call append("$", "\t(local to buffer)")
768call <SID>BinOptionL("ma")
769call append("$", "textwidth\tline length above which to break a line")
770call append("$", "\t(local to buffer)")
771call <SID>OptionL("tw")
772call append("$", "wrapmargin\tmargin from the right in which to break a line")
773call append("$", "\t(local to buffer)")
774call <SID>OptionL("wm")
775call append("$", "backspace\tspecifies what <BS>, CTRL-W, etc. can do in Insert mode")
776call append("$", " \tset bs=" . &bs)
777call append("$", "comments\tdefinition of what comment lines look like")
778call append("$", "\t(local to buffer)")
779call <SID>OptionL("com")
780call append("$", "formatoptions\tlist of flags that tell how automatic formatting works")
781call append("$", "\t(local to buffer)")
782call <SID>OptionL("fo")
Bram Moolenaar86b68352004-12-27 21:59:20 +0000783call append("$", "formatlistpat\tpattern to recognize a numbered list")
784call append("$", "\t(local to buffer)")
785call <SID>OptionL("flp")
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000786if has("eval")
787 call append("$", "formatexpr\texpression used for \"gq\" to format lines")
788 call append("$", "\t(local to buffer)")
789 call <SID>OptionL("fex")
790endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791if has("insert_expand")
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000792 call append("$", "complete\tspecifies how Insert mode completion works for CTRL-N and CTRL-P")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000793 call append("$", "\t(local to buffer)")
794 call <SID>OptionL("cpt")
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000795 call append("$", "completeopt\twhether to use a popup menu for Insert mode completion")
796 call <SID>OptionG("cot", &cot)
Bram Moolenaard3667a22006-03-16 21:35:52 +0000797 call append("$", "pumheight\tmaximum height of the popup menu")
798 call <SID>OptionG("ph", &ph)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000799 call append("$", "completefunc\tuser defined function for Insert mode completion")
800 call append("$", "\t(local to buffer)")
801 call <SID>OptionL("cfu")
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000802 call append("$", "omnifunc\tfunction for filetype-specific Insert mode completion")
Bram Moolenaare344bea2005-09-01 20:46:49 +0000803 call append("$", "\t(local to buffer)")
804 call <SID>OptionL("ofu")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805 call append("$", "dictionary\tlist of dictionary files for keyword completion")
806 call append("$", "\t(global or local to buffer)")
807 call <SID>OptionG("dict", &dict)
808 call append("$", "thesaurus\tlist of thesaurus files for keyword completion")
809 call append("$", "\t(global or local to buffer)")
810 call <SID>OptionG("tsr", &tsr)
811endif
812call append("$", "infercase\tadjust case of a keyword completion match")
813call append("$", "\t(local to buffer)")
814call <SID>BinOptionL("inf")
815if has("digraphs")
Bram Moolenaar2b7db932016-01-07 16:52:10 +0100816 call append("$", "digraph\tenable entering digraphs with c1 <BS> c2")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000817 call <SID>BinOptionG("dg", &dg)
818endif
819call append("$", "tildeop\tthe \"~\" command behaves like an operator")
820call <SID>BinOptionG("top", &top)
Bram Moolenaar4770d092006-01-12 23:22:24 +0000821call append("$", "operatorfunc\tfunction called for the\"g@\" operator")
822call <SID>OptionG("opfunc", &opfunc)
Bram Moolenaar1deee622010-07-24 20:35:12 +0200823call append("$", "showmatch\twhen inserting a bracket, briefly jump to its match")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000824call <SID>BinOptionG("sm", &sm)
825call append("$", "matchtime\ttenth of a second to show a match for 'showmatch'")
826call append("$", " \tset mat=" . &mat)
827call append("$", "matchpairs\tlist of pairs that match for the \"%\" command")
828call append("$", "\t(local to buffer)")
829call <SID>OptionL("mps")
830call append("$", "joinspaces\tuse two spaces after '.' when joining a line")
831call <SID>BinOptionG("js", &js)
832call append("$", "nrformats\t\"alpha\", \"octal\" and/or \"hex\"; number formats recognized for")
833call append("$", "\tCTRL-A and CTRL-X commands")
834call append("$", "\t(local to buffer)")
835call <SID>OptionL("nf")
836
837
838call <SID>Header("tabs and indenting")
839call append("$", "tabstop\tnumber of spaces a <Tab> in the text stands for")
840call append("$", "\t(local to buffer)")
841call <SID>OptionL("ts")
842call append("$", "shiftwidth\tnumber of spaces used for each step of (auto)indent")
843call append("$", "\t(local to buffer)")
844call <SID>OptionL("sw")
845call append("$", "smarttab\ta <Tab> in an indent inserts 'shiftwidth' spaces")
846call <SID>BinOptionG("sta", &sta)
847call append("$", "softtabstop\tif non-zero, number of spaces to insert for a <Tab>")
848call append("$", "\t(local to buffer)")
849call <SID>OptionL("sts")
850call append("$", "shiftround\tround to 'shiftwidth' for \"<<\" and \">>\"")
851call <SID>BinOptionG("sr", &sr)
852call append("$", "expandtab\texpand <Tab> to spaces in Insert mode")
853call append("$", "\t(local to buffer)")
854call <SID>BinOptionL("et")
855call append("$", "autoindent\tautomatically set the indent of a new line")
856call append("$", "\t(local to buffer)")
857call <SID>BinOptionL("ai")
858if has("smartindent")
859 call append("$", "smartindent\tdo clever autoindenting")
860 call append("$", "\t(local to buffer)")
861 call <SID>BinOptionL("si")
862endif
863if has("cindent")
864 call append("$", "cindent\tenable specific indenting for C code")
865 call append("$", "\t(local to buffer)")
866 call <SID>BinOptionL("cin")
867 call append("$", "cinoptions\toptions for C-indenting")
868 call append("$", "\t(local to buffer)")
869 call <SID>OptionL("cino")
870 call append("$", "cinkeys\tkeys that trigger C-indenting in Insert mode")
871 call append("$", "\t(local to buffer)")
872 call <SID>OptionL("cink")
873 call append("$", "cinwords\tlist of words that cause more C-indent")
874 call append("$", "\t(local to buffer)")
875 call <SID>OptionL("cinw")
876 call append("$", "indentexpr\texpression used to obtain the indent of a line")
877 call append("$", "\t(local to buffer)")
878 call <SID>OptionL("inde")
879 call append("$", "indentkeys\tkeys that trigger indenting with 'indentexpr' in Insert mode")
880 call append("$", "\t(local to buffer)")
881 call <SID>OptionL("indk")
882endif
Bram Moolenaar1deee622010-07-24 20:35:12 +0200883call append("$", "copyindent\tcopy whitespace for indenting from previous line")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000884call append("$", "\t(local to buffer)")
885call <SID>BinOptionL("ci")
Bram Moolenaar1deee622010-07-24 20:35:12 +0200886call append("$", "preserveindent\tpreserve kind of whitespace when changing indent")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000887call append("$", "\t(local to buffer)")
888call <SID>BinOptionL("pi")
889if has("lispindent")
890 call append("$", "lisp\tenable lisp mode")
891 call append("$", "\t(local to buffer)")
892 call <SID>BinOptionL("lisp")
893 call append("$", "lispwords\twords that change how lisp indenting works")
Bram Moolenaare7a88a82014-04-01 12:26:46 +0200894 call <SID>OptionL("lw")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895endif
896
897
898if has("folding")
899 call <SID>Header("folding")
900 call append("$", "foldenable\tset to display all folds open")
901 call append("$", "\t(local to window)")
902 call <SID>BinOptionL("fen")
903 call append("$", "foldlevel\tfolds with a level higher than this number will be closed")
904 call append("$", "\t(local to window)")
905 call <SID>OptionL("fdl")
906 call append("$", "foldlevelstart\tvalue for 'foldlevel' when starting to edit a file")
907 call append("$", " \tset fdls=" . &fdls)
908 call append("$", "foldcolumn\twidth of the column used to indicate folds")
909 call append("$", "\t(local to window)")
910 call <SID>OptionL("fdc")
911 call append("$", "foldtext\texpression used to display the text of a closed fold")
912 call append("$", "\t(local to window)")
913 call <SID>OptionL("fdt")
914 call append("$", "foldclose\tset to \"all\" to close a fold when the cursor leaves it")
915 call <SID>OptionG("fcl", &fcl)
916 call append("$", "foldopen\tspecifies for which commands a fold will be opened")
917 call <SID>OptionG("fdo", &fdo)
918 call append("$", "foldminlines\tminimum number of screen lines for a fold to be closed")
919 call append("$", "\t(local to window)")
920 call <SID>OptionL("fml")
921 call append("$", "commentstring\ttemplate for comments; used to put the marker in")
922 call <SID>OptionL("cms")
923 call append("$", "foldmethod\tfolding type: \"manual\", \"indent\", \"expr\", \"marker\" or \"syntax\"")
924 call append("$", "\t(local to window)")
925 call <SID>OptionL("fdm")
926 call append("$", "foldexpr\texpression used when 'foldmethod' is \"expr\"")
927 call append("$", "\t(local to window)")
928 call <SID>OptionL("fde")
929 call append("$", "foldignore\tused to ignore lines when 'foldmethod' is \"indent\"")
930 call append("$", "\t(local to window)")
931 call <SID>OptionL("fdi")
932 call append("$", "foldmarker\tmarkers used when 'foldmethod' is \"marker\"")
933 call append("$", "\t(local to window)")
934 call <SID>OptionL("fmr")
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +0100935 call append("$", "foldnestmax\tmaximum fold depth for when 'foldmethod' is \"indent\" or \"syntax\"")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936 call append("$", "\t(local to window)")
937 call <SID>OptionL("fdn")
938endif
939
940
941if has("diff")
942 call <SID>Header("diff mode")
943 call append("$", "diff\tuse diff mode for the current window")
944 call append("$", "\t(local to window)")
945 call <SID>BinOptionL("diff")
946 call append("$", "diffopt\toptions for using diff mode")
947 call <SID>OptionG("dip", &dip)
948 call append("$", "diffexpr\texpression used to obtain a diff file")
949 call <SID>OptionG("dex", &dex)
950 call append("$", "patchexpr\texpression used to patch a file")
951 call <SID>OptionG("pex", &pex)
952endif
953
954
955call <SID>Header("mapping")
956call append("$", "maxmapdepth\tmaximum depth of mapping")
957call append("$", " \tset mmd=" . &mmd)
958call append("$", "remap\trecognize mappings in mapped keys")
959call <SID>BinOptionG("remap", &remap)
960call append("$", "timeout\tallow timing out halfway into a mapping")
961call <SID>BinOptionG("to", &to)
962call append("$", "ttimeout\tallow timing out halfway into a key code")
963call <SID>BinOptionG("ttimeout", &ttimeout)
964call append("$", "timeoutlen\ttime in msec for 'timeout'")
965call append("$", " \tset tm=" . &tm)
966call append("$", "ttimeoutlen\ttime in msec for 'ttimeout'")
967call append("$", " \tset ttm=" . &ttm)
968
969
970call <SID>Header("reading and writing files")
971call append("$", "modeline\tenable using settings from modelines when reading a file")
972call append("$", "\t(local to buffer)")
973call <SID>BinOptionL("ml")
974call append("$", "modelines\tnumber of lines to check for modelines")
975call append("$", " \tset mls=" . &mls)
976call append("$", "binary\tbinary file editing")
977call append("$", "\t(local to buffer)")
978call <SID>BinOptionL("bin")
979call append("$", "endofline\tlast line in the file has an end-of-line")
980call append("$", "\t(local to buffer)")
981call <SID>BinOptionL("eol")
Bram Moolenaarf9132812015-07-21 19:19:13 +0200982call append("$", "fixendofline\tfixes missing end-of-line at end of text file")
Bram Moolenaar34d72d42015-07-17 14:18:08 +0200983call append("$", "\t(local to buffer)")
984call <SID>BinOptionL("fixeol")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000985if has("multi_byte")
Bram Moolenaar1deee622010-07-24 20:35:12 +0200986 call append("$", "bomb\tprepend a Byte Order Mark to the file")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000987 call append("$", "\t(local to buffer)")
988 call <SID>BinOptionL("bomb")
989endif
990call append("$", "fileformat\tend-of-line format: \"dos\", \"unix\" or \"mac\"")
991call append("$", "\t(local to buffer)")
992call <SID>OptionL("ff")
993call append("$", "fileformats\tlist of file formats to look for when editing a file")
994call <SID>OptionG("ffs", &ffs)
995call append("$", "textmode\tobsolete, use 'fileformat'")
996call append("$", "\t(local to buffer)")
997call <SID>BinOptionL("tx")
998call append("$", "textauto\tobsolete, use 'fileformats'")
999call <SID>BinOptionG("ta", &ta)
1000call append("$", "write\twriting files is allowed")
1001call <SID>BinOptionG("write", &write)
1002call append("$", "writebackup\twrite a backup file before overwriting a file")
1003call <SID>BinOptionG("wb", &wb)
1004call append("$", "backup\tkeep a backup after overwriting a file")
1005call <SID>BinOptionG("bk", &bk)
1006call append("$", "backupskip\tpatterns that specify for which files a backup is not made")
1007call append("$", " \tset bsk=" . &bsk)
1008call append("$", "backupcopy\twhether to make the backup as a copy or rename the existing file")
Bram Moolenaar7d76c802014-10-15 22:51:52 +02001009call append("$", "\t(global or local to buffer)")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010call append("$", " \tset bkc=" . &bkc)
1011call append("$", "backupdir\tlist of directories to put backup files in")
1012call <SID>OptionG("bdir", &bdir)
1013call append("$", "backupext\tfile name extension for the backup file")
1014call <SID>OptionG("bex", &bex)
1015call append("$", "autowrite\tautomatically write a file when leaving a modified buffer")
1016call <SID>BinOptionG("aw", &aw)
1017call append("$", "autowriteall\tas 'autowrite', but works with more commands")
1018call <SID>BinOptionG("awa", &awa)
1019call append("$", "writeany\talways write without asking for confirmation")
1020call <SID>BinOptionG("wa", &wa)
1021call append("$", "autoread\tautomatically read a file when it was modified outside of Vim")
1022call append("$", "\t(global or local to buffer)")
1023call <SID>BinOptionG("ar", &ar)
1024call append("$", "patchmode\tkeep oldest version of a file; specifies file name extension")
1025call <SID>OptionG("pm", &pm)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001026call append("$", "fsync\tforcibly sync the file to disk after writing it")
1027call <SID>BinOptionG("fs", &fs)
Bram Moolenaara06ecab2016-07-16 14:47:36 +02001028call append("$", "shortname\tuse 8.3 file names")
1029call append("$", "\t(local to buffer)")
1030call <SID>BinOptionL("sn")
Bram Moolenaar365bdf72010-07-24 20:57:44 +02001031call append("$", "cryptmethod\tencryption method for file writing: zip or blowfish")
Bram Moolenaarb702c842010-05-18 22:28:22 +02001032call append("$", "\t(local to buffer)")
1033call <SID>OptionL("cm")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001034
1035
1036call <SID>Header("the swap file")
1037call append("$", "directory\tlist of directories for the swap file")
1038call <SID>OptionG("dir", &dir)
1039call append("$", "swapfile\tuse a swap file for this buffer")
1040call append("$", "\t(local to buffer)")
1041call <SID>BinOptionL("swf")
1042call append("$", "swapsync\t\"sync\", \"fsync\" or empty; how to flush a swap file to disk")
1043call <SID>OptionG("sws", &sws)
1044call append("$", "updatecount\tnumber of characters typed to cause a swap file update")
1045call append("$", " \tset uc=" . &uc)
1046call append("$", "updatetime\ttime in msec after which the swap file will be updated")
1047call append("$", " \tset ut=" . &ut)
1048call append("$", "maxmem\tmaximum amount of memory in Kbyte used for one buffer")
1049call append("$", " \tset mm=" . &mm)
1050call append("$", "maxmemtot\tmaximum amount of memory in Kbyte used for all buffers")
1051call append("$", " \tset mmt=" . &mmt)
1052
1053
1054call <SID>Header("command line editing")
1055call append("$", "history\thow many command lines are remembered ")
1056call append("$", " \tset hi=" . &hi)
1057call append("$", "wildchar\tkey that triggers command-line expansion")
1058call append("$", " \tset wc=" . &wc)
1059call append("$", "wildcharm\tlike 'wildchar' but can also be used in a mapping")
1060call append("$", " \tset wcm=" . &wcm)
1061call append("$", "wildmode\tspecifies how command line completion works")
1062call <SID>OptionG("wim", &wim)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00001063if has("wildoptions")
1064 call append("$", "wildoptions\tempty or \"tagfile\" to list file name of matching tags")
1065 call <SID>OptionG("wop", &wop)
1066endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067call append("$", "suffixes\tlist of file name extensions that have a lower priority")
1068call <SID>OptionG("su", &su)
1069if has("file_in_path")
1070 call append("$", "suffixesadd\tlist of file name extensions added when searching for a file")
1071 call append("$", "\t(local to buffer)")
1072 call <SID>OptionL("sua")
1073endif
1074if has("wildignore")
1075 call append("$", "wildignore\tlist of patterns to ignore files for file name completion")
1076 call <SID>OptionG("wig", &wig)
1077endif
Bram Moolenaar91fc43d2013-04-05 15:41:05 +02001078call append("$", "fileignorecase\tignore case when using file names")
1079call <SID>BinOptionG("fic", &fic)
Bram Moolenaar81af9252010-12-10 20:35:50 +01001080call append("$", "wildignorecase\tignore case when completing file names")
1081call <SID>BinOptionG("wic", &wic)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082if has("wildmenu")
1083 call append("$", "wildmenu\tcommand-line completion shows a list of matches")
1084 call <SID>BinOptionG("wmnu", &wmnu)
1085endif
1086if has("vertsplit")
1087 call append("$", "cedit\tkey used to open the command-line window")
1088 call <SID>OptionG("cedit", &cedit)
1089 call append("$", "cmdwinheight\theight of the command-line window")
1090 call <SID>OptionG("cwh", &cwh)
1091endif
1092
1093
1094call <SID>Header("executing external commands")
1095call append("$", "shell\tname of the shell program used for external commands")
1096call <SID>OptionG("sh", &sh)
1097if has("amiga")
1098 call append("$", "shelltype\twhen to use the shell or directly execute a command")
1099 call append("$", " \tset st=" . &st)
1100endif
1101call append("$", "shellquote\tcharacter(s) to enclose a shell command in")
1102call <SID>OptionG("shq", &shq)
1103call append("$", "shellxquote\tlike 'shellquote' but include the redirection")
1104call <SID>OptionG("sxq", &sxq)
Bram Moolenaardb7207e2012-02-22 17:30:19 +01001105call append("$", "shellxescape\tcharacters to escape when 'shellxquote' is (")
1106call <SID>OptionG("sxe", &sxe)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001107call append("$", "shellcmdflag\targument for 'shell' to execute a command")
1108call <SID>OptionG("shcf", &shcf)
1109call append("$", "shellredir\tused to redirect command output to a file")
1110call <SID>OptionG("srr", &srr)
Bram Moolenaar551f84f2005-07-06 22:29:20 +00001111call append("$", "shelltemp\tuse a temp file for shell commands instead of using a pipe")
1112call <SID>BinOptionG("stmp", &stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001113call append("$", "equalprg\tprogram used for \"=\" command")
1114call append("$", "\t(global or local to buffer)")
1115call <SID>OptionG("ep", &ep)
1116call append("$", "formatprg\tprogram used to format lines with \"gq\" command")
1117call <SID>OptionG("fp", &fp)
1118call append("$", "keywordprg\tprogram used for the \"K\" command")
1119call <SID>OptionG("kp", &kp)
1120call append("$", "warn\twarn when using a shell command and a buffer has changes")
1121call <SID>BinOptionG("warn", &warn)
1122
1123
1124if has("quickfix")
1125 call <SID>Header("running make and jumping to errors")
1126 call append("$", "errorfile\tname of the file that contains error messages")
1127 call <SID>OptionG("ef", &ef)
1128 call append("$", "errorformat\tlist of formats for error messages")
1129 call append("$", "\t(global or local to buffer)")
1130 call <SID>OptionG("efm", &efm)
1131 call append("$", "makeprg\tprogram used for the \":make\" command")
1132 call append("$", "\t(global or local to buffer)")
1133 call <SID>OptionG("mp", &mp)
1134 call append("$", "shellpipe\tstring used to put the output of \":make\" in the error file")
1135 call <SID>OptionG("sp", &sp)
1136 call append("$", "makeef\tname of the errorfile for the 'makeprg' command")
1137 call <SID>OptionG("mef", &mef)
1138 call append("$", "grepprg\tprogram used for the \":grep\" command")
1139 call append("$", "\t(global or local to buffer)")
1140 call <SID>OptionG("gp", &gp)
1141 call append("$", "grepformat\tlist of formats for output of 'grepprg'")
1142 call <SID>OptionG("gfm", &gfm)
Bram Moolenaarad4187e2017-03-06 21:45:20 +01001143 call append("$", "makeencoding\tencoding of the \":make\" and \":grep\" output")
1144 call append("$", "\t(global or local to buffer)")
1145 call <SID>OptionG("menc", &menc)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146endif
1147
1148
Bram Moolenaara06ecab2016-07-16 14:47:36 +02001149if has("win32") || has("osfiletype")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001150 call <SID>Header("system specific")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001151 if has("osfiletype")
1152 call append("$", "osfiletype\tOS-specific information about the type of file")
1153 call append("$", "\t(local to buffer)")
1154 call <SID>OptionL("oft")
1155 endif
Bram Moolenaara06ecab2016-07-16 14:47:36 +02001156 if has("win32")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001157 call append("$", "shellslash\tuse forward slashes in file names; for Unix-like shells")
1158 call <SID>BinOptionG("ssl", &ssl)
1159 endif
1160endif
1161
1162
1163call <SID>Header("language specific")
1164call append("$", "isfname\tspecifies the characters in a file name")
1165call <SID>OptionG("isf", &isf)
1166call append("$", "isident\tspecifies the characters in an identifier")
1167call <SID>OptionG("isi", &isi)
1168call append("$", "iskeyword\tspecifies the characters in a keyword")
1169call append("$", "\t(local to buffer)")
1170call <SID>OptionL("isk")
1171call append("$", "isprint\tspecifies printable characters")
1172call <SID>OptionG("isp", &isp)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001173if has("textobjects")
1174 call append("$", "quoteescape\tspecifies escape characters in a string")
1175 call append("$", "\t(local to buffer)")
1176 call <SID>OptionL("qe")
1177endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001178if has("rightleft")
1179 call append("$", "rightleft\tdisplay the buffer right-to-left")
1180 call append("$", "\t(local to window)")
1181 call <SID>BinOptionL("rl")
Bram Moolenaar1deee622010-07-24 20:35:12 +02001182 call append("$", "rightleftcmd\twhen to edit the command-line right-to-left")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001183 call append("$", "\t(local to window)")
1184 call <SID>OptionL("rlc")
Bram Moolenaar1deee622010-07-24 20:35:12 +02001185 call append("$", "revins\tinsert characters backwards")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186 call <SID>BinOptionG("ri", &ri)
Bram Moolenaar1deee622010-07-24 20:35:12 +02001187 call append("$", "allowrevins\tallow CTRL-_ in Insert and Command-line mode to toggle 'revins'")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001188 call <SID>BinOptionG("ari", &ari)
1189 call append("$", "aleph\tthe ASCII code for the first letter of the Hebrew alphabet")
1190 call append("$", " \tset al=" . &al)
1191 call append("$", "hkmap\tuse Hebrew keyboard mapping")
1192 call <SID>BinOptionG("hk", &hk)
1193 call append("$", "hkmapp\tuse phonetic Hebrew keyboard mapping")
1194 call <SID>BinOptionG("hkp", &hkp)
1195endif
1196if has("farsi")
1197 call append("$", "altkeymap\tuse Farsi as the second language when 'revins' is set")
1198 call <SID>BinOptionG("akm", &akm)
1199 call append("$", "fkmap\tuse Farsi keyboard mapping")
1200 call <SID>BinOptionG("fk", &fk)
1201endif
1202if has("arabic")
Bram Moolenaar1deee622010-07-24 20:35:12 +02001203 call append("$", "arabic\tprepare for editing Arabic text")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204 call append("$", "\t(local to window)")
1205 call <SID>BinOptionL("arab")
Bram Moolenaar1deee622010-07-24 20:35:12 +02001206 call append("$", "arabicshape\tperform shaping of Arabic characters")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001207 call <SID>BinOptionG("arshape", &arshape)
Bram Moolenaar1deee622010-07-24 20:35:12 +02001208 call append("$", "termbidi\tterminal will perform bidi handling")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001209 call <SID>BinOptionG("tbidi", &tbidi)
1210endif
1211if has("keymap")
Bram Moolenaar2b7db932016-01-07 16:52:10 +01001212 call append("$", "keymap\tname of a keyboard mapping")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213 call <SID>OptionL("kmp")
1214endif
1215if has("langmap")
Bram Moolenaar2f3b5102014-11-19 18:54:17 +01001216 call append("$", "langmap\tlist of characters that are translated in Normal mode")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001217 call <SID>OptionG("lmap", &lmap)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02001218 call append("$", "langremap\tapply 'langmap' to mapped characters")
1219 call <SID>BinOptionG("lrm", &lrm)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001220endif
1221if has("xim")
1222 call append("$", "imdisable\twhen set never use IM; overrules following IM options")
1223 call <SID>BinOptionG("imd", &imd)
1224endif
1225call append("$", "iminsert\tin Insert mode: 1: use :lmap; 2: use IM; 0: neither")
1226call append("$", "\t(local to window)")
1227call <SID>OptionL("imi")
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001228call append("$", "imstyle\tinput method style, 0: on-the-spot, 1: over-the-spot")
1229call <SID>OptionG("imst", &imst)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001230call append("$", "imsearch\tentering a search pattern: 1: use :lmap; 2: use IM; 0: neither")
1231call append("$", "\t(local to window)")
1232call <SID>OptionL("ims")
1233if has("xim")
1234 call append("$", "imcmdline\twhen set always use IM when starting to edit a command line")
1235 call <SID>BinOptionG("imc", &imc)
Bram Moolenaar14b69452013-06-29 23:05:20 +02001236 call append("$", "imstatusfunc\tfunction to obtain IME status")
1237 call <SID>OptionG("imsf", &imsf)
1238 call append("$", "imactivatefunc\tfunction to enable/disable IME")
1239 call <SID>OptionG("imaf", &imaf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001240endif
1241
1242
1243if has("multi_byte")
1244 call <SID>Header("multi-byte characters")
1245 call append("$", "encoding\tcharacter encoding used in Vim: \"latin1\", \"utf-8\"")
1246 call append("$", "\t\"euc-jp\", \"big5\", etc.")
1247 call <SID>OptionG("enc", &enc)
1248 call append("$", "fileencoding\tcharacter encoding for the current file")
1249 call append("$", "\t(local to buffer)")
1250 call <SID>OptionL("fenc")
1251 call append("$", "fileencodings\tautomatically detected character encodings")
1252 call <SID>OptionG("fencs", &fencs)
1253 call append("$", "termencoding\tcharacter encoding used by the terminal")
1254 call <SID>OptionG("tenc", &tenc)
1255 call append("$", "charconvert\texpression used for character encoding conversion")
1256 call <SID>OptionG("ccv", &ccv)
Bram Moolenaar1deee622010-07-24 20:35:12 +02001257 call append("$", "delcombine\tdelete combining (composing) characters on their own")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258 call <SID>BinOptionG("deco", &deco)
Bram Moolenaar1deee622010-07-24 20:35:12 +02001259 call append("$", "maxcombine\tmaximum number of combining (composing) characters displayed")
Bram Moolenaar4e427192006-03-10 21:34:27 +00001260 call <SID>OptionG("mco", &mco)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001261 if has("xim") && has("gui_gtk")
1262 call append("$", "imactivatekey\tkey that activates the X input method")
1263 call <SID>OptionG("imak", &imak)
1264 endif
Bram Moolenaar1deee622010-07-24 20:35:12 +02001265 call append("$", "ambiwidth\twidth of ambiguous width characters")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001266 call <SID>OptionG("ambw", &ambw)
Bram Moolenaar3848e002016-03-19 18:42:29 +01001267 call append("$", "emoji\temoji characters are full width")
1268 call <SID>BinOptionG("emo", &emo)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001269endif
1270
1271
1272call <SID>Header("various")
1273if has("virtualedit")
1274 call append("$", "virtualedit\twhen to use virtual editing: \"block\", \"insert\" and/or \"all\"")
1275 call <SID>OptionG("ve", &ve)
1276endif
1277if has("autocmd")
1278 call append("$", "eventignore\tlist of autocommand events which are to be ignored")
1279 call <SID>OptionG("ei", &ei)
1280endif
1281call append("$", "loadplugins\tload plugin scripts when starting up")
1282call <SID>BinOptionG("lpl", &lpl)
1283call append("$", "exrc\tenable reading .vimrc/.exrc/.gvimrc in the current directory")
1284call <SID>BinOptionG("ex", &ex)
1285call append("$", "secure\tsafer working with script files in the current directory")
1286call <SID>BinOptionG("secure", &secure)
1287call append("$", "gdefault\tuse the 'g' flag for \":substitute\"")
1288call <SID>BinOptionG("gd", &gd)
1289call append("$", "edcompatible\t'g' and 'c' flags of \":substitute\" toggle")
1290call <SID>BinOptionG("ed", &ed)
Bram Moolenaard5ab34b2007-05-05 17:15:44 +00001291if exists("+opendevice")
1292 call append("$", "opendevice\tallow reading/writing devices")
1293 call <SID>BinOptionG("odev", &odev)
1294endif
1295if exists("+maxfuncdepth")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001296 call append("$", "maxfuncdepth\tmaximum depth of function calls")
1297 call append("$", " \tset mfd=" . &mfd)
Bram Moolenaard5ab34b2007-05-05 17:15:44 +00001298endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001299if has("mksession")
1300 call append("$", "sessionoptions\tlist of words that specifies what to put in a session file")
1301 call <SID>OptionG("ssop", &ssop)
1302 call append("$", "viewoptions\tlist of words that specifies what to save for :mkview")
1303 call <SID>OptionG("vop", &vop)
1304 call append("$", "viewdir\tdirectory where to store files with :mkview")
1305 call <SID>OptionG("vdir", &vdir)
1306endif
1307if has("viminfo")
1308 call append("$", "viminfo\tlist that specifies what to write in the viminfo file")
1309 call <SID>OptionG("vi", &vi)
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02001310 call append("$", "viminfofile\tfile name used for the viminfo file")
1311 call <SID>OptionG("vif", &vif)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312endif
1313if has("quickfix")
1314 call append("$", "bufhidden\twhat happens with a buffer when it's no longer in a window")
1315 call append("$", "\t(local to buffer)")
1316 call <SID>OptionL("bh")
1317 call append("$", "buftype\t\"\", \"nofile\", \"nowrite\" or \"quickfix\": type of buffer")
1318 call append("$", "\t(local to buffer)")
1319 call <SID>OptionL("bt")
1320endif
1321call append("$", "buflisted\twhether the buffer shows up in the buffer list")
1322call append("$", "\t(local to buffer)")
1323call <SID>BinOptionL("bl")
1324call append("$", "debug\tset to \"msg\" to see all error messages")
1325call append("$", " \tset debug=" . &debug)
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02001326if has("signs")
1327 call append("$", "signcolumn\twhether to show the signcolumn")
1328 call append("$", "\t(local to window)")
1329 call <SID>OptionL("scl")
1330endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001331if has("mzscheme")
1332 call append("$", "mzquantum\tinterval in milliseconds between polls for MzScheme threads")
1333 call append("$", " \tset mzq=" . &mzq)
1334endif
Bram Moolenaard4ece232015-11-10 19:48:14 +01001335if exists("&luadll")
1336 call append("$", "luadll\tname of the Lua dynamic library")
1337 call <SID>OptionG("luadll", &luadll)
1338endif
1339if exists("&perldll")
1340 call append("$", "perldll\tname of the Perl dynamic library")
1341 call <SID>OptionG("perldll", &perldll)
1342endif
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01001343if has('pythonx')
1344 call append("$", "pyxversion\twhether to use Python 2 or 3")
1345 call append("$", " \tset pyx=" . &wd)
1346endif
Bram Moolenaard4ece232015-11-10 19:48:14 +01001347if exists("&pythondll")
1348 call append("$", "pythondll\tname of the Python 2 dynamic library")
1349 call <SID>OptionG("pythondll", &pythondll)
1350endif
1351if exists("&pythonthreedll")
1352 call append("$", "pythonthreedll\tname of the Python 3 dynamic library")
1353 call <SID>OptionG("pythonthreedll", &pythonthreedll)
1354endif
Bram Moolenaara93f9752015-11-10 20:45:09 +01001355if exists("&rubydll")
1356 call append("$", "rubydll\tname of the Ruby dynamic library")
1357 call <SID>OptionG("rubydll", &rubydll)
1358endif
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01001359if exists("&tcldll")
1360 call append("$", "tcldll\tname of the Tcl dynamic library")
1361 call <SID>OptionG("tcldll", &tcldll)
1362endif
Bram Moolenaar01164a62017-11-02 22:58:42 +01001363if exists("&mzschemedll")
1364 call append("$", "mzschemedll\tname of the Tcl dynamic library")
1365 call <SID>OptionG("mzschemedll", &mzschemedll)
1366 call append("$", "mzschemegcdll\tname of the Tcl GC dynamic library")
1367 call <SID>OptionG("mzschemegcdll", &mzschemegcdll)
1368endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001369
1370set cpo&vim
1371
1372" go to first line
13731
1374
1375" reset 'modified', so that ":q" can be used to close the window
1376setlocal nomodified
1377
1378if has("syntax")
1379 " Use Vim highlighting, with some additional stuff
1380 setlocal ft=vim
1381 syn match optwinHeader "^ \=[0-9].*"
1382 syn match optwinName "^[a-z]*\t" nextgroup=optwinComment
1383 syn match optwinComment ".*" contained
1384 syn match optwinComment "^\t.*"
1385 if !exists("did_optwin_syntax_inits")
1386 let did_optwin_syntax_inits = 1
1387 hi link optwinHeader Title
1388 hi link optwinName Identifier
1389 hi link optwinComment Comment
1390 endif
1391endif
1392
1393" Install autocommands to enable mappings in option-window
1394noremap <silent> <buffer> <CR> <C-\><C-N>:call <SID>CR()<CR>
1395inoremap <silent> <buffer> <CR> <Esc>:call <SID>CR()<CR>
1396noremap <silent> <buffer> <Space> :call <SID>Space()<CR>
1397
1398" Make the buffer be deleted when the window is closed.
1399setlocal buftype=nofile bufhidden=delete noswapfile
1400
1401augroup optwin
1402 au! BufUnload,BufHidden option-window nested
1403 \ call <SID>unload() | delfun <SID>unload
1404augroup END
1405
1406fun! <SID>unload()
1407 delfun <SID>CR
1408 delfun <SID>Space
1409 delfun <SID>Find
1410 delfun <SID>Update
1411 delfun <SID>OptionL
1412 delfun <SID>OptionG
1413 delfun <SID>BinOptionL
1414 delfun <SID>BinOptionG
1415 delfun <SID>Header
1416 au! optwin
1417endfun
1418
1419" Restore the previous value of 'title' and 'icon'.
1420let &title = s:old_title
1421let &icon = s:old_icon
1422let &ru = s:old_ru
1423let &sc = s:old_sc
1424let &cpo = s:cpo_save
1425unlet 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 +02001426
1427" vim: ts=8 sw=2 sts=2