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