[GRASS5] Module information within the modules
Jan-Oliver Wagner
jan at intevation.de
Tue Nov 21 10:34:14 EST 2000
Hi GRASS-Developers,
we had an initial discussion about the opportunity
to have all GRASS commands know a description of their
own.
The aspired benefit is to
- have the short description when issuing <command> -help
- ultimately get rid of tcl-list based command definitions
in src/tcltkgrass/module
- provide valuable information to other programs such
as OSSIM through the xml-based interface description
I have extended the GRASS parser to allow to
G_define_module() and also checked in a example:
GRASS:~ > r.basins.fill -help
Description:
Generates a raster map layer showing watershed subbasins.
Usage:
r.basins.fill number=value c_map=name t_map=name result=name
Parameters:
number Number of passes through the dataset
c_map Coded stream network file name
t_map Thinned ridge network file name
result Name for the resultant watershed partition file
Now it's time to add the short description to all commands.
As a selection for the commands it seems to be a good idea
to take all that is installed to the GRASS bin directory.
Later on any module that is added to the install routine
must be provided with the internal short description first.
As the source for short description, the html documents seems
to be the best choice.
I will start with this (somewhat unamusing) job for the raster commands
right now ... :-)
Cheers
Jan
--
Jan-Oliver Wagner http://intevation.de/~jan/
Intevation GmbH http://intevation.de/
FreeGIS http://freegis.org/
----------------------------------------
If you want to unsubscribe from GRASS Development Team mailing list write to:
minordomo at geog.uni-hannover.de with
subject 'unsubscribe grass5'
More information about the grass-dev
mailing list