]> git.ipfire.org Git - thirdparty/vim.git/commitdiff
runtime(doc): Sort options.txt alphabetically
authorlaburnumT <laburnumtec@gmail.com>
Tue, 5 Dec 2023 17:37:03 +0000 (18:37 +0100)
committerChristian Brabandt <cb@256bit.org>
Tue, 5 Dec 2023 21:52:13 +0000 (22:52 +0100)
Related to: vim/vim#13630

1. Sort section 3 (option-summary) of runtime/doc/options.txt in
   alphabetical order.
2. Remove double newlines in section 3 (option-summary).

I did not alphabetically sort ttimeout and ttimeoutlen because they seem
to belong with timeout and timeoutlen respectively, but I would like
some input on that decision.

Signed-off-by: laburnumT <laburnumtec@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
runtime/doc/options.txt

index 3c0ba4c6844bf3a4a762534c568db3328f95ee15..7de9c5458aa26f6d02b60177252602c5a59b3a64 100644 (file)
@@ -840,53 +840,6 @@ A jump table for the options with a short description can be found at |Q_op|.
        to its default (empty string).
        NOTE: This option is reset when 'compatible' is set.
 
-                       *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
-'autochdir' 'acd'      boolean (default off)
-                       global
-                       {only available when compiled with it, use
-                       exists("+autochdir") to check}
-       When on, Vim will change the current working directory whenever you
-       open a file, switch buffers, delete a buffer or open/close a window.
-       It will change to the directory containing the file which was opened
-       or selected.  When a buffer has no name it also has no directory, thus
-       the current directory won't change when navigating to it.
-       Note: When this option is on some plugins may not work.
-
-                       *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
-'autoshelldir' 'asd'   boolean (default off)
-                       global
-       When on, Vim will change the current working directory whenever you
-       change the directory of the shell running in a terminal window. You
-       need proper setting-up, so whenever the shell's pwd changes an OSC 7
-       escape sequence will be emitted.  For example, on Linux, you can
-       source /etc/profile.d/vte.sh in your shell profile if you use bash or
-       zsh.  For bash this should work (put it in a bash init file): >
-               if [[ -n "$VIM_TERMINAL" ]]; then
-                   PROMPT_COMMAND='_vim_sync_PWD'
-                   function _vim_sync_PWD() {
-                       printf '\033]7;file://%s\033\\' "$PWD"
-                   }
-               fi
-<
-       Or, in a zsh init file: >
-               if [[ -n "$VIM_TERMINAL" ]]; then
-                   autoload -Uz add-zsh-hook
-                   add-zsh-hook -Uz chpwd _vim_sync_PWD
-                   function _vim_sync_PWD() {
-                       printf '\033]7;file://%s\033\\' "$PWD"
-                   }
-               fi
-<
-       In a fish init file: >
-               if test -n "$VIM_TERMINAL"
-                   function _vim_sync_PWD --on-variable=PWD
-                       printf '\033]7;file://%s\033\\' "$PWD"
-                   end
-               end
-<
-       You can find an alternative method at |terminal-autoshelldir|.
-       When the parsing of the OSC sequence fails you get *E1179* .
-
                                *'arabic'* *'arab'* *'noarabic'* *'noarab'*
 'arabic' 'arab'                boolean (default off)
                        local to window
@@ -929,6 +882,18 @@ A jump table for the options with a short description can be found at |Q_op|.
        further details see |arabic.txt|.
        NOTE: This option is set when 'compatible' is set.
 
+                       *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
+'autochdir' 'acd'      boolean (default off)
+                       global
+                       {only available when compiled with it, use
+                       exists("+autochdir") to check}
+       When on, Vim will change the current working directory whenever you
+       open a file, switch buffers, delete a buffer or open/close a window.
+       It will change to the directory containing the file which was opened
+       or selected.  When a buffer has no name it also has no directory, thus
+       the current directory won't change when navigating to it.
+       Note: When this option is on some plugins may not work.
+
                        *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
 'autoindent' 'ai'      boolean (default off)
                        local to buffer
@@ -958,6 +923,42 @@ A jump table for the options with a short description can be found at |Q_op|.
        using the global value: >
                :set autoread<
 <
