rewrite manpages in mdoc(7)#91
Open
janstary wants to merge 7 commits intolibsndfile:masterfrom
Open
Conversation
Currently, the manpages of sndfile-tools are written using the legacy man(7) markup language. I propose to rewrite them into the markup of mdoc(7), (like with libsndfile some years ago, and sndfile-resample which has since been moved here). As an example, here is a rewrite of sndfile-mix-to-mono, being the shortest of course :-) The main advantage is that the mdoc(7) language, available for decades alongside man(7), is semantical and describes the intent, as opposed the the low-level formatting of roff(7). For example: .Fl w Op Ar port means there is a -w option which takes an optional 'port' argument; as opposed to .BR \-w [ =\fIport ] which says switch to bold, type a hyphen and a 'w', then switch to italics, and type out 'port' in brackets. Both languages are well supported since the eighties; nowadays, the prevalent formatters are groff on the linuxes and mandoc on the BSDs and macOS.
Author
|
@evpobr , if you decide to merge, please don't close the PR just yet: |
janstary
changed the title
Author
|
I have no system with JACK, so please someone test that the options of sndfile-jackplay |
Just link to the homepage.
This one was a gem: help2man like it's the nineties. While here, remove the note to not touch the manpage.
Author
|
OK, it's done. Is there any interest in this? |
Author
|
(I only added the copyright line because the pre-commit hook required it.) |
Author
|
Is there any interest in this please? |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Currently, the manpages of sndfile-tools are written using the legacy man(7) markup language.
I propose to rewrite them into the markup of mdoc(7), (like with libsndfile some years ago,
and sndfile-resample which has since been moved here).
As an example, here is a rewrite of sndfile-mix-to-mono, being the shortest of course :-)
The main advantage is that the mdoc(7) language, available for decades alongside man(7),
is semantical and describes the intent, as opposed the the low-level formatting of roff(7).
For example:
.Fl w Op Ar port
means there is a -w option which takes an optional 'port' argument; as opposed to
.BR -w [ =\fIport ]
which says switch to bold, type a hyphen and a 'w', then switch to italics, and type out 'port' in brackets.
Both languages are well supported since the eighties; nowadays, the prevalent formatters
are groff on the linuxes and mandoc on the BSDs and macOS.