Skip to content

Commit

Permalink
doc: refactor manpage to use mdoc(7) macros
Browse files Browse the repository at this point in the history
Like man(7), mdoc(7) is a macro package for marking up computer manuals.
The main difference is that mdoc is semantic rather than presentational,
providing authors with a full DSL to abstract page markup from low-level
Roff commands. By contrast, `man` is minimalist and leaves formatting to
the author, who is expected to have a working amount of Roff knowledge.

Therefore the use of `mdoc` for marking up Node's manpage is a decidedly
better choice than bare `man`. Less room is left for error and mandoc(1)
offers very robust error-checking and linting.

PR-URL: #18559
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
  • Loading branch information
Alhadis authored and MylesBorins committed Feb 21, 2018
1 parent 253c030 commit ab4365e
Showing 1 changed file with 353 additions and 341 deletions.
Loading

0 comments on commit ab4365e

Please sign in to comment.