.\" Copyright (c) 1998, 1999, 2000 Free Software Foundation    -*-Text-*-
.\" See section COPYING for conditions for redistribution
.\"
.de Id
.ds Rv \\$3
.ds Dt \\$4
..
.de Sp
.if n .sp
.if t .sp 0.4
..
.Id $Id: clif.1,v 1.3 2000/04/09 08:19:27 koren Exp $
.TH Clif 1 "\*(Dt" "GNU Tools" "GNU Tools"
.SH NAME
clif \- C\-like Interpreter Framework (v0.92)
.SH SYNOPSIS
.B clif
.RI "[ " option " | " filename " ].\|.\|."
.SH WARNING
The information in this manual page can be incomplete. For full
documentation see `The Interpreter Clif Programmer's Guide'.
.SH DESCRIPTION
.B Clif \- C\-like Interpreter Framework
is open-ended system for fast development of programs with C
syntax. The program is compiled and if syntactic correct, code is
immediately generated. The code is generated for a virtual
machine. The virtual machine is a part of the framework.
.Sp
The
.B Clif
works in two basic modes as an interpreter and/or as a compiler (see 
`\|\c
.B \-fhandle\-main\c
\&\|' option). The interpreter mode is 
.I default.
In the interpreter mode, the
.B Clif
compiles each function and each loop only once and generated code is
executed repetitively. (This is kind of optimization; the source code
is not parsed over and over again.)
.Sp
The compiler mode is entered if
`\|\c
.B \-fhandle\-main\c
\&\|' option is specified. The files are compiled and code is
generated. When the compilation phase is finished,
.B Clif 
searches for the `main' function and starts execution of it.
.Sp
The
.B Clif
is submitted with subset of
.I standard C library.
The subset is still under development. Intrinsic functions can be
easily enhanced for user's purposes.
.Sp
There are interface functions supporting automatic control and data
acquisition, that can be optionally compiled with
.B Clif.
.Sp
The 
.B Clif
does not recognize bit\-field definition syntax of the
.I C language.
The 
.I C preprocessor
is not implemented yet.
.Sp
There could be discrepancies between the
.B Clif
and the
.I ANSI C Standard.
We are working on unifying of semantic of the
.B Clif
with the
.I ANSI C Standard.
.SH OPTIONS
For each command line, one or more
.I filename
can be specified (usually with 
.B .ci 
suffix). The files are parsed in order of specification in
the command line. The file
.I clif.ini
is implicitly opened. It is an initialization file. Options used
invariably are specified in the file. 
.Sp
Some of 
.BI \-f name
options have a 
.BI \-fno\- name
form. Default value is always mentioned in the option description.
Summary of options follows. Explanations are in next sections.
.hy 0
.na
.TP
.B Overall Options
.br
\-bc
\-c
\-copying
\-help
\-v
\-version
\-verbose
\-warranty
.TP
.B Options Controlling Clif behavior
\-fcall\-by\-reference
\-fno\-call\-by\-reference
\-fcall\-by\-value
\-fno\-call\-by\-value
\-fhandle\-main
.TP
.B Debugging Options
\-g
\-dy
.TP
.B Warning Options
\-w
\-Wcomment
\-Wformat
\-Wimplicit
\-Wreturn\-type
\-Wtrigraphs
\-Wuninitialized
\-Wall
\-W
\-Waggregate\-return
\-Wunused
.ad b
.hy 1
.SH OVERALL OPTIONS
.TP
.B "\-bc"
option specifies number of 512-Byte pages for the 
.B Clif
environment main memory. The arithmetical and temporary stack is
multiple of this option as well.
.TP
.B "\-c"
Compile only. (Not fully supported yet.)
.TP
.B "\-copying"
Show copying.
.TP
.B "\-help"
Show short help.
.TP
.B "\-v, \-version"
Show version.
.TP
.B "\-verbose"
Prints general purpose of the 
.B Clif
and authors.
.TP
.B "\-warranty"
Show warranty.
.ad b
.hy 1
.SH OPTIONS CONTROLLING CLIF BEHAVIOR
.TP
.B "\-fcall\-by\-reference"
Specifies parameter passing mechanism (default). If explicitly
specified, `\|\c
.B \-fno\-call\-by\-value\c
\&\|'
must be specified as well.
.TP
.B "\-fno\-call\-by\-reference"
do not pass parameter by reference. If explicitly specified, `\|\c
.B \-fcall\-by\-value\c
\&\|'
must be specified as well.
.TP
.B "\-fcall\-by\-value"
call by value parameter passing mechanism. If explicitly specified,
`\|\c
.B \-fno\-call\-by\-reference\c
\&\|'
must be specified.
.TP
.B "\-fno\-call\-by\-value"
do not pass parameters by value (default). If explicitly specified,
`\|\c
.B \-fcall\-by\-reference\c
\&\|'
must be specified.
.TP
.B "\-fhandle\-main"
simulate compiler-like behavior. The files on the command line and
included files are compiled. The `main' function must be
defined. After parsing pass, the generated code is executed. The main
function is the beginning of execution.
.ad b
.hy 1
.SH DEBUGGING OPTIONS
.TP
.B "\-g"
produce debugging information. The source lines are output during
virtual machine code execution.
.TP
.B "\-dy"
dump debugging information during parsing to standard error.
.ad b
.hy 1
.SH WARNING OPTIONS
.TP
.B "\-w"
Inhibit all warning messages.
.TP
.B "\-Wcomment"
Warn when a comment-start sequence
`\|\c
.B /*\c
\&\|'
appears in a comment.
.TP
.B "\-Wformat"
Check calls to
`\|\c
.B printf\c
\&\|',
`\|\c
.B scanf\c
\&\|', etc., to make sure that the arguments supplied have types
appropriate to the specified format string.
.TP
.B \-Wimplicit
Warn if a function or parameter is implicitly declared.
.TP
.B "\-Wreturn\-type"
Warn if the return statement is without return value in non-void
function, or with a value in
\|`\c
.B void\c
\&'
function.
.TP
.B "\-Wtrigraphs"
Warn about trigraphs usage.
.TP
.B "\-Wuninitialized"
An automatic variable is used without first being initialized.
.TP
.B "\-Wall"
All of the above warnings.
.TP
.B "\-W"
Print extra warning messages.
.TP
.B "\-Waggregate\-return"
Warn if any functions that return structures or unions are defined or
called.
.TP
.B "\-Wunused"
Warn whenever a variable is unused aside from its declaration.
.SH "FILES"
.nf
file.ci		\fBClif\fR source file
clif.ini		Initialization file
.SH "SEE ALSO"
cc(1), gcc(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1).
.br
.I
The Interpreter Clif. Programmer's Guide.\c
, L. Koren and T. Hruz
.SH BUGS
There are many, for sure. Please, help to make this software better
and report them to Ludovit Koren <koren@vm.stuba.sk>. For instructions
on reporting bugs, see the Interpreter Clif Programmer's Guide.
.SH COPYING
Copyright
.if t \(co
1998, 1999, 2000 Free Software Foundation, Inc.
.PP
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
are preserved on all copies.
.PP
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.
.PP
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for modified
versions, except that this permission notice may be included in
translations approved by the Free Software Foundation instead of in
the original English.
.SH AUTHORS
See the Interpreter 
.B Clif
Programmer's Guide for the contributors to 
.B Clif.