From 17ceb21ae7b8b3e7f82d2d4a1c959c34688f50c6 Mon Sep 17 00:00:00 2001 From: Kaz Kylheku Date: Wed, 22 Jan 2025 20:19:59 -0800 Subject: README: Add Troubleshooting section. --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index b2184c2..e270c71 100644 --- a/README.md +++ b/README.md @@ -74,4 +74,28 @@ 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. +## Troubleshooting +### I see terminal escape sequences in the output! + +This is an issue in some installations of the `man` program from +`man-db`, whereby it is not setting the environment variable +`GROFF_NO_SGR=1` to prevent GNU `groff` from emitting terminal +escapes. Try exporting that environment variable; if the problem goes +away, that is it. + +### I see an error `@page(@section) ... failed to match` + +You are on some Unix system like MacOS; `mnpgr` currently only +works with the `man` program from `man-db` commonly installed +on may GNU/Linux systems, namely +[this one]( https://gitlab.com/man-db/man-db). + +Sorry! + +That implementation of `man` establishes a `MAN_PN` environment +variable whose value we are depending on to get name of the +man page and section number. + +A patch to make `mngpr` work with other `man` implementations +would be welcome. -- cgit v1.2.3