+
+                       *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
+'autoshelldir' 'asd'   boolean (default off)
+                       global
+       When on, Vim will change the current working directory whenever you
+       change the directory of the shell running in a terminal window. You
+       need proper setting-up, so whenever the shell's pwd changes an OSC 7
+       escape sequence will be emitted.  For example, on Linux, you can
+       source /etc/profile.d/vte.sh in your shell profile if you use bash or
+       zsh.  For bash this should work (put it in a bash init file): >
+               if [[ -n "$VIM_TERMINAL" ]]; then
+                   PROMPT_COMMAND='_vim_sync_PWD'
+                   function _vim_sync_PWD() {
+                       printf '\033]7;file://%s\033\\' "$PWD"
+                   }
+               fi
+<
+       Or, in a zsh init file: >
+               if [[ -n "$VIM_TERMINAL" ]]; then
+                   autoload -Uz add-zsh-hook
+                   add-zsh-hook -Uz chpwd _vim_sync_PWD
+                   function _vim_sync_PWD() {
+                       printf '\033]7;file://%s\033\\' "$PWD"
+                   }
+               fi
+<
+       In a fish init file: >
+               if test -n "$VIM_TERMINAL"
+                   function _vim_sync_PWD --on-variable=PWD
+                       printf '\033]7;file://%s\033\\' "$PWD"
+                   end
+               end
+<
+       You can find an alternative method at |terminal-autoshelldir|.
+       When the parsing of the OSC sequence fails you get *E1179* .
+
                                 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
 'autowrite' 'aw'       boolean (default off)
                        global
@@ -1729,7 +1730,14 @@ A jump table for the options with a short description can be found at |Q_op|.
        program.  See |cinoptions-values| for the values of this option, and
        |C-indenting| for info on C indenting in general.
 
-
+                                               *'cinscopedecls'* *'cinsd'*
+'cinscopedecls' 'cinsd'        string  (default "public,protected,private")
+                       local to buffer
+       Keywords that are interpreted as a C++ scope declaration by |cino-g|.
+       Useful e.g. for working with the Qt framework that defines additional
+       scope declarations "signals", "public slots" and "private slots": >
+               set cinscopedecls+=signals,public\ slots,private\ slots
+<
                                                *'cinwords'* *'cinw'*
 'cinwords' 'cinw'      string  (default "if,else,while,do,for,switch")
                        local to buffer
@@ -1740,15 +1748,7 @@ A jump table for the options with a short description can be found at |Q_op|.
        matter, include the keyword both the uppercase and lowercase:
        "if,If,IF".
 
-                                               *'cinscopedecls'* *'cinsd'*
-'cinscopedecls' 'cinsd'        string  (default "public,protected,private")
-                       local to buffer
-       Keywords that are interpreted as a C++ scope declaration by |cino-g|.
-       Useful e.g. for working with the Qt framework that defines additional
-       scope declarations "signals", "public slots" and "private slots": >
-               set cinscopedecls+=signals,public\ slots,private\ slots
-
-<                                              *'clipboard'* *'cb'*
+                                               *'clipboard'* *'cb'*
 'clipboard' 'cb'       string  (default "autoselect,exclude:cons\|linux"
                                                  for X-windows, "" otherwise)
                        global
@@ -2084,21 +2084,6 @@ A jump table for the options with a short description can be found at |Q_op|.
        This option cannot be set from a |modeline| or in the |sandbox|, for
        security reasons.
 
-                                               *'completeslash'* *'csl'*
-'completeslash' 'csl'  string  (default: "")
-                       local to buffer
-                       {only for MS-Windows}
-       When this option is set it overrules 'shellslash' for completion:
-       - When this option is set to "slash", a forward slash is used for path
-         completion in insert mode. This is useful when editing HTML tag, or
-         Makefile with 'noshellslash' on MS-Windows.
-       - When this option is set to "backslash", backslash is used. This is
-         useful when editing a batch file with 'shellslash' set on MS-Windows.
-       - When this option is empty, same character is used as for
-         'shellslash'.
-       For Insert mode completion the buffer-local value is used.  For
-       command line completion the global value is used.
-
                                                *'completeopt'* *'cot'*
 'completeopt' 'cot'    string  (default: "menu,preview")
                        global
@@ -2144,7 +2129,6 @@ A jump table for the options with a short description can be found at |Q_op|.
                    select one from the menu. Only works in combination with
                    "menu" or "menuone".
 
-
                                        *'completepopup'* *'cpp'*
 'completepopup' 'cpp'  string (default empty)
                        global
@@ -2157,6 +2141,20 @@ A jump table for the options with a short description can be found at |Q_op|.
        You can also use |popup_findinfo()| and then set properties for an
        existing info popup with |popup_setoptions()|.  See |complete-popup|.
 
