README

   1 README for HelpMessage
   2 ======================
   3
   4 `helpm2pod` converts a specially formatted simple help message to POD (Perl's
   5 Plain Old Documentation) syntax so that a standard manual page can be
   6 generated.  It should be seen as a compact readable form of POD that can be
   7 employed as is as a usage message.  See the manual pages linkman:helpm2pod[1]
   8 and linkman:helpmessage[5].
   9
  10 There are some additional helper scripts: linkman:helpm2text[1],
  11 linkman:helpm2man[1], linkman:helpmselect[1], linkman:gitparseopt2helpm[1] and
  12 linkman:helpm4sh[1].
  13
  14 Dependencies
  15 ------------
  16
  17 * POSIX `sh`
  18 * New `awk` (the AWK scripts are fairly portable)
  19 * `sed` with Extended Regular Expressions (GNU and BSD option -r)
  20 * `getopt` (the extended GNU version preferably)
  21 * link:http://perldoc.perl.org/pod2man.html[`pod2man`]