aitjcize / aitjcize/cppman

No links in man pages accessed through `man`

Open
#130 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.4k
Forks
89
PR merge metrics
No merged PRs in 30d

Description

I would like to read the C++ man pages using the standard man command. So I ran cppman -m true, and after that I can access the man pages (after having created ~/.manpath which seems to be necessary). There is a problem though where no links are visible in the man pages when accessed through man instead of cppman. For example for std::vector this is what I get after cppman std::vector:

image

and the same page after man std::vector:

image

Note that all links are missing in the latter case. Is this known behavior, some issue on my side, or a bug? I am using Neovim as my man pager using: MANPAGER=/bin/sh -c "col -b | nvim -c 'set ft=man ts=8 nomod nolist nonu noma' -". Other man pages do show links. This is using cppman 0.5.3.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the issue with cppman -m true, man std::vector, and the supplied MANPAGER configuration, comparing the rendered output from each path. Trace the man-page generation and installation flow in cppman to find where link information is lost. Done means links remain visible when pages are opened through the standard man command.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.