[GRASS-SVN] r42946 - grass-addons/raster/r.pi/r.pi.rectangle

svn_grass at osgeo.org svn_grass at osgeo.org
Thu Jul 29 11:24:48 EDT 2010


Author: wegmann
Date: 2010-07-29 15:24:48 +0000 (Thu, 29 Jul 2010)
New Revision: 42946

Modified:
   grass-addons/raster/r.pi/r.pi.rectangle/description.html
   grass-addons/raster/r.pi/r.pi.rectangle/main.c
Log:
modified the description.html and the main.c to suit the manual page standard of GRASS

Modified: grass-addons/raster/r.pi/r.pi.rectangle/description.html
===================================================================
--- grass-addons/raster/r.pi/r.pi.rectangle/description.html	2010-07-29 15:20:21 UTC (rev 42945)
+++ grass-addons/raster/r.pi/r.pi.rectangle/description.html	2010-07-29 15:24:48 UTC (rev 42946)
@@ -1,61 +1,3 @@
-</head>
-<body bgcolor="white">
-
-<img src="grass_logo.png" alt="GRASS logo"><hr align=center size=6 noshade>
-
-<h2>NAME</h2>
-<em><b>r.pi.rectangle</b></em> converts sampling points (e.g. GPS coordinates)
-of the corner of a sampling site into an area by generating a defined rectangle.
-<h2>KEYWORDS</h2>
-raster, patch index, landscape ecology
-<h2>SYNOPSIS</h2>
-<b>r.pi.rectangle</b><br>
-<b>r.pi.rectangle help</b><br>
-
-
-
-<b>r.pi.rectangle</b> <b>input</b>=<em>name</em>
-<b>output</b>=<em>name</em> 
-<b>keyval</b>=<em>val</em>   <b>x</b>=<em>value</em>
-<b>y</b>=<em>value</em>
-<b>alignment</b>=<em>string</em>
-[<b>title</b>=<em>phrase</em>]  [--<b>overwrite</b>]  [--<b>verbose</b>] 
-[--<b>quiet</b>] 
-
-<h3>Flags:</h3>
-<DL>
-<DT><b>--overwrite</b></DT>
-<DD>Allow output files to overwrite existing files</DD>
-<DT><b>--verbose</b></DT>
-<DD>Verbose module output</DD>
-<DT><b>--quiet</b></DT>
-<DD>Quiet module output</DD>
-</DL>
-
-
-<h3>Parameters:</h3>
-<DL>
-<DT><b>input</b>=<em>name</em></DT>
-<DD>raster file with single pixels representing sampling points</DD>
-
-
-<DT><b>x</b>=<em>value</em></DT>
-<DD>extent of generated area on the x axis (width) in pixel</DD>
-
-<DT><b>y</b>=<em>value</em></DT>
-<DD>extent of generated area on the y axis (height) in pixel</DD>
-
-<DT><b>alignment</b>=<em>string</em></DT>
-<DD>alignment of the rectangle relative to the input pixel. options:
-center, top-left, top-right, bottom</DD>
-
-<DT><b>title</b>=<em>name</em></DT>
-<DD>Optional title of output map</DD>
-
-</DL>
-
-
-
 <H2>DESCRIPTION</H2>
 
 <P>
@@ -97,5 +39,3 @@
 Programming: Elshad Shirinov<br>
 Scientific concept: Dr. Martin Wegmann <br>
 Department of Remote Sensing <br>Remote Sensing and Biodiversity Unit<br> University of Wuerzburg, Germany
-
-<p><i>Last changed: $Date: 2006/04/13 19:01:37 $</i>

Modified: grass-addons/raster/r.pi/r.pi.rectangle/main.c
===================================================================
--- grass-addons/raster/r.pi/r.pi.rectangle/main.c	2010-07-29 15:20:21 UTC (rev 42945)
+++ grass-addons/raster/r.pi/r.pi.rectangle/main.c	2010-07-29 15:24:48 UTC (rev 42946)
@@ -77,7 +77,7 @@
 	parm.input->type       = TYPE_STRING ;
 	parm.input->required   = YES ;
 	parm.input->gisprompt  = "old,cell,raster" ;
-	parm.input->description= _("Name of existing raster file") ;
+	parm.input->description= _("raster file with single pixels representing sampling points") ;
 
 	parm.output = G_define_option() ;
 	parm.output->key        = "output" ;
@@ -90,19 +90,19 @@
 	parm.keyval->key        = "keyval" ;
 	parm.keyval->type       = TYPE_INTEGER ;
 	parm.keyval->required   = YES ;
-	parm.keyval->description= _("Value of relevant pixels in the input raster") ;
+	parm.keyval->description= _("Pixel value in the input raster to be used") ;
 	
 	parm.x = G_define_option() ;
 	parm.x->key        = "x" ;
 	parm.x->type       = TYPE_INTEGER ;
 	parm.x->required   = YES ;
-	parm.x->description= _("Width of the buffer") ;
+	parm.x->description= _("extent of generated area on the x axis (width) in pixel") ;
 
 	parm.y = G_define_option() ;
 	parm.y->key        = "y" ;
 	parm.y->type       = TYPE_INTEGER ;
 	parm.y->required   = YES ;
-	parm.y->description= _("Height of the buffer") ;
+	parm.y->description= _("extent of generated area on the y axis (height) in pixel") ;
 	
 	parm.alignment = G_define_option() ;
 	parm.alignment->key        = "alignment" ;
@@ -117,7 +117,7 @@
 			*str = 0;
 		strcat (str, alignments[n].name);
 	}
-	parm.alignment->description= _("Alignment of the buffer relative to the key pixel") ;
+	parm.alignment->description= _("alignment of the rectangle relative to the input pixel. options: center, top-left, top-right, bottom") ;
 
 	parm.title = G_define_option() ;
 	parm.title->key        = "title" ;



More information about the grass-commit mailing list