home *** CD-ROM | disk | FTP | other *** search
/ vim.ftp.fu-berlin.de / 2015-02-03.vim.ftp.fu-berlin.de.tar / vim.ftp.fu-berlin.de / runtime / optwin.vim < prev    next >
Encoding:
Text File  |  2012-05-31  |  53.7 KB  |  1,342 lines

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