NAME

helpm2text - format a HelpMessage to be displayed

SYNOPSIS

helpm2text [files]

DESCRIPTION

helpm2text formats a HelpMessage to be displayed as text. HelpMessage is already a format prone to be viewed as is; helpm2text simply strips comments, deletes special list indentation and makes sure that each section starts by (at least) one blank line.

If the HelpMessage does contain a lot of POD syntax, it may be more appropriate to convert to POD by helpm2pod(1) then to text by pod2text(1). pod2text(1) offers additonal options to format the document.

EXAMPLES

The following two commands give similar results:

  $ <doc.helpm helpm2text | expand -t4 | fmt -w76
  $ <doc.helpm helpm2pod | pod2text

AUTHOR

helpm2text was written by G.raud Meyer.

SEE ALSO

helpmessage(5), helpm2pod(1), pod2text(1)