For flags, the value will be "1" if the flag was given, and "0" otherwise.
Typical header definitions are as follows:
#%Module #% description: g.parser test script #%End #%flag #% key: f #% description: A flag #%end #%option #% key: raster #% type: string #% gisprompt: old,cell,raster #% description: Raster input map #% required : yes #%end
#% multiple : yesWhile this will only directly change the Usage section of the help screen, the option's environmental string may be easily parsed from within a script. For example, individual comma separated identities for an option named "input" can be parsed with the following Bash shell code:
IFS=, for opt in $GIS_OPT_INPUT ; do ... "$opt" done
A "guisection" field may be added to each option and flag to specify that the options should appear in multiple tabs in the auto-generated GUI. Any options without a guisection field go into the "Options" tab. For example:
#% guisection: tabnamewould put that option in a tab named tabname.
A "key_desc" field may be added to each option to specify the text that appears in the module's usage help section. For example:
#% key_desc: filenameadded to an input option would create the usage summary [input=filename].
g.parser -t somescriptfile
#!/bin/sh # g.parser demo script for shell programing #%Module #% description: g.parser test script #%End #%flag #% key: f #% description: A flag #%END #%option #% key: raster #% type: string #% gisprompt: old,cell,raster #% description: Raster input map #% required : yes #%end #%option #% key: vector #% type: string #% gisprompt: old,vector,vector #% description: Vector input map #% required : yes #%end #%option #% key: option1 #% type: string #% description: An option #% required : no #%end if [ -z "$GISBASE" ] ; then echo "You must be in GRASS GIS to run this program." 1>&2 exit 1 fi if [ "$1" != "@ARGS_PARSED@" ] ; then exec g.parser "$0" "$@" fi #add your code here echo "" if [ $GIS_FLAG_F -eq 1 ] ; then echo "Flag -f set" else echo "Flag -f not set" fi #test if parameter present: if [ -n "$GIS_OPT_OPTION1" ] ; then echo "Value of GIS_OPT_OPTION1: '$GIS_OPT_OPTION1'" fi echo "Value of GIS_OPT_RASTER: '$GIS_OPT_RASTER'" echo "Value of GIS_OPT_VECTOR: '$GIS_OPT_VECTOR'" #add your code here
The test.sh script will provide following help text:
./test.sh --help Description: g.parser test script Usage: test.sh [-f] option=name Flags: -f A flag Parameters: option an option
Last changed: $Date: 2007/06/11 03:24:59 $