[vim/vim] Explain how to use manpager.vim with mandoc (PR #21424)

[delreluca]

What does this change do?

Adjusts the instructions in manpager.vim's help for mandoc's frontend.

mandoc does not write the man page to stdout, instead it creates a temporary file whose path is passed as argument.

The current instructions use - so vim will read from stdin which will hang in that constellation.

A small wrapper script is suggested in the help in case anyone needs to support both behaviours.

Commit message

Problem:  Following the instructions manpager.vim's help does not work
          for mandoc's man frontend
Solution: Explain how to set up MANPAGER for mandoc

AI assistance

• AI involvement is disclosed in the commit message, or no AI was used

Checklist

• The commit message follows the Problem/Solution form above
• Signed-off-by: trailer is present (git commit -s), recommended but not required
• Tests were added, existing tests cover the change, or the change cannot be tested (say why)
• Documentation under runtime/doc/ was updated, or no update is needed

Anything reviewers should know

I have approached the maintainer of manpager.vim with the following suggestions

1. Point out that mandoc needs a different command as an additional paragraph in the help section
2. Also point out the script for cross-platform scenarios
3. Bundle the script with vim and adjust the help to reference it

and they said to go for 1+2.

No test was added, because I assume looking at the help file is enough.

---

You can view, comment on, or merge this pull request online at:

  https://github.com/vim/vim/pull/21424

Commit Summary

• ff79fd4 Explain how to use manpager.vim with mandoc

File Changes

(1 file)

• M runtime/doc/filetype.txt (15)

Patch Links:

• https://github.com/vim/vim/pull/21424.patch
• https://github.com/vim/vim/pull/21424.diff

—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.Message ID: <vim/vim/pull/21424@github.com>

[Christian Brabandt]

chrisbra left a comment (vim/vim#21424)

thanks

—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!

You are receiving this because you are subscribed to this thread.Message ID: <vim/vim/pull/21424/c5937061276@github.com>