Skip to content
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
wants to merge 7 commits into
base: master
Choose a base branch
from

Commits on May 22, 2024

  1. 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.
    janstary committed May 22, 2024
    Configuration menu
    Copy the full SHA
    5836a07 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    16f6c53 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    c826597 View commit details
    Browse the repository at this point in the history
  4. There is no libsndfile(3) manpage

    Just link to the homepage.
    janstary committed May 22, 2024
    Configuration menu
    Copy the full SHA
    3106eaf View commit details
    Browse the repository at this point in the history

Commits on May 26, 2024

  1. Configuration menu
    Copy the full SHA
    6cbe557 View commit details
    Browse the repository at this point in the history
  2. 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.
    janstary committed May 26, 2024
    Configuration menu
    Copy the full SHA
    f69998b View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    e03c49f View commit details
    Browse the repository at this point in the history