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

man and info generation #55

Open
defanor opened this issue Oct 9, 2018 · 0 comments
Open

man and info generation #55

defanor opened this issue Oct 9, 2018 · 0 comments

Comments

@defanor
Copy link

defanor commented Oct 9, 2018

It would be nice to generate basic man pages and info manuals out of the information that is already provided for help messages, but currently help2man (versions 1.41.1 and 1.47.4) fails to process cmdargs output well, particularly when modes are used: synopsis doesn't get extracted, different modes fall into the "common flags" section, etc.

One way to solve this is to aim help2man compatibility: though the multi-mode programs are not explicitly covered in its recommendations, it's still possible to rearrange the output so that all the different forms get synopsis lines, and per-mode sections elaborate on those, listing mode-specific options. A nice side effect of such an approach is that users would also get more conventional --help output.

Another approach is to generate those out of cmdArgs annotations, from cmdargs itself (--help=man, --help=info) or an additional library based on it. This could be used simultaneously with the previous one as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant