[GRASS-SVN] r40258 - grass/trunk/ps/ps.map

[svn_grass at osgeo.org]

Author: hamish
Date: 2010-01-05 10:42:23 -0500 (Tue, 05 Jan 2010)
New Revision: 40258

Modified:
   grass/trunk/ps/ps.map/ps.map.html
Log:
document header file instruction (merge from devbr6)

Modified: grass/trunk/ps/ps.map/ps.map.html
===================================================================
--- grass/trunk/ps/ps.map/ps.map.html	2010-01-05 15:41:37 UTC (rev 40257)
+++ grass/trunk/ps/ps.map/ps.map.html	2010-01-05 15:42:23 UTC (rev 40258)
@@ -558,7 +558,39 @@
 and the location's description.<!-- PERMANENT/MYNAME -->
 The text will be centered on the page above the map.
 The default text color is black.
+<P>
+If the <EM>file</EM> sub-instruction is given the header will consist
+of the text in the text file specified, with some special formatting keys:
 
+<ul>
+<li><tt>%%</tt>  - a literal %
+<li><tt>%n</tt>  - ? newline ?
+<li><tt>%_</tt>  - horizontal bar
+<li><tt>%c</tt>  - "&lt;raster name&gt; in mapset &lt;mapset name&gt;"
+<li><tt>%d</tt>  - today's date
+<li><tt>%l</tt>  - location name
+<li><tt>%L</tt>  - Location's text description
+<li><tt>%m</tt>  - mapset name
+<li><tt>%u</tt>  - user name
+<li><tt>%x</tt>  - mask info
+<li><tt>%-</tt>  - advance to this character column number (see example below)
+
+</ul>
+
+Example header file:
+<div class="code"><pre>
+%_
+LOCATION: %-27l  DATE: %d
+MAPSET:   %-27m  USER: %u
+
+RASTER MAP: %c
+MASK:     %x
+%_
+Produced by: US Army CERL, Champaign Illinois
+Software:    GRASS
+%_
+</pre></div>
+
 <P>
 
 This example prints (in red) whatever is in the file <EM>soils.hdr</EM> above