docopt / docopt.rs

Docopt for Rust (command line argument parser).
The Unlicense
754 stars 83 forks source link

Feature request: generate manpage #151

Open englishm opened 8 years ago

englishm commented 8 years ago

This may be out of scope, but...

It'd be really nice to have a way to generate a manpage (or at least part of one) from the same USAGE section used to define the actual argument parsing.

For reference: tobimensch/cli2man represents a start toward realizing such a thing in Python (though it hasn't been touched in almost a year).

Ideally, I'd like to be able to generate a complete manpage from a combination of docopts usage message parsing and some other human readable source (i.e. markdown a la ronn). The goal being to prevent mistakes where the manpage gets out of sync with the actual options by maintaining only a single definition.

BurntSushi commented 8 years ago

I think this would be very cool!