testasciidoc - Run AsciiDoc conformance tests specified in configuration file.
testasciidoc [OPTIONS] COMMAND
TESTASCIIDOC(1) TESTASCIIDOC(1)
NAME
testasciidoc - Run AsciiDoc conformance tests specified in
configuration file.
SYNOPSIS
testasciidoc [OPTIONS] COMMAND
DESCRIPTION
The testasciidoc command runs AsciiDoc conformance tests specified in
configuration file.
COMMANDS
The testasciidoc toolset has three different commands:
testasciidoc list
testasciidoc run [-n, --number NUMBER] [-b, --backend BACKEND] [OPTIONS]
testasciidoc update [-n, --number NUMBER] [-b, --backend BACKEND] [OPTIONS]
The commands perform as follows:
list
List available tests cases.
run
Execute tests (regenerate temporary test cases and compare them to
the reference files).
update
Regenerate and update test data reference files. Needs to be
launched at least once to have the reference files to compare to
during the tests.
Where:
NUMBER
Is the index number of the test case from the testasciidoc list
command.
BACKEND
Is the asciidoc backend to use.
OPTIONS
Are the options listed below.
OPTIONS
-f, --conf-file=CONF_FILE
Use configuration file CONF_FILE for more information about the
configuration file format refer to the tests documentation.
--force
Update all test data overwriting existing data
EXAMPLES
testasciidoc list
Lists all the test actions available for running or updating.
testasciidoc run
Runs all the testing actions available.
testasciidoc run --number 1 --backend html5
--conf-file=/etc/asciidoc/testasciidoc.conf
Run the test case 1 for the html5 asciidoc backend using the
configuration file /etc/asciidoc/testasciidoc.conf.
testasciidoc update --number 1 --backend html5
Generate or update the reference files used for the tests cases 1st
action of the html5 asciidoc backend.
EXIT STATUS
0
Success
1
Failure (syntax or usage error; configuration error; document
processing failure; unexpected error).
BUGS
See the AsciiDoc distribution BUGS file.
AUTHOR
AsciiDoc was originally written by Stuart Rackham. Many people have
contributed to it.
RESOURCES
GitHub: https://github.com/asciidoc/asciidoc-py3
Main web site: https://asciidoc.org/
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+---------------------------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+---------------------------------------+
|Availability | developer/documentation-tool/asciidoc |
+---------------+---------------------------------------+
|Stability | Uncommitted |
+---------------+---------------------------------------+
SEE ALSO
asciidoc(1), a2x(1)
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://github.com/asciidoc/asciidoc-
py3/releases/download/9.0.2/asciidoc-9.0.2.tar.gz.
Further information about this software can be found on the open source
community website at https://asciidoc.org/.
06/27/2022 TESTASCIIDOC(1)