[GRASS-dev] [GRASS GIS] #1031: More specific parameter information in command line help

[GRASS GIS]

#1031: More specific parameter information in command line help
--------------------------+-------------------------------------------------
 Reporter:  huhabla       |       Owner:  grass-dev at lists.osgeo.org
     Type:  enhancement   |      Status:  new                      
 Priority:  minor         |   Milestone:  7.0.0                    
Component:  libgis        |     Version:  svn-trunk                
 Keywords:  parser, help  |    Platform:  All                      
      Cpu:  All           |  
--------------------------+-------------------------------------------------
 I would like to suggest the implementation of a more informative command
 line help for grass modules. Additionally to the current parameters the
 status(age), type and if it is required or not should be displayed.

 A patch for parser_help.c is attached.

 Example r.buffer:

 {{{
 lib/gis>r.buffer help

 Description:
  Creates a raster map layer showing buffer zones surrounding cells that
 contain non-NULL category values.

 Keywords:
  raster, buffer

 Usage:
  r.buffer [-z] input=name output=name distances=value[,value,...]
    [units=string] [--overwrite] [--verbose] [--quiet]

 Flags:
   -z   Ignore zero (0) data cells instead of NULL cells
  --o   Allow output files to overwrite existing files
  --v   Verbose module output
  --q   Quiet module output

 Parameters:
       input   Name of input raster map
      output   Name for output raster map
   distances   Distance zone(s)
       units   Units of distance
               options: meters,kilometers,feet,miles,nautmiles
               default: meters
 }}}

 Will change into

 {{{
 lib/gis> r.buffer help

 Description:
  Creates a raster map layer showing buffer zones surrounding cells that
 contain non-NULL category values.

 Keywords:
  raster, buffer

 Usage:
  r.buffer [-z] input=name output=name distances=value[,value,...]
    [units=string] [--overwrite] [--verbose] [--quiet]

 Flags:
   -z   Ignore zero (0) data cells instead of NULL cells
  --o   Allow output files to overwrite existing files
  --v   Verbose module output
  --q   Quiet module output

 Parameters:
       input   Name of input raster map
               status: input
               type: cell
               required: yes
      output   Name for output raster map
               status: output
               type: cell
               required: yes
   distances   Distance zone(s)
               type: float
               required: yes
       units   Units of distance
               options: meters,kilometers,feet,miles,nautmiles
               default: meters
               type: string
               required: no
 }}}

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