1TESTASCIIDOC(1)                                                TESTASCIIDOC(1)
2
3
4

NAME

6       testasciidoc - Run AsciiDoc conformance tests specified in
7       configuration file.
8

SYNOPSIS

10       testasciidoc [OPTIONS] COMMAND
11

DESCRIPTION

13       The testasciidoc command runs AsciiDoc conformance tests specified in
14       configuration file.
15

COMMANDS

17       The testasciidoc toolset has three different commands:
18
19           testasciidoc list
20           testasciidoc run [-n, --number NUMBER] [-b, --backend BACKEND] [OPTIONS]
21           testasciidoc update [-n, --number NUMBER] [-b, --backend BACKEND] [OPTIONS]
22
23       The commands perform as follows:
24
25       list
26           List available tests cases.
27
28       run
29           Execute tests (regenerate temporary test cases and compare them to
30           the reference files).
31
32       update
33           Regenerate and update test data reference files. Needs to be
34           launched at least once to have the reference files to compare to
35           during the tests.
36
37       Where:
38
39       NUMBER
40           Is the index number of the test case from the testasciidoc list
41           command.
42
43       BACKEND
44           Is the asciidoc backend to use.
45
46       OPTIONS
47           Are the options listed below.
48

OPTIONS

50       -f, --conf-file=CONF_FILE
51           Use configuration file CONF_FILE for more information about the
52           configuration file format refer to the tests documentation.
53
54       --force
55           Update all test data overwriting existing data
56

EXAMPLES

58       testasciidoc list
59           Lists all the test actions available for running or updating.
60
61       testasciidoc run
62           Runs all the testing actions available.
63
64       testasciidoc run --number 1 --backend html5
65       --conf-file=/etc/asciidoc/testasciidoc.conf
66           Run the test case 1 for the html5 asciidoc backend using the
67           configuration file /etc/asciidoc/testasciidoc.conf.
68
69       testasciidoc update --number 1 --backend html5
70           Generate or update the reference files used for the tests cases 1st
71           action of the html5 asciidoc backend.
72

EXIT STATUS

74       0
75           Success
76
77       1
78           Failure (syntax or usage error; configuration error; document
79           processing failure; unexpected error).
80

BUGS

82       See the AsciiDoc distribution BUGS file.
83

AUTHOR

85       AsciiDoc was originally written by Stuart Rackham. Many people have
86       contributed to it.
87

RESOURCES

89       GitHub: https://github.com/asciidoc/asciidoc-py3
90
91       Main web site: https://asciidoc.org/
92

SEE ALSO

94       asciidoc(1), a2x(1)
95
96
97
98                                  07/27/2023                   TESTASCIIDOC(1)