helpm2pod - convert a specially formatted help text to POD
helpm2pod -h
helpm2pod [options] [--] [file [name.section[.helpm]]]
helpm2pod converts a HelpMessage to POD. The text is read from the given file or from standard input if a dash (-) or nothing is given.
It can also further process the POD document with pod2man(1) to obtain a man(7) document. In that case the filename is used to guess the section and the manual name. An additional optional argument allows to override the filename used for that purpose or to give one if the standard input is used.
See helpmessage(5) for a description of the HelpMessage format.
The programs helpm4sh(1) and gitparseopt2helpm(1) can be used to obtain a HelpMessage.
The options are parsed by getopt(1).
Print a help message and exit.
Convert the HelpMessage to POD; this is the default.
Convert the HelpMessage to man(7). If stdout is a tty, view the manual in a pager.
If invalid lines are detected, 1 is returned. If there are no errors, 0 is returned.
To convert the help output of this program to a manual page:
$ helpm2pod -h |helpm2pod |pod2man -n HELPM2POD >helpm2pod.1
To view the same manual in the pager:
$ helpm2pod -h |helpm2pod --man - HELPM2POD
helpm2pod was written by G.raud Meyer.
helpmessage(5), perlpod(1), pod2man(1), man(7), helpm2text(1)