#set TITLE = "Ploticus config files"
#include top

.SH DESCRIPTION
A configuration file may be used in order to initialize
each invocation of ploticus in a certain way.
Upon execution, ploticus checks for an environment variable called
\fBPLOTICUS_CONFIG\fR, which should contain the full path name of
your config file.
A configuration file is not required (unless running in
#set FILE = cgi.html
#set TAG = "cgi mode"
#include link
).  If no config file is found, standard defaults will generally be used.
.LP
The config file may be used to:
.IP
set default modes of operation
.IP
make month and weekday names appear in languages other than English 
.IP
make the standard absolute unit centimeters instead of inches
.IP
set the default date format, and other date parameters
.IP
set the default notation for numbers


.SH EXAMPLE
Examples of config files set up for Spanish and Russian
are located in the gallery directory, named
.ig >>
<a href="../gallery/plconfig.spanish">
.>>
plconfig.spanish
.ig >>
</a>
.>>
and
.ig >>
<a href="../gallery/plconfig.russian">
.>>
plconfig.russian
.ig >>
</a>
.>>
Note: Ploticus now has locale support so that non-latin alphabets
may be used.  See
.ig >>
<a href="../doc/pl.1.html#environment">
.>>
pl(1) environment
.ig >>
</a>
.>>




.SH SYNTAX
One parameter is specified per line (see the example below).
Parameters are case-insensitive and must begin in the first column of the line.
Lines beginning with \fC//\fR or \fC#\fR are taken as 
comments; blank lines are skipped.


.SH PARAMETERS
.LP
The following parameters may be set.
Parameters that are not set assume the default value, which is shown
in (parentheses).

.LP
\fBoption:\fR \fIoption\fR [\fIarg\fR]
.IP
Set any pl command line option (see
.ig >>
<a href="pl.1.html">
.>>
pl(1)
.ig >>
</a>
.>>
 for a list of supported command line options).  
Command line options that are specific only to pltab are not supported.
The given command line option will be in effect for
all invocations of pl and pltab.
This parameter may be used as many times as necessary.
.br
Example:
.br
\fCoption: -gif\fR
.br
\fCoption: -viewer xv\fR

.LP
\fBvarvalue:\fR \fIvarname\fR=\fIvalue\fR
.IP
Preset a variable to a value.
This may be used as many times as desired within the config file to
set various variables.
This may also be used to set a variable that will be referenced later
in the config file.
.br
Example: \fCvarvalue: MODE=normal\fR

.LP
\fBputenv:\fR  \fIvarname\fR=\fIvalue\fR
.IP
Set an environment variable for current process and all subprocesses.
This may be used as many times as desired within the config file to
set various environment variables.  
Especially useful when operating in 
#set FILE = "cgi.html"
#set TAG = "cgi mode"
#include link
since a CGI process often inherits an environment that is not
under the developer's control.
.br
Example: \fCputenv: ERRMODE=normal\fR


.LP
\fBtmpdir:\fR \fIdirname\fR
.IP
The directory that ploticus uses for temporary files.
By default this is /usr/tmp.  
This can also be set in \fCpl.h\fR.
.br
Example: \fCtmpdir: /tmp\fR

.LP
\fBpathslash:\fR \fIslashchar\fR
.IP
The slash character used in path names.  Default is for \fC/\fR unix.  For
windows/nt use \fC\\\fR.
This can also be set in \fCpl.h\fR.

.LP
\fBunits:\fR \fCin\fR | \fCcm\fR
.IP
The measurement unit to be used for absolute units, either inches or centimeters.
Default is \fCin\fR.
.br
Example: \fCunits: cm\fR


.LP
\fBprojectroot:\fR
.IP
The directory from which ploticus will operate.  This must be specified when
using pl in 
#set FILE = cgi.html
#set TAG = "cgi mode."
#include link


.LP
\fBnumbernotation:\fR \fCstandard\fR | \fCus\fR | \fCeuro\fR
.IP
Specifies how decimal point and thousands separators will be displayed.  
Default is \fCstandard\fR.
The following table illustrates:
.sp
.nf
 standard           us             euro
----------    ------------    -------------
     79              79               79
     79.5            79.5             79,5  
   4321.79         4321.79          4321,79 
  54321          54,321           54.321
 654321.07      654,321.07       654.321,07
1987654321    1,987,654,321    1.987.654.321

#include space

.SH SYSTEM ENVIRONMENT

.LP
\fBcpulimit:\fR
.IP
Number of seconds of CPU time that will be allowed to the \fBpl\fR or \fBpltab\fR process
or any spawned subprocesses.  Default is 10 seconds.
Any process exceeding this will abort.

.LP
\fBfilesizelimit:\fR
.IP
Number of bytes that will be allowed in any file that \fBpl\fR or \fBpltab\fR process
or any spawned subprocesses creates.  Default is 5000000 bytes.
Any process exceeding this will abort.

.LP
\fBuid:\fR
.IP
Set the effective user id of the \fBpl\fR or \fBpltab\fR process and all
its subprocesses.
Only useful in CGI environments where programs are invoked as root,

.LP
\fBgid:\fR
.IP
Same as \fBuid\fR, but sets the group id.


#include space

.SH DATE-RELATED

.LP
\fBdateformat:\fR \fIformat\fR
.IP
Set the default date format.
Supported date formats are described in
.ig >>
<a href="dates.html">
.>>
dates
.ig >>
</a>
.>>
.br
Example: \fCdateformat: dd-mmm-yyyy\fR

.fi
.LP
\fBpivotyear:\fR \fIyy\fR
.IP
Set the two digit year that should be used to convert
two-digit years to four-digit years.  If two-digit years are 
used, year values that are less than the pivot year are assumed
to be 21st century years.  Default is 77.
.br
Example: \fCpivotyear: 50\fR

.LP
\fBmonths:\fR \fIlist\fR
.IP
Specify the three-character month abbreviations to be used, all in lower case,
beginning with the first month.
Default is the English (\fCjan feb mar apr may jun jul aug sep oct nov dec\fR).
.br
Example (Spanish) (must all be on one line): 
.br
\fCmonths: ene feb mar abr pue jun jul ago sep oct nov dic\fR

.LP
\fBmonths.abbrev:\fR \fIlist\fR
.IP
short month names, capitalized for presentation, begining with the first month.
Default is English (\fCJan Feb Mar Apr May June July Aug Sept Oct Nov Dec\fR).
.br
Example (Spanish) (must all be on one line): 
.br
\fCmonths.abbrev: Ene Feb Mar Abr Pue Jun Jul Ago Sep Oct Nov Dic\fR

.LP
\fBmonths.full:\fR \fIlist\fR
.IP
full month names, capitalized for presentation.
.br
Example (Spanish) (must all be on one line): 
.br
\fCmonths.full: Enero Febrero Marcha Abril Pueda Junio Julio Agosto Septiembre Octubre Noviembre Diciembre\fR

.LP
\fBweekdays:\fR  \fIlist\fR
.IP
three-character weekday abbreviations, capitalized for presentation,
beginning with Sunday.
.br 
Example (French): \fCweekdays: Dim Lun Mar Mer Jeu Ven Sam\fR
.br
Example (Spanish): \fCweekdays: Dom Lun Mar Mie Jue Vie Sab\fR

#include bottom
