thac0/vim
1
0
Fork 0
forked from aniani/vim
Code

runtime(doc): improve the wording of 'sts', 'varts' and 'varsts' values

Browse Source 
closes: #17522

Co-authored-by: Christian Brabandt <cb@256bit.org>
Signed-off-by: Damien Lejay <damien@lejay.be>
Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
Damien Lejay 2025-06-12 21:56:19 +02:00 committed by Christian Brabandt
parent f5e3b5c04f
commit 91af4c4180
No known key found for this signature in database
GPG Key ID: F3F92DA383FDDE09
2 changed files with 45 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
runtime/doc/options.txt
View File

@ -1,4 +1,4 @@
*options.txt* For Vim version 9.1. Last change: 2025 Jun 11 *options.txt* For Vim version 9.1. Last change: 2025 Jun 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -2043,7 +2043,7 @@ A jump table for the options with a short description can be found at |Q_op|.
'smartcase' + off no automatic ignore case switch 'smartcase' + off no automatic ignore case switch
'smartindent' + off no smart indentation 'smartindent' + off no smart indentation
'smarttab' + off no smart tab size 'smarttab' + off no smart tab size
'softtabstop' + 0 tabs are always 'tabstop' positions 'softtabstop' + 0 no soft tab stops
'startofline' + on goto startofline with some commands 'startofline' + on goto startofline with some commands
'tagcase' & "followic" 'ignorecase' when searching tags file 'tagcase' & "followic" 'ignorecase' when searching tags file
'tagrelative' & off tag file names are not relative 'tagrelative' & off tag file names are not relative
@ -7829,21 +7829,24 @@ A jump table for the options with a short description can be found at |Q_op|.
*'softtabstop'* *'sts'* *'softtabstop'* *'sts'*
'softtabstop' 'sts' number (default 0) 'softtabstop' 'sts' number (default 0)
local to buffer local to buffer
Number of spaces that a <Tab> counts for while performing editing Create soft tab stops, separated by 'softtabstop' number of columns.
operations, like inserting a <Tab> or using <BS>. It "feels" like In Insert mode, pressing the <Tab> key will move the cursor to the
<Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is next soft tab stop, instead of inserting a literal tab. <BS> behaves
used. This is useful to keep the 'ts' setting at its standard value similarly in reverse. Vim inserts a minimal mix of tab and space
of 8, while being able to edit like it is set to 'sts'. However, characters to produce the visual effect.
commands like "x" still work on the actual characters.
When 'sts' is zero, this feature is off. This setting does not affect the display of existing tab characters.
When 'sts' is negative, the value of 'shiftwidth' is used.
'softtabstop' is set to 0 when the 'paste' option is set and restored A value of 0 disables this behaviour. A negative value makes Vim use
when 'paste' is reset. 'shiftwidth'. If you plan to use 'sts' and 'shiftwidth' with
See also |ins-expandtab|. When 'expandtab' is not set, the number of different values, you might consider setting 'smarttab'.
spaces is minimized by using <Tab>s.
The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is 'softtabstop' is temporarily set to 0 when 'paste' is on and reset
set. when it is turned off. It is also reset when 'compatible' is set.
NOTE: This option is set to 0 when 'compatible' is set.
The 'L' flag in 'cpoptions' alters tab behavior when 'list' is
enabled. See also |ins-expandtab| ans user manual section |30.5| for
in-depth explanations.
If Vim is compiled with the |+vartabs| feature then the value of If Vim is compiled with the |+vartabs| feature then the value of
'softtabstop' will be ignored if |'varsofttabstop'| is set to 'softtabstop' will be ignored if |'varsofttabstop'| is set to
@ -9287,36 +9290,40 @@ A jump table for the options with a short description can be found at |Q_op|.
local to buffer local to buffer
{only available when compiled with the |+vartabs| {only available when compiled with the |+vartabs|
feature} feature}
A list of the number of spaces that a <Tab> counts for while editing, Defines variable-width soft tab stops. The value is a comma-separated
such as inserting a <Tab> or using <BS>. It "feels" like variable- list of widths in columns. Each width defines the number of columns
width <Tab>s are being inserted, while in fact a mixture of spaces before the next soft tab stop. The last value repeats indefinitely.
and <Tab>s is used. Tab widths are separated with commas, with the
final value applying to all subsequent tabs.
For example, when editing assembly language files where statements For example, when editing assembly language files where statements
start in the 9th column and comments in the 41st, it may be useful start in the 9th column and comments in the 41st, it may be useful
to use the following: > to use the following: >
:set varsofttabstop=8,32,8 :set varsofttabstop=8,32,8
< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more < This sets soft tab stops at column 8, then at column 40 (8 + 32), and
for every column thereafter. every 8 columns thereafter.
Note that the value of |'softtabstop'| will be ignored while Note: this setting overrides 'softtabstop'.
'varsofttabstop' is set. See section |30.5| of the user manual for detailed explanations on how
Vim works with tabs and spaces.
*'vartabstop'* *'vts'* *'vartabstop'* *'vts'*
'vartabstop' 'vts' string (default "") 'vartabstop' 'vts' string (default "")
local to buffer local to buffer
{only available when compiled with the |+vartabs| {only available when compiled with the |+vartabs|
feature} feature}
A list of the number of spaces that a <Tab> in the file counts for, Defines variable-width tab stops. The value is a comma-separated list
separated by commas. Each value corresponds to one tab, with the of widths in columns. Each width defines the number of columns
final value applying to all subsequent tabs. For example: > before the next tab stop; the last value repeats indefinitely.
:set vartabstop=4,20,10,8
< This will make the first tab 4 spaces wide, the second 20 spaces,
the third 10 spaces, and all following tabs 8 spaces.
Note that the value of |'tabstop'| will be ignored while 'vartabstop' For example: >
is set. :set vartabstop=4,8
< This places the first tab stop 4 columns from the start of the line
and each subsequent tab stop 8 columns apart.
Note: this setting overrides 'tabstop'.
On UNIX, it is recommended to keep the default tabstop value of 8.
Consider setting 'varsofttabstop' instead.
See section |30.5| of the user manual for detailed explanations on how
Vim works with tabs and spaces.
*'verbose'* *'vbs'* *'verbose'* *'vbs'*
'verbose' 'vbs' number (default 0) 'verbose' 'vbs' number (default 0)

