Convert man pages to mdoc, clean up usage help text #1609
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rdmark
force-pushed
the
rdmark-docs-touchup
branch
4 times, most recently
from
07a54fe to
2d880e9
Compare
nucleogenic
approved these changes
Dec 23, 2025
The mdoc markup makes for a more semantic and less formatting heavy syntax Includes a number of improvements: - List all options in alphabetic order - Split out the synopsis for commands that has to be run by themselves - Move the scsimon Usage helptext from the app to the man page - Corrections of typos and updates of outdated information
This will reduce the recurring maintenance overhead of keeping the same information up to date in multiple places Only the most common use cases are covered in the usage help text now
rdmark
force-pushed
the
rdmark-docs-touchup
branch
from
2d880e9 to
4c2c161
Compare
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This changeset contains two major changes:
The mdoc markup makes for a more semantic and less formatting heavy syntax
Includes a number of improvements:
This will reduce the recurring maintenance overhead of keeping the same information up to date in multiple places
Only the most common use cases are covered in the usage help text now