1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
|
<html>
<head>
<!-- This file has been generated by unroff 1.0, 02/28/02 11:58:59. -->
<!-- Do not edit! -->
<STYLE TYPE="text/css">
<!--
A:link{text-decoration:none}
A:visited{text-decoration:none}
A:active{text-decoration:none}
-->
</STYLE>
<title>ploticus: ploticus config files</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>Ploticus config files</h2></td>
<td align=right>
<small>
<a href="../doc/Welcome.html"><img src="../doc/ploticus.gif" border=0></a><br>
<a href="../doc/Welcome.html">Welcome</a>
<a href="../gallery/index.html">Gallery</a>
<a href="../doc/Contents.html">Handbook</a>
<td></tr></table>
</td></tr>
<td>
<br>
<br>
<title>Manual page for Ploticus_config_files(PL)</title>
</head>
<body>
<p>
A configuration file may be used to make certain settings
that will apply to all ploticus invocations.<tt> </tt>
A configuration file is not required (unless running in
<a href="cgi.html">
cgi mode
</a>
). If no config file is found, standard defaults will be used.<tt> </tt>
Upon execution, ploticus checks for an environment variable called
<b>PLOTICUS_CONFIG</b>, which should contain the full path name of
your config file.<tt> </tt>
<p>
If a config file is found, it will be read and processed before command line
arguments are evaluated, and before script interpretation begins.<tt> </tt>
<p>
Typical uses of a config file are to set up non-English
month and weekday names,
to set default date or numeric notations, or to
use cm instead of inch as the absolute unit.<tt> </tt>
Many (but not all) of these settings can also be made from within an individual
script using
<a href="settings.html">
proc settings
</a>
<br><br><br>
<h2>EXAMPLE</h2>
Examples of config files set up for Spanish and Russian
are located in the gallery directory, named
<a href="../gallery/plconfig.spanish">
plconfig.spanish
</a>
and
<a href="../gallery/plconfig.russian">
plconfig.russian
</a>
<br><br><br>
<h2>SYNTAX</h2>
One parameter is specified per line (see the example below).<tt> </tt>
Parameters are case-insensitive and must begin in the first column of the line.<tt> </tt>
Lines beginning with <tt>//</tt> or <tt>#</tt> are taken as
comments; blank lines are skipped.<tt> </tt>
<br><br><br>
<h2>PARAMETERS</h2>
<p>
The following parameters may be set.<tt> </tt>
Parameters that are not set assume the default value, which is shown
in (parentheses).<tt> </tt>
<p>
<b>projectroot:</b>
<dl>
<dt><dd><p>
The directory from which ploticus will operate. This must be specified when
using pl in
<a href="cgi.html">
cgi mode.<tt> </tt>
</a>
</dl>
<p>
<b>option:</b> <i>option</i> [<i>arg</i>]
<dl>
<dt><dd><p>
Set any pl command line option (see
<a href="pl.1.html">
pl(1)
</a>
for a list of supported command line options)
or
<a href="prefabs.html">
prefab
</a>
parameter.<tt> </tt>
The given command line option will be in effect for all invocations of pl.<tt> </tt>
This parameter may be used as many times as necessary.<tt> </tt>
<br>
Example:
<pre>
option: -gif
option: -viewer xv
option: delim=comma
</pre>
</dl>
<p>
<b>varvalue:</b> <i>varname</i>=<i>value</i>
<dl>
<dt><dd><p>
Preset a variable to a value.<tt> </tt>
This may be used as many times as desired within the config file to
set various variables.<tt> </tt>
This may also be used to set a variable that will be referenced later
in the config file.<tt> </tt>
<br>
Example: <tt>varvalue: MODE=normal</tt>
</dl>
<p>
<b>putenv:</b> <i>varname</i>=<i>value</i>
<dl>
<dt><dd><p>
Set an environment variable for current process and all subprocesses.<tt> </tt>
This may be used as many times as desired within the config file to
set various environment variables.
Especially useful when operating in
<a href="cgi.html">
cgi mode
</a>
since a CGI process often inherits an environment that is not
under the developer's control.<tt> </tt>
<br>
Example: <tt>putenv: ERRMODE=normal</tt>
</dl>
<p>
<b>tmpdir:</b> <i>dirname</i>
<dl>
<dt><dd><p>
The directory that ploticus uses for temporary files.<tt> </tt>
By default this is <tt>/tmp</tt>.<tt> </tt>
This can also be set in <tt>pl.h</tt>.<tt> </tt>
<br>
Example: <tt>tmpdir: /var/tmp</tt>
</dl>
<p>
<b>units:</b> <tt>in</tt> | <tt>cm</tt>
<dl>
<dt><dd><p>
The measurement unit to be used for absolute units, either inches or centimeters.<tt> </tt>
Default is <tt>in</tt>.<tt> </tt>
If this is set in the config file, it will be in effect when command line
arguments are evaluated. If set in <b>proc settings</b>, it will not have any
effect on command line argument evaluation.<tt> </tt>
<br>
Example: <tt>units: cm</tt>
</dl>
<p>
<b>numbernotation:</b> <tt>standard</tt> | <tt>us</tt> | <tt>euro</tt>
<dl>
<dt><dd><p>
Specifies how decimal point and thousands separators will be displayed.
Default is <tt>standard</tt>.<tt> </tt>
The following table illustrates:
<p>
<pre>
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
</pre>
</dl>
<p>
<b>numberspacerthreshold:</b> <i>n</i>
<dl>
<dt><dd><p>
Specifies at what numeric magnitude thousands separators will begin to be inserted.<tt> </tt>
Default is 4, and this is used in the above table. If it were set to <tt>3</tt>, the third entry
in the above table would appear like this:
<pre>
4321.79 4,321.79 4.321,79
</pre>
<br><br><br>
</dl>
<h2>SYSTEM ENVIRONMENT</h2>
<p>
<b>cpulimit:</b>
<dl>
<dt><dd><p>
Number of seconds of CPU time that will be allowed to the <b>pl</b> or <b>pltab</b> process
or any spawned subprocesses. Default is 10 seconds.<tt> </tt>
Any process exceeding this will abort.<tt> </tt>
</dl>
<p>
<b>filesizelimit:</b>
<dl>
<dt><dd><p>
Number of bytes that will be allowed in any file that <b>pl</b> or <b>pltab</b> process
or any spawned subprocesses creates. Default is 5000000 bytes.<tt> </tt>
Any process exceeding this will abort.<tt> </tt>
</dl>
<p>
<b>uid:</b>
<dl>
<dt><dd><p>
Set the effective user id of the <b>pl</b> or <b>pltab</b> process and all
its subprocesses.<tt> </tt>
Only useful in CGI environments where programs are invoked as root,
</dl>
<p>
<b>gid:</b>
<dl>
<dt><dd><p>
Same as <b>uid</b>, but sets the group id.<tt> </tt>
<br><br><br>
</dl>
<h2>DATE-RELATED</h2>
<p>
<b>dateformat:</b> <i>format</i>
<dl>
<dt><dd><p>
Set the current date format.<tt> </tt>
<i>format</i> must be a
date format from the
<a href="dates.html">
dates manual page
</a>
that includes month, day, and year, for which arithmetic is supported.<tt> </tt>
To use other arithmetic date formats (such as quarter notation)
specify the format in the
<a href="areadef.html">
proc areadef
</a>
xscaletype or yscaletype attribute.<tt> </tt>
<br>
Example: <tt>dateformat: dd-mmm-yyyy</tt>
</dl>
<p>
<b>omitweekends</b> <tt>omit</tt> | <tt>adjust</tt> | <tt>yes</tt> | <tt>no</tt>
<dl>
<dt><dd><p>
Allows date plotting as if
Saturdays and Sundays did not exist.<tt> </tt>
Mondays will follow Fridays directly.
Useful in certain business and work-related plots.<tt> </tt>
<br>
If <tt>omit</tt>, any Saturday or Sunday dates encountered will be considered invalid and omitted;
however they will not be reported unless the -showbad command line option is used.<tt> </tt>
<br>
If <tt>adjust</tt> or <tt>yes</tt>, any Saturday or Sunday dates encountered will be silently adjusted
to the nearest weekday.<tt> </tt>
</dl>
<p>
<b>pivotyear:</b> <i>yy</i>
<dl>
<dt><dd><p>
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.<tt> </tt>
<br>
Example: <tt>pivotyear: 50</tt>
</dl>
<p>
<b>months:</b> <i>list</i>
<dl>
<dt><dd><p>
Specify the three-character month abbreviations to be used, all in lower case,
beginning with the first month.<tt> </tt>
Default is the English (<tt>jan feb mar apr may jun jul aug sep oct nov dec</tt>).<tt> </tt>
<br>
Example (Spanish) (must all be on one line):
<br>
<tt>months: ene feb mar abr pue jun jul ago sep oct nov dic</tt>
</dl>
<p>
<b>months.abbrev:</b> <i>list</i>
<dl>
<dt><dd><p>
short month names, capitalized for presentation, begining with the first month.<tt> </tt>
Default is English (<tt>Jan Feb Mar Apr May June July Aug Sept Oct Nov Dec</tt>).<tt> </tt>
<br>
Example (Spanish) (must all be on one line):
<br>
<tt>months.abbrev: Ene Feb Mar Abr Pue Jun Jul Ago Sep Oct Nov Dic</tt>
</dl>
<p>
<b>months.full:</b> <i>list</i>
<dl>
<dt><dd><p>
full month names, capitalized for presentation.<tt> </tt>
<br>
Example (Spanish) (must all be on one line):
<br>
<tt>months.full: Enero Febrero Marcha Abril Pueda Junio Julio Agosto Septiembre Octubre Noviembre Diciembre</tt>
</dl>
<p>
<b>weekdays:</b> <i>list</i>
<dl>
<dt><dd><p>
three-character weekday abbreviations, capitalized for presentation,
beginning with Sunday.<tt> </tt>
<br>
Example (French): <tt>weekdays: Dim Lun Mar Mer Jeu Ven Sam</tt>
<br>
Example (Spanish): <tt>weekdays: Dom Lun Mar Mie Jue Vie Sab</tt>
</dl>
<p>
<b>lazydates</b> <tt>month</tt>|<tt>day</tt>|<tt>both</tt>
<dl>
<dt><dd><p>
Allow handling of dates where the day component
or the month component is not known. See
<a href="dates.html">
dates
</a>
for further discussion of lazy dates.<tt> </tt>
<br>
<br>
</td></tr>
<td align=right>
<a href="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>
<br>
</td></tr>
<td align=right>
<a href="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>
</dl>
<p><hr>
Markup created by <em>unroff</em> 1.0, <tt> </tt> <tt> </tt>February 28, 2002.
</body>
</html>
|
