[GRASS-SVN] r30703 - in grass/trunk: display/drivers/HTMLMAP
display/drivers/PNG display/drivers/PS
display/drivers/XDRIVER display/drivers/cairo lib/init
svn_grass at osgeo.org
svn_grass at osgeo.org
Sun Mar 23 10:34:53 EDT 2008
Author: martinl
Date: 2008-03-23 10:34:53 -0400 (Sun, 23 Mar 2008)
New Revision: 30703
Modified:
grass/trunk/display/drivers/HTMLMAP/description.html
grass/trunk/display/drivers/PNG/description.html
grass/trunk/display/drivers/PS/description.html
grass/trunk/display/drivers/XDRIVER/description.html
grass/trunk/display/drivers/cairo/description.html
grass/trunk/lib/init/variables.html
Log:
Variables/display drivers manual page synchronization (syntax issue).
Modified: grass/trunk/display/drivers/HTMLMAP/description.html
===================================================================
--- grass/trunk/display/drivers/HTMLMAP/description.html 2008-03-23 06:07:32 UTC (rev 30702)
+++ grass/trunk/display/drivers/HTMLMAP/description.html 2008-03-23 14:34:53 UTC (rev 30703)
@@ -1,6 +1,17 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<HTML>
+<HEAD>
+ <TITLE>HTMLMAP driver</TITLE>
+ <META http-equiv=Content-Type content="text/html; charset=iso-8859-1">
+ <link rel="stylesheet" href="grassdocs.css" type="text/css">
+</HEAD>
+<BODY bgColor=white>
+
+<img src="grass_logo.png" alt="GRASS logo"><hr align=center size=6 noshade>
+
<H2>NAME</H2>
-<EM><B>HTMLMAP driver</B></EM> - driver to create HTML image maps
+<EM><B>HTMLMAP driver</B></EM> - driver to create HTML image maps.
<BR><EM>(drivers)</EM>
<H2>DESCRIPTION</H2>
@@ -10,121 +21,137 @@
provide unique URL targets for different portions of an image. The HTMLMAP
driver can create both client-side image maps embedded into HTML files, or
server-side image maps used by web server software.
-<P>Note that GRASS display commands that require the MOUSE will not work
+<P>
+Note that GRASS display commands that require the MOUSE will not work
correctly (or at all!)
-<P>Polygons can at most have 100 vertices (this limit imposed by HTML image map
-formats, see <B>GRASS_HTMLMAXPOINTS </B> below.) The driver will attempt to
+<P>
+Polygons can at most have 100 vertices (this limit imposed by HTML image map
+formats, see <B>GRASS_HTMLMAXPOINTS</B> below.) The driver will attempt to
trim polygons that have more that 100
vertices by removing vertices with the least amount of angle to the next
vertice. Also, any polygon that is entirely bounded by another polygon will be
discarded.
-<P>Text written to the driver before polygons are used as the HREF tag for all
+<P>
+Text written to the driver before polygons are used as the HREF tag for all
subsequent polygons written. All polygons that exist in a vector map will have
the same HREF tag.
-<P>The only GRASS display commands that should be used with this driver are:
+<P>
+The only GRASS display commands that should be used with this driver are:
<UL>
<LI><a href="d.text.html">d.text</A>
- - pass href information for resulting image maps.
+ - pass href information for resulting image maps.</LI>
<LI><a href="d.vect.html">d.vect</A>
- - draw polygons from a vector map. </LI></UL><BR>
+ - draw polygons from a vector map.</LI>
+</UL>
+
<H2>USAGE</H2>
+
<H3>Environment variables</H3>Several environment variables effect the operation
of HTMLMAP.
+
<UL>
<LI><B>GRASS_WIDTH=xxx</B><BR>the width of the image map (default is
- 640).<BR><BR>
+ 640).
+ </LI><BR>
<LI><B>GRASS_HEIGHT=yyy</B><BR>the height of the image map (default is
- 480).<BR><BR>
+ 480).
+ </LI><BR>
<LI><B>GRASS_HTMLTYPE=type</B><BR>the type of image mape to create (default is
- CLIENT):
- <UL>
- <DD><TT><B>CLIENT</B></TT> Netscape/IE client-side image map.
- (NAME="map")<BR>
- <DD><TT><B>APACHE</B></TT> Apache/NCSA server-side image
- map.<BR>
- <DD><TT><B>RAW</B></TT> Raw url
- and polygon vertices ( <I>url x1 y1 x2 y2
- ..... </I>), suitable for conversion to CERN server format, or any other
- format with user supplied conversion program. </DD></UL><BR>
- <LI><B>GRASS_HTMLFILE=filename</B><BR>specifies the resulting file to store
- the html image map, default is <B>htmlmap</B>. Files without absolute path
- names are written in the current directory where the driver was started.
- <BR><B><EM>Any existing file of the same name is overwritten without
- warning.</EM></B><BR><BR> </LI>
+ CLIENT):
+ <UL>
+ <DD><TT><B>CLIENT</B></TT> Netscape/IE client-side image map.
+ (NAME="map")<BR>
+ <DD><TT><B>APACHE</B></TT> Apache/NCSA server-side image
+ map.<BR>
+ <DD><TT><B>RAW</B></TT> Raw url
+ and polygon vertices ( <I>url x1 y1 x2 y2
+ ..... </I>), suitable for conversion to CERN server format, or any other
+ format with user supplied conversion program.</DD>
+ </UL>
+ </LI><BR>
+ <LI><B>GRASS_HTMLFILE=filename</B><BR>
+ specifies the resulting file to store
+ the html image map, default is <tt>htmlmap</tt>. Files without absolute path
+ names are written in the current directory where the driver was started.
+ <BR>
+ <em>Any existing file of the same name is overwritten without
+ warning.</em>
+ </LI><BR>
<LI><B>GRASS_HTMLMINDIST=n</B><BR>specifies the minimum distance in pixels
that a point must change from the previous point to keep in the list of
- vertices for a polygon. The default is <B>2</B>, which means that a
+ vertices for a polygon. The default is <tt>2</tt>, which means that a
point's x and y difference from the previous point must change by a number
of pixels greater than this value. This parameter helps to eliminate
- closely spaced points. <BR><BR></LI>
+ closely spaced points.
+ </LI><BR>
<LI><B>GRASS_HTMLMINBBOX=n</B><BR>specifies the minimum bounding box
dimensions to record a polygon as a clickable area.
- The default is <B>2</B>, which means that a polygon with a bounding box
+ The default is <tt>2</tt>, which means that a polygon with a bounding box
of less than this value is not included. This parameter helps to eliminate
- polygons than are a point or line. <BR><BR></LI>
+ polygons than are a point or line.
+ </LI><BR>
<LI><B>GRASS_HTMLMAXPOINTS=n</B><BR>specifies the maximum number of
vertices included in a polygon's clickable area.
- The default is <B>99</B>. Some browsers can only accomodate polygons of
+ The default is <tt>99</tt>. Some browsers can only accomodate polygons of
100 vertices or less. The HTMLMAP driver automatically ensures that a
polygon is closed by making the last point the same as the first
- point. <BR><BR></LI></UL>
-<P>
+ point.</LI><BR>
+</UL>
+
<H3>Typical usage</H3>
<UL>
-<LI>Start up the driver<BR><PRE> d.mon start=HTMLMAP
- d.mon select=HTMLMAP
- </PRE>
-<LI>Display text strings (HREF's) and polygons
-<BR>
-<PRE>
- echo "http://www.no-such-place.net/area51/" | d.text
- d.vect map=area51
- echo "http://www.roswell-nm.net/little/green/men.html" | d.text
- d.vect map=roswell
-</PRE>
-<LI>Stop the driver when all polygon have been displayed. This will cause a file
-named 'htmlmap' to be created in your current directory.
-<BR>
-<PRE>
- d.mon stop=HTMLMAP
-</PRE>
-<LI>You will also want to create an image for your image map. Use the PNG
-driver and other utilities to create .gif or .jpg files.
-<i>The following example is somewhat out of date and refers to options
-available in GRASS 5.</i>
-<BR>
-<PRE>
- # using previous GRASS_WIDTH & GRASS_HEIGHT
- d.mon start=PNG
- d.mon select=PNG
- d.rast map=terrain
- d.vect map=area51 fillcolor=white linecolor=blue
- d.vect map=roswell fillcolor=yellow linecolor=blue
- d.vect map=states color=green
- d.vect map=roads color=black
- d.mon stop=PNG
+ <LI>Start up the driver
+<DIV class="code"><PRE>
+d.mon start=HTMLMAP
+</PRE></DIV>
+ </LI>
+ <LI>Display text strings (HREF's) and polygons
+<DIV class="code"><PRE>
+echo "http://www.no-such-place.net/area51/" | d.text
+d.vect map=area51
+echo "http://www.roswell-nm.net/little/green/men.html" | d.text
+d.vect map=roswell
+</PRE></div>
+ <LI>Stop the driver when all polygon have been displayed. This will cause a file
+ named 'htmlmap' to be created in your current directory.
+<DIV class="code"><PRE>
+d.mon stop=HTMLMAP
+</PRE></DIV>
+ <LI>You will also want to create an image for your image map. Use the PNG
+ driver and other utilities to create .gif or .jpg files.
+ <i>The following example is somewhat out of date and refers to options
+ available in GRASS 5.</i>
+<DIV class="code"><PRE>
+# using previous GRASS_WIDTH & GRASS_HEIGHT
+d.mon start=PNG
+d.mon select=PNG
+d.rast map=terrain
+d.vect map=area51 fillcolor=white linecolor=blue
+d.vect map=roswell fillcolor=yellow linecolor=blue
+d.vect map=states color=green
+d.vect map=roads color=black
+d.mon stop=PNG
<!-- ???? FIXME -->
- # make the region the same as the newly created cell for ppm export
- g.region save=saved.reg
- g.region raster=D_cell
- r.out.ppm -q input=D_cell output=alien.ppm
+# make the region the same as the newly created cell for ppm export
+g.region save=saved.reg
+g.region raster=D_cell
+r.out.ppm -q input=D_cell output=alien.ppm
- # use the netpbm utilities to create a gif (quantize if needed)
- ppmquant 128 <alien.ppm | ppmtogif >alien.gif
+# use the netpbm utilities to create a gif (quantize if needed)
+ppmquant 128 <alien.ppm | ppmtogif >alien.gif
- # assemble some html with the image and the image map
- echo '<html><body><img src="alien.gif" usemap="#map">' >alien.html
- cat htmlmap >>alien.html
- echo '</body></html>' >>alien.html
+# assemble some html with the image and the image map
+echo '<html><body><img src="alien.gif" usemap="#map">' >alien.html
+cat htmlmap >>alien.html
+echo '</body></html>' >>alien.html
+
+# don't forget to reset your region
+g.region region=saved.reg
- # don't forget to reset your region
- g.region region=saved.reg
-
- # take a look and test it out
- netscape file:`pwd`/alien.html &
-
- </PRE>
-<BR>
+# take a look and test it out
+netscape file:`pwd`/alien.html &
+</PRE></DIV>
+ </LI>
</UL>
<H2>NOTES</H2>
@@ -132,28 +159,31 @@
HTMLMAP was adapted from the CELL driver in GRASS 4.3.
Point-in-polygon test code was lifted from Randolph Franklin's web page, see
<UL>
-<a href="http://www.ecse.rpi.edu/Homepages/wrf/">http://www.ecse.rpi.edu/Homepages/wrf/</A>
-<BR>
-<a href="http://www.ecse.rpi.edu/Homepages/wrf/research/geom/pnpoly.html">http://www.ecse.rpi.edu/Homepages/wrf/research/geom/pnpoly.html</A>
+ <LI><a href="http://www.ecse.rpi.edu/Homepages/wrf/">http://www.ecse.rpi.edu/Homepages/wrf/</A></LI>
+ <LI><a href="http://www.ecse.rpi.edu/Homepages/wrf/research/geom/pnpoly.html">http://www.ecse.rpi.edu/Homepages/wrf/research/geom/pnpoly.html</A></LI>
</UL>
-<P>If you create an HTML file with two or more images and image maps, you will
+
+<P>
+If you create an HTML file with two or more images and image maps, you will
need to edit the map names. The HTMLMAP driver creates its map with the name
-<I>map</I>. A small sed script can easily change the map name: </P>
-<PRE>sed -e 's/NAME="map"/NAME="foomap"/' < htmlmap > foomap.html
+<tt>map</tt>. A small sed script can easily change the map name:
+
+<PRE>
+ sed -e 's/NAME="map"/NAME="foomap"/' < htmlmap > foomap.html
</PRE>
<H2>SEE ALSO</H2>
<EM>
-<a href="pngdriver.html">PNG driver</A>,
-<a href="psdriver.html">PostScript driver</A>,
-<a href="xdriver.html">XDRIVER</A>
-<BR>
-<A HREF="d.frame.html">d.frame</A>,
-<A href="d.mon.html">d.mon</A>,
-<A href="d.rast.html">d.rast</A>,
-<a href="d.text.html">d.text</A>,
-<a href="d.vect.html">d.vect</A>
+ <a href="displaydrivers.html">Display drivers</a>
+ <br>
+ <a href="pngdriver.html">PNG driver</A>,
+ <a href="psdriver.html">PostScript driver</A>,
+ <a href="xdriver.html">XDRIVER</A>
+ <BR>
+ <A href="d.mon.html">d.mon</A>,
+ <a href="d.text.html">d.text</A>,
+ <a href="d.vect.html">d.vect</A>
</EM>
<p>
Modified: grass/trunk/display/drivers/PNG/description.html
===================================================================
--- grass/trunk/display/drivers/PNG/description.html 2008-03-23 06:07:32 UTC (rev 30702)
+++ grass/trunk/display/drivers/PNG/description.html 2008-03-23 14:34:53 UTC (rev 30703)
@@ -10,8 +10,9 @@
<img src="grass_logo.png" alt="GRASS logo"><hr align=center size=6 noshade>
<H2>NAME</H2>
-<EM><B> PNG driver</B></EM> - driver to create PNG and PPM images
+<EM><B> PNG driver</B></EM> - driver to create PNG and PPM images.
<BR><EM>(drivers)</EM>
+
<H2>DESCRIPTION</H2>
The PNG driver generates PNG and PPM images from GRASS display commands.
@@ -20,71 +21,77 @@
display commands are written to the PNG image file.
<H2>USAGE</H2>
+
<H3>Environment variables</H3>
Several environment variables effect the operation
of the PNG driver.
<UL>
<LI><B>GRASS_WIDTH=xxx</B><BR>
- the width of the image map (default is 640).<BR><BR>
+ the width of the image map (default is 640).</LI><BR>
<LI><B>GRASS_HEIGHT=yyy</B><BR>
- the height of the image map (default is 480).<BR><BR>
+ the height of the image map (default is 480).</LI><BR>
<LI><B>GRASS_PNGFILE=filename</B><BR>
- the filename to put the resulting image in, default is <b>map.png</b>.
+ the filename to put the resulting image in, default is <tt>map.png</tt>.
If you set GRASS_PNGFILE to a filename which ends in ".ppm", a PPM
file will be created.<br><br>
<LI><B>GRASS_BACKGROUNDCOLOR=RRGGBB</B><BR>
specifies the background color to use in RGB
notation (hex values). Default is <b>000000</b> (black).<br><br>
<LI><B>GRASS_TRANSPARENT=[TRUE|FALSE]</B><BR>
- sets transparent background on (TRUE) or off (FALSE, default).<BR><BR>
+ sets transparent background on (TRUE) or off (FALSE, default).</LI><BR>
<LI><B>GRASS_TRUECOLOR=[TRUE|FALSE]</B><BR>
- sets true-color support<BR><BR>
+ sets true-color support</LI><BR>
<LI><B>GRASS_PNG_COMPRESSION=[0|1|9]</B><BR>
- compression level of PNG files (0 = none, 1 = fastest, 9 = best, default is 6)<BR><BR>
+ compression level of PNG files (0 = none, 1 = fastest, 9 = best, default is 6)</LI><BR>
<LI><B>GRASS_PNG_AUTO_WRITE=[TRUE|FALSE]</B><BR>
- if set to "TRUE", the image file will be written after each
+ if set to <tt>TRUE</tt>, the image file will be written after each
operation (i.e. whenever a client disconnects), rather than
- only being written out when the driver terminates.<BR><BR>
+ only being written out when the driver terminates.</LI><BR>
<LI><B>GRASS_PNG_READ</B><BR>
- if "TRUE", the PNG driver will initialize the image from
- the contents of $GRASS_PNGFILE.<BR><BR>
+ if <tt>TRUE</tt>, the PNG driver will initialize the image from
+ the contents of GRASS_PNGFILE.</LI><BR>
<LI><B>GRASS_PNG_MAPPED</B><BR>
- if "TRUE", the PNG driver will map $GRASS_PNGFILE as its framebuffer,
- rather than using memory. This only works with BMP files.<BR><BR>
+ if <tt>TRUE</tt>, the PNG driver will map GRASS_PNGFILE as its framebuffer,
+ rather than using memory. This only works with BMP files.</LI><BR>
<LI><B>GRASS_RENDER_IMMEDIATE=[TRUE|FALSE]</B><BR>
tells the raster library to use its built-in PNG driver rather
than connecting to an external monitor process using sockets. If
- "<tt>TRUE</tt>", there is no need to run "<tt>d.mon start=PNG</tt>"
+ <tt>TRUE</tt>, there is no need to run <tt>d.mon start=PNG</tt>.
</UL>
<H3>Example</H3>
<OL>
-<LI>Define driver settings (here: bash shell syntax)<BR><PRE>
- export GRASS_RENDER_IMMEDIATE=TRUE
- export GRASS_TRUECOLOR=TRUE
-</PRE></LI>
-<LI>Start up the driver<BR><PRE>
- d.mon start=PNG
-</PRE></LI>
-<LI>Display raster map and vector polygons<BR>
-<PRE>
- d.rast <i>somerastermap</i>
- d.vect <i>somevectormap</i> color=red
-</PRE></LI>
-<LI> Stop the driver subsequently. This will write a
-file named <i>map.png</i> to be created in your current directory:
-<PRE>
- d.mon stop=PNG
-</PRE></LI>
+ <LI>Define driver settings (here: bash shell syntax)
+<DIV class="code"><PRE>
+export GRASS_RENDER_IMMEDIATE=TRUE
+export GRASS_TRUECOLOR=TRUE
+</PRE></DIV>
+ </LI>
+ <LI>Start up the driver
+<DIV class="code"><PRE>
+d.mon start=PNG
+</PRE></DIV>
+ </LI>
+ <LI>Display raster map and vector polygons
+<DIV class="code"><PRE>
+d.rast <i>somerastermap</i>
+d.vect <i>somevectormap</i> color=red
+</PRE></DIV>
+ </LI>
+ <LI> Stop the driver subsequently. This will write a
+ file named <tt>map.png</tt> to be created in your current directory:
+<DIV class="code"><PRE>
+d.mon stop=PNG
+</PRE></DIV>
+ </LI>
</OL>
<H2>NOTES</H2>
The PNG driver uses the libpng (see the <a href="http://www.libpng.org/pub/png/">libpng</a>
home page) and zlib (see the
-<a href="http://www.info-zip.org/pub/infozip/zlib/">info-zip</a> home
-page), all which needs to be installed for the PNG driver to work (it's
-worth it).
+<a href="http://www.zlib.net">zlib</a> home page), all which needs to
+be installed for the PNG driver to work (it's worth it).
<p>
The resolution of the <i>PNG</i> raster map is defined by the map
extents. Use <em>g.region -p</em> to get the number of rows and cols and
@@ -93,24 +100,26 @@
preserve the aspect ratio.
<p>
Further PNG file processing (e.g. quantization to 1 bit for monochrome images)
-can be done with 'pnmquant' of the <a href=http://netpbm.sourceforge.net/>netpbm</a> tools.
+can be done with 'pnmquant' of the <a href="http://netpbm.sourceforge.net/">netpbm</a> tools.
<h2>SEE ALSO</h2>
<EM>
-<A HREF="htmlmapdriver.html">HTML map driver</A>,
-<A HREF="psdriver.html">PostScript driver</A>,
-<A href="xdriver.html">XDRIVER</A>
-<BR>
-<A HREF="d.frame.html">d.frame</A>,
-<A href="d.mon.html">d.mon</A>,
-<A href="d.rast.html">d.rast</A>,
-<A href="d.vect.html">d.vect</A>
+ <a href="displaydrivers.html">Display drivers</a>
+ <br>
+ <A HREF="htmlmapdriver.html">HTMLMAP driver</A>,
+ <A HREF="psdriver.html">PostScript driver</A>,
+ <A href="xdriver.html">XDRIVER</A>
+ <BR>
+ <A HREF="d.frame.html">d.frame</A>,
+ <A href="d.mon.html">d.mon</A>,
+ <A href="d.rast.html">d.rast</A>,
+ <A href="d.vect.html">d.vect</A>
</EM>
<H2>AUTHOR</H2>
-Original version:<BR>
-Per Henrik Johansen <<I>phj (at) norgit.no</I>><BR>
-<I><a href="http://www.norgit.no">NORGIT AS</a></I>
-<P>
-Rewritten by Glynn Clements, 2003
-<p><i>Last changed: $Date$</i>
+Original version: Per Henrik Johansen <<I>phj (at) norgit.no</I>> <I><a href="http://www.norgit.no">NORGIT AS</a></I>
+<BR>
+Rewritten by: Glynn Clements, 2003
+
+<p>
+<i>Last changed: $Date$</i>
Modified: grass/trunk/display/drivers/PS/description.html
===================================================================
--- grass/trunk/display/drivers/PS/description.html 2008-03-23 06:07:32 UTC (rev 30702)
+++ grass/trunk/display/drivers/PS/description.html 2008-03-23 14:34:53 UTC (rev 30703)
@@ -10,8 +10,9 @@
<img src="grass_logo.png" alt="GRASS logo"><hr align=center size=6 noshade>
<H2>NAME</H2>
-<EM><B> PS driver</B></EM> - driver to create PostScript files
+<EM><B> PS driver</B></EM> - driver to create PostScript files.
<BR><EM>(drivers)</EM>
+
<H2>DESCRIPTION</H2>
The PS driver generates a PostScript file from GRASS display commands.
@@ -24,52 +25,50 @@
Several environment variables effect the operation
of the PS driver:
-<p>GRASS_PSFILE
-<br> name of output file. If it ends with ".eps" an EPS file
-will be created.
+<UL>
+ <LI><B>GRASS_PSFILE</B><BR>
+ name of output file. If it ends with ".eps" an EPS file
+ will be created.</LI><BR>
+ <LI><B>GRASS_PAPER</B><BR>
+ sets the screen dimensions and margins to
+ fit a standard paper size, see also GRASS_WIDTH, GRASS_HEIGHT.</LI><BR>
+ <LI><B>GRASS_WIDTH</B><BR>
+ defines the width of the screen, see also GRASS_HEIGHT</LI><BR>
+ <LI><B>GRASS_HEIGHT</B><BR>
+ defines the height of the screen, see also GRASS_WIDTH</LI><BR>
+ <LI><B>GRASS_TRUECOLOR</B><BR>
+ if <tt>TRUE</tt>, the PS driver generates color output, otherwise
+ monochrome.</LI><BR>
+ <LI><B>GRASS_LANDSCAPE</B><BR>
+ if <tt>TRUE</tt>, the screen is rotated 90 degrees
+ counter-clockwise so that a "landscape" screen fits better on
+ "portrait" paper.</LI><BR>
+ <LI><B>GRASS_PS_HEADER</B><BR>
+ if <tt>FALSE</tt>, the output is appended to any existing file,
+ and no prolog or setup sections are generated.</LI><BR>
+ <LI><B>GRASS_PS_TRAILER</B><BR>
+ if <tt>FALSE</tt>, no trailer section is generated.</LI>
+</UL>
-<p>GRASS_PAPER <br> sets the screen dimensions and margins to
-fit a standard paper size, see also GRASS_WIDTH, GRASS_HEIGHT.
-
-<p>GRASS_WIDTH
-<br> defines the width of the screen, see also GRASS_HEIGHT
-
-<p>GRASS_HEIGHT
-<br> defines the height of the screen, see also GRASS_WIDTH
-
-<p>GRASS_TRUECOLOR
-<br> if "TRUE", the PS driver generates color output, otherwise
-monochrome.
-
-<p>GRASS_LANDSCAPE
-<br> if "TRUE", the screen is rotated 90 degrees
-counter-clockwise so that a "landscape" screen fits better on
-"portrait" paper.
-
-<p>GRASS_PS_HEADER
-<br> if "FALSE", the output is appended to any existing file,
-and no prolog or setup sections are generated.
-
-<p>GRASS_PS_TRAILER
-<br> if "FALSE", no trailer section is generated.
-
-
<H3>Example</H3>
<OL>
-<LI>Start up the driver<BR><PRE>
- d.mon start=PS
-</PRE>
-<LI>Display raster map and vector polygons<BR>
-<PRE>
- d.rast <i>somerastermap</i>
- d.vect map=<i>somevectormap</i> color=red
-</PRE>
-<LI> Stop the driver subsequently. This will write a
-file named <i>map.ps</i> to be created in your current directory:
-<PRE>
- d.mon stop=PS
-</PRE></LI>
-
+ <LI>Start up the driver
+<DIV class="code"><PRE>
+d.mon start=PS
+</PRE></DIV>
+ </LI>
+ <LI>Display raster map and vector polygons
+<DIV class="code"><PRE>
+d.rast <i>somerastermap</i>
+d.vect map=<i>somevectormap</i> color=red
+</PRE></DIV>
+ </LI>
+ <LI> Stop the driver subsequently. This will write a
+ file named <tt>map.ps</tt> to be created in your current directory:
+<DIV class="code"><PRE>
+d.mon stop=PS
+</PRE></DIV>
+ </LI>
</OL>
<H2>NOTES</H2>
@@ -84,23 +83,27 @@
colorimage and setrgbcolor operators (this is the case for colour printers
which pre-date level 2 PostScript).
<p>
-Only masked images (d.rast -o, d.rgb -o, d.his -n) require PostScript level 3.
+Only masked images (<tt>d.rast -o</tt>, <tt>d.rgb -o</tt>, <tt>d.his
+-n</tt>) require PostScript level 3.
<h2>SEE ALSO</h2>
<EM>
-<A HREF="htmlmapdriver.html">HTML map driver</A>,
-<A HREF="pngdriver.html">PNG driver</A>,
-<A href="xdriver.html">XDRIVER</A>
-<BR>
-<A HREF="d.frame.html">d.frame</A>,
-<A href="d.out.file.html">d.out.file</A>,
-<A href="d.mon.html">d.mon</A>,
-<A href="d.rast.html">d.rast</A>,
-<A href="d.vect.html">d.vect</A>
+ <a href="displaydrivers.html">Display drivers</a>
+ <br>
+ <A HREF="htmlmapdriver.html">HTMLMAP driver</A>,
+ <A HREF="pngdriver.html">PNG driver</A>,
+ <A href="xdriver.html">XDRIVER</A>
+ <BR>
+ <A HREF="d.frame.html">d.frame</A>,
+ <A href="d.out.file.html">d.out.file</A>,
+ <A href="d.mon.html">d.mon</A>,
+ <A href="d.rast.html">d.rast</A>,
+ <A href="d.vect.html">d.vect</A>
</EM>
<H2>AUTHOR</H2>
Glynn Clements, 2007
-<p><i>Last changed: $Date$</i>
+<p>
+<i>Last changed: $Date$</i>
Modified: grass/trunk/display/drivers/XDRIVER/description.html
===================================================================
--- grass/trunk/display/drivers/XDRIVER/description.html 2008-03-23 06:07:32 UTC (rev 30702)
+++ grass/trunk/display/drivers/XDRIVER/description.html 2008-03-23 14:34:53 UTC (rev 30703)
@@ -13,7 +13,7 @@
<H2>NAME</H2>
<EM><B>XDRIVER - GRASS Monitor</B></EM> - driver to display GRASS maps in
-X11 environment<BR>
+X11 environment.<BR>
<EM>(drivers)</EM>
<H2>DESCRIPTION</H2>
@@ -24,23 +24,22 @@
Variables:
<ul>
-<li>GRASS_WIDTH
-<br> set the x size in pixel for the XDRIVER (default: 640)
-<li>GRASS_HEIGHT
-<br> set the y size in pixel for the XDRIVER (default: 480)
-<!-- ??? -->
-<li>XDRIVER_TRUECOLOR=[TRUE|FALSE]
-<br> Look for a TrueColor visual (?)
-<li>XDRIVER_WINDOW
-<br> ?
-<li>XDRIVER_PRIVATE_CMAP
-<br> Private color map (?)
-
-<!-- removed? -->
-<li>XDRIVER_LEFT
-<br> defines the left position of GRASS monitor (<i>removed?</i>)
-<li>XDRIVER_TOP
-<br> define the upper position of GRASS monitor (<i>removed?</i>)
+ <li><b>GRASS_WIDTH</b><br>
+ set the x size in pixel for the XDRIVER (default: 640)</li><br>
+ <li><b>GRASS_HEIGHT</b><br>
+ set the y size in pixel for the XDRIVER (default: 480)</li></br>
+ <!-- ??? -->
+ <li><b>XDRIVER_TRUECOLOR=[TRUE|FALSE]</b><br>
+ Look for a TrueColor visual (?)</li><br>
+ <li><b>XDRIVER_WINDOW</b><br>
+ ?</li><br>
+ <li><b>XDRIVER_PRIVATE_CMAP</b><br>
+ Private color map (?)</li><br>
+ <!-- removed? -->
+ <li><b>XDRIVER_LEFT</b><br>
+ defines the left position of GRASS monitor (<i>removed?</i>)</li><br>
+ <li><b>XDRIVER_TOP</b><br>
+ define the upper position of GRASS monitor (<i>removed?</i>)</li><br>
</ul>
<h3>Set the XDRIVER size</h3>
@@ -57,21 +56,24 @@
setenv GRASS_HEIGHT yyy
</pre></div>
-To control the XDRIVER, use the <A HREF="d.mon.html">d.mon</A> module.
+To control the XDRIVER, use the <em><A HREF="d.mon.html">d.mon</A></em> module.
<p>
The maximum color depth depends on the current X Server settings.
<H2>SEE ALSO</H2>
<EM>
-<A HREF="htmlmapdriver.html">HTML map driver</A>,
-<A HREF="pngdriver.html">PNG driver</A>,
-<A HREF="psdriver.html">PostScript driver</A>
-<BR>
-<A HREF="d.frame.html">d.frame</A>,
-<A HREF="d.mon.html">d.mon</A>,
-<A HREF="g.region.html">g.region</A>
+ <a href="displaydrivers.html">Display drivers</a>
+ <br>
+ <A HREF="htmlmapdriver.html">HTMLMAP driver</A>,
+ <A HREF="pngdriver.html">PNG driver</A>,
+ <A HREF="psdriver.html">PostScript driver</A>
+ <BR>
+ <A HREF="d.frame.html">d.frame</A>,
+ <A HREF="d.mon.html">d.mon</A>,
+ <A HREF="g.region.html">g.region</A>
+ <a href="d.rast.html">d.rast</A>,
+ <a href="d.vect.html">d.vect</A>
</EM>
-<BR>
<H2>AUTHORS</H2>
CERL<br>
@@ -80,6 +82,3 @@
<p>
<i>Last changed: $Date$</i>
-</p>
-</body>
-</html>
Modified: grass/trunk/display/drivers/cairo/description.html
===================================================================
--- grass/trunk/display/drivers/cairo/description.html 2008-03-23 06:07:32 UTC (rev 30702)
+++ grass/trunk/display/drivers/cairo/description.html 2008-03-23 14:34:53 UTC (rev 30703)
@@ -11,70 +11,81 @@
<H2>NAME</H2>
<EM><B>Cairo driver</B></EM> - driver for bitmap or vector output using
-the Cairo graphics library
+the Cairo graphics library.
<BR>
<EM>(drivers)</EM>
+
<H2>DESCRIPTION</H2>
-<P>
+
The Cairo driver generates PNG, BMP, PPM, PS, PDF or SVG images from GRASS
display commands, using the
<A HREF="http://www.cairographics.org/">Cairo graphics library</A>.
The image format is selected from the extension of the output file.
+
<P>
It is started as 'pseudo' monitor (output to an image file) and when
stopped, all output from previously used display commands are written to
the output file.
<H2>USAGE</H2>
+
<H3>Environment variables</H3>
+
Several environment variables affect the operation of the Cairo driver:
+
<UL>
<LI><B>GRASS_WIDTH=xxx</B><BR>
- the width of the image.<BR><BR>
+ the width of the image.
+ </LI><BR>
<LI><B>GRASS_HEIGHT=yyy</B><BR>
- the height of the image.<BR><BR>
+ the height of the image.
+ </LI><BR>
<LI><B>GRASS_CAIROFILE=filename</B><BR>
the name and format of the resulting image file, default is
- <b>map.png</b>.<BR>
+ <tt>map.png</tt>.<BR>
The image format is determined from the file extension.<BR>
Supported bitmap formats:
<UL>
- <LI><B>.png</B> - Portable Network Graphics (PNG)
- <LI><B>.bmp</B> - Windows Bitmap (BMP)
- <LI><B>.ppm</B> - Portable Pixmap (PPM)
+ <LI><B>.png</B> - Portable Network Graphics (PNG)</LI>
+ <LI><B>.bmp</B> - Windows Bitmap (BMP)</LI>
+ <LI><B>.ppm</B> - Portable Pixmap (PPM)</LI>
</UL>
Supported vector formats:
<UL>
- <LI><B>.pdf</B> - Portable Document Format (PDF)
- <LI><B>.ps</B> - PostScript (PS)
- <LI><B>.svg</B> - Scalable Vector Graphics (SVG)
+ <LI><B>.pdf</B> - Portable Document Format (PDF)</LI>
+ <LI><B>.ps</B> - PostScript (PS)</LI>
+ <LI><B>.svg</B> - Scalable Vector Graphics (SVG)</LI>
</UL>
(Note: Some formats may not be available, depending on your platform and
the Cairo library that GRASS was built with.)
- <br><br>
+ </LI><BR>
<LI><B>GRASS_BACKGROUNDCOLOR=RRGGBB</B><BR>
specifies the background color to use in RGB
- notation (hex values). Default is <b>FFFFFF</b> (white).<br><br>
+ notation (hex values). Default is <b>FFFFFF</b> (white).
+ </LI><BR>
<LI><B>GRASS_TRANSPARENT=[TRUE|FALSE]</B><BR>
- sets transparent background on (TRUE) or off (FALSE, default).<BR><BR>
+ sets transparent background on (TRUE) or off (FALSE, default).
+ </LI><BR>
<LI><B>GRASS_AUTO_WRITE=[TRUE|FALSE]</B><BR>
- if set to "TRUE", the image file will be written after each
- operation (i.e. whenever a client disconnects), rather than
- only being written out when the driver terminates.<BR>
- (Note: This only applies to bitmap formats - vector formats
- are always written directly to file)<BR><BR>
+ if set to <tt>TRUE</tt>, the image file will be written after each
+ operation (i.e. whenever a client disconnects), rather than
+ only being written out when the driver terminates.<BR>
+ (Note: This only applies to bitmap formats - vector formats
+ are always written directly to file).
+ </LI><BR>
<LI><B>GRASS_CAIRO_READ</B><BR>
- if "TRUE", the Cairo driver will initialize the image from
- the contents of $GRASS_CAIROFILE.<BR>
- (Note: This is only supported for bitmap formats)<BR><BR>
+ if <tt>TRUE</tt>, the Cairo driver will initialize the image from
+ the contents of GRASS_CAIROFILE.<BR>
+ (Note: This is only supported for bitmap formats)
+ </LI><BR>
<LI><B>GRASS_CAIRO_MAPPED</B><BR>
- if "TRUE", the Cairo driver will map $GRASS_CAIROFILE as its framebuffer,
- rather than using memory. This only works with BMP files.<BR><BR>
+ if <tt>TRUE</tt>, the Cairo driver will map GRASS_CAIROFILE as its framebuffer,
+ rather than using memory. This only works with BMP files.
+ </LI>
</UL>
+<H3>Examples</H3>
-<H3>Examples</H3>
-<P>
Example using the driver directly (bash-syntax):
<div class="code"><PRE>
export GRASS_CAIROFILE=spearfish.png
@@ -88,8 +99,7 @@
d.mon stop=cairo
</PRE></div>
-<P>
-Example using <I>d.out.file</I>:
+Example using <em><a href="d.out.file.html">d.out.file</a></em>:
<div class="code"><PRE>
d.mon x0
d.rast map=elevation.10m
@@ -100,7 +110,7 @@
</PRE></div>
<P>
-A more complicated example using <I>d.out.file</I>:
+A more complicated example using <em><a href="d.out.file.html">d.out.file</a></em>:
<div class="code"><PRE>
r.shaded.relief map=elevation.dem
r.watershed elev=elevation.dem basin=watershed.basin thresh=10000
@@ -126,25 +136,28 @@
<H2>NOTES</H2>
-<P>The driver is still in development. Enable it by specifying
+The driver is still in development. Enable it by specifying
<CODE>--with-cairo</CODE> when configuring GRASS. This
requires a reasonably recent version of the Cairo libraries
-and a working pkg-config.</P>
+and a working pkg-config.
-<P>Antialiasing is enabled by default for bitmap formats. There is
-currently no way of disabling this.</P>
+<P>
+Antialiasing is enabled by default for bitmap formats. There is
+currently no way of disabling this.
-<P>Cairo supports true vector format output whenever possible. However,
+<P>
+Cairo supports true vector format output whenever possible. However,
if the selected format doesn't support a necessary feature, Cairo may
fall back on rendering a bitmap representation of the image wrapped in
-the selected vector format.</P>
+the selected vector format.
-<P>Cairo driver output via <A HREF="d.out.file.html">d.out.file</A>
+<P>
+Cairo driver output via <em><A HREF="d.out.file.html">d.out.file</A></em>
is supported via the -c flag.</P>
<h2>SEE ALSO</h2>
<EM>
-<A HREF="htmlmapdriver.html">HTML map driver</A>,
+<A HREF="htmlmapdriver.html">HTMLMAP driver</A>,
<A HREF="pngdriver.html">PNG driver</A>,
<A HREF="psdriver.html">PostScript driver</A>,
<A href="xdriver.html">XDRIVER</A>
@@ -159,4 +172,3 @@
<H2>AUTHOR</H2>
Lars Ahlzen <<I>lars (at) ahlzen.com</I>><BR>
and the GRASS Development Team.
-
Modified: grass/trunk/lib/init/variables.html
===================================================================
--- grass/trunk/lib/init/variables.html 2008-03-23 06:07:32 UTC (rev 30702)
+++ grass/trunk/lib/init/variables.html 2008-03-23 14:34:53 UTC (rev 30703)
@@ -9,25 +9,26 @@
<img src="grass_logo.png" alt="_\|/_ GRASS logo"><hr align=center size=6 noshade>
-<H2>GRASS variables and environment variables</H2>
+<h2>GRASS variables and environment variables</h2>
<!-- file source:
./lib/init/variables.html
-->
-<P>
There are two types of variables:
<ul>
<li><a href="#enviro">shell environment</a> variables,</li>
<li><a href="#gisenv">GRASS gisenv</a> variables.</li>
</ul>
-There are a number of shell environment variable groups:
+There are a number of <i>shell</i> environment variable groups:
<ul>
-<li><a href="#png">PNG driver</a>
-<li><a href="#ps">PS driver (PostScript)</a>
-<li><a href="#dirrend">variables for direct rendering</a>
-<li><a href="#internal">variables for internal use</a>
+<li><a href="#png">PNG driver</a></li>
+<li><a href="#ps">PS driver (PostScript)</a></li>
+<li><a href="#html">HTMLMAP driver</a></li>
+<!--<li><a href="#cairo">Cairo driver</a></li>-->
+<li><a href="#dirrend">variables for direct rendering</a></li>
+<li><a href="#internal">variables for internal use</a></li>
</ul>
Any setting which needs to be modifiable by a GRASS program (e.g. MONITOR)
@@ -35,26 +36,35 @@
<h2>GRASS-related Files</h2>
+
GRASS maintains some settings in a number of files on the system. They are
detailed <a href="#files">below</a>.
<h2>Setting environment variables</h2>
-<br>Setting environment variables depends on the shell being used:
-<br> Bash: <tt>export VARIABLE=value</tt>
-<br> or
-<br> Csh: <tt>setenv VARIABLE value</tt>
-<br> or
-<br> Cmd.exe (Windows): <tt>set VARIABLE=value</tt>
+Setting environment variables depends on the shell being used:
+<br><br>
+Bash:
+<div class="code"><pre>
+export VARIABLE=value
+</pre></div>
+Csh:
+<div class="code"><pre>
+setenv VARIABLE value
+</pre></div>
+Cmd.exe (Windows):
+<div class="code"><pre>
+set VARIABLE=value
+</pre></div>
<h2>Setting environment variables permanently</h2>
+
<ul>
<li>
To get personal BASH shell definitions (aliases, color listing option, ...)
into GRASS, store them in:<br>
<tt>$HOME/.grass.bashrc</tt></li>
-
<li>
To get personal CSH shell definitions (aliases, color listing option, ...)
into GRASS, store them in:<br>
@@ -64,28 +74,24 @@
<h2>Setting GRASS variables</h2>
-Use "<a href="g.gisenv.html">g.gisenv</a>" within GRASS. This permanently
-predefines GRASS variables in the <tt>.grassrc6</tt> file.<br>
-<p>
-Usage:<BR>
+Use <em><a href="g.gisenv.html">g.gisenv</a></em> within GRASS. This permanently
+predefines GRASS variables in the <tt>.grassrc6</tt> file.
+<br><br>
+Usage:
<div class="code"><pre>
g.gisenv set="VARIABLE=VALUE"
</pre></div>
-<p>
-It looks unusual with two equals signs, but g.gisenv serves dual duty for
+It looks unusual with two equals signs, but <em>g.gisenv</em> serves dual duty for
getting and setting GRASS variables.
-<P>
-If the user just specifies a variable name, it defaults to "get" mode.
-For example:<br>
+<p>
+If the user just specifies a variable name, it defaults to <b>get</b> mode.
+For example:
<div class="code"><pre>
-GRASS ~> g.gisenv GRASS_GUI
+g.gisenv GRASS_GUI
text
</pre></div>
-<BR>
-<hr>
-<BR>
<a name="enviro"></a>
<h2>List of selected (GRASS related) environment variables</h2>
@@ -93,189 +99,248 @@
[ To be set from the terminal shell or startup scripts ]
</blockquote>
-<p>GISBASE
-<br> directory where GRASS lives. This is set automatically by the startup script.
+<dl>
+
+ <dt>GISBASE</dt>
+ <dd>directory where GRASS lives. This is set automatically by the
+ startup script.</dd>
+
+ <br>
+ <dt>GISRC</dt>
+ <dd>name of <tt>.grassrc6</tt> file. Defines the system wide value
+ while in a GRASS session.</dd>
+
+ <br>
+ <dt>GRASS_ADDON_PATH</dt>
+ <dd>[grass startup script]<br>
+ allows to specify additional paths to local GRASS modules extra
+ to standard distribution.</dd>
+
+ <br>
+ <dt>GRASS_ADDON_ETC</dt>
+ <dd>[libgis, g.findetc]<br>
+ specify paths where support files (etc/) may be found external to
+ standard distribution.</dd>
+
+ <br>
+ <dt>GRASS_BATCH_JOB</dt>
+ <dd>defines the name (path) of a shell script to be processed as batch job.</dd>
+
+ <br>
+ <dt>GRASS_ERROR_MAIL</dt>
+ <dd>set to any value to send user mail on an error or warning that
+ happens while stderr is being redirected.</dd>
+
+ <br>
+ <dt>GRASS_GNUPLOT</dt>
+ <dd>[<!-- m.svfit, s.probplt, s.sv -->i.spectral]<br>
+ program to use for plotting <em>gnuplot</em> data.</dd>
+
+ <br>
+ <dt>GRASS_GUI</dt>
+ <dd>either <tt>text</tt> or <tt>gui</tt> to define non-/graphical startup.
+ <br><br>
+ Can also specify the name of the GUI to use, e.g. <tt>tcltk</tt>
+ (<em><a href="gis.m.html">gis.m</a></em>), <tt>oldtcltk</tt>
+ (<em><a href="d.m.html">d.m</a></em>) or <tt>wxpython</tt>
+ (<em><a href="wxGUI.html">wxGUI</a></em>). Also exists as a GRASS
+ gisenv variable (see below). If this shell variable exists at GRASS
+ startup, it will determine the GUI used. If it is not defined startup
+ will default to the last GUI used.</dd>
+
+ <br>
+ <dt>GRASS_FONT_CAP</dt>
+ <dd>[g.mkfontcap, d.font, display drivers]<br>
+ specifies an alternative location (to $GISBASE/etc/fontcap) for
+ the font configuration file.</dd>
+
+ <br>
+ <dt>GRASS_HEIGHT</dt>
+ <dd>[d.mon]<br>
+ defines the height of GRASS monitor, see also GRASS_WIDTH.</dd>
+
+ <br>
+ <dt>GRASS_HTML_BROWSER</dt>
+ <dd>[init.sh, d.m, gis.m]<br>
+ defines name of HTML browser. For most platforms this should be
+ an executable in your PATH, or the full path to an executable.<br><br>
+ Mac OS X runs applications differently from the CLI.
+ Therefore, GRASS_HTML_BROWSER should be the application's signature,
+ which is a domain-like name, just reversed, i.e. com.apple.Safari. To
+ find an application's signature, type the following in a Terminal
+ (fill in the path to the application you are interested in, for
+ example: /Applications/Safari.app):<br> <code>grep -A 1
+ "CFBundleIdentifier"</code> <i>/path/to/application.app</i><code>/Contents/Info.plist</code><br>
+ The signature is the <string> following the <key>,
+ without the bracketing <string> tags.</dd>
+
+ <br>
+ <dt>GRASS_INT_ZLIB</dt>
+ <dd>[libgis]<br>
+ if the environment variable GRASS_INT_ZLIB exists, new compressed
+ rasters will be compressed using zlib instead of RLE
+ compression. Such rasters will have a <tt>compressed</tt> value of 2 in the
+ cellhd file.
+ <br><br>
+ Obviously, decompression is controlled by the
+ raster's <tt>compressed</tt> value, not the environment variable.
+ </dd>
+
+ <br>
+ <dt>GRASS_MESSAGE_FORMAT</dt>
+ <dd>[various modules]<br>
+ maybe set to either <tt>standard</tt> or <tt>gui</tt> (normally
+ GRASS takes care).</dd>
+
+ <br>
+ <dt>GRASS_MOUSE_BUTTON</dt>
+ <dd>[various modules]<br>
+ swaps mouse buttons for two-button or left-handed mice. Its value
+ has three digits 1, 2, and 3, which represent default left, middle, and right
+ buttons respectively. Setting to <tt>132</tt> will swap middle and right buttons. Note
+ that this variable should be set before a display driver is initialized (e.g.,
+ <tt>d.mon x0</tt>).</dd>
+
+ <br>
+ <dt>GRASS_PAGER</dt>
+ <dd>[various modules]<br>
+ maybe set to either <tt>less</tt> or <tt>more</tt>.</dd>
+
+ <br>
+ <dt>GRASS_PERL</dt>
+ <dd>[used during install process for generating man pages]<br>
+ set Perl with path.</dd>
+
+ <br>
+ <dt>GRASS_RND_SEED</dt>
+ <dd>set random seed
+ for <em><a href="r.mapcalc.html">r.mapcalc</a></em> rand()
+ function.</dd>
+
+ <!-- HB Sept 2005: I don't think this exists anymore:
+ <p>GRASS_STDERR
+ <br> set to any value to prevent user mail on error
+ -->
+ <br>
+ <dt>GRASS_SH</dt>
+ <dd>[shell scripts on Windows]<br>
+ path to bourne shell interpreter used to run shell scripts.</dd>
+
+ <br>
+ <dt>GRASS_PYTHON</dt>
+ <dd>[wxGUI, Python SWIG]<br>
+ set to override Python executable.</dd>
+
+ <br>
+ <dt>GRASS_TCLSH</dt>
+ <dd>[nviz]<br>
+ set tclsh shell name to override 'tclsh'.</dd>
+
+ <br>
+ <dt>GRASS_XTERM</dt>
+ <dd>lib/init/grass-xterm-wrapper<br>
+ lib/init/grass-xterm-mac<br>
+ set to any value (e.g. rxvt, aterm, gnome-terminal, konsole) to
+ substitute 'x-terminal-emulator' or 'xterm'. The Mac OS X app
+ startup defaults to an internal '$GISBASE/etc/grass-xterm-mac',
+ which emulates the necessary xterm functionality in
+ Terminal.app.</dd>
+
+ <br>
+ <dt>GRASS_UI_TERM</dt>
+ <dd>set to any value to use the terminal based parser.</dd>
-<p>GISRC
-<br> name of .grassrc6 file. GISRCRC defines the system wide value
-while in a GRASS session.
+ <br>
+ <dt>GRASS_VERSION</dt>
+ <dd>reports the current version number (used by R-stats interface etc);
+ should not be changed by user.</dd>
+
+ <br>
+ <dt>GRASS_WIDTH</dt>
+ <dd>[d.mon]<br>
+ defines the width of GRASS monitor, see also GRASS_HEIGHT.</dd>
+
+ <br>
+ <dt>GRASS_WISH</dt>
+ <dd>[d.m, nviz]<br>
+ set wish shell name to override 'wish'.</dd>
+
+ <br>
+ <dt>GRASS_NO_GLX_PBUFFERS</dt>
+ <dd>[nviz]<br>
+ set to any value to disable the use of GLX Pbuffers.</dd>
+
+ <br>
+ <dt>GRASS_NO_GLX_PIXMAPS</dt>
+ <dd>[nviz]<br>
+ Set to any value to disable the use of GLX Pixmaps.</dd>
+</dl>
-<p>GRASS_ADDON_PATH
-<br>[grass startup script]
-<br> allows to specify additional paths to local GRASS modules extra
-to standard distribution.
+<a name="png"></a>
+<h3>List of selected GRASS PNG driver environment variables</h3>
-<p>GRASS_ADDON_ETC
-<br>[libgis, g.findetc]
-<br> specify paths where support files (etc/) may be found external to
-standard distribution.
+<blockquote>
+[ These variables control the function of the PNG driver ]
+</blockquote>
-<p>GRASS_BATCH_JOB
-<br> defines the name (path) of a shell script to be processed as batch job.
+See <a href="pngdriver.html">PNG driver</a> manual page for detailed
+list of the variables.
-<p>GRASS_ERROR_MAIL
-<br> set to any value to send user mail on an error or warning that
- happens while stderr is being redirected.
+<!--
+ 2008/03 -- variables are described in PNG driver manual
+ page. The link should be enough here.
-<p>GRASS_GNUPLOT
-<br>[<!-- m.svfit, s.probplt, s.sv -->i.spectral]
-<br> program to use for plotting "gnuplot" data
+ <P></P>
-<p>GRASS_GUI
-<br> either "text" or "tcltk" to define non-/graphical startup.
-Can also specify the name of the GUI to use, e.g. "gis.m", "d.m" or
-"wxpython" (<i>wx name subject to change</i>). Also exists as a GRASS
-gisenv variable (see below). If this shell variable exists at GRASS startup,
-it will determine the GUI used. If it is not defined startup will default
-to the last GUI used.
-
-<p>GRASS_FONT_CAP
-<br>[g.mkfontcap, d.font, display drivers]
-<br> Specifies an alternative location (to $GISBASE/etc/fontcap) for
-the font configuration file.
-
-<p>GRASS_HEIGHT
-<br>[d.mon]
-<br> defines the height of GRASS monitor, see also GRASS_WIDTH
-
-<P>GRASS_HTML_BROWSER
-<br>[init.sh, d.m, gis.m]
-<br> defines name of HTML browser. For most platforms this should be
-an executable in your PATH, or the full path to an executable.<br>
- Mac OS X runs applications differently from the CLI. Therefore,
-GRASS_HTML_BROWSER should be the application's signature, which is a domain-like
-name, just reversed. ie: com.apple.Safari. To find an application's signature,
-type the following in a Terminal (fill in the path to the application you are
-interested in, for example: /Applications/Safari.app):<br>
- <code>grep -A 1 "CFBundleIdentifier"</code> <i>/path/to/application.app</i><code>/Contents/Info.plist</code><br>
- The signature is the <string>
-following the <key>, without the bracketing <string> tags.
-
-<P>GRASS_INT_ZLIB
-<br>[libgis]
-<br> If the environment variable GRASS_INT_ZLIB exists, new compressed
- rasters will be compressed using zlib instead of RLE compression. Such
- rasters will have a "compressed" value of 2 in the cellhd file.<br>
- Obviously, decompression is controlled by the raster's "compressed"
- value, not the environment variable.
-
-<p>GRASS_MESSAGE_FORMAT
-<br>[various modules]
-<br>Maybe set to either "standard" or "gui" (normally GRASS takes care)
-
-<p>GRASS_MOUSE_BUTTON
-<br>[various modules]
-<br> swaps mouse buttons for two-button or left-handed mice. Its value
-has three digits 1, 2, and 3, which represent default left, middle, and right
-buttons respectively. Setting to "132" will swap middle and right buttons. Note
-that this variable should be set before a display driver is initialized (e.g.,
-d.mon x0).
-
-<p>GRASS_PAGER
-<br>[various modules]
-<br>Maybe set to either "less" or "more"
-
-<p>GRASS_PERL
-<br>[Used during install process for generating man pages]
-<br> set perl with path
-
-<p>GRASS_RND_SEED
-<br> set random seed for r.mapcalc rand() function
-
-<!-- HB Sept 2005: I don't think this exists anymore:
-<p>GRASS_STDERR
-<br> set to any value to prevent user mail on error
--->
-
-<p>GRASS_SH
-<br>[shell scripts on Windows]
-<br>Path to bourne shell interpreter used to run shell scripts
-
-<p>GRASS_PYTHON
-<br>[wxgrass]
-<br> set to override 'python'
-
-<p>GRASS_TCLSH
-<br>[nviz]
-<br> set tclsh shell name to override 'tclsh'
-
-<p>GRASS_XTERM
-<br>lib/init/grass-xterm-wrapper
-<br>lib/init/grass-xterm-mac
-<br> set to any value (e.g. rxvt, aterm, gnome-terminal, konsole) to substitute 'x-terminal-emulator' or 'xterm'. The Mac OS X app startup defaults to an internal '$GISBASE/etc/grass-xterm-mac', which emulates the necessary xterm funtionality in Terminal.app.
-
-<p>GRASS_UI_TERM
-<br> set to any value to use the terminal based parser
-
-<p>GRASS_VERSION
-<br> reports the current version number (used by R-stats interface etc);
-<br> should not be changed by user
-
-<p>GRASS_WIDTH
-<br>[d.mon]
-<br> defines the width of GRASS monitor, see also GRASS_HEIGHT
-
-<p>GRASS_WISH
-<br>[d.m, nviz]
-<br> set wish shell name to override 'wish'
-
-<p>GRASS_NO_GLX_PBUFFERS
-<br>[nviz]
-<br> set to any value to disable the use of Pbuffers
-
-<p>GRASS_NO_GLX_PIXMAPS
-<br>[nviz]
-<br> set to any value to disable the use of GLX Pixmaps
-
-
-<a name="png"></a>
-<h3>List of selected GRASS PNG driver environment variables</h3>
-<blockquote>
-[ These variables control the function of the
- <a href="pngdriver.html">PNG Driver</a>. ]
-</blockquote>
-<P></P>
-
<p>GRASS_PNGFILE
-<br> name of PNG output file. If it ends with ".ppm" a PPM file will be created.
-
+ <br> name of PNG output file. If it ends with ".ppm" a PPM file will be created.
+
<p>GRASS_WIDTH
-<br> defines the width of GRASS monitor, see also GRASS_HEIGHT
-
+ <br> defines the width of GRASS monitor, see also GRASS_HEIGHT
+
<p>GRASS_HEIGHT
-<br> defines the height of GRASS monitor, see also GRASS_WIDTH
-
+ <br> defines the height of GRASS monitor, see also GRASS_WIDTH
+
<p>GRASS_BACKGROUNDCOLOR
-<br> defines the background color of the image created by the PNG driver
-
+ <br> defines the background color of the image created by the PNG driver
+
<p>GRASS_TRANSPARENT
-<br> if "TRUE", the image created by the PNG driver will have a
-transparent background
-
+ <br> if "TRUE", the image created by the PNG driver will have a
+ transparent background
+
<p>GRASS_PNG_COMPRESSION
-<br> compression level of PNG files (0 = none, 1 = fastest, 9 = best)
-
+ <br> compression level of PNG files (0 = none, 1 = fastest, 9 = best)
+
<p>GRASS_TRUECOLOR
-<br> if "TRUE", the PNG driver generates a true-color image
-
+ <br> if "TRUE", the PNG driver generates a true-color image
+
<p>GRASS_PNG_AUTO_WRITE
-<br> tells the PNG driver to write the image to a file whenever a
-client disconnects, rather than waiting until you stop the monitor
-
+ <br> tells the PNG driver to write the image to a file whenever a
+ client disconnects, rather than waiting until you stop the monitor
+
<p>GRASS_PNG_READ
-<br> if "TRUE", the PNG driver will initialize the image from
-the contents of $GRASS_PNGFILE
-
+ <br> if "TRUE", the PNG driver will initialize the image from
+ the contents of $GRASS_PNGFILE
+
<p>GRASS_PNG_MAPPED
-<br> if "TRUE", the PNG driver will map $GRASS_PNGFILE as its framebuffer,
+ <br> if "TRUE", the PNG driver will map $GRASS_PNGFILE as its framebuffer,
rather than using memory; this only works with BMP files
+ -->
<a name="ps"></a>
<h3>List of selected GRASS PS driver environment variables</h3>
+
<blockquote>
-[ These variables control the function of the
- <a href="psdriver.html">PS Driver</a>. ]
+[ These variables control the function of the PS driver ]
</blockquote>
+
+See <a href="psdriver.html">PS driver</a> manual page for detailed
+list of the variables.
+
+<!--
+ 2008/03 -- variables are described in PS driver manual
+ page. The link should be enough here.
+
<P></P>
<p>GRASS_PSFILE
@@ -306,178 +371,236 @@
<p>GRASS_PS_TRAILER
<br> if "FALSE", no trailer section is generated.
+-->
+<a name="html"></a>
+<h3>List of selected HTMLMAP driver environment variables</h3>
+<blockquote>
+[ These variables control the function of the HTMLMAP driver ]
+</blockquote>
+
+See <a href="htmlmapdriver.html">HTMLMAP driver</a> manual page for
+detailed list of the variables.
+
+<!--
+<a name="cairo"></a>
+<h3>List of selected Cairo driver environment variables</h3>
+
+<blockquote>
+[ These variables control the function of the Cairo driver ]
+</blockquote>
+
+See <a href="cairodriver.html">Cairo driver</a> manual page for
+detailed list of the variables.
+-->
<a name="dirrend"></a>
<h3>List of selected GRASS environment variables for direct rendering</h3>
<blockquote>
[ In addition to those which are understood by the
- <a href="pngdriver.html">PNG Driver</a>, the following variables
+ <a href="pngdriver.html">PNG driver</a>, the following variables
affect direct rendering. ]
</blockquote>
-<P></P>
-<p>GRASS_RENDER_IMMEDIATE
-<br> tells the raster library to use its built-in PNG/PS driver rather
-than connecting to an external monitor process using sockets. If
-GRASS_RENDER_IMMEDIATE=TRUE is set, there is no need to run
-"<tt>d.mon start=PNG</tt>"
+<dl>
-<p>GRASS_FONT
-<br> specifies the font as either the name of a font from
-$GISBASE/etc/fontcap (or alternative fontcap file specifed by GRASS_FONT_CAP),
-or alternatively the full path to a FreeType font file.
+ <dt>GRASS_RENDER_IMMEDIATE</dt>
+ <dd>tells the raster library to use its built-in PNG/PS driver rather
+ than connecting to an external monitor process using sockets. If
+ GRASS_RENDER_IMMEDIATE=TRUE is set, there is no need to run
+ <tt>d.mon start=PNG</tt>.</dd>
+
+ <br>
+ <dt>GRASS_FONT</dt>
+ <dd>specifies the font as either the name of a font from
+ $GISBASE/etc/fontcap (or alternative fontcap file specified by GRASS_FONT_CAP),
+ or alternatively the full path to a FreeType font file.</dd>
+
+ <br>
+ <dt>GRASS_ENCODING</dt>
+ <dd>the encoding to be assumed for text which is drawn using a
+ freetype font; may be any encoding know to <em>iconv</em>.</dd>
+</dl>
-<p>GRASS_ENCODING
-<br> the encoding to be assumed for text which is drawn using a
-freetype font; may be any encoding know to "iconv".
-
-
<a name="internal"></a>
<h3>List of selected internal GRASS environment variables</h3>
<blockquote>
-[ These variables are intended <b>for internal use only</b> by the GRASS
-software to facilitate communiction between the GIS engine, GRASS scripts,
-and the GUI.
-
-The user should not set these in a GRASS session. They are meant to be set
-locally for specific commands. ]
+ [ These variables are intended <b>for internal use only</b> by the GRASS
+ software to facilitate communication between the GIS engine, GRASS scripts,
+ and the GUI.
+
+ The user should not set these in a GRASS session. They are meant to be set
+ locally for specific commands. ]
</blockquote>
-<P></P>
-<p>GRASS_OVERWRITE
-<br>[all modules]
-<br> toggles map overwrite.
-<ul>
-<li> 0 - maps are protected (default),
-<li> 1 - maps with identical names will be overwritten.
-</ul>
-This variable is automatically created by g.parser so that the
-"<tt>--overwrite</tt>" option will
-be inherited by dependant modules as the script runs. Setting either the
-GRASS_OVERWRITE environment variable or the OVERWRITE gisenv variable detailed
-below will cause maps with identical names to be overwritten.
+<dl>
+ <dt>GRASS_OVERWRITE</dt>
+ <dd>[all modules]<br>
+ toggles map overwrite.
+ <ul>
+ <li>0 - maps are protected (default),</li>
+ <li>1 - maps with identical names will be overwritten.</li>
+ </ul>
+ This variable is automatically created
+ by <em><a href="g.parser.html">g.parser</a></em> so that the
+ <tt>--overwrite</tt> option will
+ be inherited by dependant modules as the script runs. Setting either the
+ GRASS_OVERWRITE environment variable or the OVERWRITE gisenv variable detailed
+ below will cause maps with identical names to be overwritten.</dd>
+
+ <br>
+ <dt>GRASS_VERBOSE</dt>
+ <dd>[all modules]<br>
+ toggles verbosity level
+ <ul>
+ <li>0 - only errors and warnings are printed</li>
+ <li>1 - progress messages are printed (percent complete)</li>
+ <li>2 - all module messages are printed</li>
+ <li>3 - additional verbose messages are printed</li>
+ </ul>
+ This variable is automatically created by <em><a href="g.parser.html">g.parser</a></em>
+ so that the <tt>--verbose</tt> or <tt>--quiet</tt> flags will be inherited
+ by dependant modules as the script runs.</dd>
+
+ <br>
+ <dt>GRASS_REGION</dt>
+ <dd>[libgis]<br>
+ override region settings, separate parameters with a ";". Format
+ is the same as in the WIND region settings file. Otherwise use is the same as
+ WIND_OVERRIDE.</dd>
+
+ <br>
+ <dt>WIND_OVERRIDE</dt>
+ <dd>[libgis]<br>
+ it causes programs to use the specified named region (created with
+ e.g. <tt>g.region save=...</tt>) to be used as the current region, instead of
+ the region from the WIND file.<br><br>
+ This allows programs such as gis.m to run external commands on an
+ alternate region without having to modify the WIND file then change it
+ back afterwards.</dd>
+</dl>
-<p>GRASS_VERBOSE
-<br>[all modules]
-<br> toggles verbosity level
-<ul>
-<li> 0 - only errors and warnings are printed
-<li> 1 - progress messages are printed (percent complete)
-<li> 2 - all module messages are printed
-<li> 3 - additional verbose messages are printed
-</ul>
-This variable is automatically created by <em><a href="g.parser.html">g.parser</a></em>
-so that the "<tt>--verbose</tt>" or "<tt>--quiet</tt>" flags will be inherited
-by dependant modules as the script runs.
-
-<P>GRASS_REGION
-<br>[libgis]
-<br> Override region settings, separate parameters with a ";". Format
-is the same as in the WIND region settings file. Otherwise use is the same as
-WIND_OVERRIDE.
-
-<p>WIND_OVERRIDE
-<br>[libgis]
-<br>
-It causes programs to use the specified named region (created with
-e.g. "g.region save=...") to be used as the current region, instead of
-the region from the WIND file.<br>
-This allows programs such as gis.m to run external commands on an
-alternate region without having to modify the WIND file then change it
-back afterwards.
-<BR>
-<BR><HR><BR>
-
<a name="gisenv"></a>
<h2>List of selected GRASS gisenv variables</h2>
<blockquote>
-[ Use <tt>g.gisenv</tt> to get/set/unset/change them ]
+ [ Use <em>g.gisenv</em> to get/set/unset/change them ]
</blockquote>
-<p>DEBUG
-<br>[entire GRASS]
-<br> sets level of debug message output (0: no debug messages)
-<br><tt>g.gisenv set=DEBUG=0</tt>
+<dl>
+
+ <dt>DEBUG</dt>
+ <dd>[entire GRASS]<br>
+ sets level of debug message output (0: no debug messages)
+ <div class="code"><pre>
+ g.gisenv set=DEBUG=0
+ </pre></div>
+
+ <br>
+ <dt>DM_FORM_MODE</dt>
+ <dd>[d.m]<br>
+ sets default form mode (<tt>txt</tt> or <tt>gui</tt>)</dd>
+
+ <br>
+ <dt>GISDBASE</dt>
+ <dd>initial database</dd>
-<p>DM_FORM_MODE
-<br>[d.m]
-<br> sets default form mode (txt or gui)
-<br><tt>g.gisenv set=DM_FORM_MODE=txt</tt>
+ <br>
+ <dt>GIS_LOCK</dt>
+ <dd>lock ID to prevent parallel GRASS use,
+ <br>process id of the start-up shell script</dd>
+
+ <br>
+ <dt>GRASS_DB_ENCODING</dt>
+ <dd>[d.what.vect/forms library]<br>
+ encoding of query form (utf-8, ascii, iso8859-1, koi8-r)</dd>
+
+ <br>
+ <dt>GRASS_GUI</dt>
+ <dd>either <tt>text</tt> or <tt>gui</tt> to define non-/graphical startup.
+ <br><br> Can also specify the name of the GUI to use,
+ e.g. <tt>tcltk</tt>
+ (<em><a href="gis.m.html">gis.m</a></em>), <tt>oldtcltk</tt>
+ (<em><a href="d.m.html">d.m</a></em>) or <tt>wxpython</tt>
+ (<em><a href="wxGUI.html">wxGUI</a></em>). Also exists as a shell
+ environment variable. If this shell variable exists at GRASS
+ startup, it will determine the GUI used. If it is not defined
+ startup will default to the last GUI used.</dd>
+
+ <br>
+ <dt>LOCATION</dt>
+ <dd>full path to location directory</dd>
+
+ <br>
+ <dt>LOCATION_NAME</dt>
+ <dd>initial location name</dd>
+
+ <br>
+ <dt>MAPSET</dt>
+ <dd>initial mapset</dd>
+
+ <br>
+ <dt>OVERWRITE</dt>
+ <dd>[all modules]<br>
+ toggles map overwrite.
+ <ul>
+ <li>0 - maps are protected (default),</li>
+ <li>1 - maps with identical names will be overwritten.</li>
+ </ul>
+ This variable is automatically created
+ by <em><a href="g.parser.html">g.parser</a></em> so that the
+ <tt>--overwrite</tt> option will
+ be inherited by dependant modules as the script runs. Setting either the
+ GRASS_OVERWRITE environment variable or the OVERWRITE gisenv variable detailed
+ below will cause maps with identical names to be overwritten.</dd>
+</dl>
-<p>GISDBASE
-<br> initial database
-
-<p>GIS_LOCK
-<br> lock ID to prevent parallel GRASS use,
-<br> process id of the start-up shell script
-
-<p>GRASS_DB_ENCODING
-<br>[d.what.vect/forms library]
-<br> encoding of query form (utf-8, ascii, iso8859-1, koi8-r)
-
-<p>GRASS_GUI
-<br> either "text" or "tcltk" to define non-/graphical startup.
-Can also specify the name of the GUI to use, e.g. "gis.m", "d.m" or
-"wxpython" (<i>wx name subject to change</i>). Can also exist as a GRASS
-startup shell variable. The gisenv setting defines what GUI GRASS will use
-the next time it starts.
-
-<p>LOCATION
-<br> full path to location directory
-
-<p>LOCATION_NAME
-<br> initial location name
-
-<p>MAPSET
-<br> initial mapset
-
-<p>OVERWRITE
-<br>[all modules]
-<br> toggles map overwrite.
-<br> With 0 maps are protected (default),
-<br> With 1 maps with identical names will be overwritten.
-<br> Example: <tt>g.gisenv set="OVERWRITE=0"</tt>
-<br> You can force an overwrite for an individual command by adding "--o" to the command:
-<br> <tt>r.in.gdal --o output=existing_map ...</tt>
-
-
-<BR><BR><HR><BR>
-
<a name="files"></a>
<h2>GRASS-related Files</h2>
-<p>$HOME/.grassrc6
-<br> stores the GRASS variables (but not environment variables)
+<dl>
+ <dt>$HOME/.grassrc6</dt>
+ <dd>stores the GRASS variables (but not environment variables)</dd>
+
+ <br>
+ <dt>$HOME/.grasslogin6</dt>
+ <dd>stores the DBMI passwords in this hidden file.
+ Only the file owner can access this file.</dd>
-<p>$HOME/.grasslogin6
-<br> stores the DBMI passwords in this hidden file
-Only the file owner can access this file.
+ <br>
+ <dt>$HOME/GIS_ERROR_LOG</dt>
+ <dd>if this file exists then all GRASS error and warning messages are
+ logged here. Applies to current user. To generate the file, use:
+ <tt>touch $HOME/GIS_ERROR_LOG</tt></dd>
+
+ <br>
+ <dt>$GISBASE/GIS_ERROR_LOG</dt>
+ <dd>if this file exists then all GRASS error and warning messages are
+ logged here. Applies to all users. (proper write permissions must be in place)
+ <br><br>
+ <i>Note:</i>
+ Error and warning messages encountered while using the GUI menus are not logged.
+ </dd>
+</dl>
-<p>$HOME/GIS_ERROR_LOG
-<br> If this file exists then all GRASS error and warning messages are
- logged here. Applies to current user. To generate the file, use:
-<br> <tt>touch $HOME/GIS_ERROR_LOG</tt>
+<h3>SEE ALSO</h3>
-<p>$GISBASE/GIS_ERROR_LOG
-<br> If this file exists then all GRASS error and warning messages are
- logged here. Applies to all users. (proper write permissions must be in place)
-<P>
-<i>Note:</i>
-Error and warning messages encountered while using the GUI menus are not logged.
-
-
-<h3>SEE ALSO</h3>
<em>
-<a href="g.gisenv.html">g.gisenv</a>,
-<a href="g.parser.html">g.parser</a>
+ <a href="displaydrivers.html">Display drivers</a>
+ <br>
+ <a href="g.gisenv.html">g.gisenv</a>,
+ <a href="g.parser.html">g.parser</a>
</em>
<p>
<i>Last changed: $Date$</i>
-<HR>
-<P><a href=index.html>Help Index</a></p>
-<P>© 2008 <a href="http://grass.osgeo.org">GRASS Development Team</a></P>
+
+<hr>
+
+<p>
+<a href=index.html>Help Index</a>
+<p>
+© 2008 <a href="http://grass.osgeo.org">GRASS Development Team</a>
+
</body>
</html>
More information about the grass-commit
mailing list