.ig >>
<STYLE TYPE="text/css">
<!--
        A:link{text-decoration:none}
        A:visited{text-decoration:none}
        A:active{text-decoration:none}
        OL,UL,P,BODY,TD,TR,TH,FORM { font-family: arial,helvetica,sans-serif;; font-size:small; color: #333333; }

        H1 { font-size: x-large; font-family: arial,helvetica,sans-serif; }
        H2 { font-size: large; font-family: arial,helvetica,sans-serif; }
        H3 { font-size: medium; font-family: arial,helvetica,sans-serif; }
        H4 { font-size: small; font-family: arial,helvetica,sans-serif; }
-->
</STYLE>
<title>ploticus: proc page</title>
<body bgcolor=D0D0EE vlink=0000FF>
<br>
<br>
<center>
<table cellpadding=2 bgcolor=FFFFFF width=550><tr>
<td>
  <table cellpadding=2 width=550><tr>
  <td><br><h2>proc page</h2></td>
  <td align=right>
  <small>
  <a href="../doc/welcome.html"><img src="../doc/ploticus.gif" border=0></a><br>
  Version 2.30
     </small><br><a href="../doc/scripthome.html">Scripts</a>
  <td></tr></table>
</td></tr>
<td>
<br>
<br>
.>>

.TH proc_page PL "25-AUG-2004   PL ploticus.sourceforge.net"

\fBproc page\fR indicates the beginning of a new page or image, and can be used to set attributes 
that affect an entire page or image.  
For scripts that produce multiple output pages or images, \fBproc page\fR indicates
the page break and is required.  Otherwise it is optional.


.ig >>
<br><br><br>
.>>

.SH Attributes
In order to do a page break, you can just invoke \fBproc page\fR with no attributes.


.ig >>
<br><br>
.>>


.LP
\fBtitle\fR 
.ig >>
&nbsp; &nbsp;
.>>
.ig >>
<a href="attributetypes.html#text">
.>>
\0multiline-text
.ig >>
</a>
.>>
.IP \0
Specifies a page title.
By default, title is rendered at the top center of the "page" (as determined by \fCpagesize\fR).
Title text is specified as multi-line text, ending with the first blank line.
Blank lines that are to be part of the title should be escaped using a backslash (\\).
.br
Example: 
.nf
.ft C
\fCtitle: Comparison of Survey Techniques 
     By Region 
     \\
     Fall, 1997
.fi

.ig >>
<br><br>
.>>

.LP
\fBtitledetails\fR 
.ig >>
&nbsp; &nbsp;
.>>
.ig >>
<a href="textdetails.html">
.>>
\0textdetails
.ig >>
</a>
.>>
.IP \0
Specifies detail options for the rendering of the page title.
Example: \fCtitledetails: size=14 style=BI \fR

.ig >>
<br><br>
.>>

.LP
\fBdobackground\fR 
.ig >>
&nbsp; &nbsp;
.>>
\fCyes | no\fR
.IP \0
The only time this attribute is useful is to override the default behavior for EPS, which
is to \fBnot\fR fill the entire EPS page area with the background
color (allowing EPS to draw over existing background).
For all other output devices the page area is always filled with the background color when
one is specified.
.br
Example: \fCdobackground: no\fR

.ig >>
<br><br>
.>>

.LP
\fBdopagebox\fR 
.ig >>
&nbsp; &nbsp;
.>>
\fCyes | no\fR
.IP \0
If \fBproc page\fR is used with \fCeps\fR, \fCpng\fR, or \fCgif\fR as the device,
this attribute may be used so that the 
bounding box includes the whole page 
(normally it is cropped to the design with a small margin).
Default is \fCno\fR for EPS, PNG or GIF, \fCyes\fR otherwise.
.br
Example: \fCpagebox: yes\fR


.ig >>
<br><br><br>
.>>

.SH Command line option equivalents
Many 
.ig >>
<a href="pl.1.html">
.>>
\0command line options
.ig >>
</a>
.>>
can also be set in proc page if desired.
See also
.ig >>
<a href="settings.html">
.>>
\0proc settings
.ig >>
</a>
.>>
and
.ig >>
<a href="config.html">
.>>
\0config files.
.ig >>
</a>
.>>

.ig >>
<br><br><br>
.>>

.LP
\fBoutfilename\fR 
.ig >>
&nbsp; &nbsp;
.>>
\fIfilename\fR
.IP \0
Does the same thing as the \fB-o\fR command line option.
Specifies a filename where PNG, GIF, EPS, or paginated postscript result will be placed.
For PNG, GIF and EPS a different file name should be used for every Page.

.ig >>
<br><br>
.>>

.LP
\fBmapfilename\fR 
.ig >>
&nbsp; &nbsp;
.>>
\fIfilename\fR
.IP \0
Does the same thing as the \fB-mapfile\fR command line option.

.ig >>
<br><br>
.>>

.LP
\fBcolor\fR 
.ig >>
&nbsp; &nbsp;
.>>
.ig >>
<a href="color.html">
.>>
\0color
.ig >>
</a>
.>>
.IP \0
Does the same thing as the \fB-color\fR command line option.
Sets the default color for drawn lines and text.  
.br
Example \fCcolor: white\fR

.ig >>
<br><br>
.>>

.LP
\fBbackgroundcolor\fR 
.ig >>
&nbsp; &nbsp;
.>>
.ig >>
<a href="color.html">
.>>
\0color
.ig >>
</a>
.>>
.IP \0
Does the same thing as the \fB-backgroundcolor\fR command line option.
Sets the background color for the page.  
Example \fCbackgroundcolor: blue\fR

.LP
\fBlinewidth\fR 
.ig >>
&nbsp; &nbsp;
.>>
\fIw\fR
.IP \0
Does the same thing as the \fB-linewidth\fR command line option.
Sets the default line width.  All line width specifications
will be rendered as relative to this.  
See also
.ig >>
<a href="linedetails.html">
.>>
\0linedetails.
.ig >>
</a>
.>>
.br
Example: \fClinewidth: 3.0\fR

.ig >>
<br><br>
.>>

.LP
\fBtextsize\fR  
.ig >>
&nbsp; &nbsp;
.>>
\fIp\fR
.IP \0
Does the same thing as the \fB-textsize\fR command line option.
Sets the default point size of text.  All text size specifications
will be rendered as relative to this.  
See also
.ig >>
<a href="textdetails.html">
.>>
\0textdetails.
.ig >>
</a>
.>>
.br
Example: \fCtextsize: 16\fR

.LP
\fBfont\fR 
.ig >>
&nbsp; &nbsp;
.>>
\fIfont\fR
.IP \0
Does the same thing as the \fB-font\fR command line option.
sets the overall default font to \fIfont\fR.
See also
.ig >>
<a href="fonts.html">
.>>
\0fonts
.ig >>
</a>
.>>
and 
.ig >>
<a href="textdetails.html">
.>>
\0textdetails
.ig >>
</a>
.>>
.br
PostScript example: \fCfont: /Times-Roman\fR


.ig >>
<br><br>
.>>

.LP
\fBcrop\fR  
.ig >>
&nbsp; &nbsp;
.>>
\fIx1 y1 x2 y2\fR
.IP \0
Same thing as \fB-crop\fR command line option.
After rendering crop PNG, GIF, or EPS result to a box in absolute units.

.ig >>
<br><br>
.>>

.LP
\fBtightcrop\fR 
.ig >>
&nbsp; &nbsp;
.>>
\fCyes | no\fR
.IP \0
Does the same thing as the \fB-tightcrop\fR command line option.
After rendering crop PNG, GIF or EPS result 
to the extent of the design with no margin
(normally a small margin is allowed).
.ig >>
<br><br>
.>>

.LP
\fBcroprel\fR  
.ig >>
&nbsp; &nbsp;
.>>
\fIleft bottom right top\fR
.IP \0
Same thing as \fB-croprel\fR command line option.
After rendering crop PNG, GIF, or EPS result to the extent of the design but
with an adjustable margin; positive values always adjust
the crop outward from center, negative values inward.

.ig >>
<br><br>
.>>

.LP
\fBscale\fR 
.ig >>
&nbsp; &nbsp;
.>>
\fIscalex\fR  
.ig >>
&nbsp; &nbsp;
.>>
[\fIscaley\fR]
.IP \0
Does the same thing as the \fB-scale\fR command line option.
Enlarges or reduces the size of the entire result by
the given factor(s) (less than 1.0 reduces, greater than 1.0 enlarges).
.br
Example: \fCscale: 0.7 0.5\fR

.ig >>
<br><br>
.>>

.LP
\fBlandscape\fR  
.ig >>
&nbsp; &nbsp;
.>>
\fCyes\fR | \fCno\fR
.IP \0
Does the same thing as the \fB-landscape\fR command line option,
except on a per-page basis.  Default is no.
If \fCyes\fR paper orientation will be landscape (oblong)
when using paginated postscript.  The absolute units 
origin (0,0) will be the lower left corner of the paper (paper 
held oblong).

.LP
\fBpagesize\fR 
.ig >>
&nbsp; &nbsp;
.>>
\fIwidth height\fR
.IP \0
Similar to the \fB-pagesize\fR command line option.
However, unlike with the command line option, X11 window size will be affected
if overall scaling is done.  Another noticed difference is that
background fill color on large pages works with the command line option
but not with this attribute.
.br
Example: \fCpagesize: 7 3\fR

.ig >>
<br><br>
.>>

.LP
\fBoutlabel\fR  
.ig >>
&nbsp; &nbsp;
.>>
\fIlabel\fR
.IP \0
Does the same thing as the \fB-outlabel\fR command line option.
Set an output label or title to \fIlabel\fR.  For X11 this is the window title.
For PostScript and SVG it sets the \fC%%Title\fR attribute (first page only).


.ig >>
<br><br><br>
.>>

.SH Clickmaps 

.LP
\fBclickmapdefault\fR  
.ig >>
&nbsp; &nbsp;
.>>
\fIurl\fR
.IP \0
If
.ig >>
<a href="clickmap.html">
.>>
\0clickmaps
.ig >>
</a>
.>>
are being generated, this attribute allows a "default" url to be supplied, for when
a mouse click is in none of the defined regions.

.ig >>
<br>
<br>
</td></tr>
<td align=right>
<a href="../doc/welcome.html">
<img src="../doc/ploticus.gif" border=0></a><br><small>data display engine &nbsp; <br>
<a href="../doc/Copyright.html">Copyright Steve Grubb</a>
<br>
<br>
<center>
<img src="../gallery/all.gif"> 
</center>
</td></tr>
</table>
.>>