+                                               *'completeslash'* *'csl'*
+'completeslash' 'csl'  string  (default: "")
+                       local to buffer
+                       {only for MS-Windows}
+       When this option is set it overrules 'shellslash' for completion:
+       - When this option is set to "slash", a forward slash is used for path
+         completion in insert mode. This is useful when editing HTML tag, or
+         Makefile with 'noshellslash' on MS-Windows.
+       - When this option is set to "backslash", backslash is used. This is
+         useful when editing a batch file with 'shellslash' set on MS-Windows.
+       - When this option is empty, same character is used as for
+         'shellslash'.
+       For Insert mode completion the buffer-local value is used.  For
+       command line completion the global value is used.
 
                                                *'concealcursor'* *'cocu'*
 'concealcursor' 'cocu' string (default: "")
@@ -2179,7 +2177,6 @@ A jump table for the options with a short description can be found at |Q_op|.
        Keep in mind that the cursor position is not always where it's
        displayed.  E.g., when moving vertically it may change column.
 
-
                                                *'conceallevel'* *'cole'*
 'conceallevel' 'cole'  number (default 0)
                        local to window
@@ -2557,7 +2554,6 @@ A jump table for the options with a short description can be found at |Q_op|.
                        variables overrule the terminal size values obtained
                        with system specific functions.
 
-
                                                *'cryptmethod'* *'cm'*
 'cryptmethod' 'cm'     string  (default "blowfish2")
                        global or local to buffer |global-local|
@@ -2625,7 +2621,6 @@ A jump table for the options with a short description can be found at |Q_op|.
        the current version does not recognize it, you will get *E821* .
        You need to edit this file with the later version of Vim.
 
-
                                                *'cscopepathcomp'* *'cspc'*
 'cscopepathcomp' 'cspc'        number  (default 0)
                        global
@@ -2699,7 +2694,6 @@ A jump table for the options with a short description can be found at |Q_op|.
        inserted and deleted lines (though not characters within a line) are
        taken into account.
 
-
                        *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
 'cursorcolumn' 'cuc'   boolean (default off)
                        local to window
@@ -2724,7 +2718,6 @@ A jump table for the options with a short description can be found at |Q_op|.
        When Visual mode is active the highlighting isn't used to make it
        easier to see the selected text.
 
-
                                                *'cursorlineopt'* *'culopt'*
 'cursorlineopt' 'culopt' string (default: "number,line")
                        local to window
@@ -2744,7 +2737,6 @@ A jump table for the options with a short description can be found at |Q_op|.
 
        "line" and "screenline" cannot be used together.
 
-
                                                *'debug'*
 'debug'                        string  (default "")
                        global
@@ -4747,7 +4739,6 @@ A jump table for the options with a short description can be found at |Q_op|.
        It is not allowed to change text or jump to another window while
        evaluating 'indentexpr' |textlock|.
 
-
                                                *'indentkeys'* *'indk'*
 'indentkeys' 'indk'    string  (default "0{,0},0),0],:,0#,!^F,o,O,e")
                        local to buffer
@@ -5833,6 +5824,16 @@ A jump table for the options with a short description can be found at |Q_op|.
        time in msec between two mouse clicks for the second click to be
        recognized as a multi click.
 
+                                                   *'mzquantum'* *'mzq'*
+'mzquantum' 'mzq'      number  (default 100)
+                       global
+                       {not available when compiled without the |+mzscheme|
+                       feature}
+       The number of milliseconds between polls for MzScheme threads.
+       Negative or zero value means no thread scheduling.
+       NOTE: This option is set to the Vim default value when 'compatible'
+       is reset.
+
                                                *'mzschemedll'*
 'mzschemedll'          string  (default depends on the build)
                        global
@@ -5858,16 +5859,6 @@ A jump table for the options with a short description can be found at |Q_op|.
        This option cannot be set from a |modeline| or in the |sandbox|, for
        security reasons.
 
-                                                   *'mzquantum'* *'mzq'*
-'mzquantum' 'mzq'      number  (default 100)
-                       global
-                       {not available when compiled without the |+mzscheme|
-                       feature}
-       The number of milliseconds between polls for MzScheme threads.
-       Negative or zero value means no thread scheduling.
-       NOTE: This option is set to the Vim default value when 'compatible'
-       is reset.
-
                                                        *'nrformats'* *'nf'*
 'nrformats' 'nf'       string  (default "bin,octal,hex",
                                           set to "bin,hex" in |defaults.vim|)
@@ -5958,7 +5949,6 @@ A jump table for the options with a short description can be found at |Q_op|.
        This option cannot be set from a |modeline| or in the |sandbox|, for
        security reasons.
 
-
                            *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
 'opendevice' 'odev'    boolean (default off)
                        global
@@ -5969,7 +5959,6 @@ A jump table for the options with a short description can be found at |Q_op|.
        Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
        result in editing a device.
 
-
                                                *'operatorfunc'* *'opfunc'*
 'operatorfunc' 'opfunc'        string  (default: empty)
                        global
