Update help output
authorTeemu Murtola <teemu.murtola@gmail.com>
Thu, 23 Apr 2015 10:31:22 +0000 (13:31 +0300)
committerGerrit Code Review <gerrit@gerrit.gromacs.org>
Fri, 12 Jun 2015 12:58:41 +0000 (14:58 +0200)
commit867ea01d072d64bbee718fc23dcf47bccb8ef93f
tree875712a7689a51569539e44dd75aaab2e031b1b8
parentc42dfb393378a0c89786ae8940fd724f1ff33c12
Update help output

Various changes to console help output (and some to man output) based on
feedback in #1687:
 - People seem to prefer a centered startup header with some ASCII art,
   so made the first output line just like that (except if running with
   -quiet), and center the list of authors.
 - Always start the option description at a new line.
 - Give more space to various parts of the option list so that they are
   more likely to align up.
 - Split the file listing based on input/output type.  This causes,
   e.g., some logically related options (e.g., -cpi and -cpo) to get
   separated in the output, but this seems to be the preferred approach.
 - Add formatting to the synopsis on man pages (similar to how the
   options appeared in the 4.6-era man pages, except that reasonable
   line wrapping is still there).

Clean up the design for formatting the options list; now the actual
formatting code is better encapsulated in HelpWriterContext.

The user-visible scope of this change is limited to changing behavior
that changed between 4.6 and 5.0.  Thus, the changes here should be
sufficient to close #1687.

Change-Id: I349fd9021472f064f5797441090a3f3864868280
src/gromacs/commandline/cmdlinehelpwriter.cpp
src/gromacs/commandline/tests/refdata/CommandLineHelpModuleTest_ExportsHelp.xml
src/gromacs/commandline/tests/refdata/CommandLineHelpModuleTest_PrintsGeneralHelp.xml
src/gromacs/commandline/tests/refdata/CommandLineHelpWriterTest_HandlesLongFileOptions.xml
src/gromacs/commandline/tests/refdata/CommandLineHelpWriterTest_HandlesLongOptions.xml
src/gromacs/commandline/tests/refdata/CommandLineHelpWriterTest_HandlesMultipleSections.xml
src/gromacs/commandline/tests/refdata/CommandLineHelpWriterTest_HandlesOptionTypes.xml
src/gromacs/gmxlib/copyrite.cpp
src/gromacs/onlinehelp/helpwritercontext.cpp
src/gromacs/onlinehelp/helpwritercontext.h