Add the ability to generate manpages #7
Merged
Conversation
This file contains 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
Add a config field with initial ideas about where manpages should be placed on a few operating system types: Linux, macOS, MinGW64 on Windows (used by git-bash, for instance). Plumb in the new subcommand, but don't make it do anything yet, other than print out this path. Add this path and detected OS to the output of `info`. Also, re-alphabetize the README and other places that list all subcommands.
This translates the `clap::App` to a `man::Manual` and prints it to STDOUT. Ideally, `clap` would do this for us (e.g., as described in https://rust-cli.github.io/book/in-depth/docs.html), but it's not implemented yet in clap 3 as far as I can tell.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This partially addresses the request in #5. A new binary,
generate-manpage, can be used to create a manpage, which can then be installed by the user wherever manpages go. A new subcommand,install-manpage, suggests where such a file should be placed, but doesn't do it (yet?).