aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2023-10-13 17:24:41 -0700
committerKaz Kylheku <kaz@kylheku.com>2023-10-13 17:24:41 -0700
commit835eee85a6189d7aff112a0cd1c186ceb1f00cf3 (patch)
treed60ba995aa95a3f8a8dc333b0822dc7355749706
parent183ca5d931335df5f81eaa7bba3d619521769e25 (diff)
downloadmnpgr-835eee85a6189d7aff112a0cd1c186ceb1f00cf3.tar.gz
mnpgr-835eee85a6189d7aff112a0cd1c186ceb1f00cf3.tar.bz2
mnpgr-835eee85a6189d7aff112a0cd1c186ceb1f00cf3.zip
README: some explanations why.
-rw-r--r--README.md17
1 files changed, 15 insertions, 2 deletions
diff --git a/README.md b/README.md
index e0916d9..47b8a24 100644
--- a/README.md
+++ b/README.md
@@ -3,9 +3,16 @@
`mnpgr` is a tiny TXR Lisp program that allows Vim to be used as a pager for
reading man pages.
+It works in such a way that Vim will remember your last position in each
+man page (if Vim is configured to remember file positions).
+
The program handles the backspace-driven overstrikes that indicate italic,
bold and italic+bold text, translating them to a notation which is
-colorized by the Vim syntax provided in `mnpgr.vim`.
+colorized by the Vim syntax provided in `mnpgr.vim`. Thus it has accurate
+syntax coloring, like what you see `less`.
+
+Because `mngpr` itself resolves the overstrikes, the resulting rendering
+in Vim is searchable.
## Installation
@@ -43,7 +50,9 @@ otherwise you have to remember to `chmod +x mnpgr.tlo`.
This doesn't handle the backspace overstrikes output by `man`; it can
only be used on `man` output that has been stripped of the overstrikes.
-That will then not highlight keywords in the text.
+
+That will then not highlight keywords in the text; there is only a half-baked
+highlighting that handles section headings and a few other things
Vim can be coaxed into handling backspace overstrikes by tweaks to
the `ctrlh` syntax it comes with.
@@ -56,4 +65,8 @@ overstrikes is retained under the hood.
The `mnpgr` project started as an answer to a
[Unix StackExchange](https://unix.stackexchange.com/questions/758676/open-man-or-info-pages-from-the-same-position-where-you-left-off-last-time)
question, where that was the initial solution.
+The question is specifically about saving the last position.
+If Vim alone is used as a pager without a shim script between it
+and `man`, it will not save the last position.
+