[GRASS-dev] [GRASS GIS] #953: module help information in machine-readable format

[GRASS GIS]

#953: module help information in machine-readable format
----------------------------+-----------------------------------------------
 Reporter:  cmbarton        |       Owner:  grass-dev at lists.osgeo.org
     Type:  enhancement     |      Status:  new                      
 Priority:  normal          |   Milestone:  6.5.0                    
Component:  default         |     Version:  unspecified              
 Keywords:  help, metadata  |    Platform:  All                      
      Cpu:  All             |  
----------------------------+-----------------------------------------------
 The information returned from running "<module> help" would be useful for
 a variety of interface=related tasks like auto-completion and automatic
 menu building. Unfortunately, it is completely localized, making it
 impossible to parse in a reliable fashion within scripts and computer
 code.

 I'm requesting the addition of a parameter to G_usage() which would
 replace the human-readable section descriptions with markers which can be
 relied upon to never occur in normal help text, e.g. "{{{KEYWORDS}}}\n",
 then add a (e.g.) --help-data option. It would be helpful to also include
 an unlocalized version of the keys for each of the description sections
 (e.g., Description, Flags, Usage in an English localization).

-- 
Ticket URL: <http://trac.osgeo.org/grass/ticket/953>
GRASS GIS <http://grass.osgeo.org>