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