NAME

atf-test-program - common interface to ATF test programs

SYNOPSIS

atf-test-program [-r fd] [-s srcdir] [-v var1=value1[ .. -v varN=valueN]] [test_case1[ .. test_caseN]] atf-test-program -l test_case1 [test_case1[ .. test_caseN]] atf-test-program -h

DESCRIPTION

Test programs written using the ATF libraries all share a common user interface, which is what this manual page describes.

In the first synopsis form, the test program will execute the listed test cases, or all of them if none are provided as arguments. The test cases' names can be given as glob patterns.

In the second synopsis form, the test program will list all available test cases alongside a brief description of what they do. If any arguments are specified, the list will be restricted to the matching test cases. The test cases' names can be given as glob patterns.

In the third synopsis form, the test program will print information about all supported options and their purpose.

The following options are available:

-h
Shows a short summary of all available options and their purpose.

-l
Lists available test cases alongside a brief description for each of them.

-r fd
Specifies the file descriptor to which the test case will redirect its results. These results follow a machine-parseable standardized format, and are not meant for direct user consumption. See atf-formats(5) for more details.

-s srcdir
The path to the directory where the test program is located. This is needed in all cases, except when the test program is being executed from the current directory. The test program will use this path to locate any helper data files or utilities.

-v var=value
Sets the configuration variable var to the value value.

SEE ALSO

atf-run(1), atf(7)