Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for reading docs in terminals #71

Open
shym opened this issue Oct 26, 2023 · 1 comment
Open

Support for reading docs in terminals #71

shym opened this issue Oct 26, 2023 · 1 comment

Comments

@shym
Copy link

shym commented Oct 26, 2023

This is a feature request.
In some contexts, man pages are handier than html pages (for accessibility, for instance).
Could Odig provide a command to build the manpages?

@dbuenzli
Copy link
Collaborator

dbuenzli commented Oct 26, 2023

Manpages are ill suited for the highly hyperlinked and cross referenced docs that odig generates1

However in the next release – which I hope will happen before the end of the year – I plan to add an odig man [MODULE|PKG] command which will directly load the corresponding page in a text mode browser like w3m. Basically a shortcut for:

w3m $(odig doc -f cmdliner)

Footnotes

  1. I personally find that generating manpages from the documentation I write is an insult to all the work that goes in producing them.

@dbuenzli dbuenzli changed the title Support for the generation of manpages Support for reading docs in terminals Oct 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants