<html>
<head>
<!-- This file has been generated by unroff 1.0, 03/11/09 12:56:17. -->
<!-- Do not edit! -->
<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.41 Mar2009
</small><br><a href="../doc/scripthome.html">Scripts</a>
<td></tr></table>
</td></tr>
<td>
<br>
<br>
<title>Manual page for proc_page(PL)</title>
</head>
<body>
<b>proc page</b> 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, <b>proc page</b> indicates
the page break and is required. Otherwise it is optional.<tt> </tt>
In order to just do a page break (only), invoke <b>proc page</b> with no attributes, eg.<tt> </tt>
<br>
<tt>#proc page</tt>
<br><br><br>
<h2>Attributes</h2>
<br><br>
<p>
<b>title</b>
<a href="attributetypes.html#text">
multiline-text
</a>
<dl>
<dt> <dd>
Specifies a page title.<tt> </tt>
By default, title is rendered at the top center of the "page" (as determined by <tt>pagesize</tt>).<tt> </tt>
Title text is specified as multi-line text, ending with the first blank line.<tt> </tt>
Blank lines that are to be part of the title should be escaped using a backslash (\).<tt> </tt>
<br>
Example:
<pre>
title: Comparison of Survey Techniques
By Region
\
Fall, 1997
</pre>
<tt>
<br><br>
</tt></dl>
<p>
<b>titledetails</b>
<a href="textdetails.html">
textdetails
</a>
<dl>
<dt> <dd>
Specifies detail options for the rendering of the page title.<tt> </tt>
<br>
Example: <tt>titledetails: size=14 style=BI </tt>
<br><br>
</dl>
<p>
<b>dobackground</b>
<tt>yes | no</tt>
<dl>
<dt> <dd>
The only time this attribute is useful is to override the default behavior for EPS, which
is to <b>not</b> fill the entire EPS page area with the background
color (allowing EPS to draw over existing background).<tt> </tt>
For all other output devices the page area is always filled with the background color when
one is specified.<tt> </tt>
<br>
Example: <tt>dobackground: no</tt>
<br><br>
</dl>
<p>
<b>dopagebox</b>
<tt>yes | no</tt>
<dl>
<dt> <dd>
If <b>proc page</b> is used with <tt>eps</tt>, <tt>png</tt>, or <tt>gif</tt> 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).<tt> </tt>
Default is <tt>no</tt> for EPS, PNG or GIF, <tt>yes</tt> otherwise.<tt> </tt>
<br>
Example: <tt>pagebox: yes</tt>
<br><br><br>
</dl>
<h2>Command line option equivalents</h2>
A number of proc page attributes more or less duplicate the functionality of certain command line arguments; see the
<a href="pl.1.html">
pl(1) manual page
</a>
for fuller descriptions.<tt> </tt>
Besides being made in proc page or on the command line, some of these settings can be also be made using
<a href="settings.html">
proc settings
</a>
and/or
<a href="config.html">
your config file.<tt> </tt>
</a>
<br><br><br>
<p>
<b>outfilename</b>
<i>filename</i>
<dl>
<dt> <dd>
Does the same thing as the <b>-o</b> command line option.<tt> </tt>
Specifies a filename where PNG, GIF, EPS, or paginated postscript result will be placed.<tt> </tt>
For PNG, GIF and EPS a different file name should be used for every Page.<tt> </tt>
<br>
Example: <tt>outfilename: myplot_p2.png</tt>
<br><br>
</dl>
<p>
<b>color</b>
<a href="color.html">
color
</a>
<dl>
<dt> <dd>
Does the same thing as the <b>-color</b> command line option.<tt> </tt>
Sets the default color for drawn lines and text.
<br>
Example <tt>color: white</tt>
<br><br>
</dl>
<p>
<b>backgroundcolor</b>
<a href="color.html">
color
</a>
<dl>
<dt> <dd>
Does the same thing as the <b>-backgroundcolor</b> command line option.<tt> </tt>
Sets the background color for the page.
<br>
Example <tt>backgroundcolor: blue</tt>
</dl>
<p>
<b>linewidth</b>
<i>w</i>
<dl>
<dt> <dd>
Does the same thing as the <b>-linewidth</b> command line option.<tt> </tt>
Sets the default line width. All line width specifications
will be rendered as relative to this.
See also
<a href="linedetails.html">
linedetails.<tt> </tt>
</a>
<br>
Example: <tt>linewidth: 3.0</tt>
<br><br>
</dl>
<p>
<b>textsize</b>
<i>p</i>
<dl>
<dt> <dd>
Does the same thing as the <b>-textsize</b> command line option.<tt> </tt>
Sets the default point size of text. All text size specifications
will be rendered as relative to this.
See also
<a href="textdetails.html">
textdetails.<tt> </tt>
</a>
<br>
Example: <tt>textsize: 16</tt>
</dl>
<p>
<b>font</b>
<i>font</i>
<dl>
<dt> <dd>
Does the same thing as the <b>-font</b> command line option.<tt> </tt>
sets the overall default font to <i>font</i>.<tt> </tt>
Font names having embedded spaces will be parsed correctly (but may still be problematic).<tt> </tt>
See also
<a href="fonts.html">
fonts
</a>
and
<a href="textdetails.html">
textdetails
</a>
<br>
PostScript example: <tt>font: /Times-Roman</tt>
<br><br>
</dl>
<p>
<b>crop</b>
<i>x1 y1 x2 y2</i>
<dl>
<dt> <dd>
Same thing as <b>-crop</b> command line option.<tt> </tt>
After rendering crop PNG, GIF, or EPS result to a box in absolute units.<tt> </tt>
<br>
Example: <tt>crop: 2.0 1.5 6.5 5.0</tt>
<br><br>
</dl>
<p>
<b>tightcrop</b>
<tt>yes | no</tt>
<dl>
<dt> <dd>
Does the same thing as the <b>-tightcrop</b> command line option.<tt> </tt>
After rendering crop PNG, GIF or EPS result
to the extent of the design with no margin
(normally a small margin is allowed).<tt> </tt>
<br><br>
</dl>
<p>
<b>croprel</b>
<i>left bottom right top</i>
<dl>
<dt> <dd>
Same thing as <b>-croprel</b> command line option.<tt> </tt>
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.<tt> </tt>
<br>
Example: <tt>croprel: 2.3 1.7 6.5 5.3</tt>
<br><br>
</dl>
<p>
<b>pixsize</b>
<i>width height</i>
<dl>
<dt> <dd>
Same thing as <b>-pixsize</b> command line option. If specified, the result PNG/GIF/JPG image
will have exactly the specified width and height in pixels.
Does not interact with scaling or cropping... user is responsible for ensuring that content fits appropriately into the specified size.<tt> </tt>
User is also responsible for setting <tt>pagesize</tt> appropriately for larger images.<tt> </tt>
New in 2.40
<br><br>
</dl>
<p>
<b>scale</b>
<i>scalex</i>
[<i>scaley</i>]
<dl>
<dt> <dd>
Does the same thing as the <b>-scale</b> command line option.<tt> </tt>
Enlarges or reduces the size of the entire result by
the given factor(s) (less than 1.0 reduces, greater than 1.0 enlarges).<tt> </tt>
<br>
Example: <tt>scale: 0.7 0.5</tt>
<br><br>
</dl>
<p>
<b>landscape</b>
<tt>yes</tt> | <tt>no</tt>
<dl>
<dt> <dd>
Does the same thing as the <b>-landscape</b> command line option,
except on a per-page basis. Default is no.<tt> </tt>
If <tt>yes</tt> 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).<tt> </tt>
</dl>
<p>
<b>pagesize</b>
<i>width height</i>
<dl>
<dt> <dd>
Similar to the <b>-pagesize</b> command line option.<tt> </tt>
There are a few subtle differences due to the order in which various tasks are done.<tt> </tt>
<br>
Example: <tt>pagesize: 7 3</tt>
<br><br>
</dl>
<p>
<b>outlabel</b>
<i>label</i>
<dl>
<dt> <dd>
Does the same thing as the <b>-outlabel</b> command line option.<tt> </tt>
Set an output label or title to <i>label</i>. For X11 this is the window title.<tt> </tt>
For PostScript and SVG it sets the <tt>%%Title</tt> attribute (first page only).<tt> </tt>
<br><br><br>
</dl>
<h2>Clickmaps</h2>
<p>
<p>
<b>csmap</b>
<tt>yes | no</tt>
<dl>
<dt> <dd>
If <tt>yes</tt>, this turns on client-side image map generation (equivalent to the <b>-csmap</b>
command line option).<tt> </tt>
<br><br>
</dl>
<p>
<b>mapfilename</b>
<i>filename</i>
<dl>
<dt> <dd>
Does the same thing as the <b>-mapfile</b> command line option.<tt> </tt>
<br><br>
</dl>
<p>
<b>clickmapdefault</b>
<i>url</i>
<dl>
<dt> <dd>
If
<a href="clickmap.html">
clickmaps
</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.<tt> </tt>
<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 <br>
<a href="../doc/Copyright.html">Copyright Steve Grubb</a>
<br>
<br>
<center>
<img src="../gallery/all.gif">
</center>
</td></tr>
</table>
<br>
<center>
<table><tr><td>
Ploticus is hosted at http://ploticus.sourceforge.net</td><td> </td><td>
<a href="http://sourceforge.net/projects/ploticus"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=38453&type=12"
width="120" height="30" border="0"
alt="Get ploticus data display engine at SourceForge.net. Fast, secure and Free Open Source software downloads" /></a>
</td></tr></table>
</center>
</dl>
<p><hr>
Markup created by <em>unroff</em> 1.0, <tt> </tt> <tt> </tt>March 11, 2009.
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
ed05dc5f357c49fdded780f52b150dce
>
files
>
61
