-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Auto-generate manpage, help docs, etc. #552
Copy link
Copy link
Closed
Labels
A-helpArea: documentation, including docs.rs, readme, examples, etc...Area: documentation, including docs.rs, readme, examples, etc...C-enhancementCategory: Raise on the bar on expectationsCategory: Raise on the bar on expectationsS-blockedStatus: Blocked on something else such as an RFC or other implementation work.Status: Blocked on something else such as an RFC or other implementation work.
Metadata
Metadata
Assignees
Labels
A-helpArea: documentation, including docs.rs, readme, examples, etc...Area: documentation, including docs.rs, readme, examples, etc...C-enhancementCategory: Raise on the bar on expectationsCategory: Raise on the bar on expectationsS-blockedStatus: Blocked on something else such as an RFC or other implementation work.Status: Blocked on something else such as an RFC or other implementation work.
Maintainer notes:
I'd love to have support to generate a manpage. This would use a mechanism and infrastructure similar to #376. Additional functions to override or augment portions of the generated manpage could come later, but I think with relatively few additions this could become an incredibly useful mechanism.
bin_namevalue.1.NAMEsection should default tobin_name \- about, whereaboutis the string set by.about.SYNOPSISsection should contain the usage strings for the command and every subcommand.DESCRIPTIONsection would need some new paragraph-style information provided (also usable as a more structured.before_help).AUTHORSsection should contain the author information, if provided.SEE ALSOsection would need some new mechanism to populate it.I'd be happy to help with manpage markup, once I see the details of the mechanism used in #376.