8
runtime/doc/quickref.txt
View File

@ -1,4 +1,4 @@
*quickref.txt* For Vim version 9.1. Last change: 2025 Jun 10 *quickref.txt* For Vim version 9.1. Last change: 2025 Jun 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -920,7 +920,7 @@ Short explanation of each option: *option-list*
'smartindent' 'si' smart autoindenting for C programs 'smartindent' 'si' smart autoindenting for C programs
'smarttab' 'sta' <Tab> in leading whitespace indents by 'shiftwidth' 'smarttab' 'sta' <Tab> in leading whitespace indents by 'shiftwidth'
'smoothscroll' 'sms' scroll by screen lines when 'wrap' is set 'smoothscroll' 'sms' scroll by screen lines when 'wrap' is set
'softtabstop' 'sts' number of spaces that <Tab> uses while editing 'softtabstop' 'sts' number of columns between two soft tab stops
'spell' enable spell checking 'spell' enable spell checking
'spellcapcheck' 'spc' pattern to locate end of a sentence 'spellcapcheck' 'spc' pattern to locate end of a sentence
'spellfile' 'spf' files where |zg| and |zw| store words 'spellfile' 'spf' files where |zg| and |zw| store words
@ -987,8 +987,8 @@ Short explanation of each option: *option-list*
'undoreload' 'ur' max nr of lines to save for undo on a buffer reload 'undoreload' 'ur' max nr of lines to save for undo on a buffer reload
'updatecount' 'uc' after this many characters flush swap file 'updatecount' 'uc' after this many characters flush swap file
'updatetime' 'ut' after this many milliseconds flush swap file 'updatetime' 'ut' after this many milliseconds flush swap file
'varsofttabstop' 'vsts' a list of number of spaces when typing <Tab> 'varsofttabstop' 'vsts' a list of number of columns between soft tab stops
'vartabstop' 'vts' a list of number of spaces for <Tab>s 'vartabstop' 'vts' a list of number of columns between tab stops
'verbose' 'vbs' give informative messages 'verbose' 'vbs' give informative messages
'verbosefile' 'vfile' file to write messages in 'verbosefile' 'vfile' file to write messages in
'viewdir' 'vdir' directory where to store files with :mkview 'viewdir' 'vdir' directory where to store files with :mkview