option

option_enum(VARIABLE DESCRIPTION ENUM_VALUES DEFAULT **kwargs)

Create a CMake integer option that can be modified through CLI. Option defined this way will be visible in cmake-gui interface as well as SoCMake help_options() help menu. To override the variable use cmake -D<VARIABLE>=<VALUE>

Parameters

Name	Type	Description
VARIABLE	string	name of the variable.
DESCRIPTION	string	short description string for the variable
ENUM_VALUES	list[string]	possible values variable can have
DEFAULT	integer	default value of the variable
ADVANCED	boolean	optional, mark options as advanced, it will not show in help menu

---

option_string(VARIABLE DESCRIPTION DEFAULT **kwargs)

Create a CMake string option that can be modified through CLI. Option defined this way will be visible in cmake-gui interface as well as SoCMake help_options() help menu. To override the variable use cmake -D<VARIABLE>=<VALUE>

Parameters

Name	Type	Description
VARIABLE	string	name of the variable.
DESCRIPTION	string	short description string for the variable
DEFAULT	string	default value of the variable
ADVANCED	bool	optional, mark options as advanced, it will not show in help menu

---

option_file(VARIABLE DESCRIPTION DEFAULT **kwargs)

Create a CMake file path option that can be modified through CLI. Option defined this way will be visible in cmake-gui interface as well as SoCMake help_options() help menu. To override the variable use cmake -D<VARIABLE>=<VALUE>

Parameters

Name	Type	Description
VARIABLE	string	name of the variable.
DESCRIPTION	string	short description string for the variable
DEFAULT	string	default value of the variable
ADVANCED	bool	optional, mark options as advanced, it will not show in help menu
CHECK_EXISTS	bool	optional, check if the file path exists at the time of configuring the project, default FALSE

---

option_directory(VARIABLE DESCRIPTION DEFAULT **kwargs)

Create a CMake directory path option that can be modified through CLI. Option defined this way will be visible in cmake-gui interface as well as SoCMake help_options() help menu. To override the variable use cmake -D<VARIABLE>=<VALUE>

Parameters

Name	Type	Description
VARIABLE	string	name of the variable.
DESCRIPTION	string	short description string for the variable
DEFAULT	string	default value of the variable
ADVANCED	bool	optional, mark options as advanced, it will not show in help menu
CHECK_EXISTS	bool	optional, check if the directory path exists at the time of configuring the project, default FALSE

---

option_integer(VARIABLE DESCRIPTION DEFAULT **kwargs)

Create a CMake integer option that can be modified through CLI. Option defined this way will be visible in cmake-gui interface as well as SoCMake help_options() help menu. To override the variable use cmake -D<VARIABLE>=<VALUE>

Parameters

Name	Type	Description
VARIABLE	string	name of the variable.
DESCRIPTION	string	short description string for the variable
DEFAULT	integer	default value of the variable
ADVANCED	boolean	optional, mark options as advanced, it will not show in help menu

---

option_boolean(VARIABLE DESCRIPTION DEFAULT **kwargs)

Create a CMake boolean option that can be modified through CLI. Option defined this way will be visible in cmake-gui interface as well as SoCMake help_options() help menu. To override the variable use cmake -D<VARIABLE>=<VALUE>

Parameters

Name	Type	Description
VARIABLE	string	name of the variable.
DESCRIPTION	string	short description string for the variable
DEFAULT	boolean	default value of the variable
ADVANCED	boolean	optional, mark options as advanced, it will not show in help menu