Static man page (#14)#16
Open
juneb125 wants to merge 8 commits into
Open
Conversation
* reformat flags notation using [man-pages(7)](https://man7.org/linux/man-pages/man7/man-pages.7.html) as a style-guide * use font macros (`B`, `I`, etc.) instead of inline font escapes (`\fB`, `\fI`, etc.) * get DESCRIPTION sentence from GitHub repo's description * (+ some other things)
Owner
|
This is awesome stuff, thank you! Buuut. I really want to eliminate multiple sources of truth, because inevitably we will forget to update the manpage as CLI might change... Do you think there are any solutions/mitigations for this? I thought if we could somehow template-in the part of manpage regarding CLI interface but keep your free-flowing description, but not sure if there are existing tools for this. |
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
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.
Closes #14.
Start with the man page generated by clap_mangen:
cargo run -q -- --generate-manpage > meread.1... then improve upon it. Also, update README.md and nix instructions.
Resources: