[LAU] [semi-OT] Writiing manpages (the practical way)

Ferenc W√°gner wferi at niif.hu
Wed Apr 22 12:20:08 CEST 2020


"Jeanette C." <julien at mail.upb.de> writes:

> I'd like to write a manpage for a small program that I have and I'd
> also like to practise. So I've been wondering what the real developers
> use.
>
> Are you writing your manpages straight in (G)ROFF or is there a
> "modern" pre-preprocessor that is widely used?

Straight groff isn't too bad, though I'm an old-school LaTeX fan.
Anyway, man(7) provides usable documentation.  I'd expect CMake to
support it, but I've got Automake experience only.

I also use pod2man, mostly for scripts which can easily embed their
documentation.  This helps with not forgetting to update the manpage,
but isn't standard and somewhat limiting with fancy stuff.

For API documentation (not for now) there is doxygen2man.
-- 
Feri


More information about the Linux-audio-user mailing list