.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
.TH FAUST "1" "January 2017" "FAUST (DSP to C++ compiler), Version 0.9.95" "User Commands"
.SH NAME
FAUST \- functional programming language for realtime audio applications
.SH DESCRIPTION
FAUST (DSP to C++ compiler), Version 0.9.95
Copyright \(co 2002\-2016, GRAME \- Centre National de Creation Musicale. All rights reserved.
.PP
usage: faust [options] file1 [file2 ...]
.IP
where options represent zero or more compiler options
and fileN represents a faust source file (.dsp extension).
.SS "options :"
.TP
\fB\-h\fR
print this \fB\-\-help\fR message
.TP
\fB\-v\fR
print compiler \fB\-\-version\fR information
.TP
\fB\-d\fR
print compilation \fB\-\-details\fR
.TP
\fB\-tg\fR
print the internal \fB\-\-task\-graph\fR in dot format file
.TP
\fB\-sg\fR
print the internal \fB\-\-signal\-graph\fR in dot format file
.TP
\fB\-ps\fR
print block\-diagram \fB\-\-postscript\fR file
.TP
\fB\-svg\fR
print block\-diagram \fB\-\-svg\fR file
.TP
\fB\-mdoc\fR
print \fB\-\-mathdoc\fR of a Faust program in LaTeX format in a \fB\-mdoc\fR directory
.TP
\fB\-mdlang\fR <l>
load \fB\-\-mathdoc\-lang\fR <l> if translation file exists (<l> = en, fr, ...)
.TP
\fB\-stripmdoc\fR
apply \fB\-\-strip\-mdoc\-tags\fR when printing Faust \fB\-mdoc\fR listings
.TP
\fB\-sd\fR
try to further \fB\-\-simplify\-diagrams\fR before drawing them
.HP
\fB\-f\fR <n>                 \fB\-\-fold\fR <n> threshold during block\-diagram generation (default 25 elements)
.HP
\fB\-mns\fR <n>       \fB\-\-max\-name\-size\fR <n> threshold during block\-diagram generation (default 40 char)
.TP
\fB\-sn\fR
use \fB\-\-simple\-names\fR (without arguments) during block\-diagram generation
.TP
\fB\-xml\fR
generate an XML description file
.TP
\fB\-json\fR
generate a JSON description file
.TP
\fB\-blur\fR
add a \fB\-\-shadow\-blur\fR to SVG boxes
.TP
\fB\-lb\fR
generate \fB\-\-left\-balanced\fR expressions
.TP
\fB\-mb\fR
generate \fB\-\-mid\-balanced\fR expressions (default)
.TP
\fB\-rb\fR
generate \fB\-\-right\-balanced\fR expressions
.TP
\fB\-lt\fR
generate \fB\-\-less\-temporaries\fR in compiling delays
.HP
\fB\-mcd\fR <n>       \fB\-\-max\-copy\-delay\fR <n> threshold between copy and ring buffer implementation (default 16 samples)
.TP
\fB\-a\fR <file>
C++ architecture file
.HP
\fB\-i\fR             \fB\-\-inline\-architecture\-files\fR
.HP
\fB\-cn\fR <name>     \fB\-\-class\-name\fR <name> specify the name of the dsp class to be used instead of mydsp
.HP
\fB\-t\fR <sec>       \fB\-\-timeout\fR <sec>, abort compilation after <sec> seconds (default 120)
.HP
\fB\-time\fR          \fB\-\-compilation\-time\fR, flag to display compilation phases timing information
.TP
\fB\-o\fR <file>
C++ output file
.HP
\fB\-vec\fR           \fB\-\-vectorize\fR generate easier to vectorize code
.HP
\fB\-vs\fR <n>        \fB\-\-vec\-size\fR <n> size of the vector (default 32 samples)
.HP
\fB\-lv\fR <n>        \fB\-\-loop\-variant\fR [0:fastest (default), 1:simple]
.HP
\fB\-omp\fR           \fB\-\-openMP\fR generate OpenMP pragmas, activates \fB\-\-vectorize\fR option
.HP
\fB\-pl\fR            \fB\-\-par\-loop\fR generate parallel loops in \fB\-\-openMP\fR mode
.HP
\fB\-sch\fR           \fB\-\-scheduler\fR generate tasks and use a Work Stealing scheduler, activates \fB\-\-vectorize\fR option
.HP
\fB\-dfs\fR           \fB\-\-deepFirstScheduling\fR schedule vector loops in deep first order
.HP
\fB\-g\fR             \fB\-\-groupTasks\fR group single\-threaded sequential tasks together when \fB\-omp\fR or \fB\-sch\fR is used
.HP
\fB\-uim\fR           \fB\-\-user\-interface\-macros\fR add user interface macro definitions in the C++ code
.TP
\fB\-single\fR
use \fB\-\-single\-precision\-floats\fR for internal computations (default)
.TP
\fB\-double\fR
use \fB\-\-double\-precision\-floats\fR for internal computations
.TP
\fB\-quad\fR
use \fB\-\-quad\-precision\-floats\fR for internal computations
.TP
\fB\-flist\fR
use \fB\-\-file\-list\fR used to eval process
.HP
\fB\-norm\fR          \fB\-\-normalized\-form\fR prints signals in normalized form and exits
.HP
\fB\-I\fR <dir>       \fB\-\-import\-dir\fR <dir> add the directory <dir> to the import search path
.HP
\fB\-O\fR <dir>       \fB\-\-output\-dir\fR <dir> specify the relative directory of the generated C++ output, and the output directory of additional generated files (SVG, XML...)
.HP
\fB\-e\fR             \fB\-\-export\-dsp\fR export expanded DSP (all included libraries)
.HP
\fB\-inpl\fR          \fB\-\-in\-place\fR generates code working when input and output buffers are the same (in scalar mode only)
.HP
\fB\-inj\fR <f>       \fB\-\-inject\fR source file <f> into architecture file instead of compile a dsp file
.PP
example :
faust \fB\-a\fR jack\-gtk.cpp \fB\-o\fR myfx.cpp myfx.dsp
.SH COPYRIGHT
Copyright \(co 2002\-2016, GRAME \- Centre National de Creation Musicale. All rights reserved.