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

[Dennis Schulmeister-Zimolong]

Hi all,

I can also recommend help2man, provided the program follows the general
--help and --version convention. I had very good experience with it for
some of my python programs. help2man takes the output of the program
to generate the man page and merges it with a custom groff/text file
for additional sections.

Kind regards,
Dennis

On Wed, 22 Apr 2020 12:52:42 +0200
Jacob <jacob01 at gmx.net> wrote:

> On 22.04.20 11:12, Jeanette C. wrote:
> > Hey hey,
> > 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.
> 
> I have been using the help2man program in such cases which creates a
> man page by running your executable using the --help and --version
> options (which should follow the GNU guidelines) and parsing the
> output. You can either tweak the output by using command line options
> or at least use it as starting point for further modifications.
> 
> HTH
> Jacob
> _______________________________________________
> Linux-audio-user mailing list
> Linux-audio-user at lists.linuxaudio.org
> https://lists.linuxaudio.org/listinfo/linux-audio-user