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

Use help2man to generate interim man page #456

Closed
casey opened this issue Jul 7, 2019 · 0 comments · Fixed by #463
Closed

Use help2man to generate interim man page #456

casey opened this issue Jul 7, 2019 · 0 comments · Fixed by #463

Comments

@casey
Copy link
Owner

casey commented Jul 7, 2019

Eventually, I'd like to have a voluminous man page that includes:

  • Documentation of command line syntax (autogenerated by clap)
  • The contents of the current readme (generated using asciidoctor's roff backend)
  • The just file grammar

However, this is waiting on a few things, mostly for me to get to it, and for clap to land man page generation support.

In the mean time, @NickeZ who's working on packaging just for Debian, mentioned that we could use the help2man utility to generate a serviceable man page from the output of just --help.

This seems like a good interim step. In order to make sure that the man page is consistent across packages, we should build it and check it in to the repository as man/just.1

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

Successfully merging a pull request may close this issue.

1 participant