README

   1 README for HelpMessage
   2 ======================
   3
   4 HelpMessage is a simple text documentation format described in
   5 linkman:helpmessage[5] that can be converted to
   6 link:http://perldoc.perl.org/perlpod.html[POD] (Perl's Plain Old Documentation)
   7 and that is more compact and more readable than POD.  It is meant to be
   8 embedded inside scripts and to serve both as a usage message if printed almost
   9 as is and as a standard manual page generated by the standard POD tools.
  10
  11 User visible changes are described in link:NEWS.html[+NEWS+].  The project is
  12 available online at
  13 link:https://gitorious.org/graud-utils/helpmessage[Gitorious].
  14
  15 Commands
  16 --------
  17
  18 * linkman:helpm2pod[1] is the main script: it converts a HelpMessage to POD
  19   syntax so that a standard manual page can be generated.
  20 * linkman:helpm2man[1] calls `helpm2pod` and `pod2man` to build a manual page.
  21 * linkman:helpm2text[1] can be used to format a message to be displayed.
  22 * linkman:helpmselect[1] selects some sections from a HelpMessage.
  23 * linkman:gitparseopt2helpm[1] reuses a parsing specification to
  24   git-rev-parse(1) to document the available options or to create a
  25   minimalistic HelpMessage.
  26 * linkman:helpm4sh[1] extracts a HelpMessage from here documents or comments in
  27   shell scripts (or in awk scripts).
  28
  29 Dependencies
  30 ------------
  31
  32 * POSIX `sh`
  33 * New `awk` (the AWK scripts are fairly portable)
  34 * `sed` with Extended Regular Expressions (GNU and BSD option -r)
  35 * `getopt` (the extended GNU version preferably)
  36 * link:http://perldoc.perl.org/pod2man.html[`pod2man`]
  37
  38 Credits & License
  39 -----------------
  40
  41 HelpMessage was written by G.raud Meyer.
  42
  43 HelpMessage is free software; you can redistribute and/or modify if under the
  44 terms of the GNU General Public License version 2 as published by the Free
  45 Software Foundation.  The full text of the license can be found in the root of
  46 the project sources, in the file link:COPYING[+COPYING+].  Otherwise see
  47 <http://www.gnu.org/licenses/>.