docs: use clap_mangen and roff to generate manpage #231
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CosmicHorrorDev
approved these changes
Oct 2, 2023
Collaborator
CosmicHorrorDev
left a comment
There was a problem hiding this comment.
Thanks for taking this on! This is a huge improvement over the existing manpage
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #226.
cargo xtask gen && man gen/sd.1to try it out.I think this also fixes (?) #134, including list of flags and its formatting, and return codes. Unfornutaly clap_mangen has no custom section support (yet), so I've learned from clap-rs/clap#3579 and used roff to make the EXIT STATUSES and EXAMPLES sections.
Note that the list of flags formatting is "fixed" with separating each flag into its own paragraph, but that should be tolerable I guess.