-
Notifications
You must be signed in to change notification settings - Fork 36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
rewrite manpages in mdoc(7) #91
Open
janstary
wants to merge
7
commits into
libsndfile:master
Choose a base branch
from
janstary:manpages
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Commits on May 22, 2024
-
rewrite sndfile-mix-to-mono(1) on mdoc(7)
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.
Configuration menu - View commit details
-
Copy full SHA for 5836a07 - Browse repository at this point
Copy the full SHA 5836a07View commit details -
Configuration menu - View commit details
-
Copy full SHA for 16f6c53 - Browse repository at this point
Copy the full SHA 16f6c53View commit details -
Configuration menu - View commit details
-
Copy full SHA for c826597 - Browse repository at this point
Copy the full SHA c826597View commit details -
Configuration menu - View commit details
-
Copy full SHA for 3106eaf - Browse repository at this point
Copy the full SHA 3106eafView commit details
Commits on May 26, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 6cbe557 - Browse repository at this point
Copy the full SHA 6cbe557View commit details -
rewrite sndfile-waveform(1) in mdoc(7)
This one was a gem: help2man like it's the nineties. While here, remove the note to not touch the manpage.
Configuration menu - View commit details
-
Copy full SHA for f69998b - Browse repository at this point
Copy the full SHA f69998bView commit details -
Configuration menu - View commit details
-
Copy full SHA for e03c49f - Browse repository at this point
Copy the full SHA e03c49fView commit details
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.