OS Manuals

/usr/bin/a2x

Text based documentation

From asciidoc 10.2.1-r9 (os), captured 2026-11-05 by running a2x --help (exit 0). permalink

Usage: a2x [OPTIONS] SOURCE_FILE

A toolchain manager for AsciiDoc (converts Asciidoc text files to other file formats)

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -a ATTRIBUTE, --attribute=ATTRIBUTE
                        set asciidoc attribute value
  --asciidoc-opts=ASCIIDOC_OPTS
                        asciidoc options
  --copy                DEPRECATED: does nothing
  --conf-file=CONF_FILE
                        configuration file
  -D PATH, --destination-dir=PATH
                        output directory (defaults to SOURCE_FILE directory)
  -d DOCTYPE, --doctype=DOCTYPE
                        article, manpage, book
  -b BACKEND, --backend=BACKEND
                        name of backend plugin
  --epubcheck           check EPUB output with epubcheck
  -f FORMAT, --format=FORMAT
                        chunked, epub, htmlhelp, manpage, pdf, text, xhtml, dvi, ps, tex, docbook
  --icons               use admonition, callout and navigation icons
  --icons-dir=PATH      admonition and navigation icon directory
  -k, --keep-artifacts  do not delete temporary build files
  --lynx                use lynx to generate text files
  -L, --no-xmllint      do not check asciidoc output with xmllint
  -n, --dry-run         just print the commands that would have been executed
  -r PATH, --resource=PATH
                        resource file or directory containing resource files
  -m FILE, --resource-manifest=FILE
                        read resources from FILE
  --resource-dir=PATH   DEPRECATED: use --resource
  -s, --skip-asciidoc   DEPRECATED: redundant
  --stylesheet=STYLESHEET
                        HTML CSS stylesheet file name
  --safe                DEPRECATED: does nothing
  --dblatex-opts=DBLATEX_OPTS
                        dblatex options
  --backend-opts=BACKEND_OPTS
                        backend plugin options
  --fop                 use FOP to generate PDF files
  --fop-opts=FOP_OPTS   options for FOP pdf generation
  --xsltproc-opts=XSLTPROC_OPTS
                        xsltproc options for XSL stylesheets
  --xsl-file=XSL_FILE   custom XSL stylesheet
  -v, --verbose         increase verbosity
Options (30)
OptionDescriptionSource
--versionshow program's version number and exithelp
-h, --helpshow this help message and exithelp
-a, --attribute ATTRIBUTEset asciidoc attribute valuehelp
--asciidoc-opts ASCIIDOC_OPTSasciidoc optionshelp
--copyDEPRECATED: does nothinghelp
--conf-file CONF_FILEconfiguration filehelp
-D, --destination-dir PATHoutput directory (defaults to SOURCE_FILE directory)help
-d, --doctype DOCTYPEarticle, manpage, bookhelp
-b, --backend BACKENDname of backend pluginhelp
--epubcheckcheck EPUB output with epubcheckhelp
-f, --format FORMATchunked, epub, htmlhelp, manpage, pdf, text, xhtml, dvi, ps, tex, docbookhelp
--iconsuse admonition, callout and navigation iconshelp
--icons-dir PATHadmonition and navigation icon directoryhelp
-k, --keep-artifactsdo not delete temporary build fileshelp
--lynxuse lynx to generate text fileshelp
-L, --no-xmllintdo not check asciidoc output with xmllinthelp
-n, --dry-runjust print the commands that would have been executedhelp
-r, --resource PATHresource file or directory containing resource fileshelp
-m, --resource-manifest FILEread resources from FILEhelp
--resource-dir PATHDEPRECATED: use --resourcehelp
-s, --skip-asciidocDEPRECATED: redundanthelp
--stylesheet STYLESHEETHTML CSS stylesheet file namehelp
--safeDEPRECATED: does nothinghelp
--dblatex-opts DBLATEX_OPTSdblatex optionshelp
--backend-opts BACKEND_OPTSbackend plugin optionshelp
--fopuse FOP to generate PDF fileshelp
--fop-opts FOP_OPTSoptions for FOP pdf generationhelp
--xsltproc-opts XSLTPROC_OPTSxsltproc options for XSL stylesheetshelp
--xsl-file XSL_FILEcustom XSL stylesheethelp
-v, --verboseincrease verbosityhelp

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