[r2003-05-24 20:20:06 by cvscast] Beppe: Docbook manual and troff man page.

Original author: cvscast
Date: 2003-05-24 20:20:06+00:00

doc/cduce.1

+.TH "CDUCE" "1" "" "CDUCE" "1"
+
+.SH NAME
+cduce \- The CDuce interpreter
+.SH SYNOPSIS
+
+\fBcduce\fR [ \fB  -v
+--quiet
+--silent\fR ] [ \fB  --dump \fIfile\fB\fR ] [ \fB  \fIfile.cd\fB\fR\fI ...\fR ] [ \fB--args \fIargument\fB\fR\fI ...\fR ]
+
+.SH "DESCRIPTION"
+.PP
+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 --args option are
+passed to the source file(s).
+.SH "OPTIONS"
+.PP
+This program follows the usual GNU command line syntax,
+with long options starting with two dashes (`--'). A
+summary of the options supported by \fBcduce\fR
+is included below.  
+.SS "GENERIC OPTIONS"
+.TP
+\fB--dump \fIfile\fB\fR
+This options allows persistence between several invocations of the
+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
+Display a short help message and exit.
+.TP
+\fB--license\fR
+Show license information
+.TP
+\fB--quiet\fR
+Suppress normal output (typing, results). It is normally
+used when the CDuce interpreter is used in the context of batch
+processing.
+.TP
+\fB-v, --version\fR
+Show version information and exit.
+.SS "PROGRAM OPTIONS"
+.PP
+.TP
+\fB--args \fIarguments\fB\fR
+All the arguments following \fB--args\fR are passed to the CDuce
+program, in the variable \fBargv\fR (of type \fB[ String*
+]\fR, which means sequence of character strings).
+.SH "REPORTING BUGS"
+.PP
+Report bugs to <bugs@cduce.org>.
+.SH "SEE ALSO"
+.PP
+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 \fBCDuce\fR website:
+\fIhttp://www.cduce.org\fR.
+.SH "AUTHOR"
+.PP
+Alain Frisch <Alain.Frisch@ens.fr> with small contributions of
+Giuseppe Castagna <Giuseppe.Castagna@ens.fr>, Stefano Zacchiroli <zack@di.ens.fr>.

doc/cduce.docbook

+<!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>