OS Manuals

/usr/bin/btest

The BTest test framework

From zeek-btest 9.0.1-r1 (enterprise-packages), captured 2026-11-08 by running btest --help (exit 0). permalink

Also provided by 1 other package version
Usage: btest [options] <directories>

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -U, --update-baseline
                        create a new baseline from the tests' output
  -u, --update-interactive
                        interactively asks whether to update baseline for a failed test
  -d, --diagnostics     show diagnostic output for failed tests
  -D, --diagnostics-all
                        show diagnostic output for ALL tests
  -f DIAGFILE, --file-diagnostics=DIAGFILE
                        write diagnostic output for failed tests into file; if file exists, it is
                        overwritten
  -v, --verbose         show commands as they are executed
  -w, --wait            wait for <enter> after each failed (with -d) or all (with -D) tests
  -b, --brief           outputs only failed tests
  -c CONFIG, --config=CONFIG
                        configuration file
  -t, --tmp-keep        do not delete tmp files created for running tests
  -j, --jobs            number of threads running tests in parallel; with no argument will use all
                        CPUs
  -g GROUPS, --groups=GROUPS
                        execute only tests of given comma-separated list of groups
  -r, --rerun           execute commands for tests that failed last time
  -q, --quiet           suppress information output other than about failed tests
  -x XMLFILE, --xml=XMLFILE
                        write a report of test results in JUnit XML format to file; if file
                        exists, it is overwritten
  -a ALTERNATIVES, --alternative=ALTERNATIVES
                        activate given alternative
  -S, --sphinx          indicates that we're running from inside Sphinx; for internal purposes
  -T, --update-times    create a new timing baseline for tests being measured
  -R format, --documentation=format
                        Output documentation for tests, supported formats: rst, md
  -A, --show-all        For console output, show one-liners for passing/skipped tests in addition
                        to any failing ones
  -z RETRIES, --retries=RETRIES
                        Retry failed tests this many times to determine if they are unstable
  --trace-file=TRACEFILE
                        write Chrome tracing file to file; if file exists, it is overwritten
  -F, --abort-on-failure
                        terminate after first test failure
  -l, --list            list available tests instead of executing them
  -s DEFAULTS, --set=DEFAULTS
                        Override default key used in btest.cfg with another value. Can be
                        specified multiple times.
  -i TESTS_FILE, --tests-file=TESTS_FILE
                        Load list of tests to execute from file.
  -P, --progress-bar    display progress bar using OSC 9;4 escape sequences (set
                        BTEST_OSC94_PROGRESS to permanently enable)
Options (29)
OptionDescriptionSource
--versionshow program's version number and exithelp
-h, --helpshow this help message and exithelp
-U, --update-baselinecreate a new baseline from the tests' outputhelp
-u, --update-interactiveinteractively asks whether to update baseline for a failed testhelp
-d, --diagnosticsshow diagnostic output for failed testshelp
-D, --diagnostics-allshow diagnostic output for ALL testshelp
-f, --file-diagnostics DIAGFILEwrite diagnostic output for failed tests into file;help
-v, --verboseshow commands as they are executedhelp
-w, --waitwait for <enter> after each failed (with -d) or all (with -D) testshelp
-b, --briefoutputs only failed testshelp
-c, --config CONFIGconfiguration filehelp
-t, --tmp-keepdo not delete tmp files created for running testshelp
-j, --jobsnumber of threads running tests in parallel;help
-g, --groups GROUPSexecute only tests of given comma-separated list of groupshelp
-r, --rerunexecute commands for tests that failed last timehelp
-q, --quietsuppress information output other than about failed testshelp
-x, --xml XMLFILEwrite a report of test results in JUnit XML format to file;help
-a, --alternative ALTERNATIVESactivate given alternativehelp
-S, --sphinxindicates that we're running from inside Sphinx;help
-T, --update-timescreate a new timing baseline for tests being measuredhelp
-R, --documentation formatOutput documentation for tests, supported formats: rst, mdhelp
-A, --show-allFor console output, show one-liners for passing/skipped tests in addition to any failing oneshelp
-z, --retries RETRIESRetry failed tests this many times to determine if they are unstablehelp
--trace-file TRACEFILEwrite Chrome tracing file to file;help
-F, --abort-on-failureterminate after first test failurehelp
-l, --listlist available tests instead of executing themhelp
-s, --set DEFAULTSOverride default key used in btest.cfg with another value.help
-i, --tests-file TESTS_FILELoad list of tests to execute from file.help
-P, --progress-bardisplay progress bar using OSC 9;4 escape sequences (set BTEST_OSC94_PROGRESS to permanently enable)help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.