# API Sanity Checker Options

## Information Options

- -h|-help

Print this help.

- -info

Print complete information.

- -v|-version

Print version.

- -dumpversion

Print the tool version and don't do anything else.

## General Options

- -l|-lib|-library NAME

Library name (without version).

- -d|-descriptor PATH

Path to the library descriptor.

- -gen|-generate

Generate test(s). Options -l and -d should be specified. To generate test for the particular function use it with -f option.

- -build|-make

Build test(s). Options -l and -d should be specified. To build test for the particular function use it with -f option.

- -run

Run test(s), create test report. Options -l and -d should be specified. To run test for the particular function use it with -f option.

- -clean

Clean test(s). Options -l and -d should be specified. To clean test for the particular function use it with -f option.

## Extra Options

- -d-tmpl|-descriptor-template

Create library descriptor template ./VERSION.xml

- -s-tmpl|-specialized-type-template

Create specialized type template ./SPECTYPES.xml

- -vnum NUM

Specify library version outside the descriptor.

- -s|-symbol NAME

Generate/Build/Run test for specified interface (mangled name in C++).

- -symbols-list PATH

This option allow to specify a file with a list of functions (one per line, mangled names in C++) that should be tested, other library interfaces will not be tested.

- -header NAME

This option allows to restrict a list of functions that should be tested by providing a header file name in which they are declared. This option was introduced for step-by-step tests development.

- -xvfb

Use Xvfb-server instead of current X-server (default) for running tests.

- -t2c|-template2code

Generate tests in the universal Template2Code format.

- -strict-gen

Terminate the process of generating tests if cannot generate at least one test case.

- -strict-build

Terminate the process of building tests if cannot build at least one test case.

- -strict-run

Terminate the process of running tests if at least one test case is failed.

- -strict

This option enables all -strict-* options.

- -r|-random

Random tests generating mode.

- -min

Generate minimun code (as far as possible).

- -max

Generate maximum code (as far as possible).

- -show-retval

Show the function return type in the report.

- -check-retval

Insert requirements on return values (retval!=NULL) for each called interface.

- -st|-specialized-types PATH

Path to the collection of specialized types.

- -td|-test-data PATH

Path to the directory with test data.

- -headers-only

If the library consists of inline functions only and has no shared objects then you should specify this option.

- -no-inline

Don't generate tests for inline functions.

- -keep-internal

Generate tests for internal symbols (functions with '__' prefix and methods of classes declared inside other classes).

- -isolated

Allow to restrict functions usage by the lists specified by the -functions-list option
or by the group devision in the descriptor.

- -view-only

Remove all files from the test suite except *.html files. This option allows to create a lightweight html-index for all tests in the test suite.

- -disable-default-values

Disable usage of default values for function parameters.

- -optimize-includes LEVEL

Enable optimization of the list of included headers in each test case. Available levels: High (default), Medium, Low, None - disable.

- -p|-params PATH

Path to file with the function parameter names. It can be used for improving generated tests if the library header files don't contain parameter names. File format:
func1;param1;param2;param3 ...
func2;param1;param2;param3 ...
...

- -l-full|-lib-full NAME

Library name in the report title.

- -relpath|-reldir PATH

Replace {RELPATH} in the library descriptor by PATH.

- -lang LANG

Set library language (C or C++). You can use this option if the tool cannot auto-detect a language.

- -target COMPILER

The compiler that should be used to build generated tests under Windows: gcc - GNU compiler, cl - MS compiler (default).

- -debug

Write extended log for debugging.

- -cache

Cache the ABI dump and use it on the next run.

## Other Options

- -test

Run internal tests. Create a simple library and run the tool on it. This option allows to check if the tool works correctly on the system.

- -disable-variable-reuse

Disable reusing of previously created variables.

- -long-variable-names

Enable long (complex) variable names instead of short names (default).

- -b|-browse PROGRAM

Open report(s) in the browser (firefox, opera, etc.).

- -open

Open report(s) in the default browser.