[ET Trac] [Einstein Toolkit] #120: Improve built-in help system

[Einstein Toolkit]

#120: Improve built-in help system
-------------------------+--------------------------------------------------
 Reporter:  hinder       |       Owner:  mthomas
     Type:  enhancement  |      Status:  new    
 Priority:  major        |   Milestone:         
Component:  SimFactory   |     Version:         
 Keywords:               |  
-------------------------+--------------------------------------------------
 SimFactory currently provides a single help screen when you type "sim
 help".  I would like to be able to do "sim help <command>" and get help
 which is relevant for that command.  This help should say briefly what the
 command does, and give a comprehensive list of the options specific to
 that command.  The top-level "sim help" command should then give a list of
 the commands, and a list of the simfactory options which apply to all
 commands.  This first help page should be kept as brief as possible so
 that it is easy to see at a glance what commands are available.  The most
 common commands should be listed first, and maybe separated from the less
 common commands.

 I think this is important as it is the first port-of-call when someone
 wants to know how to use a particular feature, especially when the syntax
 is similar but not quite the same as in SimFactory 1.

-- 
Ticket URL: <https://trac.einsteintoolkit.org/ticket/120>
Einstein Toolkit <http://einsteintoolkit.org>
The Einstein Toolkit