Asciidoctor User Manual

Base directory containing the document and resources. Defaults to the directory containing the source file, or the working directory if the source is read from a stream. When combined with the safe mode setting, can be used to chroot the execution of the program.

Set safe mode level: unsafe, safe, server or secure. Disables potentially dangerous macros in source files, such as include::[]. If not set, the safe mode level defaults to unsafe when Asciidoctor is invoked using this script.

Set safe mode level to safe. Enables include directives, but prevents access to ancestor paths of source file. Provided for compatibility with the asciidoc command. If not set, the safe mode level defaults to unsafe when Asciidoctor is invoked using this script.

Define, override or delete a document attribute. Command-line attributes take precedence over attributes defined in the source file unless the value ends with @.

Backend output file format: html5, docbook5, docbook45 and manpage are supported out of the box. You can also use the backend alias names html (aliased to html5) or docbook (aliased to docbook5). Other values can be passed, but if Asciidoctor cannot resolve the backend to a converter, it will fail. Defaults to html5.

Document type: article, book, manpage or inline. Sets the root element when using the docbook backend and the style class on the HTML body element when using the html backend. The book document type allows multiple level-0 section titles in a single document. The manpage document type enables parsing of metadata necessary to produce a man page. The inline document type allows the content of a single paragraph to be formatted and returned without wrapping it in a containing element. Defaults to article.

Destination output directory. Defaults to the directory containing the source file, or the working directory if the source is read from a stream. If specified, the directory is resolved relative to the working directory.

Template engine to use for the custom converter templates. The gem with the same name as the engine will be loaded automatically. This name is also used to build the full path to the custom converter templates. If a template engine is not specified, it will be auto-detected based on the file extension of the custom converter templates found.

Specifies the eRuby implementation to use for executing the custom converter templates written in ERB. Supported values are erb and erubis. Defaults to erb.

Add the specified directory to the load path, so that -r can load extensions from outside the default Ruby load path. This option may be specified more than once.

Auto-number section titles. Synonym for --attribute sectnums.

Write output to file OUT_FILE. Defaults to the base name of the input file suffixed with backend extension. The file is resolved relative to the working directory. If the input is read from standard input or a named pipe (fifo), then the output file defaults to stdout. If OUT_FILE is -, then the output file is written to standard output.

Source directory. Currently only used if the destination directory is also specified. Used to preserve the directory structure of files converted within this directory in the destination directory. If specified, the directory is resolved relative to the working directory.

Require the specified library before executing the processor, using the standard Ruby require. This option may be specified more than once.

Output an embeddable document, which excludes the header, the footer, and everything outside the body of the document. This option is useful for producing documents that can be inserted into an external template.

A directory containing custom converter templates that override one or more templates from the built-in set. (requires tilt gem)

The minimum logging level that triggers a non-zero exit code (failure). If this option is not set (default: FATAL), the program exits with a status code zero even if warnings or errors have been logged.

Silence warnings.

Include backtrace information on errors. Not enabled by default.

Verbosely print processing information and configuration file checks to stderr.

Display timings information (time to read, parse and convert).

Print the help message. Show the command usage if TOPIC is not specified (or not recognized). Dump the Asciidoctor man page (in troff/groff format) if TOPIC is manpage.

Print program version number.