Bug: man page and --help are not consistent

[zachriggle]

Thanks again @chmln for creating a neat tool -- and thanks for bothering to create a man page at all, it's a rarity for FOSS command line tools.

Currently, the --help and man sd output each have different details listed.

• --help is missing the EXAMPLES that the manpage has
• man is missing some of the list of valid values for --flags, and is not formatted well
• man and --help disagree on the names of the arguments (e.g. replace-with vs replace_with)
• --help is missing the return codes

[xixixao]

I'll tack on here that for me on macOS the man page doesn't render examples correctly:

 Regex use. Let's trim some trailing whitespace
              $ echo 'lorem ipsum 23   ' | sd '' ''
              lorem ipsum 23

this is what I see in man sd, but the build.rs shows that it should include sd '\\s+$' ''

[nc7s]

If help message and man page can be unified then help2man might help.

[vassudanagunta]

I'll tack on here that for me on macOS the man page doesn't render examples correctly:

 Regex use. Let's trim some trailing whitespace
              $ echo 'lorem ipsum 23   ' | sd '' ''
              lorem ipsum 23

I came here to report this as a bug. It is far more harmful than the man page and help page simply being different, thus deserving its own issue: #226.

[alerque]

Instead of help2man this project should use the clap_mangen package to regenerate man pages that exactly match the CLI parsing at build time.

See also my comment here.

[CosmicHorrorDev]

This should be fixed with the merge of #231