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