aboutsummaryrefslogtreecommitdiff
path: root/vim/doc
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2017-11-04 18:48:22 +1300
committerTom Ryder <tom@sanctum.geek.nz>2017-11-04 18:48:22 +1300
commit63087e57b8b1aa030b431b86f3be533ee20f07dc (patch)
treed9c129817e6e9722bdd8c559dc2f341991b68040 /vim/doc
parentMerge branch 'hotfix/v0.6.1' (diff)
parentUpdate dotfiles(7) manual from README.md (diff)
downloaddotfiles-0.7.0.tar.gz (sig)
dotfiles-0.7.0.zip
Merge branch 'release/v0.7.0'v0.7.0
* release/v0.7.0: (21 commits) Update dotfiles(7) manual from README.md Bump version number Add heading for Vim plugins subsection Update README to mention Vim plugins Rename toggle plugin again, use commands not funcs Add short documentation for new custom plugins Use same comment boilerplate for custom plugins Check 'eval' feature for loading command_typos.vim Wrap detect_background.vim func call in 'silent!' Rename and refactor option toggle plugin Don't suggest mappings in Vim plugin comments Move Vim background detection logic into plugin Specify an install-vim-autoload target Spin 'fo' toggle out into new flag toggler plugin Spin copyable linebreak config into new plugin Spin stable join config out into new plugin Use <Plug> prefix, make space strip configurable Rename a misnamed variable in big_file.vim Rename bigfile plugin to big_file Move trailing space strip config into plugin ...
Diffstat (limited to 'vim/doc')
-rw-r--r--vim/doc/big_file.txt (renamed from vim/doc/bigfile.txt)2
-rw-r--r--vim/doc/command_typos.txt12
-rw-r--r--vim/doc/copy_linebreak.txt13
-rw-r--r--vim/doc/detect_background.txt14
-rw-r--r--vim/doc/fixed_join.txt11
-rw-r--r--vim/doc/strip_trailing_whitespace.txt12
-rw-r--r--vim/doc/toggle_option_flag.txt16
7 files changed, 79 insertions, 1 deletions
diff --git a/vim/doc/bigfile.txt b/vim/doc/big_file.txt
index d7e56f28..aea0ee79 100644
--- a/vim/doc/bigfile.txt
+++ b/vim/doc/big_file.txt
@@ -1,4 +1,4 @@
-*bigfile.txt* Disable slow options for big files to speed things up
+*big_file.txt* Disable slow options for big files to speed things up
Author: Tom Ryder <tom@sanctum.geek.nz>
License: Same terms as Vim itself (see |license|)
diff --git a/vim/doc/command_typos.txt b/vim/doc/command_typos.txt
new file mode 100644
index 00000000..93f37df9
--- /dev/null
+++ b/vim/doc/command_typos.txt
@@ -0,0 +1,12 @@
+*command_typos.txt* Bind capital-letter versions of common commands
+
+Author: Tom Ryder <tom@sanctum.geek.nz>
+License: Same terms as Vim itself (see |license|)
+
+This plugin defines custom commands like :W, :Qa, and :Wq to match their
+lowercase analogues, to forgive me when my pinky finger doesn't roll off the
+Shift key quite soon enough after pressing the colon key.
+
+This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun
+off into a separate distribution as it solidifies and this documentation
+improves.
diff --git a/vim/doc/copy_linebreak.txt b/vim/doc/copy_linebreak.txt
new file mode 100644
index 00000000..c8463386
--- /dev/null
+++ b/vim/doc/copy_linebreak.txt
@@ -0,0 +1,13 @@
+*copy_linebreak.txt* Mapping to toggle copy-paste friendly linebreak options
+
+Author: Tom Ryder <tom@sanctum.geek.nz>
+License: Same terms as Vim itself (see |license|)
+
+This plugin provides a mapping target <Plug>CopyLinebreak to create a binding
+for a user to quickly toggle |'linebreak'|-related settings when |'wrap'| is
+enabled, to switch between human-readable output and a format friendly for
+copy-pasting with terminal emulators or screen/tmux.
+
+This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun
+off into a separate distribution as it solidifies and this documentation
+improves.
diff --git a/vim/doc/detect_background.txt b/vim/doc/detect_background.txt
new file mode 100644
index 00000000..ad42221c
--- /dev/null
+++ b/vim/doc/detect_background.txt
@@ -0,0 +1,14 @@
+*detect_background.txt* Figure out 'background' with a bias towards "dark"
+
+Author: Tom Ryder <tom@sanctum.geek.nz>
+License: Same terms as Vim itself (see |license|)
+
+This plugin inspects the $COLORFGBG environment variable to determine whether
+the user is using a terminal with a light background. It reverses Vim's
+built-in attempts to do this, which have the opposite default.
+
+It does not inspect the value of the $TERM variable or |'term'| at all.
+
+This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun
+off into a separate distribution as it solidifies and this documentation
+improves.
diff --git a/vim/doc/fixed_join.txt b/vim/doc/fixed_join.txt
new file mode 100644
index 00000000..0ee957d0
--- /dev/null
+++ b/vim/doc/fixed_join.txt
@@ -0,0 +1,11 @@
+*fixed_join.txt* Mapping to join lines in normal mode without moving cursor
+
+Author: Tom Ryder <tom@sanctum.geek.nz>
+License: Same terms as Vim itself (see |license|)
+
+This plugin provides a mapping target <Plug>FixedJoin to create a binding for a
+user to join lines in normal mode without the cursor jumping around.
+
+This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun
+off into a separate distribution as it solidifies and this documentation
+improves.
diff --git a/vim/doc/strip_trailing_whitespace.txt b/vim/doc/strip_trailing_whitespace.txt
new file mode 100644
index 00000000..670877c9
--- /dev/null
+++ b/vim/doc/strip_trailing_whitespace.txt
@@ -0,0 +1,12 @@
+*strip_trailing_whitespace.txt* Strip trailing whitespace from whole buffer
+
+Author: Tom Ryder <tom@sanctum.geek.nz>
+License: Same terms as Vim itself (see |license|)
+
+This plugin is the author's approach to stripping trailing whitespace from an
+entire buffer, including empty lines at the end, without making command noise
+and without moving the cursor from its current position.
+
+This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun
+off into a separate distribution as it solidifies and this documentation
+improves.
diff --git a/vim/doc/toggle_option_flag.txt b/vim/doc/toggle_option_flag.txt
new file mode 100644
index 00000000..16557d5c
--- /dev/null
+++ b/vim/doc/toggle_option_flag.txt
@@ -0,0 +1,16 @@
+*toggle_option_flag.txt* Commands to toggle single-character option flags
+
+Author: Tom Ryder <tom@sanctum.geek.nz>
+License: Same terms as Vim itself (see |license|)
+
+This plugin provides commands :ToggleOptionFlag and :ToggleOptionFlagLocal to
+toggle the values of options like |'formatoptions'| or |'complete'| that have
+values comprised of single-character flags. The author originally designed it
+for toggling flags in |'formatoptions'| quickly.
+
+ :ToggleOptionFlag formatoptions a
+ :ToggleOptionFlagLocal shortmess I
+
+This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun
+off into a separate distribution as it solidifies and this documentation
+improves.