[r2003-05-25 22:48:50 by cvscast] Beppe: Updated manual

Original author: cvscast
Date: 2003-05-25 22:48:50+00:00

doc/cduce.1

-.TH "CDUCE" "1" "25th May 2003" "" ""
+.TH "CDUCE" "1" "26th of May 2003" "" ""
 
 .SH NAME
 cduce \- The CDuce interpreter
 .SH SYNOPSIS
 
-\fBcduce\fR [ \fB  -v
+\fBcduce\fR [ \fB-v
 --quiet
---license\fR ] [ \fB  --dump \fIfile\fB\fR ] [ \fB  \fIfile.cd\fB\fR\fI ...\fR ] [ \fB--arg \fIargument\fB\fR\fI ...\fR ]
+--license\fR ] [ \fB--dump \fIfile\fB\fR ] [ \fB \fIfile[.cd]\fB\fR\fI ...\fR ] [ \fB--arg \fIargument\fB\fR\fI ...\fR ]
 
 .SH "DESCRIPTION"
 .PP
@@ -14,11 +14,15 @@ The \fBcduce\fR command considers all the .cd files on the command
 line that follow the options as CDuce sources, and executes them
 successively. If no CDuce file is given on the command line, the interpreter
 uses the standard input. All the arguments that follow the --arg option are
-passed to the source file(s). If no CDuce file is given on the command line
-then the interpreter uses the standard input.
+passed to the source file(s). 
+.PP
+If no CDuce file is given on the command line
+then the interpreter uses the standard input and behaves as an interactive
+toplevel. Toplevel phrases are processed after each \fB;;\fR. Mutually recursive declarations of types or functions must be contained in a single adjacent sequence of phrases (without \fB;;\fR inbetween).
+In order to allow persistence (option \fB--dump\fR) to operate, you must quit the toplevel with \fBCtrl-D\fR and not \fBCtrl-C\fR.
 .SH "OPTIONS"
 .PP
-This program follows the usual GNU command line syntax,
+This program follows the usual syntax,
 with long options starting with two dashes (`--'). A
 summary of the options supported by \fBcduce\fR
 is included below.  
@@ -30,11 +34,11 @@ interpreter: the current environment (defined types and values) is saved in
 \fIfile\fR when the interpreter terminates and it is restored if
 the interpreter is started again with the same option and file.
 .TP
-\fB-h, -?, --help\fR
+\fB-h,  --help\fR
 Display a short help message and exit.
 .TP
 \fB--license\fR
-Show license information
+Show license information and exit.
 .TP
 \fB--quiet\fR
 Suppress normal output (typing, results). It is normally

doc/cduce.docbook

@@ -24,7 +24,7 @@
   <option>--dump <filename>file</filename></option>
 </arg>
 <arg choice="opt" rep="repeat">
-  <option><filename>file.cd</filename></option>
+  <option><filename>file[.cd]</filename></option>
 </arg>
 <arg choice="opt" rep="repeat"><option>--arg <filename>argument</filename></option></arg>
 </cmdsynopsis>
@@ -37,8 +37,14 @@ The <command>cduce</command> command considers all the .cd files on the command
 line that follow the options as CDuce sources, and executes them
 successively. If no CDuce file is given on the command line, the interpreter
 uses the standard input. All the arguments that follow the --arg option are
-passed to the source file(s). If no CDuce file is given on the command line
-then the interpreter uses the standard input.
+passed to the source file(s). 
+</para>
+<para>
+If no CDuce file is given on the command line
+then the interpreter uses the standard input and behaves as an interactive
+toplevel. Toplevel phrases are processed after each <command>;;</command>. Mutually recursive declarations of types or functions must be contained in a single adjacent sequence of phrases (without <command>;;</command> inbetween).
+
+In order to allow persistence (option <option>--dump</option>) to operate, you must quit the toplevel with <command>Ctrl-D</command> and not <command>Ctrl-C</command>.
 </para>
 </refsect1>
 
@@ -46,7 +52,7 @@ then the interpreter uses the standard input.
 <refsect1>
 <title>Options</title>
 <para>
-This program follows the usual GNU command line syntax,
+This program follows the usual syntax,
 with long options starting with two dashes (`--'). A
 summary of the options supported by <command>cduce</command>
 is included below.		</para>
@@ -69,7 +75,7 @@ the interpreter is started again with the same option and file.</para>
 
 
 <varlistentry>
-<term><option>-h</option>, <option>-?</option>, <option>--help</option></term>
+<term><option>-h</option>, <option>--help</option></term>
 <listitem>
 <para>Display a short help message and exit.</para>
 </listitem>
@@ -79,7 +85,7 @@ the interpreter is started again with the same option and file.</para>
 <varlistentry>
 <term><option>--license</option></term>
 <listitem>
-<para>Show license information</para>
+<para>Show license information and exit.</para>
 </listitem>
 </varlistentry>