Home My Page Projects Code Snippets Project Openings diderot
Summary Activity Tracker Tasks SCM

SCM Repository

[diderot] Annotation of /branches/charisee_dev/doc/man/diderotc.1.txt
ViewVC logotype

Annotation of /branches/charisee_dev/doc/man/diderotc.1.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3269 - (view) (download)

1 : jhr 2492 DIDEROTC(1)
2 :     ===========
3 :     :doctype: manpage
4 :    
5 :    
6 :     NAME
7 :     ----
8 :     diderotc - compiler for the parallel domain-specific language Diderot
9 :    
10 :    
11 :     SYNOPSIS
12 :     --------
13 :     *diderotc* ['OPTIONS'] 'FILE'
14 :    
15 :    
16 :     DESCRIPTION
17 :     -----------
18 :     The diderotc(1) command compiles Diderot source code into either a library
19 :     (the default) or stand-alone executable.
20 :     The Diderot language is a parallel domain-specific language for image-analysis
21 :     algorithms.
22 :    
23 :    
24 :     OPTIONS
25 :     -------
26 :     *-h, --help*::
27 :     Display a list of command-line options and then exit.
28 :     This list includes additional options used to support development and debugging of
29 :     the compiler.
30 :    
31 :     *--exec*::
32 :     Compile the Diderot program to run as a standalone executable.
33 :    
34 :     *-o, --output*='OUTFILE'::
35 :     Use the name 'OUTFILE' as the stem for the generated code files.
36 :     When coupled with the *--exec* flag, 'OUTFILE' will be the name of
37 :     the executable.
38 :    
39 :     *--namespace*='PREFIX'::
40 :     Specify a namespace prefix for generated interface to the Diderot program.
41 :     The default namespace prefix is \texttt{Diderot}.
42 :    
43 :     *--snapshot*::
44 :     Generate code to get a snapshot of strand states (ignored if the *--exec* flag is given).
45 :    
46 :     *--target*='TARGET'::
47 :     Specify the target platform for the generated code.
48 :     The *diderotc* compiler currently supports the following choices for 'TARGET':
49 :    
50 :     *c*;;
51 :     single-threaded sequential implementation.
52 :     *pthread*;;
53 :     parallel implementation for multiprocessors using pthreads.
54 :     *cl*;;
55 :     parallel implementation for GPUs using OpenCL.
56 :    
57 :     Note that not all targets are supported by all installations. Use the *--help* command to
58 :     determine the targets supported by a given instance of the compiler.
59 :    
60 :     *--double*::
61 :     Use double-precision floating-point for the Diderot real type.
62 :    
63 :     //*--longint*::
64 :     // Use 64-bit integers for the Diderot real type.
65 :    
66 :     *-g, --debug*::
67 :     Enable assertions and debugging information in the generated code and runtime system.
68 :    
69 :     *--log*::
70 :     Emit a log file of the compiler's intermediate representations.
71 :     This option is mainly used to debug the compiler.
72 :    
73 :    
74 :     OUTPUT FILES
75 :     ------------
76 :     The *diderotc* compiler produces one or more output files, depending on the command-line
77 :     options.
78 :     These files will have a common stem, which will either be the stem of the source file (i.e.,
79 :     'foo' for the source file 'foo.diderot') or the name specified by the *--output* option.
80 :    
81 :     RUNTIME OPTIONS
82 :     ---------------
83 :     The executables produced by the compiler when using the *--exec* option recognize
84 :     a number of standard options.
85 :    
86 :     *-verbose*::
87 :     Enable runtime-system messages to stderr.
88 :    
89 :     *-timing*::
90 :     Report execution time to stdout.
91 :    
92 :    
93 :     ENVIRONMENT
94 :     -----------
95 :    
96 :     *DIDEROT_TEEM_DIR*::
97 :     If this environment variable is present, it is used to specify the path
98 :     to the Teem installation.
99 :     The *diderotc* compiler uses this path to find teem executables, libraries, and include
100 :     files that are used during the compilation process.
101 :    
102 :    
103 :     SEE ALSO
104 :     --------
105 :     *diderot-api*(5)
106 :    
107 :     teem -- http://teem.sourceforge.net
108 :    
109 :     AUTHOR
110 :     ------
111 :    
112 :     Maintained by the Diderot project (http://diderot-language.cs.uchicago.edu[]).

root@smlnj-gforge.cs.uchicago.edu
ViewVC Help
Powered by ViewVC 1.0.0