Skip to content

variables

Stéphane Letz edited this page Sep 28, 2024 · 9 revisions

Variables reference

This section describes all the variables that control the build process. All these variables are defined for cmake but not all of them are exposed by the Makefile.

Variables that control the project generation

Variables defined at Makefile level only

Name default comment
FAUSTDIR faustdir the project folder name
IOSDIR iosdir the project folder name used by the ioslib target only
CMAKEOPT -DCMAKE_BUILD_TYPE=Release the project build types
see CMAKE_BUILD_TYPE in cmake documentation
GENERATOR "Unix Makefiles" on Unix like systems
"MSYS Makefiles" on Windows
BACKENDS backends.cmake defines the embedded backends

Variables defined at cmake level only

Name default comment
UNIVERSAL off MacOSX only: control universal binaries generation
CMAKE_VERBOSE_MAKEFILE off Makefiles only: control make verbosity
INCLUDE_STATIC off Include libfaust static library
INCLUDE_DYNAMIC off Include libfaust dynamic library
INCLUDE_OSC on Include Faust OSC static library
INCLUDE_HTTP on Include Faust HTTPD library
OSCDYNAMIC off Include Faust OSC dynamic library
HTTPDYNAMIC off Include Faust HTTPD dynamic library
USE_LLVM_CONFIG on makes use of llvm-config to scan LLVM settings
when off, cmake try to use llvm-config.cmake (if any)
LLVM_CONFIG llvm-config to use an alternate llvm-config name or path
LINK_LLVM_STATIC on to link statically/dynamically with LLVM
LIBMICROHTTPD_CFLAGS off to be used for manuel libmicrohttpd C flags settings
LIBMICROHTTPD_LDFLAGS off to be used for manuel libmicrohttpd link flags settings
note that both variables must be in use to take effect

These variables are to be passed to cmake using a -DVARNAME=val option

Variables that control the project compilation

Name default comment
BUILDOPT --config Release compiles in release mode
depends on CMAKE_BUILD_TYPE (see CMAKEOPT above)
JOBS -j 4 when using make
-jobs 4 with Xcode projects
/maxcpucount:4 with MSVC projects

Variables that control the project installation

Name default comment
DESTDIR the install destination directory
PREFIX /usr/local the install destination prefix on Unix
C:\Program Files the install destination prefix on Windows
note that the PREFIX variable is translated to CMAKE_INSTALL_PREFIX at cmake level