path: root/runtime/scripts/optwin.lua

---@param x string
---@return string
local function N_(x)
  return vim.fn.gettext(x)
end

---@type {header:string,[integer]:[string,string]}[]
local options_list = {
  {
    header = N_ 'important',
    { 'cpoptions', N_ 'list of flags to specify Vi compatibility' },
    { 'runtimepath', N_ 'list of directories used for runtime files and plugins' },
    { 'packpath', N_ 'list of directories used for plugin packages' },
    { 'helpfile', N_ 'name of the main help file' },
  },
  {
    header = N_ 'moving around, searching and patterns',
    { 'whichwrap', N_ 'list of flags specifying which commands wrap to another line' },
    {
      'startofline',
      N_ 'many jump commands move the cursor to the first non-blank\ncharacter of a line',
    },
    { 'follow', N_ 'multicursor: motions cascade to all cursors' },
    { 'paragraphs', N_ 'nroff macro names that separate paragraphs' },
    { 'sections', N_ 'nroff macro names that separate sections' },
    { 'path', N_ 'list of directory names used for file searching' },
    { 'findfunc', N_ 'function called for :find' },
    { 'cdhome', N_ ':cd without argument goes to the home directory' },
    { 'cdpath', N_ 'list of directory names used for :cd' },
    { 'autochdir', N_ 'change to directory of file in buffer' },
    { 'wrapscan', N_ 'search commands wrap around the end of the buffer' },
    { 'incsearch', N_ 'show match for partly typed search command' },
    { 'regexpengine', N_ 'select the default regexp engine used' },
    { 'ignorecase', N_ 'ignore case when using a search pattern' },
    { 'smartcase', N_ "override 'ignorecase' when pattern has upper case characters" },
    { 'maxsearchcount', N_ 'maximum number for the search count feature' },
    { 'casemap', N_ 'what method to use for changing case of letters' },
    { 'maxmempattern', N_ 'maximum amount of memory in Kbyte used for pattern matching' },
    { 'define', N_ 'pattern for a macro definition line' },
    { 'include', N_ 'pattern for an include-file line' },
    { 'includeexpr', N_ 'expression used to transform an include line to a file name' },
    { 'jumpoptions', N_ 'controls the behavior of the jumplist' },
  },
  {
    header = N_ 'tags',
    { 'tagbsearch', N_ 'use binary searching in tags files' },
    { 'taglength', N_ 'number of significant characters in a tag name or zero' },
    { 'tags', N_ 'list of file names to search for tags' },
    {
      'tagcase',
      N_ 'how to handle case when searching in tags files:\n"followic" to follow \'ignorecase\', "ignore" or "match"',
    },
    { 'tagrelative', N_ 'file names in a tags file are relative to the tags file' },
    { 'tagstack', N_ 'a :tag command will use the tagstack' },
    { 'showfulltag', N_ 'when completing tags in Insert mode show more info' },
    { 'tagfunc', N_ 'a function to be used to perform tag searches' },
  },
  {
    header = N_ 'displaying text',
    { 'scroll', N_ 'number of lines to scroll for CTRL-U and CTRL-D' },
    { 'smoothscroll', N_ 'scroll by screen line' },
    { 'scrolloff', N_ 'number of screen lines to show around the cursor' },
    { 'scrolloffpad', N_ 'vertically center cursor even at end of file' },
    { 'wrap', N_ 'long lines wrap' },
    { 'linebreak', N_ "wrap long lines at a character in 'breakat'" },
    { 'breakindent', N_ 'preserve indentation in wrapped text' },
    { 'breakindentopt', N_ 'adjust breakindent behaviour' },
    { 'breakat', N_ 'which characters might cause a line break' },
    { 'showbreak', N_ 'string to put before wrapped screen lines' },
    { 'sidescroll', N_ 'minimal number of columns to scroll horizontally' },
    { 'sidescrolloff', N_ 'minimal number of columns to keep left and right of the cursor' },
    {
      'display',
      N_ 'include "lastline" to show the last line even if it doesn\'t fit\ninclude "uhex" to show unprintable characters as a hex number',
    },
    {
      'fillchars',
      N_ 'characters to use for the status line, folds, diffs,\nbuffer text, filler lines and truncation in the completion menu',
    },
    { 'cmdheight', N_ 'number of lines used for the command-line' },
    { 'columns', N_ 'width of the display' },
    { 'lines', N_ 'number of lines in the display' },
    { 'window', N_ 'number of lines to scroll for CTRL-F and CTRL-B' },
    { 'lazyredraw', N_ "don't redraw while executing macros" },
    { 'redrawtime', N_ "timeout for 'hlsearch' and :match highlighting in msec" },
    { 'writedelay', N_ 'delay in msec for each char written to the display' },
    { 'redrawdebug', N_ 'change the way redrawing works (debug)' },
    { 'list', N_ 'show <Tab> as ^I and end-of-line as $' },
    { 'listchars', N_ 'list of strings used for list mode' },
    { 'number', N_ 'show the line number for each line' },
    { 'relativenumber', N_ 'show the relative line number for each line' },
    { 'numberwidth', N_ 'number of columns to use for the line number' },
    { 'chistory', N_ 'maximum number of quickfix lists that can be stored in history' },
    { 'lhistory', N_ 'maximum number of location lists that can be stored in history' },
    { 'conceallevel', N_ 'controls whether concealable text is hidden' },
    { 'concealcursor', N_ 'modes in which text in the cursor line can be concealed' },
  },
  {
    header = N_ 'syntax, highlighting and spelling',
    { 'background', N_ '"dark" or "light"; the background color brightness' },
    { 'filetype', N_ 'type of file; triggers the FileType event when set' },
    { 'syntax', N_ 'name of syntax highlighting used' },
    { 'synmaxcol', N_ 'maximum column to look for syntax items' },
    { 'hlsearch', N_ 'highlight all matches for the last used search pattern' },
    { 'termguicolors', N_ 'use GUI colors for the terminal' },
    { 'cursorcolumn', N_ 'highlight the screen column of the cursor' },
    { 'cursorline', N_ 'highlight the screen line of the cursor' },
    { 'cursorlineopt', N_ "specifies which area 'cursorline' highlights" },
    { 'colorcolumn', N_ 'columns to highlight' },
    { 'spell', N_ 'highlight spelling mistakes' },
    { 'spelllang', N_ 'list of accepted languages' },
    { 'spellfile', N_ 'file that "zg" adds good words to' },
    { 'spellcapcheck', N_ 'pattern to locate the end of a sentence' },
    { 'spelloptions', N_ 'flags to change how spell checking works' },
    { 'spellsuggest', N_ 'methods used to suggest corrections' },
    { 'mkspellmem', N_ 'amount of memory used by :mkspell before compressing' },
    { 'winhighlight', N_ 'override highlighting-groups window-locally' },
  },
  {
    header = N_ 'multiple windows',
    { 'laststatus', N_ '0, 1, 2 or 3; when to use a status line for the last window' },
    { 'statuscolumn', N_ 'custom format for the status column' },
    { 'statusline', N_ 'alternate format to be used for a status line' },
    { 'equalalways', N_ 'make all windows the same size when adding/removing windows' },
    { 'eadirection', N_ 'in which direction \'equalalways\' works: "ver", "hor" or "both"' },
    { 'winheight', N_ 'minimal number of lines used for the current window' },
    { 'winminheight', N_ 'minimal number of lines used for any window' },
    { 'winfixbuf', N_ 'keep window focused on a single buffer' },
    { 'winfixheight', N_ 'keep the height of the window' },
    { 'winfixwidth', N_ 'keep the width of the window' },
    { 'winwidth', N_ 'minimal number of columns used for the current window' },
    { 'winminwidth', N_ 'minimal number of columns used for any window' },
    { 'winpinned', N_ 'prevent closing window with :only and :fclose' },
    { 'helpheight', N_ 'initial height of the help window' },
    { 'previewheight', N_ 'default height for the preview window' },
    { 'previewpopup', N_ 'use floating window for preview' },
    { 'previewwindow', N_ 'identifies the preview window' },
    { 'winbar', N_ 'custom format for the window bar' },
    { 'winborder', N_ 'border of floating window' },
    { 'winblend', N_ 'transparency level for floating windows' },
    { 'hidden', N_ "don't unload a buffer when no longer shown in a window" },
    { 'switchbuf', N_ '"useopen" and/or "split"; which window to use when jumping\nto a buffer' },
    { 'splitbelow', N_ 'a new window is put below the current one' },
    { 'splitkeep', N_ 'determines scroll behavior for split windows' },
    { 'splitright', N_ 'a new window is put right of the current one' },
    { 'scrollbind', N_ 'this window scrolls together with other bound windows' },
    { 'scrollopt', N_ '"ver", "hor" and/or "jump"; list of options for \'scrollbind\'' },
    { 'cursorbind', N_ "this window's cursor moves together with other bound windows" },
  },
  {
    header = N_ 'multiple tab pages',
    { 'showtabline', N_ '0, 1 or 2; when to use a tab pages line' },
    { 'tabclose', N_ 'behaviour when closing tab pages: left, uselast or empty' },
    { 'tabpagemax', N_ 'maximum number of tab pages to open for -p and "tab all"' },
    { 'tabline', N_ 'custom tab pages line' },
  },
  {
    header = N_ 'terminal',
    { 'scrolljump', N_ 'minimal number of lines to scroll at a time' },
    { 'guicursor', N_ 'specifies what the cursor looks like in different modes' },
    { 'title', N_ 'show info in the window title' },
    { 'titlelen', N_ "percentage of 'columns' used for the window title" },
    { 'titlestring', N_ 'when not empty, string to be used for the window title' },
    { 'titleold', N_ 'string to restore the title to when exiting Vim' },
    { 'icon', N_ 'set the text of the icon for this window' },
    { 'iconstring', N_ 'when not empty, text for the icon of this window' },
  },
  {
    header = N_ 'using the mouse',
    { 'mouse', N_ 'list of flags for using the mouse' },
    { 'mousescroll', N_ 'amount to scroll by when scrolling with a mouse' },
    { 'mousefocus', N_ 'the window with the mouse pointer becomes the current one' },
    { 'mousehide', N_ 'hide the mouse pointer while typing' },
    {
      'mousemodel',
      N_ '"extend", "popup" or "popup_setpos"; what the right\nmouse button is used for',
    },
    { 'mousetime', N_ 'maximum time in msec to recognize a double-click' },
    { 'mousemoveevent', N_ 'deliver mouse move events to input queue' },
  },
  {
    header = N_ 'GUI',
    { 'guifont', N_ 'list of font names to be used in the GUI' },
    { 'guifontwide', N_ 'list of font names to be used for double-wide characters' },
    { 'browsedir', N_ '"last", "buffer" or "current": which directory used for\nthe file browser' },
    { 'langmenu', N_ 'language to be used for the menus' },
    { 'menuitems', N_ 'maximum number of items in one menu' },
    { 'winaltkeys', N_ '"no", "yes" or "menu"; how to use the ALT key' },
    { 'linespace', N_ 'number of pixel lines to use between characters' },
    { 'termsync', N_ 'synchronize redraw output with the host terminal' },
  },
  {
    header = N_ 'messages and info',
    { 'shortmess', N_ 'list of flags to make messages shorter' },
    { 'messagesopt', N_ 'options for outputting messages' },
    { 'showcmd', N_ "show (partial) command keys in location given by 'showcmdloc'" },
    { 'showcmdloc', N_ "location where to show the (partial) command keys for 'showcmd'" },
    { 'showmode', N_ 'display the current mode in the status line' },
    { 'ruler', N_ 'show cursor position below each window' },
    { 'rulerformat', N_ 'alternate format to be used for the ruler' },
    { 'report', N_ 'threshold for reporting number of changed lines' },