aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDoron Behar <doron.behar@gmail.com>2019-08-28 02:38:58 +0300
committerJustin M. Keyes <justinkz@gmail.com>2019-08-28 01:38:58 +0200
commit3c9c64d9dd486598f36c597da1eaffebb3bf4cef (patch)
tree7751866696f0d13003b9bd47a12846f350fd60ed
parent09cbd6769b737e9de88e9885f19c2bd0f5fa5795 (diff)
downloadrneovim-3c9c64d9dd486598f36c597da1eaffebb3bf4cef.tar.gz
rneovim-3c9c64d9dd486598f36c597da1eaffebb3bf4cef.tar.bz2
rneovim-3c9c64d9dd486598f36c597da1eaffebb3bf4cef.zip
doc: man.vim #10817
ref #10808
-rw-r--r--runtime/doc/filetype.txt15
1 files changed, 12 insertions, 3 deletions
diff --git a/runtime/doc/filetype.txt b/runtime/doc/filetype.txt
index 1f7d09ae32..c579c390c6 100644
--- a/runtime/doc/filetype.txt
+++ b/runtime/doc/filetype.txt
@@ -515,9 +515,6 @@ MAN *ft-man-plugin* *:Man* *man.vim*
View manpages in Nvim. Supports highlighting, completion, locales, and
navigation. Also see |find-manpage|.
-To use Nvim as a manpager: >
- export MANPAGER='nvim +Man!'
-
man.vim will always attempt to reuse the closest man window (above/left) but
otherwise create a split.
@@ -554,6 +551,18 @@ Variables:
:let b:man_default_sections = '3,2'
*g:man_hardwrap* Hard-wrap to $MANWIDTH. May improve layout.
+To use Nvim as a manpager: >
+ export MANPAGER='nvim +Man!'
+
+Note that when running `man` from the shell and with that `MANPAGER` in your
+environment, `man` will pre-format the manpage using `groff`. Thus, Neovim
+will inevitably display the manual page as it was passed to it from stdin. One
+of the caveats of this is that the width will _always_ be hard-wrapped and not
+soft wrapped as with `:Man`. You can set in your environment: >
+ export MANWIDTH=999
+
+So `groff`'s pre-formatting output will be the same as with `:Man` i.e soft-wrapped.
+
PDF *ft-pdf-plugin*
Two maps, <C-]> and <C-T>, are provided to simulate a tag stack for navigating