Module command line parser - Revision history

Neteler: + Overview table of parser standard options

2015-11-28T18:04:08Z

+ Overview table of parser standard options

← Older revision		Revision as of 18:04, 28 November 2015
Line 98:		Line 98:
	* {{cmd\|g.parser}} itself		* {{cmd\|g.parser}} itself

	== API ===		== API ==

	=== C API ===		=== C API ===
Line 106:		Line 106:
	=== Parser standard options ===		=== Parser standard options ===

	see http://grass.osgeo.org/programming7/parser__standard__options_8c.html		* see http://grass.osgeo.org/programming7/parser__standard__options_8c.html
			* Overview table of [https://grass.osgeo.org/grass71/manuals/parser_standard_options.html parser standard options]

	[[Category: FAQ]]		[[Category: FAQ]]
	[[Category: Linking to other languages]]		[[Category: Linking to other languages]]

Neteler: +Troubleshooting

2015-02-26T14:48:07Z

+Troubleshooting

← Older revision		Revision as of 14:48, 26 February 2015
Line 57:		Line 57:
	* see also the {{cmd\|g.parser}} help page		* see also the {{cmd\|g.parser}} help page
	* Code examples:		* Code examples:
	** Shell scripts:		** '''Shell scripts''':
	*** [https://trac.osgeo.org/grass/browser/grass/branches/releasebranch_6_4/scripts/i.landsat.rgb/i.landsat.rgb#L21 imagery]		*** [https://trac.osgeo.org/grass/browser/grass/branches/releasebranch_6_4/scripts/i.landsat.rgb/i.landsat.rgb#L21 imagery]
	*** [https://trac.osgeo.org/grass/browser/grass/branches/releasebranch_6_4/scripts/r.blend/r.blend#L15 raster]		*** [https://trac.osgeo.org/grass/browser/grass/branches/releasebranch_6_4/scripts/r.blend/r.blend#L15 raster]
Line 63:		Line 63:
	*** [https://trac.osgeo.org/grass/browser/grass/branches/releasebranch_6_4/scripts/r3.mapcalculator/r3.mapcalculator#L16 voxel]		*** [https://trac.osgeo.org/grass/browser/grass/branches/releasebranch_6_4/scripts/r3.mapcalculator/r3.mapcalculator#L16 voxel]
	*** [https://trac.osgeo.org/grass/browser/grass/branches/releasebranch_6_4/scripts/ other examples]		*** [https://trac.osgeo.org/grass/browser/grass/branches/releasebranch_6_4/scripts/ other examples]
	** Python ~~script~~:		** '''Python scripts''':
	*** [https://trac.osgeo.org/grass/browser/grass/trunk/scripts/i.landsat.rgb/i.landsat.rgb.py#L22 imagery]		*** [https://trac.osgeo.org/grass/browser/grass/trunk/scripts/i.landsat.rgb/i.landsat.rgb.py#L22 imagery]
	*** [https://trac.osgeo.org/grass/browser/grass/trunk/scripts/r.rgb/r.rgb.py#L15 raster]		*** [https://trac.osgeo.org/grass/browser/grass/trunk/scripts/r.rgb/r.rgb.py#L15 raster]
Line 69:		Line 69:
	*** [https://trac.osgeo.org/grass/browser/grass/trunk/scripts/r3.in.xyz/r3.in.xyz.py#L22 voxel]		*** [https://trac.osgeo.org/grass/browser/grass/trunk/scripts/r3.in.xyz/r3.in.xyz.py#L22 voxel]
	*** [https://trac.osgeo.org/grass/browser/grass/trunk/scripts other examples]		*** [https://trac.osgeo.org/grass/browser/grass/trunk/scripts other examples]
	** C/C++ code:		** '''C/C++ code''':
	*** [https://trac.osgeo.org/grass/browser/grass/trunk/db/db.tables/main.c#L64 database]		*** [https://trac.osgeo.org/grass/browser/grass/trunk/db/db.tables/main.c#L64 database]
	*** [https://trac.osgeo.org/grass/browser/grass/trunk/display/d.rast/main.c#L42 display]		*** [https://trac.osgeo.org/grass/browser/grass/trunk/display/d.rast/main.c#L42 display]
	*** [https://trac.osgeo.org/grass/browser/grass/trunk/general/g.~~mlist~~/main.c#L36 general]		*** [https://trac.osgeo.org/grass/browser/grass/trunk/general/g.list/main.c#L36 general]
	*** [https://trac.osgeo.org/grass/browser/grass/trunk/imagery/i.segment/parse_args.c#L10 imagery]		*** [https://trac.osgeo.org/grass/browser/grass/trunk/imagery/i.segment/parse_args.c#L10 imagery]
	*** [https://trac.osgeo.org/grass/browser/grass/trunk/raster/r.resamp.bspline/main.c#L64 raster]		*** [https://trac.osgeo.org/grass/browser/grass/trunk/raster/r.resamp.bspline/main.c#L64 raster]
Line 78:		Line 78:
	*** [https://trac.osgeo.org/grass/browser/grass/trunk/raster3d/r3.gwflow/main.c#L50 voxel]		*** [https://trac.osgeo.org/grass/browser/grass/trunk/raster3d/r3.gwflow/main.c#L50 voxel]
	*** [https://trac.osgeo.org/grass/browser/grass/trunk/ other examples]		*** [https://trac.osgeo.org/grass/browser/grass/trunk/ other examples]

			== Troubleshooting ==

			Q: my python scripts are lacking the automatically generated flag for --overwrite in the GUI

			A: You should be using standardized option G_OPT_R_INPUT, the definition can be found here:
			http://grass.osgeo.org/programming7/parser__standard__options_8c_source.html

			The key here is to specify 'new' in gisprompt, but only for output map. 'new' means that a new map will be created and parser then knows that it should check whether there is already a map of such name and if yes, require overwrite. Based on 'new', the overwrite flag is created.

	== WPS process description ==		== WPS process description ==

Neteler: expanded

2013-12-09T21:16:14Z

expanded

← Older revision		Revision as of 21:16, 9 December 2013
Line 1:		Line 1:
	GRASS GIS's command line parser is used by just about all modules to check input values, create help pages and GUIs. With the help of the ''g.parser'' module your shell or Python scripts can automatically generate help page templates and fully functional GUI windows. (This is a frontend for the G_parser() function in the C API; see the [http://grass.osgeo.org/programming7/ programmer's manual] if you are interested in that)		GRASS GIS's command line parser is used by just about all modules to check input values, create help pages and GUIs. With the help of the ''g.parser'' module your shell or Python scripts can automatically generate help page templates and fully functional GUI windows. (This is a frontend for the G_parser() function in the C API; see the [http://grass.osgeo.org/programming7/parser_8c.html programmer's manual] if you are interested in that)

	== Command line parser ==		== Command line parser ==
Line 12:		Line 12:
	* Options may be limited to a discrete set of answers. This results in a pulldown menu in the GUI and a strict answer from the command line.		* Options may be limited to a discrete set of answers. This results in a pulldown menu in the GUI and a strict answer from the command line.

	* The first option= listed by --help may be ~~skiped~~, for example:		* The first option= listed by --help may be skipped, for example:
	d.rast elevation.dem		d.rast elevation.dem

			* Examples (works with any existing GRASS GIS command):
			r.in.ascii --script
			v.in.ascii --script

	* Option names may be shortened up to the point where they collide. Thus shortening option names in a module with color= and column= options would require at minimum colo= and colu=.		* Option names may be shortened up to the point where they collide. Thus shortening option names in a module with color= and column= options would require at minimum colo= and colu=.
Line 76:		Line 80:

	== WPS process description ==		== WPS process description ==

	Starting with GRASS7, the WPS process description can be automatically generated with the option '--wps-process-description', see [[WPS]].		Starting with GRASS7, the WPS process description can be automatically generated with the option '--wps-process-description', see [[WPS]].

Line 84:		Line 89:
	* {{cmd\|g.parser}} itself		* {{cmd\|g.parser}} itself

			== API ===

			=== C API ===

			see http://grass.osgeo.org/programming7/parser_8c.html

			=== Parser standard options ===

			see http://grass.osgeo.org/programming7/parser__standard__options_8c.html

	[[Category: FAQ]]		[[Category: FAQ]]
	[[Category: Linking to other languages]]		[[Category: Linking to other languages]]

Neteler: +Using the parser in own scripts

2013-11-27T20:03:54Z

+Using the parser in own scripts

@@ Line 1: / Line 1: @@
-GRASS GIS's command line parser is used by just about all modules to check input values, create help pages and GUIs. With the help of the ''g.parser'' module your shell or Python scripts can automatically generate help page templates and fully functional GUI windows. (This is a frontend for the G_parser() function in the C API; see the programmer's manual if you are interested in that)
+GRASS GIS's command line parser is used by just about all modules to check input values, create help pages and GUIs. With the help of the ''g.parser'' module your shell or Python scripts can automatically generate help page templates and fully functional GUI windows. (This is a frontend for the G_parser() function in the C API; see the [http://grass.osgeo.org/programming7/ programmer's manual] if you are interested in that)
 == Command line parser ==
@@ Line 48: / Line 44: @@
 * Auto-created with the <tt>--html-description</tt> command line option.
 == WPS process description ==

Neteler: + List of available options for parameters and flags

2013-11-18T12:38:46Z

+ List of available options for parameters and flags

← Older revision		Revision as of 12:38, 18 November 2013
Line 1:		Line 1:
	GRASS's command line parser is used by just about all modules to check input values, create help pages and GUIs. With the help of the ''g.parser'' module your shell or Python scripts can automatically generate help page templates and fully functional GUI windows. (This is a frontend for the G_parser() function in the C API; see the programmer's manual if you are interested in that)		GRASS GIS's command line parser is used by just about all modules to check input values, create help pages and GUIs. With the help of the ''g.parser'' module your shell or Python scripts can automatically generate help page templates and fully functional GUI windows. (This is a frontend for the G_parser() function in the C API; see the programmer's manual if you are interested in that)

	* see the {{cmd\|g.parser}} help page		* List of [http://grass.osgeo.org/programming7/parser__standard__options_8c.html available options for parameters and flags]
			* see also the {{cmd\|g.parser}} help page

Neteler: +WPS

2012-08-06T13:01:14Z

+WPS

← Older revision		Revision as of 13:01, 6 August 2012
Line 47:		Line 47:

	* Auto-created with the <tt>--html-description</tt> command line option.		* Auto-created with the <tt>--html-description</tt> command line option.

			== WPS process description ==
			Starting with GRASS7, the WPS process description can be automatically generated with the option '--wps-process-description', see [[WPS]].

	== Exceptions ==		== Exceptions ==

⚠️Landa: /* Exceptions */

2011-04-07T11:37:05Z

Exceptions

← Older revision		Revision as of 11:37, 7 April 2011
Line 50:		Line 50:
	== Exceptions ==		== Exceptions ==

	Due to technical reasons some modules do not use the standard parser in GRASS 6. These include:		Due to technical reasons some modules do not use the standard parser in ''GRASS 6''. These include:
	* r.mapcalc		* {{cmd\|r.mapcalc}}
	* g.parser itself		* {{cmd\|g.parser}} itself


	[[Category: FAQ]]		[[Category: FAQ]]
	[[Category: Linking to other languages]]		[[Category: Linking to other languages]]

Neteler: small updates

2011-04-04T19:21:44Z

small updates

← Older revision		Revision as of 19:21, 4 April 2011
Line 1:		Line 1:
	GRASS's command line parser is used by just about all modules to check input values, create help pages and GUIs. With the help of the ''g.parser'' module your shell or Python scripts can automatically generate help page templates and fully functional GUI windows. (This is a frontend for the G_parser() function in the C API; see the programmer's manual if you are interested in that)		GRASS's command line parser is used by just about all modules to check input values, create help pages and GUIs. With the help of the ''g.parser'' module your shell or Python scripts can automatically generate help page templates and fully functional GUI windows. (This is a frontend for the G_parser() function in the C API; see the programmer's manual if you are interested in that)

	* see the ~~[http://grass.ibiblio.org/grass63/manuals/html63_user/g.parser.html~~ g.parser help page]		* see the {{cmd\|g.parser}} help page


Line 44:		Line 44:
	If the environment variable <tt>GRASS_UI_TERM</tt> is set to any value, then an interactive question/answer text based UI is launched instead of the graphical UI window.		If the environment variable <tt>GRASS_UI_TERM</tt> is set to any value, then an interactive question/answer text based UI is launched instead of the graphical UI window.

	== Help page template ==		== Help page HTML template ==

	* Auto-created with the <tt>--html-description</tt> command line option.		* Auto-created with the <tt>--html-description</tt> command line option.
Line 50:		Line 50:
	== Exceptions ==		== Exceptions ==

	Due to technical reasons some modules do not use the standard parser. These include:		Due to technical reasons some modules do not use the standard parser in GRASS 6. These include:
	* r.mapcalc		* r.mapcalc
	* g.parser		* g.parser itself
	* the photo.* modules


	[[Category: FAQ]]		[[Category: FAQ]]
			[[Category: Linking to other languages]]

⚠️Paul K: /* GUI window parser */

2008-02-02T01:47:03Z

GUI window parser

← Older revision		Revision as of 01:47, 2 February 2008
Line 33:		Line 33:
	== GUI window parser ==		== GUI window parser ==

	* If a module is called with no options or flags specified then a GUI window is launched.		* If a module is called with no options or flags specified then a GUI window is launched, unless the environment variable GRASS_UI_TERM is set (to any value), in which case the command-line interactive parser is launched.
	* If a module is called with options and flags specified, but with the --ui flag, then a GUI window is started with those options and flags already set to the given values. (useful for interactive scripts)		* If a module is called with options and flags specified, but with the --ui flag, then a GUI window is started with those options and flags already set to the given values. (useful for interactive scripts)

⚠️HamishBowman: /* GUI window parser */

2007-12-18T08:10:56Z

GUI window parser

← Older revision		Revision as of 08:10, 18 December 2007
Line 34:		Line 34:

	* If a module is called with no options or flags specified then a GUI window is launched.		* If a module is called with no options or flags specified then a GUI window is launched.
	* If a module is called with options and flags specified, but with the --ui flag, then a GUI window is started with those options and flags already ~~populated~~. (useful for interactive scripts)		* If a module is called with options and flags specified, but with the --ui flag, then a GUI window is started with those options and flags already set to the given values. (useful for interactive scripts)

	* Auto-created from <tt>--tcltk</tt> or <tt>--interface-description</tt> (for XML) command line options.		* Auto-created from <tt>--tcltk</tt> or <tt>--interface-description</tt> (for XML) command line options.