man
man copied to clipboard
rust-cli
Generate structured man pages
In discussing #31, @yoshuawuyts mentioned that we might be calling `man` differently. That made me realize that we don't _have_ any documentation about the typical way to call `man` (e.g.,...
The `Opt::new` function forces items to labeled `--long=NEW`. Many programs man pages have display options as `--long NEW` or `--long NEW1 NEW2`. Would it be possible in the future to...
This PR adds the API for version and date as discussed in #26. Because the current date would be the date that the man page is generated (which might be...
This PR revises the exit section to allow the user to specify custom status codes and messages to correspond to those codes, implementing the API discussed in #25.
As noted in the comments, the `exit_status` section is currently hard-coded, but should be revised to accept arguments. Specifically, the exit status section will currently always be: ```text EXIT STATUS...
I am including version and date in the same issue because I've checked several man(1) pages and noticed that the formatting of the two is related: specifically, the version will...
I'm thinking almost all sections should be optional, but we want to somewhat restrict which sections are possible. Which sections should we have? From what I've seen, we should probably...
Found myself debugging a tool today, and turned out I had 2 tools installed with duplicate names. The way I found out was thanks to the "source" section in the...
Applies to #10. Per https://github.com/killercup/clap-man-demo/blob/master/build.rs#L17-L19, we should have a method to generate a file name. ## API ### Current ```rust for man in gen_manuals(&app) { let name = "clap-man-demo.1"; //...
The current API is more of a sketch of what this could look like. On chat there seems to be a sentiment that the current API might not suffice for...