Generate manual pages from the clap documentation #167

Open
opened 2025-12-13 16:40:19 +01:00 by oysteikt · 2 comments
Owner

manpages can be nice, even if they just repeat the same information as --help

manpages can be nice, even if they just repeat the same information as `--help`
oysteikt added the documentation label 2025-12-13 16:40:19 +01:00
oysteikt added this to the Initial release milestone 2025-12-13 16:49:34 +01:00
Author
Owner

This seems to be broken with clap_mangen, I believe it has to do with the way we flatten subcommands. Are we doing this wrong, or is it just not supported?

This seems to be broken with `clap_mangen`, I believe it has to do with the way we flatten subcommands. Are we doing this wrong, or is it just not supported?
oysteikt added a new dependency 2025-12-16 05:16:19 +01:00
oysteikt removed this from the Initial release milestone 2025-12-16 07:20:30 +01:00
Author
Owner

clap_mangen works well with the subcommands now, but it does not render newlines and such easily. However, the library exposes it's roff generation tool, so we could make our own transformations and render the manpages more manually.

The name, synopsis, subcommands, options sections look pretty good at least.

`clap_mangen` works well with the subcommands now, but it does not render newlines and such easily. However, the library exposes it's roff generation tool, so we could make our own transformations and render the manpages more manually. The name, synopsis, subcommands, options sections look pretty good at least.
oysteikt added reference manpages 2026-01-09 12:48:44 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Reference: Projects/muscl#167