DIDEROTC(1)
===========
:doctype: manpage


NAME
----
diderotc - compiler for the parallel domain-specific language Diderot


SYNOPSIS
--------
*diderotc* ['OPTIONS'] 'FILE'


DESCRIPTION
-----------
The diderotc(1) command compiles Diderot source code into either a library
(the default) or stand-alone executable.
The Diderot language is a parallel domain-specific language for image-analysis
algorithms.


OPTIONS
-------
*-h, --help*::
  Display a list of command-line options and then exit.
  This list includes additional options used to support development and debugging of
  the compiler.

*--exec*::
  Compile the Diderot program to run as a standalone executable.

*-o, --output*='OUTFILE'::
  Use the name 'OUTFILE' as the stem for the generated code files.
  When coupled with the *--exec* flag, 'OUTFILE' will be the name of
  the executable.

*--namespace*='PREFIX'::
  Specify a namespace prefix for generated interface to the Diderot program.
  The default namespace prefix is \texttt{Diderot}.

*--snapshot*::
  Generate code to get a snapshot of strand states (ignored if the *--exec* flag is given).

*--target*='TARGET'::
  Specify the target platform for the generated code.
  The *diderotc* compiler currently supports the following choices for 'TARGET':

  *c*;;
    single-threaded sequential implementation.
  *pthread*;;
    parallel implementation for multiprocessors using pthreads.
  *cl*;;
    parallel implementation for GPUs using OpenCL.

  Note that not all targets are supported by all installations.  Use the *--help* command to
  determine the targets supported by a given instance of the compiler.

*--double*::
  Use double-precision floating-point for the Diderot real type.

//*--longint*::
//  Use 64-bit integers for the Diderot real type.

*-g, --debug*::
  Enable assertions and debugging information in the generated code and runtime system.

*--log*::
  Emit a log file of the compiler's intermediate representations.
  This option is mainly used to debug the compiler.


OUTPUT FILES
------------
  The *diderotc* compiler produces one or more output files, depending on the command-line
  options.
  These files will have a common stem, which will either be the stem of the source file (i.e.,
  'foo' for the source file 'foo.diderot') or the name specified by the *--output* option.
  
RUNTIME OPTIONS
---------------
  The executables produced by the compiler when using the *--exec* option recognize
  a number of standard options.

*-verbose*::
  Enable runtime-system messages to stderr.

*-timing*::
  Report execution time to stdout.


ENVIRONMENT
-----------

*DIDEROT_TEEM_DIR*::
  If this environment variable is present, it is used to specify the path
  to the Teem installation.
  The *diderotc* compiler uses this path to find teem executables, libraries, and include
  files that are used during the compilation process.


SEE ALSO
--------
  *diderot-api*(5)

  teem -- http://teem.sourceforge.net

AUTHOR
------

Maintained by the Diderot project (http://diderot-language.cs.uchicago.edu[]).