cduce.docbook 4.19 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN">

<refentry id="cduce">

<refmeta>
<refentrytitle>cduce</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>

<refnamediv>
<refname>cduce</refname>
<refpurpose>The CDuce interpreter</refpurpose>
</refnamediv>

<refsynopsisdiv>
<cmdsynopsis>
<command>cduce</command>
<arg choice="opt">
  <option>-v</option>
  <option>--quiet</option>
21
  <option>--license</option>
22 23 24 25 26
</arg>
<arg choice="opt">
  <option>--dump <filename>file</filename></option>
</arg>
<arg choice="opt" rep="repeat">
27
  <option><filename>file[.cd]</filename></option>
28
</arg>
29
<arg choice="opt" rep="repeat"><option>--arg <filename>argument</filename></option></arg>
30 31 32 33 34 35 36 37 38
</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
<title>Description</title>
<para>
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
39
uses the standard input. All the arguments that follow the --arg option are
40 41 42 43 44 45 46 47
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>.
48 49 50 51 52 53 54
</para>
</refsect1>


<refsect1>
<title>Options</title>
<para>
55
This program follows the usual syntax,
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
with long options starting with two dashes (`--'). A
summary of the options supported by <command>cduce</command>
is included below.		</para>
		

<refsect2>
<title>Generic Options</title>
<variablelist>


<varlistentry>
<term><option>--dump <filename>file</filename></option></term>
<listitem>
<para> This options allows persistence between several invocations of the
interpreter: the current environment (defined types and values) is saved in
<filename>file</filename> when the interpreter terminates and it is restored if
the interpreter is started again with the same option and file.</para>
</listitem>
</varlistentry>


<varlistentry>
78
<term><option>-h</option>, <option>--help</option></term>
79 80 81 82 83 84 85 86 87
<listitem>
<para>Display a short help message and exit.</para>
</listitem>
</varlistentry>


<varlistentry>
<term><option>--license</option></term>
<listitem>
88
<para>Show license information and exit.</para>
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
</listitem>
</varlistentry>


<varlistentry>
<term><option>--quiet</option></term>
<listitem>
<para>Suppress normal output (typing, results). It is normally
      used when the CDuce interpreter is used in the context of batch
      processing.</para>
</listitem>
</varlistentry>


<varlistentry>
<term><option>-v</option>, <option>--version</option></term>
<listitem>
<para>Show version information and exit.</para>
</listitem>
</varlistentry>
</variablelist>

</refsect2>

<refsect2>
<title>PROGRAM OPTIONS</title>
<para>
<variablelist>

<varlistentry>
119
<term><option>--arg <filename>arguments</filename></option></term>
120 121 122

<listitem>
<para>
123
All the arguments following <option>--arg</option> are passed to the CDuce
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
program, in the variable <command>argv</command> (of type <command>[ String*
]</command>, which means sequence of character strings).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect2>

</refsect1>
	
<refsect1>
<title>Reporting bugs</title>
<para>
Report bugs to <email>bugs@cduce.org</email>.
</para>

</refsect1>



	
<refsect1>
<title>SEE ALSO</title>
<para>
A complete documentation, reference manual, tutorial, technical articles on
implementation and theoretical issues, benchmarks, source code, mailing lists
and forums can be found on the <emphasis>CDuce</emphasis> website:
<filename>http://www.cduce.org</filename>.
</para>

</refsect1>

<refsect1>
<title>AUTHOR</title>
<para>
Alain Frisch <email>Alain.Frisch@ens.fr</email> with small contributions of
161
Giuseppe Castagna <email>Giuseppe.Castagna@ens.fr</email>, and Stefano Zacchiroli <email>zack@di.ens.fr</email>.
162 163 164 165 166 167 168 169
</para>

</refsect1>




</refentry>