Regenerate nvim config
This commit is contained in:
82
config/neovim/store/lazy-plugins/vim-sleuth/doc/sleuth.txt
Normal file
82
config/neovim/store/lazy-plugins/vim-sleuth/doc/sleuth.txt
Normal file
@ -0,0 +1,82 @@
|
||||
*sleuth.txt* Heuristically set buffer options
|
||||
|
||||
Author: Tim Pope <http://tpo.pe/>
|
||||
Repo: https://github.com/tpope/vim-sleuth
|
||||
License: Same terms as Vim itself (see |license|)
|
||||
|
||||
This plugin is only available if 'compatible' is not set.
|
||||
|
||||
SUMMARY *sleuth*
|
||||
|
||||
Automatic detection happens on the |BufNewFile|, |BufReadPost|, and
|
||||
|BufFilePost| events. Sleuth first consults modelines, then EditorConfig
|
||||
(https://editorconfig.org) files. If neither of these produces a value for
|
||||
'expandtab' and 'shiftwidth', a heuristic algorithm is used to guess them,
|
||||
first on the current file, and then on other files with the same extension in
|
||||
the same and parent directories.
|
||||
|
||||
The full list of detected options is as follows:
|
||||
|
||||
Vim Option Safe? EditorConfig key ~
|
||||
'filetype' Y vim_filetype
|
||||
'expandtab' Y indent_style
|
||||
'shiftwidth' Y indent_size
|
||||
'tabstop' Y tab_width
|
||||
'textwidth' Y max_line_length
|
||||
'fixendofline' Y insert_final_newline
|
||||
'endofline' insert_final_newline
|
||||
'fileformat' end_of_line
|
||||
'fileencoding' charset
|
||||
'bomb' charset
|
||||
|
||||
Options marked "safe" are those guaranteed not to toggle 'modified'. These
|
||||
are the only options that will be set in 'nomodifiable' buffers, and the only
|
||||
options that Sleuth will detect in a modeline. Safe options will also be
|
||||
reapplied on every |FileType| event, so that they can override any |ftplugin|
|
||||
settings.
|
||||
|
||||
Sleuth always sets 'softtabstop' to -1, effectively mirroring 'shiftwidth'.
|
||||
|
||||
INTERFACE *sleuth-interface*
|
||||
|
||||
*:Sleuth*
|
||||
:Sleuth Manually detect indentation.
|
||||
|
||||
:verbose Sleuth Manually detect indentation, and display the reason
|
||||
each option was set.
|
||||
|
||||
*SleuthIndicator()*
|
||||
SleuthIndicator() Indicator for inclusion in 'statusline'. Or use
|
||||
flagship.vim to have it included automatically.
|
||||
|
||||
CONFIGURATION *sleuth-configuration*
|
||||
|
||||
To override detection and force options for a particular file or directory,
|
||||
use a |modeline| or EditorConfig (https://editorconfig.org/), respectively.
|
||||
|
||||
*g:sleuth_{filetype}_heuristics*
|
||||
To disable the heuristic algorithm for a given 'filetype', assign a false
|
||||
value to a variable named like g:sleuth_{filetype}_heuristics:
|
||||
>
|
||||
let g:sleuth_gitcommit_heuristics = 0
|
||||
<
|
||||
*g:sleuth_heuristics*
|
||||
Alternatively, one can disable heuristics by default, and opt-in for
|
||||
individual file types:
|
||||
>
|
||||
let g:sleuth_heuristics = 0
|
||||
let g:sleuth_perl_heuristics = 1
|
||||
<
|
||||
*g:sleuth_automatic*
|
||||
Sleuth used to support setting g:sleuth_automatic to a false value and instead
|
||||
calling :Sleuth selectively from |FileType| autocommands. This will no longer
|
||||
work quite right, and thus g:sleuth_automatic has been deprecated in favor of
|
||||
the heuristics options above.
|
||||
|
||||
*g:sleuth_no_filetype_indent_on*
|
||||
Sleuth forces |:filetype-indent-on| by default, which enables file-type
|
||||
specific indenting algorithms and is highly recommended. To opt out:
|
||||
>
|
||||
let g:sleuth_no_filetype_indent_on = 1
|
||||
<
|
||||
vim:tw=78:et:ft=help:norl:
|
||||
10
config/neovim/store/lazy-plugins/vim-sleuth/doc/tags
Normal file
10
config/neovim/store/lazy-plugins/vim-sleuth/doc/tags
Normal file
@ -0,0 +1,10 @@
|
||||
:Sleuth sleuth.txt /*:Sleuth*
|
||||
SleuthIndicator() sleuth.txt /*SleuthIndicator()*
|
||||
g:sleuth_automatic sleuth.txt /*g:sleuth_automatic*
|
||||
g:sleuth_heuristics sleuth.txt /*g:sleuth_heuristics*
|
||||
g:sleuth_no_filetype_indent_on sleuth.txt /*g:sleuth_no_filetype_indent_on*
|
||||
g:sleuth_{filetype}_heuristics sleuth.txt /*g:sleuth_{filetype}_heuristics*
|
||||
sleuth sleuth.txt /*sleuth*
|
||||
sleuth-configuration sleuth.txt /*sleuth-configuration*
|
||||
sleuth-interface sleuth.txt /*sleuth-interface*
|
||||
sleuth.txt sleuth.txt /*sleuth.txt*
|
||||
Reference in New Issue
Block a user