NEWS

   1 Release Notes for HelpMessage version/0.2
   2 -----------------------------------------
   3
   4 .New features
   5  * `helpmselect`: new script that removes sections from a HelpMessage.
   6  * All the scripts accept at most a single file argument now.
   7  * `helpm2pod`, `helpm2man`: attempt to guess the manual name and the manual
   8    section from the filename or from a given specification.
   9  * `helpm2pod`: support verbatim blocks inside list descriptions; the
  10    manual helpmessage(5) would already imply that this was supported.
  11  * Let getopt(1) parse the options of the scripts that have more than a single
  12    version option; this allows in general to intermix options and non
  13    options; `gitparseopt2helpm` was the only script modified.
  14
  15 .Fixes and Improvements
  16  * Portability to many more AWK implementations (nawk from Solaris or
  17    Heirloom, mawk and the original AWK should be supported).
  18  * Run awk from sh in all the scripts to avoid hardcoding the awk path.
  19  * Be strict about the usage: fail when unrecognized options or extraneous
  20    arguments are given.
  21  * Make sure that a filename cannot be interpreted as an assignment by awk.
  22  * `helpm2pod`: properly escape lines containing single quotes when passing
  23    them on shell command lines.
  24  * `helpm2pod`: do add a required blank line after a verbatim block.
  25  * `helpm2pod`: do not add blank lines when the input already has them.
  26  * `helpm2text`: recognize a blank header to avoid adding an unrequired blank
  27    line before the first section.
  28
  29 .Documentation changes
  30  * Document the single letter options; they are required when getopt(1) is not
  31    the extended GNU version.
  32  * List getopt as a dependency.
  33  * Add manual sections about the exit status.
  34
  35 \f
  36 Release Notes for HelpMessage version/0.1
  37 -----------------------------------------
  38
  39 This is the first release of HelpMessage, a set of portable scripts to convert
  40 a special format named HelpMessage to POD, man or text.
  41
  42 The included scripts are `helpm2pod`, `helpm2man`, `helpm2text`,
  43 `gitparseopt2helpm` and `helpm4sh`; the format is defined in the manual page
  44 helpmessage(5).