Boost.Test > Components > The Unit Test Framework > Parameters
Boost Test logo

The Unit Test Framework parameters

The Unit Test Framework supports two ways to configure test program execution at runtime: using command line arguments and setting environment variables. Command line argument always prevails the environment variable value.

A parameter's specification includes: the full parameter name, corresponding environment variable name, command line argument name, acceptable values and long description. The default value for the parameter is bolded in a list of parameters. All values are case sensitive and are required to exactly match the parameter specification.

The Unit Test Framework parses command line and exclude all framework parameters and their values from the arguments list forwarded to the user's function init_unit_test_suite. The command line arguments format expected by the framework is: --<parameter name>=<parameter_value>. The parameter name is case sensitive. The parameter name is required to exactly match the name in parameter specification. The should not be any spaces between '=' and both parameter name and parameter value.

The environment variable name is case sensitive and is required to exactly match the name in parameter specification.

Here is the list of all parameters: