1ASCIIDOCTOR(1) Asciidoctor Manual ASCIIDOCTOR(1)
2
6 asciidoctor - converts AsciiDoc source files to HTML, DocBook, and
7 other formats
8
10 asciidoctor [OPTION]... FILE...
11
13 The asciidoctor(1) command converts the AsciiDoc source file(s) FILE to
14 HTML5, DocBook 5, man(ual) page, and other custom output formats.
15 If FILE is - then the AsciiDoc source is read from standard input.
17
19 Security Settings
20 -B, --base-dir=DIR
21 Base directory containing the document and resources. Defaults to
22 the directory containing the source file or, if the source is read
23 from a stream, the working directory. When combined with the safe
24 mode setting, can be used to chroot the execution of the program.
25 -S, --safe-mode=SAFE_MODE
27 Set safe mode level: unsafe, safe, server, or secure. Disables
28 potentially dangerous macros in source files, such as include::[].
29 If not set, the safe mode level defaults to unsafe when Asciidoctor
30 is invoked using this script.
31 --safe
33 Set safe mode level to safe. Enables include directives, but
34 prevents access to ancestor paths of source file. Provided for
35 compatibility with the asciidoc command. If not set, the safe mode
36 level defaults to unsafe when Asciidoctor is invoked using this
37 script.
38 Document Settings
40 -a, --attribute=ATTRIBUTE
41 Define, override, or unset a document attribute. Command-line
42 attributes take precedence over attributes defined in the source
43 file unless either the name or value ends in @.
44 ATTRIBUTE is normally formatted as a key-value pair, in the form
46 NAME=VALUE. Alternate forms are NAME (where the VALUE defaults to
47 an empty string), NAME! (unsets the NAME attribute), and
48 NAME=VALUE@ (or NAME@=VALUE) (where VALUE does not override the
49 NAME attribute if it’s already defined in the source document).
50 Values containing spaces should be enclosed in quotes.
51 This option may be specified more than once.
53 -b, --backend=BACKEND
55 Backend output file format: html5, docbook5, and manpage are
56 supported out of the box. You can also use the backend alias names
57 html (aliased to html5) or docbook (aliased to docbook5). Other
58 values can be passed, but if Asciidoctor cannot resolve the backend
59 to a converter, it will fail. Defaults to html5.
60 -d, --doctype=DOCTYPE
62 Document type: article, book, manpage, or inline. Sets the root
63 element when using the docbook backend and the style class on the
64 HTML body element when using the html backend. The book document
65 type allows multiple level-0 section titles in a single document.
66 The manpage document type enables parsing of metadata necessary to
67 produce a man page. The inline document type allows the content of
68 a single paragraph to be formatted and returned without wrapping it
69 in a containing element. Defaults to article.
70 Document Conversion
72 -D, --destination-dir=DIR
73 Destination output directory. Defaults to the directory containing
74 the source file or, if the source is read from a stream, the
75 working directory. If specified, the directory is resolved relative
76 to the working directory.
77 -E, --template-engine=NAME
79 Template engine to use for the custom converter templates. The gem
80 with the same name as the engine will be loaded automatically. This
81 name is also used to build the full path to the custom converter
82 templates. If a template engine is not specified, it will be
83 auto-detected based on the file extension of the custom converter
84 templates found.
85 -e, --eruby
87 Specifies the eRuby implementation to use for executing the custom
88 converter templates written in ERB. Supported values are erb and
89 erubis. Defaults to erb.
90 -I, --load-path=DIRECTORY
92 Add the specified directory to the load path, so that -r can load
93 extensions from outside the default Ruby load path. This option may
94 be specified more than once.
95 -n, --section-numbers
97 Auto-number section titles. Synonym for --attribute sectnums.
98 -o, --out-file=OUT_FILE
100 Write output to file OUT_FILE. Defaults to the base name of the
101 input file suffixed with backend extension. The file is resolved
102 relative to the working directory. If the input is read from
103 standard input or a named pipe (fifo), then the output file
104 defaults to stdout. If OUT_FILE is -, then the output file is
105 written to standard output.
106 -R, --source-dir=DIR
108 Source directory. Currently only used if the destination directory
109 is also specified. Used to preserve the directory structure of
110 files converted within this directory in the destination directory.
111 If specified, the directory is resolved relative to the working
112 directory.
113 -r, --require=LIBRARY
115 Require the specified library before executing the processor, using
116 the standard Ruby require. This option may be specified more than
117 once.
118 -s, --no-header-footer
120 Output an embeddable document, which excludes the header, the
121 footer, and everything outside the body of the document. This
122 option is useful for producing documents that can be inserted into
123 an external template.
124 -T, --template-dir=DIR
126 A directory containing custom converter templates that override one
127 or more templates from the built-in set. (requires tilt gem)
128 If there is a subfolder that matches the engine name (if
130 specified), that folder is appended to the template directory path.
131 Similarly, if there is a subfolder in the resulting template
132 directory that matches the name of the backend, that folder is
133 appended to the template directory path.
134 This option may be specified more than once. Matching templates
136 found in subsequent directories override ones previously
137 discovered.
138 Processing Information
140 --failure-level=LEVEL
141 The minimum logging level that triggers a non-zero exit code
142 (failure). If this option is not set (default: FATAL), the program
143 exits with exit code zero even if warnings or errors have been
144 logged.
145 -q, --quiet
147 Silence application log messages and script warnings.
148 --trace
150 Include backtrace information when reporting errors.
151 -v, --verbose
153 Sets log level to DEBUG so application messages logged at INFO or
154 DEBUG level are printed to stderr.
155 -w, --warnings
157 Turn on script warnings (applies to executed code).
158 -t, --timings
160 Print timings report to stderr (time to read, parse, and convert).
161 Program Information
163 -h, --help [TOPIC]
164 Print a help message. Show the command usage if TOPIC is not
165 specified or recognized. Dump the Asciidoctor man page (in
166 troff/groff format) if TOPIC is manpage.
167 -V, --version
169 Print program version number.
170 -v can also be used if no source files are specified.
172
174 Asciidoctor honors the SOURCE_DATE_EPOCH environment variable. If this
175 variable is assigned an integer value, that value is used as the epoch
176 of all input documents and as the local date and time. See
177 https://reproducible-builds.org/specs/source-date-epoch/ for more
178 information about this environment variable.
179
181 0
182 Success.
183 1
185 Failure (syntax or usage error; configuration error; document
186 processing failure; unexpected error).
187
189 Refer to the Asciidoctor issue tracker at
190 https://github.com/asciidoctor/asciidoctor/issues?q=is%3Aopen.
191
193 Asciidoctor was written by Dan Allen, Ryan Waldron, Jason Porter, Nick
194 Hengeveld, and other contributors.
195 AsciiDoc was written by Stuart Rackham and has received contributions
197 from many other individuals.
198
200 Project web site: https://asciidoctor.org
201 Git source repository on GitHub:
203 https://github.com/asciidoctor/asciidoctor
204 GitHub organization: https://github.com/asciidoctor
206 Discussion list / forum: http://discuss.asciidoctor.org
208
210 Copyright (C) 2012-2021 Dan Allen, Ryan Waldron, and the Asciidoctor
211 Project. Free use of this software is granted under the terms of the
212 MIT License.
213
215 Dan Allen
216 Sarah White
218 Ryan Waldron
220Asciidoctor 2.0.15 2021-04-27 ASCIIDOCTOR(1)