blob: 5bb78cdb0a52bf3eac3670441be2dfd559dfafd1 [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 Moolenaar65e0d772020-06-14 17:29:55 +02004" Last Change: 2020 Jun 10
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.
Bram Moolenaar9c474b22018-02-27 17:04:25 +0100125" Reset 'undolevels' to avoid undo'ing until the buffer is empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000126let s:old_title = &title
127let s:old_icon = &icon
128let s:old_sc = &sc
129let s:old_ru = &ru
Bram Moolenaar9c474b22018-02-27 17:04:25 +0100130let s:old_ul = &ul
131set notitle noicon nosc noru ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +0000132
133" If the current window is a help window, try finding a non-help window.
134" Relies on syntax highlighting to be switched on.
135let s:thiswin = winnr()
136while exists("b:current_syntax") && b:current_syntax == "help"
Bram Moolenaar251e1912011-06-19 05:09:16 +0200137 wincmd w
Bram Moolenaar071d4272004-06-13 20:20:40 +0000138 if s:thiswin == winnr()
139 break
140 endif
141endwhile
142
Bram Moolenaarab6c8582017-08-11 17:15:09 +0200143" Open the window. $OPTWIN_CMD is set to "tab" for ":tab options".
144exe $OPTWIN_CMD . ' new option-window'
Bram Moolenaar251e1912011-06-19 05:09:16 +0200145setlocal ts=15 tw=0 noro buftype=nofile
Bram Moolenaar071d4272004-06-13 20:20:40 +0000146
147" Insert help and a "set" command for each option.
148call append(0, '" Each "set" line shows the current value of an option (on the left).')
149call append(1, '" Hit <CR> on a "set" line to execute it.')
150call append(2, '" A boolean option will be toggled.')
Bram Moolenaar2f3b5102014-11-19 18:54:17 +0100151call append(3, '" For other options you can edit the value before hitting <CR>.')
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152call append(4, '" Hit <CR> on a help line to open a help window on this option.')
153call append(5, '" Hit <CR> on an index line to jump there.')
154call append(6, '" Hit <Space> on a "set" line to refresh it.')
155
156" These functions are called often below. Keep them fast!
157
158" Init a local binary option
159fun! <SID>BinOptionL(name)
Bram Moolenaar251e1912011-06-19 05:09:16 +0200160 let val = getwinvar(winnr('#'), '&' . a:name)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000161 call append("$", substitute(substitute(" \tset " . val . a:name . "\t" .
162 \!val . a:name, "0", "no", ""), "1", "", ""))
163endfun
164
165" Init a global binary option
166fun! <SID>BinOptionG(name, val)
167 call append("$", substitute(substitute(" \tset " . a:val . a:name . "\t" .
168 \!a:val . a:name, "0", "no", ""), "1", "", ""))
169endfun
170
171" Init a local string option
172fun! <SID>OptionL(name)
Bram Moolenaar251e1912011-06-19 05:09:16 +0200173 let val = escape(getwinvar(winnr('#'), '&' . a:name), " \t\\\"|")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000174 call append("$", " \tset " . a:name . "=" . val)
175endfun
176
177" Init a global string option
178fun! <SID>OptionG(name, val)
Bram Moolenaar251e1912011-06-19 05:09:16 +0200179 call append("$", " \tset " . a:name . "=" . escape(a:val, " \t\\\"|"))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180endfun
181
182let s:idx = 1
183let s:lnum = line("$")
184call append("$", "")
185
186fun! <SID>Header(text)
187 let line = s:idx . " " . a:text
188 if s:idx < 10
189 let line = " " . line
190 endif
191 call append("$", "")
192 call append("$", line)
193 call append("$", "")
194 call append(s:lnum, line)
195 let s:idx = s:idx + 1
196 let s:lnum = s:lnum + 1
197endfun
198
199" Get the value of 'pastetoggle'. It could be a special key.
200fun! <SID>PTvalue()
201 redir @a
202 silent set pt
203 redir END
204 return substitute(@a, '[^=]*=\(.*\)', '\1', "")
205endfun
206
207" Restore the previous value of 'cpoptions' here, it's used below.
208let &cpo = s:cpo_save
209
210" List of all options, organized by function.
211" The text should be sufficient to know what the option is used for.
212
213call <SID>Header("important")
214call append("$", "compatible\tbehave very Vi compatible (not advisable)")
215call <SID>BinOptionG("cp", &cp)
216call append("$", "cpoptions\tlist of flags to specify Vi compatibility")
217call <SID>OptionG("cpo", &cpo)
218call append("$", "insertmode\tuse Insert mode as the default mode")
219call <SID>BinOptionG("im", &im)
220call append("$", "paste\tpaste mode, insert typed text literally")
221call <SID>BinOptionG("paste", &paste)
222call append("$", "pastetoggle\tkey sequence to toggle paste mode")
223if &pt =~ "\x80"
224 call append("$", " \tset pt=" . <SID>PTvalue())
225else
226 call <SID>OptionG("pt", &pt)
227endif
228call append("$", "runtimepath\tlist of directories used for runtime files and plugins")
229call <SID>OptionG("rtp", &rtp)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +0100230call append("$", "packpath\tlist of directories used for plugin packages")
231call <SID>OptionG("pp", &pp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000232call append("$", "helpfile\tname of the main help file")
233call <SID>OptionG("hf", &hf)
234
235
236call <SID>Header("moving around, searching and patterns")
237call append("$", "whichwrap\tlist of flags specifying which commands wrap to another line")
238call append("$", "\t(local to window)")
239call <SID>OptionL("ww")
240call append("$", "startofline\tmany jump commands move the cursor to the first non-blank")
241call append("$", "\tcharacter of a line")
242call <SID>BinOptionG("sol", &sol)
243call append("$", "paragraphs\tnroff macro names that separate paragraphs")
244call <SID>OptionG("para", &para)
245call append("$", "sections\tnroff macro names that separate sections")
246call <SID>OptionG("sect", &sect)
247call append("$", "path\tlist of directory names used for file searching")
248call append("$", "\t(global or local to buffer)")
249call <SID>OptionG("pa", &pa)
250call append("$", "cdpath\tlist of directory names used for :cd")
251call <SID>OptionG("cd", &cd)
Bram Moolenaarfa9a3702010-07-24 15:48:31 +0200252if exists("+autochdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000253 call append("$", "autochdir\tchange to directory of file in buffer")
254 call <SID>BinOptionG("acd", &acd)
255endif
256call append("$", "wrapscan\tsearch commands wrap around the end of the buffer")
257call <SID>BinOptionG("ws", &ws)
258call append("$", "incsearch\tshow match for partly typed search command")
259call <SID>BinOptionG("is", &is)
260call append("$", "magic\tchange the way backslashes are used in search patterns")
261call <SID>BinOptionG("magic", &magic)
Bram Moolenaare6ae6222013-05-21 21:01:10 +0200262call append("$", "regexpengine\tselect the default regexp engine used")
263call <SID>OptionG("re", &re)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264call append("$", "ignorecase\tignore case when using a search pattern")
265call <SID>BinOptionG("ic", &ic)
266call append("$", "smartcase\toverride 'ignorecase' when pattern has upper case characters")
267call <SID>BinOptionG("scs", &scs)
Bram Moolenaar1deee622010-07-24 20:35:12 +0200268call append("$", "casemap\twhat method to use for changing case of letters")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000269call <SID>OptionG("cmp", &cmp)
Bram Moolenaar52b4b552005-03-07 23:00:57 +0000270call append("$", "maxmempattern\tmaximum amount of memory in Kbyte used for pattern matching")
271call append("$", " \tset mmp=" . &mmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000272call append("$", "define\tpattern for a macro definition line")
273call append("$", "\t(global or local to buffer)")
274call <SID>OptionG("def", &def)
275if has("find_in_path")
276 call append("$", "include\tpattern for an include-file line")
277 call append("$", "\t(local to buffer)")
278 call <SID>OptionL("inc")
279 call append("$", "includeexpr\texpression used to transform an include line to a file name")
280 call append("$", "\t(local to buffer)")
281 call <SID>OptionL("inex")
282endif
283
284
285call <SID>Header("tags")
286call append("$", "tagbsearch\tuse binary searching in tags files")
287call <SID>BinOptionG("tbs", &tbs)
288call append("$", "taglength\tnumber of significant characters in a tag name or zero")
289call append("$", " \tset tl=" . &tl)
290call append("$", "tags\tlist of file names to search for tags")
291call append("$", "\t(global or local to buffer)")
292call <SID>OptionG("tag", &tag)
Bram Moolenaar0f6562e2015-11-24 18:48:14 +0100293call append("$", "tagcase\thow to handle case when searching in tags files:")
294call append("$", "\t\"followic\" to follow 'ignorecase', \"ignore\" or \"match\"")
295call append("$", "\t(global or local to buffer)")
296call <SID>OptionG("tc", &tc)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000297call append("$", "tagrelative\tfile names in a tags file are relative to the tags file")
298call <SID>BinOptionG("tr", &tr)
299call append("$", "tagstack\ta :tag command will use the tagstack")
300call <SID>BinOptionG("tgst", &tgst)
301call append("$", "showfulltag\twhen completing tags in Insert mode show more info")
302call <SID>BinOptionG("sft", &sft)
Bram Moolenaar45e18cb2019-04-28 18:05:35 +0200303if has("eval")
304 call append("$", "tagfunc\ta function to be used to perform tag searches")
305 call append("$", "\t(local to buffer)")
306 call <SID>OptionL("tfu")
307endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308if has("cscope")
309 call append("$", "cscopeprg\tcommand for executing cscope")
310 call <SID>OptionG("csprg", &csprg)
311 call append("$", "cscopetag\tuse cscope for tag commands")
312 call <SID>BinOptionG("cst", &cst)
313 call append("$", "cscopetagorder\t0 or 1; the order in which \":cstag\" performs a search")
314 call append("$", " \tset csto=" . &csto)
315 call append("$", "cscopeverbose\tgive messages when adding a cscope database")
316 call <SID>BinOptionG("csverb", &csverb)
317 call append("$", "cscopepathcomp\thow many components of the path to show")
318 call append("$", " \tset cspc=" . &cspc)
Bram Moolenaar1deee622010-07-24 20:35:12 +0200319 call append("$", "cscopequickfix\twhen to open a quickfix window for cscope")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000320 call <SID>OptionG("csqf", &csqf)
Bram Moolenaar251e1912011-06-19 05:09:16 +0200321 call append("$", "cscoperelative\tfile names in a cscope file are relative to that file")
322 call <SID>BinOptionG("csre", &csre)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323endif
324
325
326call <SID>Header("displaying text")
327call append("$", "scroll\tnumber of lines to scroll for CTRL-U and CTRL-D")
328call append("$", "\t(local to window)")
329call <SID>OptionL("scr")
330call append("$", "scrolloff\tnumber of screen lines to show around the cursor")
331call append("$", " \tset so=" . &so)
332call append("$", "wrap\tlong lines wrap")
Bram Moolenaar87768892018-05-15 21:42:51 +0200333call append("$", "\t(local to window)")
334call <SID>BinOptionL("wrap")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000335call append("$", "linebreak\twrap long lines at a character in 'breakat'")
336call append("$", "\t(local to window)")
337call <SID>BinOptionL("lbr")
Bram Moolenaar597a4222014-06-25 14:39:50 +0200338call append("$", "breakindent\tpreserve indentation in wrapped text")
339call append("$", "\t(local to window)")
340call <SID>BinOptionL("bri")
341call append("$", "breakindentopt\tadjust breakindent behaviour")
342call append("$", "\t(local to window)")
343call <SID>OptionL("briopt")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000344call append("$", "breakat\twhich characters might cause a line break")
345call <SID>OptionG("brk", &brk)
346call append("$", "showbreak\tstring to put before wrapped screen lines")
347call <SID>OptionG("sbr", &sbr)
348call append("$", "sidescroll\tminimal number of columns to scroll horizontally")
349call append("$", " \tset ss=" . &ss)
350call append("$", "sidescrolloff\tminimal number of columns to keep left and right of the cursor")
351call append("$", " \tset siso=" . &siso)
352call append("$", "display\tinclude \"lastline\" to show the last line even if it doesn't fit")
353call append("$", "\tinclude \"uhex\" to show unprintable characters as a hex number")
354call <SID>OptionG("dy", &dy)
355call append("$", "fillchars\tcharacters to use for the status line, folds and filler lines")
356call <SID>OptionG("fcs", &fcs)
357call append("$", "cmdheight\tnumber of lines used for the command-line")
358call append("$", " \tset ch=" . &ch)
359call append("$", "columns\twidth of the display")
360call append("$", " \tset co=" . &co)
361call append("$", "lines\tnumber of lines in the display")
362call append("$", " \tset lines=" . &lines)
Bram Moolenaar1b20d3d2010-07-24 20:44:02 +0200363call append("$", "window\tnumber of lines to scroll for CTRL-F and CTRL-B")
364call append("$", " \tset window=" . &window)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000365call append("$", "lazyredraw\tdon't redraw while executing macros")
366call <SID>BinOptionG("lz", &lz)
Bram Moolenaar63ce8c02008-06-04 12:29:14 +0000367if has("reltime")
368 call append("$", "redrawtime\ttimeout for 'hlsearch' and :match highlighting in msec")
369 call append("$", " \tset rdt=" . &rdt)
370endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000371call append("$", "writedelay\tdelay in msec for each char written to the display")
372call append("$", "\t(for debugging)")
373call append("$", " \tset wd=" . &wd)
374call append("$", "list\tshow <Tab> as ^I and end-of-line as $")
375call append("$", "\t(local to window)")
376call <SID>BinOptionL("list")
377call append("$", "listchars\tlist of strings used for list mode")
378call <SID>OptionG("lcs", &lcs)
379call append("$", "number\tshow the line number for each line")
380call append("$", "\t(local to window)")
381call <SID>BinOptionL("nu")
Bram Moolenaar64486672010-05-16 15:46:46 +0200382call append("$", "relativenumber\tshow the relative line number for each line")
383call append("$", "\t(local to window)")
384call <SID>BinOptionL("rnu")
Bram Moolenaar592e0a22004-07-03 16:05:59 +0000385if has("linebreak")
386 call append("$", "numberwidth\tnumber of columns to use for the line number")
387 call append("$", "\t(local to window)")
388 call <SID>OptionL("nuw")
389endif
Bram Moolenaar860cae12010-06-05 23:22:07 +0200390if has("conceal")
Bram Moolenaarfa9a3702010-07-24 15:48:31 +0200391 call append("$", "conceallevel\tcontrols whether concealable text is hidden")
Bram Moolenaar860cae12010-06-05 23:22:07 +0200392 call append("$", "\t(local to window)")
Bram Moolenaarfa9a3702010-07-24 15:48:31 +0200393 call <SID>OptionL("cole")
Bram Moolenaar4f99eae2010-07-24 15:56:43 +0200394 call append("$", "concealcursor\tmodes in which text in the cursor line can be concealed")
Bram Moolenaarfa9a3702010-07-24 15:48:31 +0200395 call append("$", "\t(local to window)")
396 call <SID>OptionL("cocu")
Bram Moolenaar860cae12010-06-05 23:22:07 +0200397endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000398
399
Bram Moolenaar7887d882005-07-01 22:33:52 +0000400call <SID>Header("syntax, highlighting and spelling")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000401call append("$", "background\t\"dark\" or \"light\"; the background color brightness")
402call <SID>OptionG("bg", &bg)
Bram Moolenaar314dd792019-02-03 15:27:20 +0100403call append("$", "filetype\ttype of file; triggers the FileType event when set")
404call append("$", "\t(local to buffer)")
405call <SID>OptionL("ft")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000406if has("syntax")
407 call append("$", "syntax\tname of syntax highlighting used")
408 call append("$", "\t(local to buffer)")
409 call <SID>OptionL("syn")
Bram Moolenaar9ff70112005-07-11 22:29:03 +0000410 call append("$", "synmaxcol\tmaximum column to look for syntax items")
411 call append("$", "\t(local to buffer)")
412 call <SID>OptionL("smc")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000413endif
414call append("$", "highlight\twhich highlighting to use for various occasions")
415call <SID>OptionG("hl", &hl)
416call append("$", "hlsearch\thighlight all matches for the last used search pattern")
417call <SID>BinOptionG("hls", &hls)
Bram Moolenaar68e65602019-05-26 21:33:31 +0200418call append("$", "wincolor\thighlight group to use for the window")
419call append("$", "\t(local to window)")
420call <SID>OptionL("wcr")
Bram Moolenaar8a24b792016-04-30 16:13:10 +0200421if has("termguicolors")
Bram Moolenaar8e3d1b62016-04-30 15:17:19 +0200422 call append("$", "termguicolors\tuse GUI colors for the terminal")
Bram Moolenaar868cfc12016-04-30 16:49:58 +0200423 call <SID>BinOptionG("tgc", &tgc)
Bram Moolenaar8e3d1b62016-04-30 15:17:19 +0200424endif
Bram Moolenaar7887d882005-07-01 22:33:52 +0000425if has("syntax")
Bram Moolenaarf71a3db2006-03-12 21:50:18 +0000426 call append("$", "cursorcolumn\thighlight the screen column of the cursor")
427 call append("$", "\t(local to window)")
428 call <SID>BinOptionL("cuc")
429 call append("$", "cursorline\thighlight the screen line of the cursor")
430 call append("$", "\t(local to window)")
431 call <SID>BinOptionL("cul")
Bram Moolenaar410e98a2019-09-09 22:05:49 +0200432 call append("$", "cursorlineopt\tspecifies which area 'cursorline' highlights")
433 call append("$", "\t(local to window)")
434 call <SID>OptionL("culopt")
Bram Moolenaar607cc1e2010-07-18 18:47:44 +0200435 call append("$", "colorcolumn\tcolumns to highlight")
436 call append("$", "\t(local to window)")
437 call <SID>OptionL("cc")
Bram Moolenaar7887d882005-07-01 22:33:52 +0000438 call append("$", "spell\thighlight spelling mistakes")
439 call append("$", "\t(local to window)")
440 call <SID>BinOptionL("spell")
441 call append("$", "spelllang\tlist of accepted languages")
442 call append("$", "\t(local to buffer)")
443 call <SID>OptionL("spl")
444 call append("$", "spellfile\tfile that \"zg\" adds good words to")
445 call append("$", "\t(local to buffer)")
446 call <SID>OptionL("spf")
Bram Moolenaar551f84f2005-07-06 22:29:20 +0000447 call append("$", "spellcapcheck\tpattern to locate the end of a sentence")
448 call append("$", "\t(local to buffer)")
449 call <SID>OptionL("spc")
Bram Moolenaar65e0d772020-06-14 17:29:55 +0200450 call append("$", "spelloptions\tflags to change how spell checking works")
451 call append("$", "\t(local to buffer)")
452 call <SID>OptionL("spo")
Bram Moolenaar7887d882005-07-01 22:33:52 +0000453 call append("$", "spellsuggest\tmethods used to suggest corrections")
454 call <SID>OptionG("sps", &sps)
Bram Moolenaarac6e65f2005-08-29 22:25:38 +0000455 call append("$", "mkspellmem\tamount of memory used by :mkspell before compressing")
456 call <SID>OptionG("msm", &msm)
Bram Moolenaar7887d882005-07-01 22:33:52 +0000457endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000458
459
460call <SID>Header("multiple windows")
461call append("$", "laststatus\t0, 1 or 2; when to use a status line for the last window")
462call append("$", " \tset ls=" . &ls)
463if has("statusline")
464 call append("$", "statusline\talternate format to be used for a status line")
465 call <SID>OptionG("stl", &stl)
466endif
467call append("$", "equalalways\tmake all windows the same size when adding/removing windows")
468call <SID>BinOptionG("ea", &ea)
Bram Moolenaar314dd792019-02-03 15:27:20 +0100469call append("$", "eadirection\tin which direction 'equalalways' works: \"ver\", \"hor\" or \"both\"")
470call <SID>OptionG("ead", &ead)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000471call append("$", "winheight\tminimal number of lines used for the current window")
472call append("$", " \tset wh=" . &wh)
473call append("$", "winminheight\tminimal number of lines used for any window")
474call append("$", " \tset wmh=" . &wmh)
475call append("$", "winfixheight\tkeep the height of the window")
476call append("$", "\t(local to window)")
477call <SID>BinOptionL("wfh")
Bram Moolenaarbe4d5062006-03-18 21:30:13 +0000478call append("$", "winfixwidth\tkeep the width of the window")
479call append("$", "\t(local to window)")
480call <SID>BinOptionL("wfw")
Bram Moolenaar314dd792019-02-03 15:27:20 +0100481call append("$", "winwidth\tminimal number of columns used for the current window")
482call append("$", " \tset wiw=" . &wiw)
483call append("$", "winminwidth\tminimal number of columns used for any window")
484call append("$", " \tset wmw=" . &wmw)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000485call append("$", "helpheight\tinitial height of the help window")
486call append("$", " \tset hh=" . &hh)
487if has("quickfix")
Bram Moolenaar85850f32019-07-19 22:05:51 +0200488 call append("$", "previewpopup\tuse a popup window for preview")
489 call append("$", " \tset pvp=" . &pvp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000490 call append("$", "previewheight\tdefault height for the preview window")
491 call append("$", " \tset pvh=" . &pvh)
492 call append("$", "previewwindow\tidentifies the preview window")
493 call append("$", "\t(local to window)")
494 call <SID>BinOptionL("pvw")
495endif
496call append("$", "hidden\tdon't unload a buffer when no longer shown in a window")
497call <SID>BinOptionG("hid", &hid)
498call append("$", "switchbuf\t\"useopen\" and/or \"split\"; which window to use when jumping")
499call append("$", "\tto a buffer")
500call <SID>OptionG("swb", &swb)
501call append("$", "splitbelow\ta new window is put below the current one")
502call <SID>BinOptionG("sb", &sb)
Bram Moolenaar314dd792019-02-03 15:27:20 +0100503call append("$", "splitright\ta new window is put right of the current one")
504call <SID>BinOptionG("spr", &spr)
505call append("$", "scrollbind\tthis window scrolls together with other bound windows")
506call append("$", "\t(local to window)")
507call <SID>BinOptionL("scb")
508call append("$", "scrollopt\t\"ver\", \"hor\" and/or \"jump\"; list of options for 'scrollbind'")
509call <SID>OptionG("sbo", &sbo)
510call append("$", "cursorbind\tthis window's cursor moves together with other bound windows")
511call append("$", "\t(local to window)")
512call <SID>BinOptionL("crb")
Bram Moolenaar74675a62017-07-15 13:53:23 +0200513if has("terminal")
Bram Moolenaar6d150f72018-04-21 20:03:20 +0200514 call append("$", "termwinsize\tsize of a terminal window")
Bram Moolenaar74675a62017-07-15 13:53:23 +0200515 call append("$", "\t(local to window)")
Bram Moolenaar6d150f72018-04-21 20:03:20 +0200516 call <SID>OptionL("tws")
517 call append("$", "termwinkey\tkey that precedes Vim commands in a terminal window")
Bram Moolenaar74675a62017-07-15 13:53:23 +0200518 call append("$", "\t(local to window)")
Bram Moolenaar6d150f72018-04-21 20:03:20 +0200519 call <SID>OptionL("twk")
520 call append("$", "termwinscroll\tmax number of lines to keep for scrollback in a terminal window")
521 call append("$", "\t(local to window)")
Bram Moolenaarc6ddce32019-02-08 12:47:03 +0100522 if has('win32')
523 call append("$", "termwintype\ttype of pty to use for a terminal window")
524 call <SID>OptionG("twt", &twt)
525 endif
Bram Moolenaar6d150f72018-04-21 20:03:20 +0200526 call <SID>OptionL("twsl")
Bram Moolenaar0aed9a22017-08-19 23:18:02 +0200527 if exists("&winptydll")
528 call append("$", "winptydll\tname of the winpty dynamic library")
529 call <SID>OptionG("winptydll", &winptydll)
530 endif
Bram Moolenaar74675a62017-07-15 13:53:23 +0200531endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000532
533
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000534call <SID>Header("multiple tab pages")
535call append("$", "showtabline\t0, 1 or 2; when to use a tab pages line")
536call append("$", " \tset stal=" . &stal)
537call append("$", "tabpagemax\tmaximum number of tab pages to open for -p and \"tab all\"")
538call append("$", " \tset tpm=" . &tpm)
539call append("$", "tabline\tcustom tab pages line")
540call <SID>OptionG("tal", &tal)
Bram Moolenaarf9393ef2006-04-24 19:47:27 +0000541if has("gui")
542 call append("$", "guitablabel\tcustom tab page label for the GUI")
543 call <SID>OptionG("gtl", &gtl)
544 call append("$", "guitabtooltip\tcustom tab page tooltip for the GUI")
545 call <SID>OptionG("gtt", &gtt)
546endif
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000547
548
Bram Moolenaar071d4272004-06-13 20:20:40 +0000549call <SID>Header("terminal")
550call append("$", "term\tname of the used terminal")
551call <SID>OptionG("term", &term)
552call append("$", "ttytype\talias for 'term'")
553call <SID>OptionG("tty", &tty)
554call append("$", "ttybuiltin\tcheck built-in termcaps first")
555call <SID>BinOptionG("tbi", &tbi)
556call append("$", "ttyfast\tterminal connection is fast")
557call <SID>BinOptionG("tf", &tf)
558call append("$", "weirdinvert\tterminal that requires extra redrawing")
559call <SID>BinOptionG("wiv", &wiv)
560call append("$", "esckeys\trecognize keys that start with <Esc> in Insert mode")
561call <SID>BinOptionG("ek", &ek)
562call append("$", "scrolljump\tminimal number of lines to scroll at a time")
563call append("$", " \tset sj=" . &sj)
564call append("$", "ttyscroll\tmaximum number of lines to use scrolling instead of redrawing")
565call append("$", " \tset tsl=" . &tsl)
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200566if has("gui") || has("win32")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567 call append("$", "guicursor\tspecifies what the cursor looks like in different modes")
568 call <SID>OptionG("gcr", &gcr)
569endif
570if has("title")
571 let &title = s:old_title
572 call append("$", "title\tshow info in the window title")
573 call <SID>BinOptionG("title", &title)
574 set notitle
575 call append("$", "titlelen\tpercentage of 'columns' used for the window title")
576 call append("$", " \tset titlelen=" . &titlelen)
577 call append("$", "titlestring\twhen not empty, string to be used for the window title")
578 call <SID>OptionG("titlestring", &titlestring)
579 call append("$", "titleold\tstring to restore the title to when exiting Vim")
580 call <SID>OptionG("titleold", &titleold)
581 let &icon = s:old_icon
582 call append("$", "icon\tset the text of the icon for this window")
583 call <SID>BinOptionG("icon", &icon)
584 set noicon
585 call append("$", "iconstring\twhen not empty, text for the icon of this window")
586 call <SID>OptionG("iconstring", &iconstring)
587endif
588if has("win32")
589 call append("$", "restorescreen\trestore the screen contents when exiting Vim")
590 call <SID>BinOptionG("rs", &rs)
591endif
592
593
594call <SID>Header("using the mouse")
595call append("$", "mouse\tlist of flags for using the mouse")
596call <SID>OptionG("mouse", &mouse)
597if has("gui")
598 call append("$", "mousefocus\tthe window with the mouse pointer becomes the current one")
599 call <SID>BinOptionG("mousef", &mousef)
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +0100600endif
601call append("$", "scrollfocus\tthe window with the mouse pointer scrolls with the mouse wheel")
602call <SID>BinOptionG("scf", &scf)
603if has("gui")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000604 call append("$", "mousehide\thide the mouse pointer while typing")
605 call <SID>BinOptionG("mh", &mh)
606endif
607call append("$", "mousemodel\t\"extend\", \"popup\" or \"popup_setpos\"; what the right")
608call append("$", "\tmouse button is used for")
609call <SID>OptionG("mousem", &mousem)
610call append("$", "mousetime\tmaximum time in msec to recognize a double-click")
611call append("$", " \tset mouset=" . &mouset)
612call append("$", "ttymouse\t\"xterm\", \"xterm2\", \"dec\" or \"netterm\"; type of mouse")
613call <SID>OptionG("ttym", &ttym)
614if has("mouseshape")
615 call append("$", "mouseshape\twhat the mouse pointer looks like in different modes")
616 call <SID>OptionG("mouses", &mouses)
617endif
618
619
620if has("gui")
621 call <SID>Header("GUI")
622 call append("$", "guifont\tlist of font names to be used in the GUI")
623 call <SID>OptionG("gfn", &gfn)
624 if has("xfontset")
625 call append("$", "guifontset\tpair of fonts to be used, for multibyte editing")
626 call <SID>OptionG("gfs", &gfs)
627 endif
628 call append("$", "guifontwide\tlist of font names to be used for double-wide characters")
629 call <SID>OptionG("gfw", &gfw)
630 if has("mac")
631 call append("$", "antialias\tuse smooth, antialiased fonts")
632 call <SID>BinOptionG("anti", &anti)
633 endif
634 call append("$", "guioptions\tlist of flags that specify how the GUI works")
635 call <SID>OptionG("go", &go)
636 if has("gui_gtk")
637 call append("$", "toolbar\t\"icons\", \"text\" and/or \"tooltips\"; how to show the toolbar")
638 call <SID>OptionG("tb", &tb)
639 if has("gui_gtk2")
Bram Moolenaar1deee622010-07-24 20:35:12 +0200640 call append("$", "toolbariconsize\tsize of toolbar icons")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000641 call <SID>OptionG("tbis", &tbis)
642 endif
643 call append("$", "guiheadroom\troom (in pixels) left above/below the window")
644 call append("$", " \tset ghr=" . &ghr)
645 endif
Bram Moolenaarfb539272014-08-22 19:21:47 +0200646 if has("directx")
647 call append("$", "renderoptions\toptions for text rendering")
648 call <SID>OptionG("rop", &rop)
649 endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650 call append("$", "guipty\tuse a pseudo-tty for I/O to external commands")
651 call <SID>BinOptionG("guipty", &guipty)
652 if has("browse")
653 call append("$", "browsedir\t\"last\", \"buffer\" or \"current\": which directory used for the file browser")
654 call <SID>OptionG("bsdir", &bsdir)
655 endif
656 if has("multi_lang")
657 call append("$", "langmenu\tlanguage to be used for the menus")
658 call <SID>OptionG("langmenu", &lm)
659 endif
660 call append("$", "menuitems\tmaximum number of items in one menu")
661 call append("$", " \tset mis=" . &mis)
662 if has("winaltkeys")
663 call append("$", "winaltkeys\t\"no\", \"yes\" or \"menu\"; how to use the ALT key")
664 call <SID>OptionG("wak", &wak)
665 endif
666 call append("$", "linespace\tnumber of pixel lines to use between characters")
667 call append("$", " \tset lsp=" . &lsp)
Bram Moolenaara2a80162017-11-21 23:09:50 +0100668 if has("balloon_eval") || has("balloon_eval_term")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000669 call append("$", "balloondelay\tdelay in milliseconds before a balloon may pop up")
670 call append("$", " \tset bdlay=" . &bdlay)
Bram Moolenaara2a80162017-11-21 23:09:50 +0100671 if has("balloon_eval")
672 call append("$", "ballooneval\tuse balloon evaluation in the GUI")
673 call <SID>BinOptionG("beval", &beval)
674 endif
675 if has("balloon_eval_term")
676 call append("$", "balloonevalterm\tuse balloon evaluation in the terminal")
677 call <SID>BinOptionG("bevalterm", &beval)
678 endif
Bram Moolenaar52b4b552005-03-07 23:00:57 +0000679 if has("eval")
680 call append("$", "balloonexpr\texpression to show in balloon eval")
681 call append("$", " \tset bexpr=" . &bexpr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000682 endif
683 endif
Bram Moolenaard5ab34b2007-05-05 17:15:44 +0000684 if exists("+macatsui")
Bram Moolenaarf9393ef2006-04-24 19:47:27 +0000685 call append("$", "macatsui\tuse ATSUI text drawing; disable to avoid display problems")
686 call <SID>OptionG("macatsui", &macatsui)
687 endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000688endif
689
690if has("printer")
691 call <SID>Header("printing")
Bram Moolenaar8299df92004-07-10 09:47:34 +0000692 call append("$", "printoptions\tlist of items that control the format of :hardcopy output")
693 call <SID>OptionG("popt", &popt)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 call append("$", "printdevice\tname of the printer to be used for :hardcopy")
695 call <SID>OptionG("pdev", &pdev)
Bram Moolenaar8299df92004-07-10 09:47:34 +0000696 if has("postscript")
697 call append("$", "printexpr\texpression used to print the PostScript file for :hardcopy")
698 call <SID>OptionG("pexpr", &pexpr)
699 endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000700 call append("$", "printfont\tname of the font to be used for :hardcopy")
701 call <SID>OptionG("pfn", &pfn)
702 call append("$", "printheader\tformat of the header used for :hardcopy")
703 call <SID>OptionG("pheader", &pheader)
Bram Moolenaar8299df92004-07-10 09:47:34 +0000704 if has("postscript")
705 call append("$", "printencoding\tencoding used to print the PostScript file for :hardcopy")
706 call <SID>OptionG("penc", &penc)
707 endif
Bram Moolenaar76cbe812019-02-17 17:53:49 +0100708 call append("$", "printmbcharset\tthe CJK character set to be used for CJK output from :hardcopy")
709 call <SID>OptionG("pmbcs", &pmbcs)
710 call append("$", "printmbfont\tlist of font names to be used for CJK output from :hardcopy")
711 call <SID>OptionG("pmbfn", &pmbfn)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000712endif
713
714call <SID>Header("messages and info")
715call append("$", "terse\tadd 's' flag in 'shortmess' (don't show search message)")
716call <SID>BinOptionG("terse", &terse)
717call append("$", "shortmess\tlist of flags to make messages shorter")
718call <SID>OptionG("shm", &shm)
719call append("$", "showcmd\tshow (partial) command keys in the status line")
720let &sc = s:old_sc
721call <SID>BinOptionG("sc", &sc)
722set nosc
723call append("$", "showmode\tdisplay the current mode in the status line")
724call <SID>BinOptionG("smd", &smd)
725call append("$", "ruler\tshow cursor position below each window")
726let &ru = s:old_ru
727call <SID>BinOptionG("ru", &ru)
728set noru
729if has("statusline")
730 call append("$", "rulerformat\talternate format to be used for the ruler")
731 call <SID>OptionG("ruf", &ruf)
732endif
733call append("$", "report\tthreshold for reporting number of changed lines")
734call append("$", " \tset report=" . &report)
735call append("$", "verbose\tthe higher the more messages are given")
736call append("$", " \tset vbs=" . &vbs)
Bram Moolenaar7887d882005-07-01 22:33:52 +0000737call append("$", "verbosefile\tfile to write messages in")
738call <SID>OptionG("vfile", &vfile)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739call append("$", "more\tpause listings when the screen is full")
740call <SID>BinOptionG("more", &more)
741if has("dialog_con") || has("dialog_gui")
742 call append("$", "confirm\tstart a dialog when a command fails")
743 call <SID>BinOptionG("cf", &cf)
744endif
745call append("$", "errorbells\tring the bell for error messages")
746call <SID>BinOptionG("eb", &eb)
747call append("$", "visualbell\tuse a visual bell instead of beeping")
748call <SID>BinOptionG("vb", &vb)
Bram Moolenaarf9132812015-07-21 19:19:13 +0200749call append("$", "belloff\tdo not ring the bell for these reasons")
Bram Moolenaardd1616e2015-07-22 22:22:59 +0200750call <SID>OptionG("belloff", &belloff)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000751if has("multi_lang")
752 call append("$", "helplang\tlist of preferred languages for finding help")
753 call <SID>OptionG("hlg", &hlg)
754endif
755
756
757call <SID>Header("selecting text")
758call append("$", "selection\t\"old\", \"inclusive\" or \"exclusive\"; how selecting text behaves")
759call <SID>OptionG("sel", &sel)
760call append("$", "selectmode\t\"mouse\", \"key\" and/or \"cmd\"; when to start Select mode")
761call append("$", "\tinstead of Visual mode")
762call <SID>OptionG("slm", &slm)
763if has("clipboard")
764 call append("$", "clipboard\t\"unnamed\" to use the * register like unnamed register")
765 call append("$", "\t\"autoselect\" to always put selected text on the clipboard")
766 call <SID>OptionG("cb", &cb)
767endif
768call append("$", "keymodel\t\"startsel\" and/or \"stopsel\"; what special keys can do")
769call <SID>OptionG("km", &km)
770
771
772call <SID>Header("editing text")
773call append("$", "undolevels\tmaximum number of changes that can be undone")
Bram Moolenaar7d76c802014-10-15 22:51:52 +0200774call append("$", "\t(global or local to buffer)")
Bram Moolenaar9c474b22018-02-27 17:04:25 +0100775call append("$", " \tset ul=" . s:old_ul)
Bram Moolenaar4694a172016-04-21 14:05:23 +0200776call append("$", "undofile\tautomatically save and restore undo history")
777call <SID>BinOptionG("udf", &udf)
778call append("$", "undodir\tlist of directories for undo files")
779call <SID>OptionG("udir", &udir)
Bram Moolenaar59f931e2010-07-24 20:27:03 +0200780call append("$", "undoreload\tmaximum number lines to save for undo on a buffer reload")
781call append("$", " \tset ur=" . &ur)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782call append("$", "modified\tchanges have been made and not written to a file")
783call append("$", "\t(local to buffer)")
784call <SID>BinOptionL("mod")
785call append("$", "readonly\tbuffer is not to be written")
786call append("$", "\t(local to buffer)")
787call <SID>BinOptionL("ro")
788call append("$", "modifiable\tchanges to the text are not possible")
789call append("$", "\t(local to buffer)")
790call <SID>BinOptionL("ma")
791call append("$", "textwidth\tline length above which to break a line")
792call append("$", "\t(local to buffer)")
793call <SID>OptionL("tw")
794call append("$", "wrapmargin\tmargin from the right in which to break a line")
795call append("$", "\t(local to buffer)")
796call <SID>OptionL("wm")
797call append("$", "backspace\tspecifies what <BS>, CTRL-W, etc. can do in Insert mode")
798call append("$", " \tset bs=" . &bs)
799call append("$", "comments\tdefinition of what comment lines look like")
800call append("$", "\t(local to buffer)")
801call <SID>OptionL("com")
802call append("$", "formatoptions\tlist of flags that tell how automatic formatting works")
803call append("$", "\t(local to buffer)")
804call <SID>OptionL("fo")
Bram Moolenaar86b68352004-12-27 21:59:20 +0000805call append("$", "formatlistpat\tpattern to recognize a numbered list")
806call append("$", "\t(local to buffer)")
807call <SID>OptionL("flp")
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000808if has("eval")
809 call append("$", "formatexpr\texpression used for \"gq\" to format lines")
810 call append("$", "\t(local to buffer)")
811 call <SID>OptionL("fex")
812endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000813if has("insert_expand")
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000814 call append("$", "complete\tspecifies how Insert mode completion works for CTRL-N and CTRL-P")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815 call append("$", "\t(local to buffer)")
816 call <SID>OptionL("cpt")
Bram Moolenaarbb15b652005-10-03 21:52:09 +0000817 call append("$", "completeopt\twhether to use a popup menu for Insert mode completion")
818 call <SID>OptionG("cot", &cot)
Bram Moolenaar36e4d982019-08-20 21:12:16 +0200819 if exists("+completepopup")
820 call append("$", "completepopup\toptions for the Insert mode completion info popup")
821 call <SID>OptionG("cpp", &cpp)
822 endif
Bram Moolenaard3667a22006-03-16 21:35:52 +0000823 call append("$", "pumheight\tmaximum height of the popup menu")
824 call <SID>OptionG("ph", &ph)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +0100825 call append("$", "pumwidth\tminimum width of the popup menu")
826 call <SID>OptionG("pw", &pw)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000827 call append("$", "completefunc\tuser defined function for Insert mode completion")
828 call append("$", "\t(local to buffer)")
829 call <SID>OptionL("cfu")
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000830 call append("$", "omnifunc\tfunction for filetype-specific Insert mode completion")
Bram Moolenaare344bea2005-09-01 20:46:49 +0000831 call append("$", "\t(local to buffer)")
832 call <SID>OptionL("ofu")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833 call append("$", "dictionary\tlist of dictionary files for keyword completion")
834 call append("$", "\t(global or local to buffer)")
835 call <SID>OptionG("dict", &dict)
836 call append("$", "thesaurus\tlist of thesaurus files for keyword completion")
837 call append("$", "\t(global or local to buffer)")
838 call <SID>OptionG("tsr", &tsr)
839endif
840call append("$", "infercase\tadjust case of a keyword completion match")
841call append("$", "\t(local to buffer)")
842call <SID>BinOptionL("inf")
843if has("digraphs")
Bram Moolenaar2b7db932016-01-07 16:52:10 +0100844 call append("$", "digraph\tenable entering digraphs with c1 <BS> c2")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845 call <SID>BinOptionG("dg", &dg)
846endif
847call append("$", "tildeop\tthe \"~\" command behaves like an operator")
848call <SID>BinOptionG("top", &top)
Bram Moolenaar4770d092006-01-12 23:22:24 +0000849call append("$", "operatorfunc\tfunction called for the\"g@\" operator")
850call <SID>OptionG("opfunc", &opfunc)
Bram Moolenaar1deee622010-07-24 20:35:12 +0200851call append("$", "showmatch\twhen inserting a bracket, briefly jump to its match")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000852call <SID>BinOptionG("sm", &sm)
853call append("$", "matchtime\ttenth of a second to show a match for 'showmatch'")
854call append("$", " \tset mat=" . &mat)
855call append("$", "matchpairs\tlist of pairs that match for the \"%\" command")
856call append("$", "\t(local to buffer)")
857call <SID>OptionL("mps")
858call append("$", "joinspaces\tuse two spaces after '.' when joining a line")
859call <SID>BinOptionG("js", &js)
860call append("$", "nrformats\t\"alpha\", \"octal\" and/or \"hex\"; number formats recognized for")
861call append("$", "\tCTRL-A and CTRL-X commands")
862call append("$", "\t(local to buffer)")
863call <SID>OptionL("nf")
864
865
866call <SID>Header("tabs and indenting")
867call append("$", "tabstop\tnumber of spaces a <Tab> in the text stands for")
868call append("$", "\t(local to buffer)")
869call <SID>OptionL("ts")
870call append("$", "shiftwidth\tnumber of spaces used for each step of (auto)indent")
871call append("$", "\t(local to buffer)")
872call <SID>OptionL("sw")
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200873if has("vartabs")
874 call append("$", "vartabstop\tlist of number of spaces a tab counts for")
875 call append("$", "\t(local to buffer)")
876 call <SID>OptionL("vts")
877 call append("$", "varsofttabstop\tlist of number of spaces a soft tabsstop counts for")
878 call append("$", "\t(local to buffer)")
879 call <SID>OptionL("vsts")
880endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000881call append("$", "smarttab\ta <Tab> in an indent inserts 'shiftwidth' spaces")
882call <SID>BinOptionG("sta", &sta)
883call append("$", "softtabstop\tif non-zero, number of spaces to insert for a <Tab>")
884call append("$", "\t(local to buffer)")
885call <SID>OptionL("sts")
886call append("$", "shiftround\tround to 'shiftwidth' for \"<<\" and \">>\"")
887call <SID>BinOptionG("sr", &sr)
888call append("$", "expandtab\texpand <Tab> to spaces in Insert mode")
889call append("$", "\t(local to buffer)")
890call <SID>BinOptionL("et")
891call append("$", "autoindent\tautomatically set the indent of a new line")
892call append("$", "\t(local to buffer)")
893call <SID>BinOptionL("ai")
894if has("smartindent")
895 call append("$", "smartindent\tdo clever autoindenting")
896 call append("$", "\t(local to buffer)")
897 call <SID>BinOptionL("si")
898endif
899if has("cindent")
900 call append("$", "cindent\tenable specific indenting for C code")
901 call append("$", "\t(local to buffer)")
902 call <SID>BinOptionL("cin")
903 call append("$", "cinoptions\toptions for C-indenting")
904 call append("$", "\t(local to buffer)")
905 call <SID>OptionL("cino")
906 call append("$", "cinkeys\tkeys that trigger C-indenting in Insert mode")
907 call append("$", "\t(local to buffer)")
908 call <SID>OptionL("cink")
909 call append("$", "cinwords\tlist of words that cause more C-indent")
910 call append("$", "\t(local to buffer)")
911 call <SID>OptionL("cinw")
912 call append("$", "indentexpr\texpression used to obtain the indent of a line")
913 call append("$", "\t(local to buffer)")
914 call <SID>OptionL("inde")
915 call append("$", "indentkeys\tkeys that trigger indenting with 'indentexpr' in Insert mode")
916 call append("$", "\t(local to buffer)")
917 call <SID>OptionL("indk")
918endif
Bram Moolenaar1deee622010-07-24 20:35:12 +0200919call append("$", "copyindent\tcopy whitespace for indenting from previous line")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000920call append("$", "\t(local to buffer)")
921call <SID>BinOptionL("ci")
Bram Moolenaar1deee622010-07-24 20:35:12 +0200922call append("$", "preserveindent\tpreserve kind of whitespace when changing indent")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000923call append("$", "\t(local to buffer)")
924call <SID>BinOptionL("pi")
925if has("lispindent")
926 call append("$", "lisp\tenable lisp mode")
927 call append("$", "\t(local to buffer)")
928 call <SID>BinOptionL("lisp")
929 call append("$", "lispwords\twords that change how lisp indenting works")
Bram Moolenaare7a88a82014-04-01 12:26:46 +0200930 call <SID>OptionL("lw")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000931endif
932
933
934if has("folding")
935 call <SID>Header("folding")
936 call append("$", "foldenable\tset to display all folds open")
937 call append("$", "\t(local to window)")
938 call <SID>BinOptionL("fen")
939 call append("$", "foldlevel\tfolds with a level higher than this number will be closed")
940 call append("$", "\t(local to window)")
941 call <SID>OptionL("fdl")
942 call append("$", "foldlevelstart\tvalue for 'foldlevel' when starting to edit a file")
943 call append("$", " \tset fdls=" . &fdls)
944 call append("$", "foldcolumn\twidth of the column used to indicate folds")
945 call append("$", "\t(local to window)")
946 call <SID>OptionL("fdc")
947 call append("$", "foldtext\texpression used to display the text of a closed fold")
948 call append("$", "\t(local to window)")
949 call <SID>OptionL("fdt")
950 call append("$", "foldclose\tset to \"all\" to close a fold when the cursor leaves it")
951 call <SID>OptionG("fcl", &fcl)
952 call append("$", "foldopen\tspecifies for which commands a fold will be opened")
953 call <SID>OptionG("fdo", &fdo)
954 call append("$", "foldminlines\tminimum number of screen lines for a fold to be closed")
955 call append("$", "\t(local to window)")
956 call <SID>OptionL("fml")
957 call append("$", "commentstring\ttemplate for comments; used to put the marker in")
958 call <SID>OptionL("cms")
959 call append("$", "foldmethod\tfolding type: \"manual\", \"indent\", \"expr\", \"marker\" or \"syntax\"")
960 call append("$", "\t(local to window)")
961 call <SID>OptionL("fdm")
962 call append("$", "foldexpr\texpression used when 'foldmethod' is \"expr\"")
963 call append("$", "\t(local to window)")
964 call <SID>OptionL("fde")
965 call append("$", "foldignore\tused to ignore lines when 'foldmethod' is \"indent\"")
966 call append("$", "\t(local to window)")
967 call <SID>OptionL("fdi")
968 call append("$", "foldmarker\tmarkers used when 'foldmethod' is \"marker\"")
969 call append("$", "\t(local to window)")
970 call <SID>OptionL("fmr")
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +0100971 call append("$", "foldnestmax\tmaximum fold depth for when 'foldmethod' is \"indent\" or \"syntax\"")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000972 call append("$", "\t(local to window)")
973 call <SID>OptionL("fdn")
974endif
975
976
977if has("diff")
978 call <SID>Header("diff mode")
979 call append("$", "diff\tuse diff mode for the current window")
980 call append("$", "\t(local to window)")
981 call <SID>BinOptionL("diff")
982 call append("$", "diffopt\toptions for using diff mode")
983 call <SID>OptionG("dip", &dip)
984 call append("$", "diffexpr\texpression used to obtain a diff file")
985 call <SID>OptionG("dex", &dex)
986 call append("$", "patchexpr\texpression used to patch a file")
987 call <SID>OptionG("pex", &pex)
988endif
989
990
991call <SID>Header("mapping")
992call append("$", "maxmapdepth\tmaximum depth of mapping")
993call append("$", " \tset mmd=" . &mmd)
994call append("$", "remap\trecognize mappings in mapped keys")
995call <SID>BinOptionG("remap", &remap)
996call append("$", "timeout\tallow timing out halfway into a mapping")
997call <SID>BinOptionG("to", &to)
998call append("$", "ttimeout\tallow timing out halfway into a key code")
999call <SID>BinOptionG("ttimeout", &ttimeout)
1000call append("$", "timeoutlen\ttime in msec for 'timeout'")
1001call append("$", " \tset tm=" . &tm)
1002call append("$", "ttimeoutlen\ttime in msec for 'ttimeout'")
1003call append("$", " \tset ttm=" . &ttm)
1004
1005
1006call <SID>Header("reading and writing files")
1007call append("$", "modeline\tenable using settings from modelines when reading a file")
1008call append("$", "\t(local to buffer)")
1009call <SID>BinOptionL("ml")
Bram Moolenaar68e65602019-05-26 21:33:31 +02001010call append("$", "modelineexpr\tallow setting expression options from a modeline")
1011call <SID>BinOptionG("mle", &mle)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012call append("$", "modelines\tnumber of lines to check for modelines")
1013call append("$", " \tset mls=" . &mls)
1014call append("$", "binary\tbinary file editing")
1015call append("$", "\t(local to buffer)")
1016call <SID>BinOptionL("bin")
1017call append("$", "endofline\tlast line in the file has an end-of-line")
1018call append("$", "\t(local to buffer)")
1019call <SID>BinOptionL("eol")
Bram Moolenaarf9132812015-07-21 19:19:13 +02001020call append("$", "fixendofline\tfixes missing end-of-line at end of text file")
Bram Moolenaar34d72d42015-07-17 14:18:08 +02001021call append("$", "\t(local to buffer)")
1022call <SID>BinOptionL("fixeol")
Bram Moolenaar76cbe812019-02-17 17:53:49 +01001023call append("$", "bomb\tprepend a Byte Order Mark to the file")
1024call append("$", "\t(local to buffer)")
1025call <SID>BinOptionL("bomb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001026call append("$", "fileformat\tend-of-line format: \"dos\", \"unix\" or \"mac\"")
1027call append("$", "\t(local to buffer)")
1028call <SID>OptionL("ff")
1029call append("$", "fileformats\tlist of file formats to look for when editing a file")
1030call <SID>OptionG("ffs", &ffs)
1031call append("$", "textmode\tobsolete, use 'fileformat'")
1032call append("$", "\t(local to buffer)")
1033call <SID>BinOptionL("tx")
1034call append("$", "textauto\tobsolete, use 'fileformats'")
1035call <SID>BinOptionG("ta", &ta)
1036call append("$", "write\twriting files is allowed")
1037call <SID>BinOptionG("write", &write)
1038call append("$", "writebackup\twrite a backup file before overwriting a file")
1039call <SID>BinOptionG("wb", &wb)
1040call append("$", "backup\tkeep a backup after overwriting a file")
1041call <SID>BinOptionG("bk", &bk)
1042call append("$", "backupskip\tpatterns that specify for which files a backup is not made")
1043call append("$", " \tset bsk=" . &bsk)
1044call append("$", "backupcopy\twhether to make the backup as a copy or rename the existing file")
Bram Moolenaar7d76c802014-10-15 22:51:52 +02001045call append("$", "\t(global or local to buffer)")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001046call append("$", " \tset bkc=" . &bkc)
1047call append("$", "backupdir\tlist of directories to put backup files in")
1048call <SID>OptionG("bdir", &bdir)
1049call append("$", "backupext\tfile name extension for the backup file")
1050call <SID>OptionG("bex", &bex)
1051call append("$", "autowrite\tautomatically write a file when leaving a modified buffer")
1052call <SID>BinOptionG("aw", &aw)
1053call append("$", "autowriteall\tas 'autowrite', but works with more commands")
1054call <SID>BinOptionG("awa", &awa)
1055call append("$", "writeany\talways write without asking for confirmation")
1056call <SID>BinOptionG("wa", &wa)
1057call append("$", "autoread\tautomatically read a file when it was modified outside of Vim")
1058call append("$", "\t(global or local to buffer)")
1059call <SID>BinOptionG("ar", &ar)
1060call append("$", "patchmode\tkeep oldest version of a file; specifies file name extension")
1061call <SID>OptionG("pm", &pm)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001062call append("$", "fsync\tforcibly sync the file to disk after writing it")
1063call <SID>BinOptionG("fs", &fs)
Bram Moolenaara06ecab2016-07-16 14:47:36 +02001064call append("$", "shortname\tuse 8.3 file names")
1065call append("$", "\t(local to buffer)")
1066call <SID>BinOptionL("sn")
Bram Moolenaar365bdf72010-07-24 20:57:44 +02001067call append("$", "cryptmethod\tencryption method for file writing: zip or blowfish")
Bram Moolenaarb702c842010-05-18 22:28:22 +02001068call append("$", "\t(local to buffer)")
1069call <SID>OptionL("cm")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070
1071
1072call <SID>Header("the swap file")
1073call append("$", "directory\tlist of directories for the swap file")
1074call <SID>OptionG("dir", &dir)
1075call append("$", "swapfile\tuse a swap file for this buffer")
1076call append("$", "\t(local to buffer)")
1077call <SID>BinOptionL("swf")
1078call append("$", "swapsync\t\"sync\", \"fsync\" or empty; how to flush a swap file to disk")
1079call <SID>OptionG("sws", &sws)
1080call append("$", "updatecount\tnumber of characters typed to cause a swap file update")
1081call append("$", " \tset uc=" . &uc)
1082call append("$", "updatetime\ttime in msec after which the swap file will be updated")
1083call append("$", " \tset ut=" . &ut)
1084call append("$", "maxmem\tmaximum amount of memory in Kbyte used for one buffer")
1085call append("$", " \tset mm=" . &mm)
1086call append("$", "maxmemtot\tmaximum amount of memory in Kbyte used for all buffers")
1087call append("$", " \tset mmt=" . &mmt)
1088
1089
1090call <SID>Header("command line editing")
1091call append("$", "history\thow many command lines are remembered ")
1092call append("$", " \tset hi=" . &hi)
1093call append("$", "wildchar\tkey that triggers command-line expansion")
1094call append("$", " \tset wc=" . &wc)
1095call append("$", "wildcharm\tlike 'wildchar' but can also be used in a mapping")
1096call append("$", " \tset wcm=" . &wcm)
1097call append("$", "wildmode\tspecifies how command line completion works")
1098call <SID>OptionG("wim", &wim)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00001099if has("wildoptions")
1100 call append("$", "wildoptions\tempty or \"tagfile\" to list file name of matching tags")
1101 call <SID>OptionG("wop", &wop)
1102endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001103call append("$", "suffixes\tlist of file name extensions that have a lower priority")
1104call <SID>OptionG("su", &su)
1105if has("file_in_path")
1106 call append("$", "suffixesadd\tlist of file name extensions added when searching for a file")
1107 call append("$", "\t(local to buffer)")
1108 call <SID>OptionL("sua")
1109endif
1110if has("wildignore")
1111 call append("$", "wildignore\tlist of patterns to ignore files for file name completion")
1112 call <SID>OptionG("wig", &wig)
1113endif
Bram Moolenaar91fc43d2013-04-05 15:41:05 +02001114call append("$", "fileignorecase\tignore case when using file names")
1115call <SID>BinOptionG("fic", &fic)
Bram Moolenaar81af9252010-12-10 20:35:50 +01001116call append("$", "wildignorecase\tignore case when completing file names")
1117call <SID>BinOptionG("wic", &wic)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001118if has("wildmenu")
1119 call append("$", "wildmenu\tcommand-line completion shows a list of matches")
1120 call <SID>BinOptionG("wmnu", &wmnu)
1121endif
Bram Moolenaar314dd792019-02-03 15:27:20 +01001122call append("$", "cedit\tkey used to open the command-line window")
1123call <SID>OptionG("cedit", &cedit)
1124call append("$", "cmdwinheight\theight of the command-line window")
1125call <SID>OptionG("cwh", &cwh)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001126
1127
1128call <SID>Header("executing external commands")
1129call append("$", "shell\tname of the shell program used for external commands")
1130call <SID>OptionG("sh", &sh)
1131if has("amiga")
1132 call append("$", "shelltype\twhen to use the shell or directly execute a command")
1133 call append("$", " \tset st=" . &st)
1134endif
1135call append("$", "shellquote\tcharacter(s) to enclose a shell command in")
1136call <SID>OptionG("shq", &shq)
1137call append("$", "shellxquote\tlike 'shellquote' but include the redirection")
1138call <SID>OptionG("sxq", &sxq)
Bram Moolenaardb7207e2012-02-22 17:30:19 +01001139call append("$", "shellxescape\tcharacters to escape when 'shellxquote' is (")
1140call <SID>OptionG("sxe", &sxe)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001141call append("$", "shellcmdflag\targument for 'shell' to execute a command")
1142call <SID>OptionG("shcf", &shcf)
1143call append("$", "shellredir\tused to redirect command output to a file")
1144call <SID>OptionG("srr", &srr)
Bram Moolenaar551f84f2005-07-06 22:29:20 +00001145call append("$", "shelltemp\tuse a temp file for shell commands instead of using a pipe")
1146call <SID>BinOptionG("stmp", &stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001147call append("$", "equalprg\tprogram used for \"=\" command")
1148call append("$", "\t(global or local to buffer)")
1149call <SID>OptionG("ep", &ep)
1150call append("$", "formatprg\tprogram used to format lines with \"gq\" command")
1151call <SID>OptionG("fp", &fp)
1152call append("$", "keywordprg\tprogram used for the \"K\" command")
1153call <SID>OptionG("kp", &kp)
1154call append("$", "warn\twarn when using a shell command and a buffer has changes")
1155call <SID>BinOptionG("warn", &warn)
1156
1157
1158if has("quickfix")
Bram Moolenaaracc22402020-06-07 21:07:18 +02001159 call <SID>Header("running make and jumping to errors (quickfix)")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001160 call append("$", "errorfile\tname of the file that contains error messages")
1161 call <SID>OptionG("ef", &ef)
1162 call append("$", "errorformat\tlist of formats for error messages")
1163 call append("$", "\t(global or local to buffer)")
1164 call <SID>OptionG("efm", &efm)
1165 call append("$", "makeprg\tprogram used for the \":make\" command")
1166 call append("$", "\t(global or local to buffer)")
1167 call <SID>OptionG("mp", &mp)
1168 call append("$", "shellpipe\tstring used to put the output of \":make\" in the error file")
1169 call <SID>OptionG("sp", &sp)
1170 call append("$", "makeef\tname of the errorfile for the 'makeprg' command")
1171 call <SID>OptionG("mef", &mef)
1172 call append("$", "grepprg\tprogram used for the \":grep\" command")
1173 call append("$", "\t(global or local to buffer)")
1174 call <SID>OptionG("gp", &gp)
1175 call append("$", "grepformat\tlist of formats for output of 'grepprg'")
1176 call <SID>OptionG("gfm", &gfm)
Bram Moolenaarad4187e2017-03-06 21:45:20 +01001177 call append("$", "makeencoding\tencoding of the \":make\" and \":grep\" output")
1178 call append("$", "\t(global or local to buffer)")
1179 call <SID>OptionG("menc", &menc)
Bram Moolenaaracc22402020-06-07 21:07:18 +02001180 call append("$", "quickfixtextfunc\tfunction to display text in the quickfix window")
1181 call <SID>OptionG("qftf", &qftf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182endif
1183
1184
Bram Moolenaara06ecab2016-07-16 14:47:36 +02001185if has("win32") || has("osfiletype")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186 call <SID>Header("system specific")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187 if has("osfiletype")
1188 call append("$", "osfiletype\tOS-specific information about the type of file")
1189 call append("$", "\t(local to buffer)")
1190 call <SID>OptionL("oft")
1191 endif
Bram Moolenaara06ecab2016-07-16 14:47:36 +02001192 if has("win32")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001193 call append("$", "shellslash\tuse forward slashes in file names; for Unix-like shells")
1194 call <SID>BinOptionG("ssl", &ssl)
Bram Moolenaar088e8e32019-08-08 22:15:18 +02001195 call append("$", "completeslash\tspecifies slash/backslash used for completion")
1196 call <SID>OptionG("csl", &csl)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001197 endif
1198endif
1199
1200
1201call <SID>Header("language specific")
1202call append("$", "isfname\tspecifies the characters in a file name")
1203call <SID>OptionG("isf", &isf)
1204call append("$", "isident\tspecifies the characters in an identifier")
1205call <SID>OptionG("isi", &isi)
1206call append("$", "iskeyword\tspecifies the characters in a keyword")
1207call append("$", "\t(local to buffer)")
1208call <SID>OptionL("isk")
1209call append("$", "isprint\tspecifies printable characters")
1210call <SID>OptionG("isp", &isp)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001211if has("textobjects")
1212 call append("$", "quoteescape\tspecifies escape characters in a string")
1213 call append("$", "\t(local to buffer)")
1214 call <SID>OptionL("qe")
1215endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001216if has("rightleft")
1217 call append("$", "rightleft\tdisplay the buffer right-to-left")
1218 call append("$", "\t(local to window)")
1219 call <SID>BinOptionL("rl")
Bram Moolenaar1deee622010-07-24 20:35:12 +02001220 call append("$", "rightleftcmd\twhen to edit the command-line right-to-left")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001221 call append("$", "\t(local to window)")
1222 call <SID>OptionL("rlc")
Bram Moolenaar1deee622010-07-24 20:35:12 +02001223 call append("$", "revins\tinsert characters backwards")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001224 call <SID>BinOptionG("ri", &ri)
Bram Moolenaar1deee622010-07-24 20:35:12 +02001225 call append("$", "allowrevins\tallow CTRL-_ in Insert and Command-line mode to toggle 'revins'")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001226 call <SID>BinOptionG("ari", &ari)
1227 call append("$", "aleph\tthe ASCII code for the first letter of the Hebrew alphabet")
1228 call append("$", " \tset al=" . &al)
1229 call append("$", "hkmap\tuse Hebrew keyboard mapping")
1230 call <SID>BinOptionG("hk", &hk)
1231 call append("$", "hkmapp\tuse phonetic Hebrew keyboard mapping")
1232 call <SID>BinOptionG("hkp", &hkp)
1233endif
1234if has("farsi")
1235 call append("$", "altkeymap\tuse Farsi as the second language when 'revins' is set")
1236 call <SID>BinOptionG("akm", &akm)
1237 call append("$", "fkmap\tuse Farsi keyboard mapping")
1238 call <SID>BinOptionG("fk", &fk)
1239endif
1240if has("arabic")
Bram Moolenaar1deee622010-07-24 20:35:12 +02001241 call append("$", "arabic\tprepare for editing Arabic text")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001242 call append("$", "\t(local to window)")
1243 call <SID>BinOptionL("arab")
Bram Moolenaar1deee622010-07-24 20:35:12 +02001244 call append("$", "arabicshape\tperform shaping of Arabic characters")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001245 call <SID>BinOptionG("arshape", &arshape)
Bram Moolenaar1deee622010-07-24 20:35:12 +02001246 call append("$", "termbidi\tterminal will perform bidi handling")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001247 call <SID>BinOptionG("tbidi", &tbidi)
1248endif
1249if has("keymap")
Bram Moolenaar2b7db932016-01-07 16:52:10 +01001250 call append("$", "keymap\tname of a keyboard mapping")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001251 call <SID>OptionL("kmp")
1252endif
1253if has("langmap")
Bram Moolenaar2f3b5102014-11-19 18:54:17 +01001254 call append("$", "langmap\tlist of characters that are translated in Normal mode")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255 call <SID>OptionG("lmap", &lmap)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02001256 call append("$", "langremap\tapply 'langmap' to mapped characters")
1257 call <SID>BinOptionG("lrm", &lrm)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258endif
1259if has("xim")
1260 call append("$", "imdisable\twhen set never use IM; overrules following IM options")
1261 call <SID>BinOptionG("imd", &imd)
1262endif
1263call append("$", "iminsert\tin Insert mode: 1: use :lmap; 2: use IM; 0: neither")
1264call append("$", "\t(local to window)")
1265call <SID>OptionL("imi")
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001266call append("$", "imstyle\tinput method style, 0: on-the-spot, 1: over-the-spot")
1267call <SID>OptionG("imst", &imst)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001268call append("$", "imsearch\tentering a search pattern: 1: use :lmap; 2: use IM; 0: neither")
1269call append("$", "\t(local to window)")
1270call <SID>OptionL("ims")
1271if has("xim")
1272 call append("$", "imcmdline\twhen set always use IM when starting to edit a command line")
1273 call <SID>BinOptionG("imc", &imc)
Bram Moolenaar14b69452013-06-29 23:05:20 +02001274 call append("$", "imstatusfunc\tfunction to obtain IME status")
1275 call <SID>OptionG("imsf", &imsf)
1276 call append("$", "imactivatefunc\tfunction to enable/disable IME")
1277 call <SID>OptionG("imaf", &imaf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001278endif
1279
1280
Bram Moolenaar76cbe812019-02-17 17:53:49 +01001281call <SID>Header("multi-byte characters")
1282call append("$", "encoding\tcharacter encoding used in Vim: \"latin1\", \"utf-8\"")
1283call append("$", "\t\"euc-jp\", \"big5\", etc.")
1284call <SID>OptionG("enc", &enc)
1285call append("$", "fileencoding\tcharacter encoding for the current file")
1286call append("$", "\t(local to buffer)")
1287call <SID>OptionL("fenc")
1288call append("$", "fileencodings\tautomatically detected character encodings")
1289call <SID>OptionG("fencs", &fencs)
1290call append("$", "termencoding\tcharacter encoding used by the terminal")
1291call <SID>OptionG("tenc", &tenc)
1292call append("$", "charconvert\texpression used for character encoding conversion")
1293call <SID>OptionG("ccv", &ccv)
1294call append("$", "delcombine\tdelete combining (composing) characters on their own")
1295call <SID>BinOptionG("deco", &deco)
1296call append("$", "maxcombine\tmaximum number of combining (composing) characters displayed")
1297call <SID>OptionG("mco", &mco)
1298if has("xim") && has("gui_gtk")
1299 call append("$", "imactivatekey\tkey that activates the X input method")
1300 call <SID>OptionG("imak", &imak)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001301endif
Bram Moolenaar76cbe812019-02-17 17:53:49 +01001302call append("$", "ambiwidth\twidth of ambiguous width characters")
1303call <SID>OptionG("ambw", &ambw)
1304call append("$", "emoji\temoji characters are full width")
1305call <SID>BinOptionG("emo", &emo)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001306
1307
1308call <SID>Header("various")
Bram Moolenaar314dd792019-02-03 15:27:20 +01001309call append("$", "virtualedit\twhen to use virtual editing: \"block\", \"insert\" and/or \"all\"")
1310call <SID>OptionG("ve", &ve)
1311call append("$", "eventignore\tlist of autocommand events which are to be ignored")
1312call <SID>OptionG("ei", &ei)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001313call append("$", "loadplugins\tload plugin scripts when starting up")
1314call <SID>BinOptionG("lpl", &lpl)
1315call append("$", "exrc\tenable reading .vimrc/.exrc/.gvimrc in the current directory")
1316call <SID>BinOptionG("ex", &ex)
1317call append("$", "secure\tsafer working with script files in the current directory")
1318call <SID>BinOptionG("secure", &secure)
1319call append("$", "gdefault\tuse the 'g' flag for \":substitute\"")
1320call <SID>BinOptionG("gd", &gd)
1321call append("$", "edcompatible\t'g' and 'c' flags of \":substitute\" toggle")
1322call <SID>BinOptionG("ed", &ed)
Bram Moolenaard5ab34b2007-05-05 17:15:44 +00001323if exists("+opendevice")
1324 call append("$", "opendevice\tallow reading/writing devices")
1325 call <SID>BinOptionG("odev", &odev)
1326endif
1327if exists("+maxfuncdepth")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001328 call append("$", "maxfuncdepth\tmaximum depth of function calls")
1329 call append("$", " \tset mfd=" . &mfd)
Bram Moolenaard5ab34b2007-05-05 17:15:44 +00001330endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001331if has("mksession")
1332 call append("$", "sessionoptions\tlist of words that specifies what to put in a session file")
1333 call <SID>OptionG("ssop", &ssop)
1334 call append("$", "viewoptions\tlist of words that specifies what to save for :mkview")
1335 call <SID>OptionG("vop", &vop)
1336 call append("$", "viewdir\tdirectory where to store files with :mkview")
1337 call <SID>OptionG("vdir", &vdir)
1338endif
1339if has("viminfo")
1340 call append("$", "viminfo\tlist that specifies what to write in the viminfo file")
1341 call <SID>OptionG("vi", &vi)
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02001342 call append("$", "viminfofile\tfile name used for the viminfo file")
1343 call <SID>OptionG("vif", &vif)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001344endif
1345if has("quickfix")
1346 call append("$", "bufhidden\twhat happens with a buffer when it's no longer in a window")
1347 call append("$", "\t(local to buffer)")
1348 call <SID>OptionL("bh")
1349 call append("$", "buftype\t\"\", \"nofile\", \"nowrite\" or \"quickfix\": type of buffer")
1350 call append("$", "\t(local to buffer)")
1351 call <SID>OptionL("bt")
1352endif
1353call append("$", "buflisted\twhether the buffer shows up in the buffer list")
1354call append("$", "\t(local to buffer)")
1355call <SID>BinOptionL("bl")
1356call append("$", "debug\tset to \"msg\" to see all error messages")
1357call append("$", " \tset debug=" . &debug)
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02001358if has("signs")
1359 call append("$", "signcolumn\twhether to show the signcolumn")
1360 call append("$", "\t(local to window)")
1361 call <SID>OptionL("scl")
1362endif
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001363if has("mzscheme")
1364 call append("$", "mzquantum\tinterval in milliseconds between polls for MzScheme threads")
1365 call append("$", " \tset mzq=" . &mzq)
1366endif
Bram Moolenaard4ece232015-11-10 19:48:14 +01001367if exists("&luadll")
1368 call append("$", "luadll\tname of the Lua dynamic library")
1369 call <SID>OptionG("luadll", &luadll)
1370endif
1371if exists("&perldll")
1372 call append("$", "perldll\tname of the Perl dynamic library")
1373 call <SID>OptionG("perldll", &perldll)
1374endif
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01001375if has('pythonx')
1376 call append("$", "pyxversion\twhether to use Python 2 or 3")
1377 call append("$", " \tset pyx=" . &wd)
1378endif
Bram Moolenaard4ece232015-11-10 19:48:14 +01001379if exists("&pythondll")
1380 call append("$", "pythondll\tname of the Python 2 dynamic library")
1381 call <SID>OptionG("pythondll", &pythondll)
1382endif
Bram Moolenaar94073162018-01-31 21:49:05 +01001383if exists("&pythonhome")
1384 call append("$", "pythonhome\tname of the Python 2 home directory")
1385 call <SID>OptionG("pythonhome", &pythonhome)
1386endif
Bram Moolenaard4ece232015-11-10 19:48:14 +01001387if exists("&pythonthreedll")
1388 call append("$", "pythonthreedll\tname of the Python 3 dynamic library")
1389 call <SID>OptionG("pythonthreedll", &pythonthreedll)
1390endif
Bram Moolenaar94073162018-01-31 21:49:05 +01001391if exists("&pythonthreehome")
1392 call append("$", "pythonthreehome\tname of the Python 3 home directory")
1393 call <SID>OptionG("pythonthreehome", &pythonthreehome)
1394endif
Bram Moolenaara93f9752015-11-10 20:45:09 +01001395if exists("&rubydll")
1396 call append("$", "rubydll\tname of the Ruby dynamic library")
1397 call <SID>OptionG("rubydll", &rubydll)
1398endif
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01001399if exists("&tcldll")
1400 call append("$", "tcldll\tname of the Tcl dynamic library")
1401 call <SID>OptionG("tcldll", &tcldll)
1402endif
Bram Moolenaar01164a62017-11-02 22:58:42 +01001403if exists("&mzschemedll")
1404 call append("$", "mzschemedll\tname of the Tcl dynamic library")
1405 call <SID>OptionG("mzschemedll", &mzschemedll)
1406 call append("$", "mzschemegcdll\tname of the Tcl GC dynamic library")
1407 call <SID>OptionG("mzschemegcdll", &mzschemegcdll)
1408endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001409
1410set cpo&vim
1411
1412" go to first line
14131
1414
1415" reset 'modified', so that ":q" can be used to close the window
1416setlocal nomodified
1417
1418if has("syntax")
1419 " Use Vim highlighting, with some additional stuff
1420 setlocal ft=vim
1421 syn match optwinHeader "^ \=[0-9].*"
1422 syn match optwinName "^[a-z]*\t" nextgroup=optwinComment
1423 syn match optwinComment ".*" contained
1424 syn match optwinComment "^\t.*"
1425 if !exists("did_optwin_syntax_inits")
1426 let did_optwin_syntax_inits = 1
1427 hi link optwinHeader Title
1428 hi link optwinName Identifier
1429 hi link optwinComment Comment
1430 endif
1431endif
1432
1433" Install autocommands to enable mappings in option-window
1434noremap <silent> <buffer> <CR> <C-\><C-N>:call <SID>CR()<CR>
1435inoremap <silent> <buffer> <CR> <Esc>:call <SID>CR()<CR>
1436noremap <silent> <buffer> <Space> :call <SID>Space()<CR>
1437
1438" Make the buffer be deleted when the window is closed.
1439setlocal buftype=nofile bufhidden=delete noswapfile
1440
1441augroup optwin
1442 au! BufUnload,BufHidden option-window nested
1443 \ call <SID>unload() | delfun <SID>unload
1444augroup END
1445
1446fun! <SID>unload()
1447 delfun <SID>CR
1448 delfun <SID>Space
1449 delfun <SID>Find
1450 delfun <SID>Update
1451 delfun <SID>OptionL
1452 delfun <SID>OptionG
1453 delfun <SID>BinOptionL
1454 delfun <SID>BinOptionG
1455 delfun <SID>Header
1456 au! optwin
1457endfun
1458
1459" Restore the previous value of 'title' and 'icon'.
1460let &title = s:old_title
1461let &icon = s:old_icon
1462let &ru = s:old_ru
1463let &sc = s:old_sc
1464let &cpo = s:cpo_save
Bram Moolenaar9c474b22018-02-27 17:04:25 +01001465let &ul = s:old_ul
1466unlet s:old_title s:old_icon s:old_ru s:old_sc s:cpo_save s:idx s:lnum s:old_ul
Bram Moolenaar251e1912011-06-19 05:09:16 +02001467
1468" vim: ts=8 sw=2 sts=2