summaryrefslogtreecommitdiff
path: root/opt/sleuth/doc/sleuth.txt
diff options
context:
space:
mode:
authorMichael Smith <mikesmiffy128@gmail.com>2022-05-22 22:47:23 +0100
committerMichael Smith <mikesmiffy128@gmail.com>2022-05-22 22:47:23 +0100
commit95aea6b533e71e478d61d18fac71cca116c56a4d (patch)
tree1a1f42f723772258cc54551495826768f374474a /opt/sleuth/doc/sleuth.txt
Add all the plugins I currently use
Diffstat (limited to 'opt/sleuth/doc/sleuth.txt')
-rw-r--r--opt/sleuth/doc/sleuth.txt34
1 files changed, 34 insertions, 0 deletions
diff --git a/opt/sleuth/doc/sleuth.txt b/opt/sleuth/doc/sleuth.txt
new file mode 100644
index 0000000..76832a0
--- /dev/null
+++ b/opt/sleuth/doc/sleuth.txt
@@ -0,0 +1,34 @@
+*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*
+
+This plugin automatically adjusts 'shiftwidth' and 'expandtab' heuristically
+based on the current file, or, in the case the current file is new, blank, or
+otherwise insufficient, by looking at other files of the same type in the
+current and parent directories. In lieu of adjusting 'softtabstop',
+'smarttab' is enabled.
+
+ *:Sleuth*
+:Sleuth Manually detect indentation.
+
+ *SleuthIndicator()*
+SleuthIndicator() Indicator for inclusion in 'statusline'. Or use
+ flagship.vim to have it included automatically.
+
+SETTINGS *sleuth-settings*
+
+Automatic detection of buffer options can be controlled with:
+>
+ let g:sleuth_automatic = 0
+<
+or:
+>
+ let b:sleuth_automatic = 0
+<
+ vim:tw=78:et:ft=help:norl: