\About
\DClean Options

\c A utility to change the  options
\c of Clean applications
\c© 1998
\cUniversity of Nijmegen
\cand
\cHILT - High Level Software Tools B.V.
\cNijmegen - The Netherlands

\dFor information about the Clean System
\d see <http://www.cs.kun.nl/~clean/>
\EndAbout

\Help

\DClean Options

\c A utility to change the  options
\c of Clean applications
\c© 1987-1997

Clean Options is a utility to change the run-time options of PowerPC
applications that are generated with the Clean Programming environment.

\DCopyright Notice and Disclaimer

© 1998

Computing Science Institute
University of Nijmegen
Nijmegen - The Netherlands
and
HILT - High Level Software Tools B.V.
Nijmegen - The Netherlands

e-mail: clean@cs.kun.nl
www: <http://www.cs.kun.nl/~clean/>

We do not make any warranty, either express or implied, with respect to this 
software.

\DUsage

Choose "Open Application..." from the File Menu, or drop an application on
the Clean Options application.

\DExplanation of the options

Application options are stored in the resource of the corresponding application 
and examined by its run-time system before the execution starts.

\b¥   Configuration

Set the heap space and the maximal amount of space available for the stacks. 
The stack space is created outside the heap space. The extra memory is needed 
for administration and is highly determined by the number of files and 
windows that are opened. 40 to 60K will be enough in general. An application 
may crash when this value is set too low.

The application will stop with a run-time error message when a heap turns out 
to be too small during execution. It will also stops when the stack is too small 
and code is generated to test on the stack boundaries. 
When the stack boundaries are not checked the program may crash or behave 
unpredictable after a stack overflow.

Increase the space sizes when the application needs more memory. It is also 
possible that the application requires less memory. For an optimal tuning look 
at the run-time information that the application can produce (see below).

\b¥   Information

An application can produce all kinds of information to make an optimal tuning 
of the memory size to be assigned to the application possible.

The execution time will be displayed when the application stops and Show 
Execution Time is chosen.

Each time the garbage collector is invoked this is displayed when Show Garbage 
Collections is chosen. The run-time system uses both a copying as well as a 
mark-scan garbage collection algorithm. It automatically switches between 
these two garbage collection strategies to obtain an optimal time/space 
behaviour. This option gives you information about how  well the heap size
was chosen.

In addition, also the sizes of the different stacks are printed when Print Stack 
Size is chosen. This helps to tune the sizes of the stacks.

\b¥   Output

With these options one has control over the way the result of the Start function 
is displayed.

Choose Show Constructors and all constructors and brackets will be shown. 
Choose Basic Values Only if you only want to display basic values only (integers, 
booleans, strings, characters, reals).

Choose No Console if the I/O of the program is handled via the I/O libraries. 
When this option is chosen no console (output window) for the program will be 
provided and the result of the Start function will not be displayed. When the 
Clean program explicitly tries to write to the console a console window will be 
opened. So, when your program terminates unexpectedly probably a run-time 
error has been detected. Choose one of the other Output options and run the 
program again to be able to read the error message.

The font and size of the generated output on the console can also be set in the 
dialog that appears when the Font button is pressed. This option has no effect 
when the output of the program is done via the I/O libraries of Clean.

\EndHelp
