Authoring man pages with mdoc(7)

Further to my post “Why i like mdoc(7) for man pages”[a], i've now written a quickstart guide to encourage people to use mdoc(7)[b] when authoring man pages.

“Writing man pages with mdoc(7): a quickstart guide”

The guide gives some historical background, explains why the mdoc(7) language should be preferred over the man(7) language (and why Markdown is a bad language for man page authoring), briefly covers the existence of both groff and mandoc, then systematically works through a small example that (hopefully!) shows how easy it us to use mdoc(7). Finally, it finishes off with information about where to find more detailed documentation.

☙

🏷 dev,documentation,ict

Glossary

Gemlog Home

☙

[a] “Why i like mdoc(7) for man pages”

Man page: mdoc(7)