[GRASS-SVN] r47143 - in grass/trunk: display display/d.mon
lib/cairodriver lib/htmldriver lib/init lib/pngdriver lib/psdriver
svn_grass at osgeo.org
svn_grass at osgeo.org
Sun Jul 17 15:16:57 EDT 2011
Author: martinl
Date: 2011-07-17 12:16:57 -0700 (Sun, 17 Jul 2011)
New Revision: 47143
Modified:
grass/trunk/display/Makefile
grass/trunk/display/d.mon/d.mon.html
grass/trunk/lib/cairodriver/cairodriver.html
grass/trunk/lib/htmldriver/htmldriver.html
grass/trunk/lib/init/variables.html
grass/trunk/lib/pngdriver/pngdriver.html
grass/trunk/lib/psdriver/psdriver.html
Log:
update display driver manual pages
Modified: grass/trunk/display/Makefile
===================================================================
--- grass/trunk/display/Makefile 2011-07-17 16:36:10 UTC (rev 47142)
+++ grass/trunk/display/Makefile 2011-07-17 19:16:57 UTC (rev 47143)
@@ -41,7 +41,4 @@
include $(MODULE_TOPDIR)/include/Make/Dir.make
-default: parsubdirs $(HTMLDIR)/displaydrivers.html
-
-$(HTMLDIR)/displaydrivers.html: displaydrivers.html
- $(INSTALL_DATA) $< $@
+default: parsubdirs
Modified: grass/trunk/display/d.mon/d.mon.html
===================================================================
--- grass/trunk/display/d.mon/d.mon.html 2011-07-17 16:36:10 UTC (rev 47142)
+++ grass/trunk/display/d.mon/d.mon.html 2011-07-17 19:16:57 UTC (rev 47143)
@@ -12,7 +12,7 @@
of running monitors by setting the <b>-l</b> flag on the command
line. Note that some monitor drivers use environment
<em><a href="variables.html">variables</a></em> or the specific
-<em><a href="displaydrivers.html">driver documentation</a></em>.
+<em><a href="variables.html#rendering">driver documentation</a></em>.
<p>
When a monitor is <em>started</em>, it is therefore also
Modified: grass/trunk/lib/cairodriver/cairodriver.html
===================================================================
--- grass/trunk/lib/cairodriver/cairodriver.html 2011-07-17 16:36:10 UTC (rev 47142)
+++ grass/trunk/lib/cairodriver/cairodriver.html 2011-07-17 19:16:57 UTC (rev 47143)
@@ -9,149 +9,171 @@
<img src="grass_logo.png" alt="GRASS logo"><hr align=center size=6 noshade>
-<H2>NAME</H2>
-<EM><B>Cairo driver</B></EM> - driver for bitmap or vector output using
-the Cairo graphics library.
-<BR>
-<EM>(drivers)</EM>
+<h2>NAME</h2>
+<em><b>Cairo driver</b></em> - display driver for bitmap or vector
+output using the Cairo graphics library.
-<H2>DESCRIPTION</H2>
+<h2>DESCRIPTION</h2>
-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 Cairo driver generates PNG, BMP, PPM, PS, PDF or SVG images by
+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.
+The Cairo driver is used for GRASS display commands by default if
+available, otherwise <em><a href="pngdriver.html">PNG driver</a></em>
+is used.
-<H2>USAGE</H2>
+<h2>USAGE</h2>
-<H3>Environment variables</H3>
+<h3>Environment variables</h3>
+The Cairo driver can be enabled by
+setting <b>GRASS_RENDER_IMMEDIATE</b> variable, eg.
+
+<div class="code"><pre>
+export GRASS_RENDER_IMMEDIATE=cairo
+</pre></div>
+
Several environment variables affect the operation of the Cairo driver:
-<UL>
- <LI><B>GRASS_RENDER_IMMEDIATE=[FALSE|TRUE|PNG|PS|HTML|cairo]</B><BR>
- tells the raster library which driver to use. If
- <tt>TRUE</tt>, the cairo driver is used if it is enabled, otherwise the PNG driver is used.
- <LI><B>GRASS_WIDTH=xxx</B><BR>
- the width of the image.
- </LI>
- <LI><B>GRASS_HEIGHT=yyy</B><BR>
- the height of the image.
- </LI>
- <LI><B>GRASS_PNGFILE=filename</B><BR>
+<ul>
+ <li><b>GRASS_WIDTH=xxx</b><br>
+ the width of the image map (default is 640).
+ </li>
+ <li><b>GRASS_HEIGHT=yyy</b><br>
+ the height of the image map (default is 480).
+ </li>
+ <li><b>GRASS_BACKGROUNDCOLOR=RRGGBB</b><br>
+ specifies the background color to use in RGB notation (hex or
+ R:G:B values). Named colors are also supported. Default
+ is <b>FFFFFF</b> (white).
+ </li>
+ <li><b>GRASS_TRANSPARENT=[TRUE|FALSE]</b><br>
+ sets transparent background on (TRUE) or off (FALSE, default).
+ </li>
+ <li><b>GRASS_ANTIALIAS</b><br> can be <em>default</em>,
+ <em>none</em>, <em>gray</em>, or <em>subpixel</em>, corresponding to
+ <a href="http://www.cairographics.org/manual/cairo-cairo-t.html#cairo-antialias-t">cairo_antialias_t</a>
+ </li>
+ <li><b>GRASS_PNGFILE=filename</b><br>
the name and format of the resulting image file, default is
- <tt>map.png</tt>.<BR>
- The image format is determined from the file extension.<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>
- <LI><B>.bmp</B> - Windows Bitmap (BMP, 32-bpp)
- (these are not readable by some older viewers)</LI>
- <LI><B>.ppm</B> - Portable Pixmap (PPM + PGM for alpha channel)</LI>
- </UL>
+ <ul>
+ <li><b>.png</b> - Portable Network Graphics (PNG)</li>
+ <li><b>.bmp</b> - Windows Bitmap (BMP, 32-bpp)
+ (these are not readable by some older viewers)</li>
+ <li><b>.ppm</b> - Portable Pixmap (PPM + PGM for alpha channel)</li>
+ </ul>
Supported vector formats:
- <UL>
- <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>
+ <ul>
+ <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.)
- </LI>
- <LI><B>GRASS_BACKGROUNDCOLOR=RRGGBB</B><BR>
- specifies the background color to use in RGB
- notation (hex values). Default is <b>FFFFFF</b> (white).
- </LI>
- <LI><B>GRASS_TRANSPARENT=[TRUE|FALSE]</B><BR>
- sets transparent background on (TRUE) or off (FALSE, default).
- </LI>
- <LI><B>GRASS_PNG_READ</B><BR>
+ </li>
+ <li><b>GRASS_PNG_READ</b><br>
if <tt>TRUE</tt>, the Cairo driver will initialize the image from
- the contents of GRASS_PNGFILE.<BR>
- (Note: This is only supported for bitmap formats)
- </LI>
- <LI><B>GRASS_PNG_MAPPED</B><BR>
+ the contents of GRASS_PNGFILE.<br>
+ (<em>Note: This is only supported for bitmap formats</em>)
+ </li>
+ <li><b>GRASS_PNG_MAPPED</b><br>
if <tt>TRUE</tt>, the Cairo driver will map GRASS_PNGFILE as its framebuffer,
- rather than using memory. This only works with BMP files.
- </LI>
- <LI><B>GRASS_ANTIALIAS</B><BR> can be <em>default</em>,
- <em>none</em>, <em>gray</em>, or <em>subpixel</em>, corresponding to
- <a href="http://www.cairographics.org/manual/cairo-cairo-t.html#cairo-antialias-t">cairo_antialias_t</a>
- </LI>
- <LI><B>GRASS_LINE_WIDTH</B><BR>
+ rather than using memory.<br>
+ (<em>Note: This only works with BMP files.</em>)
+ </li>
+<!-- used ?
+ <li><b>GRASS_LINE_WIDTH</b><br>
the default line width.
- </LI>
- <LI><B>GRASS_TEXT_SIZE</B><BR>
+ </li>
+ <li><b>GRASS_TEXT_SIZE</b><br>
the default text size.
- </LI>
- <LI><B>GRASS_FRAME</B><BR>
+ </li>
+ <li><b>GRASS_FRAME</b><br>
contains 4 coordinates, <em>top,bottom,left,right</em>, defining the initial frame.
- </LI>
-</UL>
+ </li>
+-->
+ <li><b>GRASS_CAIRO_SCREEN</b><br>
+ defines Cairo screen
+ </li>
+ <li><b>GRASS_CAIRO_VISUAL</b><br>
+ defines Cairo visual
+ </li>
+</ul>
-<H3>Examples</H3>
+<h3>Examples</h3>
Example using the driver to generate a PNG file (bash-syntax):
-<div class="code"><PRE>
-export GRASS_PNGFILE=spearfish.png
+
+<div class="code"><pre>
+export GRASS_RENDER_IMMEDIATE=cairo
+export GRASS_PNGFILE=nc_spm.png
export GRASS_WIDTH=800
export GRASS_HEIGHT=800
-export GRASS_RENDER_IMMEDIATE=CAIRO
export GRASS_PNG_READ=TRUE
-d.rast map=elevation.10m
+g.region rast=elevation
+d.rast map=elevation
d.vect map=streams width=1 color=blue fcolor=aqua type=area,line
-d.vect map=roads width=2
-</PRE></div>
+d.vect map=roadsmajor width=2
+</pre></div>
Example using the driver to generate a PDF file (bash-syntax):
-<div class="code"><PRE>
-export GRASS_PNGFILE=spearfish.pdf
+
+<div class="code"><pre>
+export GRASS_RENDER_IMMEDIATE=cairo
+export GRASS_PNGFILE=nc_spm.pdf
export GRASS_WIDTH=800
export GRASS_HEIGHT=800
-export GRASS_RENDER_IMMEDIATE=CAIRO
-export GRASS_PNG_READ=TRUE
-d.rast map=elevation.10m
-d.vect map=streams width=1 color=blue fcolor=aqua type=area,line
-d.vect map=roads width=2
-</PRE></div>
+g.region rast=elevation
+d.rast map=elevation
+</pre></div>
-<H2>NOTES</H2>
+<h2>NOTES</h2>
The driver is still in development. Enable it by specifying
-<CODE>--with-cairo</CODE> when configuring GRASS. This
+<code>--with-cairo</code> when configuring GRASS. This
requires a reasonably recent version of the Cairo libraries
-and a working pkg-config.
+and a working <tt>pkg-config</tt>.
-<P>
+<p>
Antialiasing is enabled by default for bitmap formats. There is
currently no way of disabling this.
-<P>
+<p>
+The resolution of the output images is defined by current region
+extents. Use <tt>g.region -p</tt> to get the number of rows and cols
+and use the environment variables to set the image size. If you would
+like a larger image, multiply both rows and cols by the same whole
+number to preserve the aspect ratio.
+
+<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.
<h2>SEE ALSO</h2>
-<EM>
-<a href="displaydrivers.html">Display drivers</a>
-<br>
-<A HREF="pngdriver.html">PNG driver</A>,
-<A HREF="psdriver.html">PostScript driver</A>,
-<BR>
-<A href="d.rast.html">d.rast</A>,
-<A href="d.vect.html">d.vect</A>
-</EM>
+<em>
+ <a href="pngdriver.html">PNG driver</a>,
+ <a href="psdriver.html">PS driver</a>,
+ <a href="htmldriver.html">HTML driver</a>,
+ <a href="variables.html">variables</a>
+ <br><br>
+ <a href="d.rast.html">d.rast</a>,
+ <a href="d.vect.html">d.vect</a>,
+ <a href="d.mon.html">d.mon</a>,
+ <a href="d.erase.html">d.erase</a>,
+ <a href="d.redraw.html">d.redraw</a>
+</em>
-<H2>AUTHOR</H2>
-Lars Ahlzen <<I>lars (at) ahlzen.com</I>><BR>
+<h2>AUTHOR</h2>
+Lars Ahlzen <<i>lars (at) ahlzen.com</i>><br>
and the GRASS Development Team.
Modified: grass/trunk/lib/htmldriver/htmldriver.html
===================================================================
--- grass/trunk/lib/htmldriver/htmldriver.html 2011-07-17 16:36:10 UTC (rev 47142)
+++ grass/trunk/lib/htmldriver/htmldriver.html 2011-07-17 19:16:57 UTC (rev 47143)
@@ -1,7 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
- <TITLE>HTMLMAP driver</TITLE>
+ <TITLE>HTML driver</TITLE>
<META http-equiv=Content-Type content="text/html; charset=iso-8859-1">
<link rel="stylesheet" href="grassdocs.css" type="text/css">
</HEAD>
@@ -9,128 +9,144 @@
<img src="grass_logo.png" alt="GRASS logo"><hr align=center size=6 noshade>
-<H2>NAME</H2>
+<h2>NAME</h2>
-<EM><B>HTMLMAP driver</B></EM> - driver to create HTML image maps.
-<BR><EM>(drivers)</EM>
+<em><b>HTML driver</b></em> - display driver to create HTML image maps.
-<H2>DESCRIPTION</H2>
+<h2>DESCRIPTION</h2>
-The HTMLMAP driver allows the generation of HTML image maps
-for area vector data. HTML image maps are used in conjunction with images to
-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
-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
-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
-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:
-<UL>
- <LI><a href="d.text.html">d.text</A>
- - 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>
+The HTML driver allows the generation of HTML image maps for area
+vector data. HTML image maps are used in conjunction with images to
+provide unique URL targets for different portions of an image. The
+HTML driver can create both client-side image maps embedded into HTML
+files, or server-side image maps used by web server software.
-<H2>USAGE</H2>
+<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.
-<H3>Environment variables</H3>Several environment variables effect the operation
-of HTMLMAP.
+<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.
-<UL>
- <LI><B>GRASS_WIDTH=xxx</B><BR>the width of the image map (default is
- 640).
- </LI>
- <LI><B>GRASS_HEIGHT=yyy</B><BR>the height of the image map (default is
- 480).
- </LI>
- <LI><B>GRASS_HTMLTYPE=type</B><BR>the type of image mape to create (default is
- CLIENT):
- <DL>
- <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>
- </DL>
- </LI>
- <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
+<p>
+The only GRASS display commands that should be used with this driver
+are:
+<ul>
+ <li><em><a href="d.text.html">d.text</a></em> - pass href
+ information for resulting image maps.</li>
+ <li><em><a href="d.vect.html">d.vect</a></em> - draw polygons from a
+ vector map.</li>
+</ul>
+
+<h2>USAGE</h2>
+
+<h3>Environment variables</h3>
+
+The HTML driver can be enabled by
+setting <b>GRASS_RENDER_IMMEDIATE</b> variable, eg.
+
+<div class="code"><pre>
+export GRASS_RENDER_IMMEDIATE=html
+</pre></div>
+
+Several environment variables effect the operation of the HTML driver:
+
+<ul>
+ <li><b>GRASS_WIDTH=xxx</b><br>
+ the width of the image map (default is 640).
+ </li>
+ <li><b>GRASS_HEIGHT=yyy</b><br>
+ the height of the image map (default is 480).
+ </li>
+ <li><b>GRASS_HTMLTYPE=type</b><br> type of image mape to create
+ (default is CLIENT):
+ <dl>
+ <dd><tt><b>CLIENT</b></tt> Netscape/IE client-side
+ image map (NAME="map").</dd>
+ <dd><tt><b>APACHE</b></tt> Apache/NCSA server-side image
+ map.</dd>
+ <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>
+ </dl>
+ </li>
+ <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>
- <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 <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.
- </LI>
- <LI><B>GRASS_HTMLMINBBOX=n</B><BR>specifies the minimum bounding box
- dimensions to record a polygon as a clickable area.
- 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.
- </LI>
- <LI><B>GRASS_HTMLMAXPOINTS=n</B><BR>specifies the maximum number of
- vertices included in a polygon's clickable area.
- The default is <tt>99</tt>. Some browsers can only accommodate 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.</LI>
-</UL>
+ </li>
+ <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 <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.
+ </li>
+ <li><b>GRASS_HTMLMINBBOX=n</b><br>
+ specifies the minimum bounding box dimensions to record a polygon
+ as a clickable area. 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.
+ </li>
+ <li><b>GRASS_HTMLMAXPOINTS=n</b><br>
+ specifies the maximum number of vertices included in a polygon's
+ clickable area. The default is <tt>99</tt>. Some browsers can only
+ accommodate 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.</li>
+</ul>
-<H3>Typical usage</H3>
-<UL>
- <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>
+<h3>Example</h3>
+
+Start up the driver
+
+<div class="code"><pre>
+d.mon start=html
+</pre></div>
+
+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>
+</pre></div>
+
+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=html
+</pre></div>
+
+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.mon start=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
+d.mon stop=png
<!-- ???? FIXME -->
# make the region the same as the newly created cell for ppm export
g.region save=saved.reg
@@ -150,41 +166,45 @@
# take a look and test it out
netscape file:`pwd`/alien.html &
-</PRE></DIV>
- </LI>
-</UL>
+</pre></div>
-<H2>NOTES</H2>
+<h2>NOTES</h2>
-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>
- <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>
+HTML was adapted from the CELL driver in GRASS 4.3.
+Point-in-polygon test code was lifted from Randolph Franklin's web
+page, see
-<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
+<ul>
+ <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 need to edit the map names. The HTML driver creates its map
+with the name
<tt>map</tt>. A small sed script can easily change the map name:
-<PRE>
+<pre>
sed -e 's/NAME="map"/NAME="foomap"/' < htmlmap > foomap.html
-</PRE>
+</pre>
-<H2>SEE ALSO</H2>
+<h2>SEE ALSO</h2>
-<EM>
- <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>
+<em>
+ <a href="cairodriver.html">Cairo driver</a>,
+ <a href="pngdriver.html">PNG driver</a>,
+ <a href="htmldriver.html">HTML driver</a>,
+ <a href="variables.html">variables</a>
+ <br><br>
+ <a href="d.rast.html">d.rast</a>,
+ <a href="d.vect.html">d.vect</a>,
+ <a href="d.mon.html">d.mon</a>,
+ <a href="d.erase.html">d.erase</a>,
+ <a href="d.redraw.html">d.redraw</a>
+</em>
<p>
<i>Last changed: $Date$</i>
Modified: grass/trunk/lib/init/variables.html
===================================================================
--- grass/trunk/lib/init/variables.html 2011-07-17 16:36:10 UTC (rev 47142)
+++ grass/trunk/lib/init/variables.html 2011-07-17 19:16:57 UTC (rev 47143)
@@ -23,27 +23,17 @@
There are a number of <i>shell</i> environment variable groups:
<ul>
-<li><a href="#cairo">Cairo driver</a></li>
-<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="#dirrend">variables for direct rendering</a></li>
+<li><a href="#rendering">variables for 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)
-has to be a GRASS <i>gisenv</i> variable.
+<i>Note:</i> Any setting which needs to be modifiable by a GRASS module
+(e.g. MONITOR by <em><a href="d.mon.html">d.mon</a></em>) has to be a GRASS
+gisenv variable.
+<h2>Setting shell environment variables</h2>
-<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>
-
-Setting environment variables depends on the shell being used:
+Setting shell environment variables depends on the shell being used:
<br><br>
Bash:
<div class="code"><pre>
@@ -58,7 +48,7 @@
set VARIABLE=value
</pre></div>
-<h2>Setting environment variables permanently</h2>
+To set up shell environment variables permanently:
<ul>
<li>
@@ -72,7 +62,7 @@
</ul>
-<h2>Setting GRASS variables</h2>
+<h2>Setting GRASS gisenv variables</h2>
Use <em><a href="g.gisenv.html">g.gisenv</a></em> within GRASS. This permanently
predefines GRASS variables in the <tt>.grass7/rc</tt> file.
@@ -88,12 +78,12 @@
If the user just specifies a variable name, it defaults to <b>get</b> mode.
For example:
<div class="code"><pre>
-g.gisenv GRASS_GUI
-text
+g.gisenv MAPSET
+PERMANENT
</pre></div>
<a name="enviro"></a>
-<h2>List of selected (GRASS related) environment variables</h2>
+<h2>List of selected (GRASS related) shell environment variables</h2>
<blockquote>
[ To be set from the terminal shell or startup scripts ]
@@ -110,9 +100,9 @@
while in a GRASS session.</dd>
<dt>GRASS_ADDON_PATH</dt>
- <dd>[grass startup script]<br>
- allows to specify additional paths to local GRASS modules extra
- to standard distribution. The default on GNU/Linux is $HOME/.grass7/addons</dd>
+ <dd>[grass startup script]<br> allows to specify additional paths to
+ local GRASS modules extra to standard distribution. The default on
+ GNU/Linux is <tt>$HOME/.grass7/addons</tt>.</dd>
<dt>GRASS_ADDON_ETC</dt>
<dd>[libgis, g.findetc]<br>
@@ -120,22 +110,35 @@
standard distribution.</dd>
<dt>GRASS_BATCH_JOB</dt>
- <dd>defines the name (path) of a shell script to be processed as batch job.</dd>
+ <dd>defines the name (path) of a shell script to be processed as
+ batch job.</dd>
<dt>GIS_ERROR_LOG</dt>
- <dd>If set, $GIS_ERROR_LOG should be the absolute path to the log file (a
- relative path will be interpreted relative to the process' cwd, not
- the cwd at the point the user set the variable). If not set,
- $HOME/GIS_ERROR_LOG is used instead. The file will only be used if
- it already exists.</dd>
+ <dd>If set, GIS_ERROR_LOG should be the absolute path to the log
+ file (a relative path will be interpreted relative to the process'
+ cwd, not the cwd at the point the user set the variable). If not
+ set, <tt>$HOME/GIS_ERROR_LOG</tt> is used instead. The file will
+ only be used if it already exists.</dd>
<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>
+ <dt>GRASS_FONT</dt>
+ <dd>[display drivers]<br>
+ specifies the font as either the name of a font from
+ <tt>$GISBASE/etc/fontcap</tt> (or alternative fontcap file
+ specified by GRASS_FONT_CAP), or alternatively the full path to a
+ FreeType font file.</dd>
+
+ <dt>GRASS_ENCODING</dt>
+ <dd>[display drivers]<br>
+ the encoding to be assumed for text which is drawn using a
+ freetype font; may be any encoding know to <em>iconv</em>.</dd>
+
<dt>GRASS_FONT_CAP</dt>
<dd>[g.mkfontcap, d.font, display drivers]<br>
- specifies an alternative location (to $GISBASE/etc/fontcap) for
+ specifies an alternative location (to <tt>$GISBASE/etc/fontcap</tt>) for
the font configuration file.</dd>
<dt>GRASS_GNUPLOT</dt>
@@ -144,44 +147,39 @@
<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>wxpython</tt>
+ <br><br> Can also specify the name of the GUI to use,
+ e.g. <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>
+ 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>
- <dt>GRASS_HEIGHT</dt>
- <dd>[d.mon]<br>
- defines the height of GRASS monitor, see also GRASS_WIDTH.</dd>
<dt>GRASS_HTML_BROWSER</dt>
- <dd>[init.sh, wxgui]<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, 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>
+ <dd>[init.sh, wxgui]<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, 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>
<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.
+ <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>
<dt>GRASS_MESSAGE_FORMAT</dt>
- <dd>[various modules, wxGUI]<br>
- maybe set to either
+ <dd>[various modules, wxGUI]<br> maybe set to either
<ul>
<li><tt>standard</tt> - sets percentage output and message
formatting style to standard formatting,</li>
@@ -195,11 +193,12 @@
</ul></dd>
<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.,
+ <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>
<dt>GRASS_PAGER</dt>
@@ -261,11 +260,7 @@
<dt>GRASS_VERSION</dt>
<dd>reports the current version number (used by R-stats interface etc);
should not be changed by user.</dd>
-
- <dt>GRASS_WIDTH</dt>
- <dd>[d.mon]<br>
- defines the width of GRASS monitor, see also GRASS_HEIGHT.</dd>
-
+
<dt>GRASS_NO_GLX_PBUFFERS</dt>
<dd>[nviz]<br>
set to any value to disable the use of GLX Pbuffers.</dd>
@@ -275,72 +270,35 @@
Set to any value to disable the use of GLX Pixmaps.</dd>
</dl>
-<a name="cairo"></a>
-<h3>List of selected GRASS Cairo driver environment variables</h3>
-
+<a name="rendering"></a>
+<h3>List of selected GRASS environment variables for rendering</h3>
<blockquote>
-[ These variables control the function of the Cairo driver. ]
+[ In addition to those which are understood by specific <em>GRASS display
+ drivers</em>, the following variables affect rendering. ]
</blockquote>
-See <a href="cairodriver.html">Cairo driver</a> manual page for detailed
-list of the variables.
-
-<a name="png"></a>
-<h3>List of selected GRASS PNG driver environment variables</h3>
-
-<blockquote>
-[ These variables control the function of the PNG driver. ]
-</blockquote>
-
-See <a href="pngdriver.html">PNG driver</a> manual page for detailed
-list of the variables.
-
-<a name="ps"></a>
-<h3>List of selected GRASS PS driver environment variables</h3>
-
-<blockquote>
-[ 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.
-
-<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="htmldriver.html">HTMLMAP 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
- affect direct rendering. ]
-</blockquote>
-
<dl>
-
<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>
+ <dd>tells the display library which driver to use; possible
+ values: <em><a href="cairodriver.html">cairo</a></em>, <em><a href="pngdriver.html">png</a></em>, <em><a href="psdriver.html">ps</a></em>
+ or <em><a href="htmldriver.html">html</a></em></dd>
- <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>
+ <dt>GRASS_WIDTH</dt>
+ <dd>defines the width of output image (default is 640).</dd>
- <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>
+ <dt>GRASS_HEIGHT</dt>
+ <dd>defines the height of output image (default is 480).</dd>
</dl>
+For specific driver-related variables see:
+
+<ul>
+ <li><em><a href="cairodriver.html">Cairo driver</a></em></li>
+ <li><em><a href="pngdriver.html">PNG driver</a></em></li>
+ <li><em><a href="psdriver.html">PS (Postscript) driver</a></em></li>
+ <li><em><a href="htmldriver.html">HTML driver</a></em></li>
+</ul>
+
<a name="internal"></a>
<h3>List of selected internal GRASS environment variables</h3>
<blockquote>
@@ -460,30 +418,26 @@
below will cause maps with identical names to be overwritten.</dd>
</dl>
-<a name="files"></a>
<h2>GRASS-related Files</h2>
<dl>
- <dt>$HOME/.grass7/rc</dt>
- <dd>stores the GRASS variables (but not environment variables)</dd>
+ <dt><tt>$HOME/.grass7/rc</tt></dt>
+ <dd>stores the GRASS gisenv variables (not shell environment variables)</dd>
- <dt>$HOME/.grasslogin7</dt>
+ <dt><tt>$HOME/.grass7/login</tt></dt>
<dd>stores the DBMI passwords in this hidden file.
Only the file owner can access this file.</dd>
- <dt>$HOME/GIS_ERROR_LOG</dt>
+ <dt><tt>$HOME/GIS_ERROR_LOG</tt></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><br>
See also GIS_ERROR_LOG variable.</dd>
-
</dl>
-<h3>SEE ALSO</h3>
+<h2>SEE ALSO</h2>
<em>
- <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>
@@ -496,7 +450,7 @@
<p>
<a href=index.html>Help Index</a>
<p>
-© 2008 <a href="http://grass.osgeo.org">GRASS Development Team</a>
+© 2008-2011 <a href="http://grass.osgeo.org">GRASS Development Team</a>
</body>
</html>
Modified: grass/trunk/lib/pngdriver/pngdriver.html
===================================================================
--- grass/trunk/lib/pngdriver/pngdriver.html 2011-07-17 16:36:10 UTC (rev 47142)
+++ grass/trunk/lib/pngdriver/pngdriver.html 2011-07-17 19:16:57 UTC (rev 47143)
@@ -9,106 +9,131 @@
<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.
-<BR><EM>(drivers)</EM>
+<h2>NAME</h2>
+<em><b>PNG driver</b></em> - display driver to create PNG, PPM, or BMP images.
-<H2>DESCRIPTION</H2>
+<h2>DESCRIPTION</h2>
-The PNG driver generates PNG and PPM images from GRASS display commands.
-Per default PNG files are written with this driver. It is started as 'pseudo' monitor
-(image file instead) and when stopped, all output from previously used
-display commands are written to the PNG image file.
+The PNG driver generates PNG, PPM, or BMP images from GRASS display
+commands. Per default PNG files are written with this driver. This
+driver is used by default if <em><a href="cairodriver.html">Cairo
+driver</a></em> is not available.
-<H2>USAGE</H2>
+<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).</LI>
- <LI><B>GRASS_HEIGHT=yyy</B><BR>
- the height of the image map (default is 480).</LI>
- <LI><B>GRASS_PNGFILE=filename</B><BR>
+<h3>Environment variables</h3>
+
+The PNG driver can be enabled by setting <b>GRASS_RENDER_IMMEDIATE</b>
+variable, eg.
+
+<div class="code"><pre>
+export GRASS_RENDER_IMMEDIATE=png
+</pre></div>
+
+Several environment variables affect the operation of the PNG driver:
+
+<ul>
+ <li><b>GRASS_WIDTH=xxx</b><br>
+ the width of the image map (default is 640).
+ </li>
+ <li><b>GRASS_HEIGHT=yyy</b><br>
+ the height of the image map (default is 480).
+ </li>
+ <li><b>GRASS_BACKGROUNDCOLOR=RRGGBB</b><br>
+ specifies the background color to use in RGB notation (hex or
+ R:G:B values). Named colors are also supported. Default
+ is <b>FFFFFF</b> (white).
+ </li>
+ <li><b>GRASS_TRANSPARENT=[TRUE|FALSE]</b><br>
+ sets transparent background on (TRUE) or off (FALSE, default).
+ </li>
+ <li><b>GRASS_TRUECOLOR=[TRUE|FALSE]</b><br>
+ sets true-color support. Default is TRUE.
+ </li>
+ <li><b>GRASS_PNGFILE=filename</b><br>
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 (with alpha channel stored in a PGM image, if applicable).
If you set GRASS_PNGFILE to a filename which ends in ".bmp", a 32-bpp
BMP file will be created (these are not readable by some older viewers).
- <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).</LI>
- <LI><B>GRASS_TRUECOLOR=[TRUE|FALSE]</B><BR>
- sets true-color support. Default is TRUE</LI>
- <LI><B>GRASS_PNG_COMPRESSION=[0|1|9]</B><BR>
- compression level of PNG files (0 = none, 1 = fastest, 9 = best, default is 6)</LI>
- <LI><B>GRASS_PNG_READ</B><BR>
+ </li>
+ <li><b>GRASS_PNG_COMPRESSION=[0|1|9]</b><br>
+ compression level of PNG files (0 = none, 1 = fastest, 9 = best, default is 6)
+ </li>
+ <li><b>GRASS_PNG_READ</b><br>
if <tt>TRUE</tt>, the PNG driver will initialize the image from
- the contents of GRASS_PNGFILE.</LI>
- <LI><B>GRASS_PNG_MAPPED</B><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>
- <LI><B>GRASS_RENDER_IMMEDIATE=[FALSE|TRUE|PNG|PS|HTML|cairo]</B><BR>
- tells the raster library which driver to use. If
- <tt>TRUE</tt>, the cairo driver is used if it is enabled, otherwise the PNG driver is used.
- <LI><B>GRASS_LINE_WIDTH</B><BR>
+ the contents of GRASS_PNGFILE.
+ </li>
+ <li><b>GRASS_PNG_MAPPED</b><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>
+ <!-- used ?
+ <li><b>GRASS_LINE_WIDTH</b><br>
the default line width.
- </LI>
- <LI><B>GRASS_TEXT_SIZE</B><BR>
+ </li>
+ <li><b>GRASS_TEXT_SIZE</b><br>
the default text size.
- </LI>
- <LI><B>GRASS_FRAME</B><BR>
+ </li>
+ <li><b>GRASS_FRAME</b><br>
contains 4 coordinates, <em>top,bottom,left,right</em>, defining the initial frame.
- </LI>
-</UL>
+ </li>
+ -->
+</ul>
-<H3>Example</H3>
+<h3>Example</h3>
-<DIV class="code"><PRE>
-# Define driver settings (here: bash shell syntax)
-export GRASS_RENDER_IMMEDIATE=PNG
+<div class="code"><pre>
+export GRASS_RENDER_IMMEDIATE=png
export GRASS_TRUECOLOR=TRUE
-# Display raster map and vector polygons
-d.rast <i>somerastermap</i>
-d.vect <i>somevectormap</i> color=red
-</PRE></DIV>
+g.region rast=elevation
+d.rast elevation
+d.vect roadsmajor color=red
+</pre></div>
+
This writes a file named <tt>map.png</tt> in your current directory.
-<H2>NOTES</H2>
+<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
+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.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
-use the environment variables to set the PNG size. If you would like a
-larger image, multiply both rows and cols by the same whole number to
-preserve the aspect ratio.
+The resolution of the output images is defined by current region
+extents. Use <tt>g.region -p</tt> to get the number of rows and cols
+and use the environment variables to set the image size. If you would
+like a larger image, multiply both rows and cols by the same whole
+number to 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.
+Further PNG file processing (e.g. quantization to 1 bit for monochrome
+images) can be done with <tt>pnmquant</tt> of
+the <a href="http://netpbm.sourceforge.net/">netpbm</a> tools.
<h2>SEE ALSO</h2>
-<EM>
-<a href="displaydrivers.html">Display drivers</a>
+<em>
+ <a href="cairodriver.html">Cairo driver</a>,
+ <a href="psdriver.html">PS driver</a>,
+ <a href="htmldriver.html">HTML driver</a>,
+ <a href="variables.html">variables</a>
+ <br><br>
+ <a href="d.rast.html">d.rast</a>,
+ <a href="d.vect.html">d.vect</a>,
+ <a href="d.mon.html">d.mon</a>,
+ <a href="d.erase.html">d.erase</a>,
+ <a href="d.redraw.html">d.redraw</a>
+</em>
+
+<h2>AUTHOR</h2>
+
+Original version: Per Henrik Johansen <<i>phj (at)
+norgit.no</i>> <!-- broken link <I><a href="http://www.norgit.no">NORGIT AS</a></i> -->
<br>
-<A HREF="cairodriver.html">CAIRO driver</A>,
-<A HREF="psdriver.html">PostScript driver</A>,
-<BR>
-<A href="d.rast.html">d.rast</A>,
-<A href="d.vect.html">d.vect</A>
-</EM>
-
-<H2>AUTHOR</H2>
-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>
Modified: grass/trunk/lib/psdriver/psdriver.html
===================================================================
--- grass/trunk/lib/psdriver/psdriver.html 2011-07-17 16:36:10 UTC (rev 47142)
+++ grass/trunk/lib/psdriver/psdriver.html 2011-07-17 19:16:57 UTC (rev 47143)
@@ -9,99 +9,113 @@
<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.
-<BR><EM>(drivers)</EM>
+<h2>NAME</h2>
+<em><b>PS driver</b></em> - display driver to create PostScript files.
-<H2>DESCRIPTION</H2>
+<h2>DESCRIPTION</h2>
The PS driver generates a PostScript file from GRASS display commands.
-The driver is started as 'pseudo' monitor (PS file instead) and when
-stopped, all output from previously used display commands are written
-to the PostScript file.
-<H2>USAGE</H2>
-<H3>Environment variables</H3>
-Several environment variables effect the operation
-of the PS driver:
+<h2>USAGE</h2>
-<UL>
- <LI><B>GRASS_RENDER_IMMEDIATE=[FALSE|TRUE|PNG|PS|HTML|cairo]</B><BR>
- tells the raster library which driver to use. If
- <tt>TRUE</tt>, the cairo driver is used if it is enabled, otherwise the PNG driver is used.
- <LI><B>GRASS_PSFILE</B><BR>
+<h3>Environment variables</h3>
+
+The PS driver can be enabled by setting <b>GRASS_RENDER_IMMEDIATE</b>
+variable, eg.
+
+<div class="code"><pre>
+export GRASS_RENDER_IMMEDIATE=ps
+</pre></div>
+
+Several environment variables effect the operation of the PS driver:
+
+<ul>
+ <li><b>GRASS_WIDTH=xxx</b><br>
+ the width of the image map (default is 640).
+ </li>
+ <li><b>GRASS_HEIGHT=yyy</b><br>
+ the height of the image map (default is 480).
+ </li>
+ <li><b>GRASS_TRUECOLOR=[TRUE|FALSE]</b><br>
+ sets true-color support. Default is FALSE.
+ </li>
+ <li><b>GRASS_PSFILE</b><br>
name of output file. If it ends with ".eps" an EPS file
- will be created.</LI>
- <LI><B>GRASS_PAPER</B><BR>
+ will be created.
+ </li>
+ <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>
- <LI><B>GRASS_WIDTH</B><BR>
- defines the width of the screen, see also GRASS_HEIGHT</LI>
- <LI><B>GRASS_HEIGHT</B><BR>
- defines the height of the screen, see also GRASS_WIDTH</LI>
- <LI><B>GRASS_TRUECOLOR</B><BR>
- if <tt>TRUE</tt>, the PS driver generates color output, otherwise
- monochrome.</LI>
- <LI><B>GRASS_LANDSCAPE</B><BR>
+ fit a standard paper size, see also GRASS_WIDTH, GRASS_HEIGHT.
+ </li>
+ <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>
- <LI><B>GRASS_PS_HEADER</B><BR>
+ "portrait" paper.
+ </li>
+ <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>
- <LI><B>GRASS_PS_TRAILER</B><BR>
- if <tt>FALSE</tt>, no trailer section is generated.</LI>
- <LI><B>GRASS_LINE_WIDTH</B><BR>
+ and no prolog or setup sections are generated.
+ </li>
+ <li><b>GRASS_PS_TRAILER</b><br>
+ if <tt>FALSE</tt>, no trailer section is generated.
+ </li>
+ <!-- used ?
+ <li><b>GRASS_LINE_WIDTH</b><br>
the default line width.
- </LI>
- <LI><B>GRASS_TEXT_SIZE</B><BR>
+ </li>
+ <li><b>GRASS_TEXT_SIZE</b><br>
the default text size.
- </LI>
- <LI><B>GRASS_FRAME</B><BR>
+ </li>
+ <li><b>GRASS_FRAME</b><br>
contains 4 coordinates, <em>top,bottom,left,right</em>, defining the initial frame.
- </LI>
-</UL>
+ </li>
+ -->
+</ul>
-<H3>Example</H3>
+<h3>Example</h3>
-<DIV class="code"><PRE>
-# Define driver settings (here: bash shell syntax)
-export GRASS_RENDER_IMMEDIATE=PS
+<div class="code"><pre>
+export GRASS_RENDER_IMMEDIATE=ps
export GRASS_TRUECOLOR=TRUE
-# Display raster map and vector polygons
-d.rast <i>somerastermap</i>
-d.vect <i>somevectormap</i> color=red
-</PRE></DIV>
+g.region rast=elevation
+d.rast elevation
+d.vect roadsmajor color=red
+</pre></div>
This writes a file named <tt>map.ps</tt> in your current directory.
-<H2>NOTES</H2>
+<h2>NOTES</h2>
-The resolution of the <i>PS</i> raster map is defined by the map
-extents. Use <em>g.region -p</em> to get the number of rows and cols and
-use the environment variables to set the PS size. If you would like a
-larger image, multiply both rows and cols by the same whole number to
-preserve the aspect ratio.
-<P>
+The resolution of the output files is defined by current region
+extents. Use <tt>g.region -p</tt> to get the number of rows and cols
+and use the environment variables to set the image size. If you would
+like a larger image, multiply both rows and cols by the same whole
+number to preserve the aspect ratio.
+
+<p>
GRASS_TRUECOLOR requires either PostScript level 2 or level 1 plus the
-colorimage and setrgbcolor operators (this is the case for colour printers
-which pre-date level 2 PostScript).
+colorimage and setrgbcolor operators (this is the case for colour
+printers which pre-date level 2 PostScript).
+
<p>
-Only masked images (<tt>d.rast -o</tt>, <tt>d.rgb -o</tt>, <tt>d.his
--n</tt>) require PostScript level 3.
+Masked images (<tt>d.rast</tt>, <tt>d.rgb</tt>, <tt>d.his -n</tt>)
+require PostScript level 3.
<h2>SEE ALSO</h2>
-<EM>
-<a href="displaydrivers.html">Display drivers</a>
-<br>
-<A HREF="cairodriver.html">CAIRO driver</A>,
-<A HREF="pngdriver.html">PNG driver</A>
-<BR>
-<A href="d.rast.html">d.rast</A>,
-<A href="d.vect.html">d.vect</A>
-</EM>
+<em>
+ <a href="cairodriver.html">Cairo driver</a>,
+ <a href="pngdriver.html">PNG driver</a>,
+ <a href="htmldriver.html">HTML driver</a>,
+ <a href="variables.html">variables</a>
+ <br><br>
+ <a href="d.rast.html">d.rast</a>,
+ <a href="d.vect.html">d.vect</a>,
+ <a href="d.mon.html">d.mon</a>,
+ <a href="d.erase.html">d.erase</a>,
+ <a href="d.redraw.html">d.redraw</a>
+</em>
-<H2>AUTHOR</H2>
+<h2>AUTHOR</h2>
Glynn Clements, 2007
More information about the grass-commit
mailing list