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

RFE: consider adding man pages #5524

Open
cuviper opened this issue Aug 29, 2022 · 2 comments
Open

RFE: consider adding man pages #5524

cuviper opened this issue Aug 29, 2022 · 2 comments

Comments

@cuviper
Copy link
Member

cuviper commented Aug 29, 2022

It is generally expected that CLI programs on unix-like systems should have a man page. Elsewhere in the Rust toolchain, we do have rustc.1, rustdoc.1, cargo.1, and many cargo-*.1 subcommands. It seems reasonable that we could have rustfmt.1 and cargo-fmt.1 as well.

See also rust-lang/rust#98977 for discussion about autogenerating man pages.

@calebcartwright
Copy link
Member

This is a fair ask, though not sure when we'll have capacity to get around to it

@davidBar-On
Copy link
Contributor

I am willing to help with this issue, but I am not sure what is the scope of the required solution. Is it only creating a man page file similar to this rustfmt.1t file - created mainly using help2man (its man output text is here)? Are additional activities required, such as automatic install of the file as part of rustfmt install (which I have no idea how to do ...)?

I assume that automatic generation of the man page is not required, as it is also not implemented yet for rustc/rustdoc.

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