cduce.docbook 3.69 KB
Newer Older
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
<!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>
  <option>--silent</option>
</arg>
<arg choice="opt">
  <option>--dump <filename>file</filename></option>
</arg>
<arg choice="opt" rep="repeat">
  <option><filename>file.cd</filename></option>
</arg>
<arg choice="opt" rep="repeat"><option>--args <filename>argument</filename></option></arg>
</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
uses the standard input. All the arguments that follow the --args option are
passed to the source file(s).
</para>
</refsect1>


<refsect1>
<title>Options</title>
<para>
This program follows the usual GNU command line syntax,
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>
<term><option>-h</option>, <option>-?</option>, <option>--help</option></term>
<listitem>
<para>Display a short help message and exit.</para>
</listitem>
</varlistentry>


<varlistentry>
<term><option>--license</option></term>
<listitem>
<para>Show license information</para>
</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>
<term><option>--args <filename>arguments</filename></option></term>

<listitem>
<para>
All the arguments following <option>--args</option> are passed to the CDuce
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
Giuseppe Castagna <email>Giuseppe.Castagna@ens.fr</email>, Stefano Zacchiroli <email>zack@di.ens.fr</email>.
</para>

</refsect1>




</refentry>