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

Add manpage that linux distributions can ship #10544

Open
UnlimitedCookies opened this issue Nov 10, 2024 · 3 comments
Open

Add manpage that linux distributions can ship #10544

UnlimitedCookies opened this issue Nov 10, 2024 · 3 comments

Comments

@UnlimitedCookies
Copy link

Generally I expect a binary like /usr/bin/cabal to be accompanied by a helpful manpage.
This should include available flags/subcommands and perhaps a few examples.

@ffaf1
Copy link
Collaborator

ffaf1 commented Nov 11, 2024

We have (undocumented) cabal man.

@ulysses4ever
Copy link
Collaborator

It'd be nice to have, I agree. The downside is we already have a big issue with our reference manual and cabal --help duplicating each other and wildly diverging at times, with some info available in one but not in the other.

cabal man had little maintenance over the recent years, I think, so I'd expect it to be even more badly outdated. I wish someone worked on making our help pages uniform and produced from a single source of truth. Even providing examples of setups that achieve that would be helpful.

I noticed you can't say cabal man build or such, which would be desirable too.

@UnlimitedCookies
Copy link
Author

It'd be nice to have, I agree. The downside is we already have a big issue with our reference manual and cabal --help duplicating each other and wildly diverging at times, with some info available in one but not in the other.

Perhaps they could be consolidated into one or few sources of information that then get populated into the various sources. The git manpages are a good example for how to do it right, but it seems like they spent quite a lot of effort on that.

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

3 participants