@@ -5981,20 +5970,17 @@ A jump table for the options with a short description can be found at |Q_op|.
        This option cannot be set from a |modeline| or in the |sandbox|, for
        security reasons.
 
-
                                        *'osfiletype'* *'oft'*
 'osfiletype' 'oft'     string (default: "")
                        local to buffer
        This option was supported on RISC OS, which has been removed.
 
-
                                *'packpath'* *'pp'*
 'packpath' 'pp'                string  (default: see 'runtimepath')
        Directories used to find packages.  See |packages|.
        This option cannot be set from a |modeline| or in the |sandbox|, for
        security reasons.
 
-
                                                *'paragraphs'* *'para'*
 'paragraphs' 'para'    string  (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
                        global
@@ -7440,7 +7426,6 @@ A jump table for the options with a short description can be found at |Q_op|.
           "number"     display signs in the 'number' column. If the number
                        column is not present, then behaves like "auto".
 
-
                        *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
 'smartcase' 'scs'      boolean (default off)
                        global
@@ -7708,7 +7693,6 @@ A jump table for the options with a short description can be found at |Q_op|.
        This option cannot be set from a |modeline| or in the |sandbox|, for
        security reasons.
 
-
                        *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
 'splitbelow' 'sb'      boolean (default off)
                        global
@@ -8091,14 +8075,12 @@ A jump table for the options with a short description can be found at |Q_op|.
        Keep in mind that only one of the tab pages is the current one, others
        are invisible and you can't jump to their windows.
 
-
                                                *'tabpagemax'* *'tpm'*
 'tabpagemax' 'tpm'     number  (default 10)
                        global
        Maximum number of tab pages to be opened by the |-p| command line
        argument or the ":tab all" command. |tabpage|
 
-
                                                *'tabstop'* *'ts'*
 'tabstop' 'ts'         number  (default 8)
                        local to buffer
@@ -8518,6 +8500,7 @@ A jump table for the options with a short description can be found at |Q_op|.
                                *'timeout'* *'to'* *'notimeout'* *'noto'*
 'timeout' 'to'         boolean (default on)
                        global
+
                                                *'ttimeout'* *'nottimeout'*
 'ttimeout'             boolean (default off, set in |defaults.vim|)
                        global
@@ -9298,7 +9281,6 @@ A jump table for the options with a short description can be found at |Q_op|.
        a pattern from the list.  This avoids problems when a future version
        uses another default.
 
-
                    *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
 'wildignorecase' 'wic' boolean (default off)
                        global
@@ -9307,7 +9289,6 @@ A jump table for the options with a short description can be found at |Q_op|.
        Does not apply when the shell is used to expand wildcards, which
        happens when there are special characters.
 
-
                                *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
 'wildmenu' 'wmnu'      boolean (default off, set in |defaults.vim|)
                        global
@@ -9475,6 +9456,21 @@ A jump table for the options with a short description can be found at |Q_op|.
        Note: Do not confuse this with the height of the Vim window, use
        'lines' for that.
 
+                       *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
+'winfixheight' 'wfh'   boolean (default off)
+                       local to window  |local-noglobal|
+       Keep the window height when windows are opened or closed and
+       'equalalways' is set.  Also for |CTRL-W_=|.  Set by default for the
+       |preview-window| and |quickfix-window|.
+       The height may be changed anyway when running out of room.
+
+                       *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
+'winfixwidth' 'wfw'    boolean (default off)
+                       local to window  |local-noglobal|
+       Keep the window width when windows are opened or closed and
+       'equalalways' is set.  Also for |CTRL-W_=|.
+       The width may be changed anyway when running out of room.
+
                                                *'winheight'* *'wh'* *E591*
 'winheight' 'wh'       number  (default 1)
                        global
@@ -9495,21 +9491,6 @@ A jump table for the options with a short description can be found at |Q_op|.
        'winheight' applies to the current window.  Use 'winminheight' to set
        the minimal height for other windows.
 
-                       *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
-'winfixheight' 'wfh'   boolean (default off)
-                       local to window  |local-noglobal|
-       Keep the window height when windows are opened or closed and
-       'equalalways' is set.  Also for |CTRL-W_=|.  Set by default for the
-       |preview-window| and |quickfix-window|.
-       The height may be changed anyway when running out of room.
-
-                       *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
-'winfixwidth' 'wfw'    boolean (default off)
-                       local to window  |local-noglobal|
-       Keep the window width when windows are opened or closed and
-       'equalalways' is set.  Also for |CTRL-W_=|.
-       The width may be changed anyway when running out of room.
-
                                                *'winminheight'* *'wmh'*
 'winminheight' 'wmh'   number  (default 1)
                        global