asciidoctor 1.5.8 → 2.0.17

data/man/asciidoctor.1

@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: asciidoctor
-.\"    Author: Dan Allen, Sarah White, Ryan Waldron
-.\" Generator: Asciidoctor 1.5.8
-.\"      Date: 2018-10-28
+.\"    Author: Dan Allen, Sarah White
+.\" Generator: Asciidoctor 2.0.17
+.\"      Date: 2022-01-05
 .\"    Manual: Asciidoctor Manual
-.\"    Source: Asciidoctor 1.5.8
+.\"    Source: Asciidoctor 2.0.17
 .\"  Language: English
 .\"
-.TH "ASCIIDOCTOR" "1" "2018-10-28" "Asciidoctor 1.5.8" "Asciidoctor Manual"
+.TH "ASCIIDOCTOR" "1" "2022-01-05" "Asciidoctor 2.0.17" "Asciidoctor Manual"
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .ss \n[.ss] 0
@@ -28,13 +28,13 @@
 .  LINKSTYLE blue R < >
 .\}
 .SH "NAME"
-asciidoctor \- converts AsciiDoc source files to HTML, DocBook and other formats
+asciidoctor \- converts AsciiDoc source files to HTML, DocBook, and other formats
 .SH "SYNOPSIS"
 .sp
 \fBasciidoctor\fP [\fIOPTION\fP]... \fIFILE\fP...
 .SH "DESCRIPTION"
 .sp
-The asciidoctor(1) command converts the AsciiDoc source file(s) \fIFILE\fP to HTML5, DocBook 5, DocBook 4.5, man(ual) page and other custom output formats.
+The asciidoctor(1) command converts the AsciiDoc source file(s) \fIFILE\fP to HTML5, DocBook 5, man(ual) page, and other custom output formats.
 .sp
 If \fIFILE\fP is \fI\-\fP then the AsciiDoc source is read from standard input.
 .SH "OPTIONS"
@@ -43,13 +43,13 @@ If \fIFILE\fP is \fI\-\fP then the AsciiDoc source is read from standard input.
 \fB\-B, \-\-base\-dir\fP=\fIDIR\fP
 .RS 4
 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.
+Defaults to the directory containing the source file or, if the source is read from a stream, the working directory.
 When combined with the safe mode setting, can be used to chroot the execution of the program.
 .RE
 .sp
 \fB\-S, \-\-safe\-mode\fP=\fISAFE_MODE\fP
 .RS 4
-Set safe mode level: \fIunsafe\fP, \fIsafe\fP, \fIserver\fP or \fIsecure\fP.
+Set safe mode level: \fIunsafe\fP, \fIsafe\fP, \fIserver\fP, or \fIsecure\fP.
 Disables potentially dangerous macros in source files, such as \f(CRinclude::[]\fP.
 If not set, the safe mode level defaults to \fIunsafe\fP when Asciidoctor is invoked using this script.
 .RE
@@ -65,11 +65,11 @@ If not set, the safe mode level defaults to \fIunsafe\fP when Asciidoctor is inv
 .sp
 \fB\-a, \-\-attribute\fP=\fIATTRIBUTE\fP
 .RS 4
-Define, override or delete a document attribute.
-Command\-line attributes take precedence over attributes defined in the source file unless the value ends with \fI@\fP.
+Define, override, or unset a document attribute.
+Command\-line attributes take precedence over attributes defined in the source file unless either the name or value ends in \fI@\fP.
 .sp
 \fIATTRIBUTE\fP is normally formatted as a key\-value pair, in the form \fINAME=VALUE\fP.
-Alternate acceptable forms are \fINAME\fP (where the \fIVALUE\fP defaults to an empty string), \fINAME!\fP (unassigns the \fINAME\fP attribute) and \fINAME=VALUE@\fP (where \fIVALUE\fP does not override value of \fINAME\fP attribute if it\(cqs already defined in the source document).
+Alternate forms are \fINAME\fP (where the \fIVALUE\fP defaults to an empty string), \fINAME!\fP (unsets the \fINAME\fP attribute), and \fINAME=VALUE@\fP (or \fINAME@=VALUE\fP) (where \fIVALUE\fP does not override the \fINAME\fP attribute if it\(cqs already defined in the source document).
 Values containing spaces should be enclosed in quotes.
 .sp
 This option may be specified more than once.
@@ -77,7 +77,7 @@ This option may be specified more than once.
 .sp
 \fB\-b, \-\-backend\fP=\fIBACKEND\fP
 .RS 4
-Backend output file format: \fIhtml5\fP, \fIdocbook5\fP, \fIdocbook45\fP and \fImanpage\fP are supported out of the box.
+Backend output file format: \fIhtml5\fP, \fIdocbook5\fP, and \fImanpage\fP are supported out of the box.
 You can also use the backend alias names \fIhtml\fP (aliased to \fIhtml5\fP) or \fIdocbook\fP (aliased to \fIdocbook5\fP).
 Other values can be passed, but if Asciidoctor cannot resolve the backend to a converter, it will fail.
 Defaults to \fIhtml5\fP.
@@ -85,7 +85,7 @@ Defaults to \fIhtml5\fP.
 .sp
 \fB\-d, \-\-doctype\fP=\fIDOCTYPE\fP
 .RS 4
-Document type: \fIarticle\fP, \fIbook\fP, \fImanpage\fP or \fIinline\fP.
+Document type: \fIarticle\fP, \fIbook\fP, \fImanpage\fP, or \fIinline\fP.
 Sets the root element when using the \fIdocbook\fP backend and the style class on the HTML body element when using the \fIhtml\fP backend.
 The \fIbook\fP document type allows multiple level\-0 section titles in a single document.
 The \fImanpage\fP document type enables parsing of metadata necessary to produce a man page.
@@ -97,7 +97,7 @@ Defaults to \fIarticle\fP.
 \fB\-D, \-\-destination\-dir\fP=\fIDIR\fP
 .RS 4
 Destination output directory.
-Defaults to the directory containing the source file, or the working directory if the source is read from a stream.
+Defaults to the directory containing the source file or, if the source is read from a stream, the working directory.
 If specified, the directory is resolved relative to the working directory.
 .RE
 .sp
@@ -109,11 +109,10 @@ 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.
 .RE
 .sp
-\fB\-e, \-\-eruby\fP
+\fB\-e, \-\-embedded\fP
 .RS 4
-Specifies the eRuby implementation to use for executing the custom converter templates written in ERB.
-Supported values are \fIerb\fP and \fIerubis\fP.
-Defaults to \fIerb\fP.
+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.
 .RE
 .sp
 \fB\-I, \-\-load\-path\fP=\fIDIRECTORY\fP
@@ -172,51 +171,56 @@ Matching templates found in subsequent directories override ones previously disc
 .sp
 \fB\-\-failure\-level\fP=\fILEVEL\fP
 .RS 4
-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.
+Set the minimum logging level (default: FATAL) that yields a non\-zero exit code (i.e., failure).
+If this option is not set, the program exits with a zero exit code even if warnings or errors have been logged.
 .RE
 .sp
 \fB\-q, \-\-quiet\fP
 .RS 4
-Silence warnings.
+Silence application log messages and script warnings.
 .RE
 .sp
 \fB\-\-trace\fP
 .RS 4
-Include backtrace information on errors.
-Not enabled by default.
+Include backtrace information when reporting errors.
 .RE
 .sp
 \fB\-v, \-\-verbose\fP
 .RS 4
-Verbosely print processing information and configuration file checks to stderr.
+Sets log level to DEBUG so application messages logged at INFO or DEBUG level are printed to stderr.
+.RE
+.sp
+\fB\-w, \-\-warnings\fP
+.RS 4
+Turn on script warnings (applies to executed code).
 .RE
 .sp
 \fB\-t, \-\-timings\fP
 .RS 4
-Display timings information (time to read, parse and convert).
+Print timings report to stderr (time to read, parse, and convert).
 .RE
 .SS "Program Information"
 .sp
 \fB\-h, \-\-help\fP [\fITOPIC\fP]
 .RS 4
-Print the help message.
-Show the command usage if \fITOPIC\fP is not specified (or not recognized).
+Print a help message.
+Show the command usage if \fITOPIC\fP is not specified or recognized.
 Dump the Asciidoctor man page (in troff/groff format) if \fITOPIC\fP is \fImanpage\fP.
+Print an AsciiDoc syntax crib sheet (in AsciiDoc) if \fITOPIC\fP is \fIsyntax\fP.
 .RE
 .sp
 \fB\-V, \-\-version\fP
 .RS 4
 Print program version number.
 .sp
-\f(CR\-v\fP can also be used if no other flags or arguments are present.
+\fB\-v\fP can also be used if no source files are specified.
 .RE
 .SH "ENVIRONMENT"
 .sp
 \fBAsciidoctor\fP honors the \fBSOURCE_DATE_EPOCH\fP environment variable.
 If this variable is assigned an integer value, that value is used as the epoch of all input documents and as the local date and time.
 See \c
-.URL "https://reproducible\-builds.org/specs/source\-date\-epoch/" "" " "
+.URL "https://reproducible\-builds.org/specs/source\-date\-epoch/" "" ""
 for more information about this environment variable.
 .SH "EXIT STATUS"
 .sp
@@ -235,30 +239,28 @@ Refer to the \fBAsciidoctor\fP issue tracker at \c
 .URL "https://github.com/asciidoctor/asciidoctor/issues?q=is%3Aopen" "" "."
 .SH "AUTHORS"
 .sp
-\fBAsciidoctor\fP was written by Dan Allen, Ryan Waldron, Jason Porter, Nick Hengeveld and other contributors.
+\fBAsciidoctor\fP is led and maintained by Dan Allen and Sarah White and has received contributions from many individuals in the Asciidoctor community.
+The project was started in 2012 by Ryan Waldron based on a prototype written by Nick Hengeveld for the Git website.
+Jason Porter wrote the first implementation of the CLI interface provided by this command.
 .sp
-\fBAsciiDoc\fP was written by Stuart Rackham and has received contributions from many other individuals.
+\fBAsciiDoc.py\fP was created by Stuart Rackham and has received contributions from many individuals in the AsciiDoc.py community.
 .SH "RESOURCES"
 .sp
-\fBProject web site:\fP \c
+\fBProject website:\fP \c
 .URL "https://asciidoctor.org" "" ""
 .sp
-\fBGit source repository on GitHub:\fP \c
+\fBProject documentation:\fP \c
+.URL "https://docs.asciidoctor.org" "" ""
+.sp
+\fBSource repository:\fP \c
 .URL "https://github.com/asciidoctor/asciidoctor" "" ""
 .sp
-\fBGitHub organization:\fP \c
-.URL "https://github.com/asciidoctor" "" ""
+\fBCommunity chat:\fP \c
+.URL "https://asciidoctor.zulipchat.com" "" ""
 .sp
-\fBDiscussion list / forum:\fP \c
-.URL "http://discuss.asciidoctor.org" "" ""
+\fBDiscussion list:\fP \c
+.URL "https://discuss.asciidoctor.org" "" ""
 .SH "COPYING"
 .sp
-Copyright (C) 2012\-2018 Dan Allen, Ryan Waldron and the Asciidoctor Project.
-Free use of this software is granted under the terms of the MIT License.
-.SH "AUTHORS"
-.sp
-Dan Allen
-.sp
-Sarah White
-.sp
-Ryan Waldron
+Copyright (C) 2012\-present Dan Allen, Sarah White, Ryan Waldron, and the individual contributors to Asciidoctor.
+Use of this software is granted under the terms of the MIT License.

data/man/asciidoctor.adoc

@@ -1,35 +1,37 @@
 = asciidoctor(1)
-Dan Allen; Sarah White; Ryan Waldron
+Dan Allen; Sarah White
 :doctype: manpage
+:release-version: 2.0.17
 :man manual: Asciidoctor Manual
-:man source: Asciidoctor 1.5.8
-:page-layout: base
+:man source: Asciidoctor {release-version}
+ifdef::backend-manpage[:!author:]
 
-== NAME
+== Name
 
-asciidoctor - converts AsciiDoc source files to HTML, DocBook and other formats
+asciidoctor - converts AsciiDoc source files to HTML, DocBook, and other formats
 
-== SYNOPSIS
+== Synopsis
 
 *asciidoctor* [_OPTION_]... _FILE_...
 
-== DESCRIPTION
+== Description
 
-The asciidoctor(1) command converts the AsciiDoc source file(s) _FILE_ to HTML5, DocBook 5, DocBook 4.5, man(ual) page and other custom output formats.
+The asciidoctor(1) command converts the AsciiDoc source file(s) _FILE_ to HTML5, DocBook 5, man(ual) page, and other custom output formats.
 
 If _FILE_ is _-_ then the AsciiDoc source is read from standard input.
 
-== OPTIONS
+== Options
 
+// tag::options[]
 === Security Settings
 
 *-B, --base-dir*=_DIR_::
   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.
+  Defaults to the directory containing the source file or, if the source is read from a stream, the working directory.
   When combined with the safe mode setting, can be used to chroot the execution of the program.
 
 *-S, --safe-mode*=_SAFE_MODE_::
-  Set safe mode level: _unsafe_, _safe_, _server_ or _secure_.
+  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.
 
@@ -42,23 +44,23 @@ If _FILE_ is _-_ then the AsciiDoc source is read from standard input.
 === Document Settings
 
 *-a, --attribute*=_ATTRIBUTE_::
-  Define, override or delete a document attribute.
-  Command-line attributes take precedence over attributes defined in the source file unless the value ends with _@_.
+  Define, override, or unset a document attribute.
+  Command-line attributes take precedence over attributes defined in the source file unless either the name or value ends in _@_.
 +
 _ATTRIBUTE_ is normally formatted as a key-value pair, in the form _NAME=VALUE_.
-Alternate acceptable forms are _NAME_ (where the _VALUE_ defaults to an empty string), _NAME!_ (unassigns the _NAME_ attribute) and _NAME=VALUE@_ (where _VALUE_ does not override value of _NAME_ attribute if it's already defined in the source document).
+Alternate forms are _NAME_ (where the _VALUE_ defaults to an empty string), _NAME!_ (unsets the _NAME_ attribute), and _NAME=VALUE@_ (or _NAME@=VALUE_) (where _VALUE_ does not override the _NAME_ attribute if it's already defined in the source document).
 Values containing spaces should be enclosed in quotes.
 +
 This option may be specified more than once.
 
 *-b, --backend*=_BACKEND_::
-  Backend output file format: _html5_, _docbook5_, _docbook45_ and _manpage_ are supported out of the box.
+  Backend output file format: _html5_, _docbook5_, 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_.
 
 *-d, --doctype*=_DOCTYPE_::
-  Document type: _article_, _book_, _manpage_ or _inline_.
+  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.
@@ -69,7 +71,7 @@ This option may be specified more than once.
 
 *-D, --destination-dir*=_DIR_::
   Destination output directory.
-  Defaults to the directory containing the source file, or the working directory if the source is read from a stream.
+  Defaults to the directory containing the source file or, if the source is read from a stream, the working directory.
   If specified, the directory is resolved relative to the working directory.
 
 *-E, --template-engine*=_NAME_::
@@ -78,10 +80,9 @@ This option may be specified more than once.
   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.
 
-*-e, --eruby*::
-  Specifies the eRuby implementation to use for executing the custom converter templates written in ERB.
-  Supported values are _erb_ and _erubis_.
-  Defaults to _erb_.
+*-e, --embedded*::
+  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.
 
 *-I, --load-path*=_DIRECTORY_::
   Add the specified directory to the load path, so that _-r_ can load extensions from outside the default Ruby load path.
@@ -125,41 +126,45 @@ Matching templates found in subsequent directories override ones previously disc
 === Processing Information
 
 *--failure-level*=_LEVEL_::
-  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.
+  Set the minimum logging level (default: FATAL) that yields a non-zero exit code (i.e., failure).
+  If this option is not set, the program exits with a zero exit code even if warnings or errors have been logged.
 
 *-q, --quiet*::
-  Silence warnings.
+  Silence application log messages and script warnings.
 
 *--trace*::
-  Include backtrace information on errors.
-  Not enabled by default.
+  Include backtrace information when reporting errors.
 
 *-v, --verbose*::
-  Verbosely print processing information and configuration file checks to stderr.
+  Sets log level to DEBUG so application messages logged at INFO or DEBUG level are printed to stderr.
+
+*-w, --warnings*::
+  Turn on script warnings (applies to executed code).
 
 *-t, --timings*::
-  Display timings information (time to read, parse and convert).
+  Print timings report to stderr (time to read, parse, and convert).
 
 === Program Information
 
 *-h, --help* [_TOPIC_]::
-  Print the help message.
-  Show the command usage if _TOPIC_ is not specified (or not recognized).
+  Print a help message.
+  Show the command usage if _TOPIC_ is not specified or recognized.
   Dump the Asciidoctor man page (in troff/groff format) if _TOPIC_ is _manpage_.
+  Print an AsciiDoc syntax crib sheet (in AsciiDoc) if _TOPIC_ is _syntax_.
 
 *-V, --version*::
   Print program version number.
 +
-`-v` can also be used if no other flags or arguments are present.
+*-v* can also be used if no source files are specified.
+// end::options[]
 
-== ENVIRONMENT
+== Environment
 
 *Asciidoctor* honors the *SOURCE_DATE_EPOCH* environment variable.
 If this variable is assigned an integer value, that value is used as the epoch of all input documents and as the local date and time.
 See https://reproducible-builds.org/specs/source-date-epoch/ for more information about this environment variable.
 
-== EXIT STATUS
+== Exit Status
 
 *0*::
   Success.
@@ -167,27 +172,31 @@ See https://reproducible-builds.org/specs/source-date-epoch/ for more informatio
 *1*::
   Failure (syntax or usage error; configuration error; document processing failure; unexpected error).
 
-== BUGS
+== Bugs
 
 Refer to the *Asciidoctor* issue tracker at https://github.com/asciidoctor/asciidoctor/issues?q=is%3Aopen.
 
-== AUTHORS
+== Authors
+
+*Asciidoctor* is led and maintained by Dan Allen and Sarah White and has received contributions from many individuals in the Asciidoctor community.
+The project was started in 2012 by Ryan Waldron based on a prototype written by Nick Hengeveld for the Git website.
+Jason Porter wrote the first implementation of the CLI interface provided by this command.
 
-*Asciidoctor* was written by Dan Allen, Ryan Waldron, Jason Porter, Nick Hengeveld and other contributors.
+*AsciiDoc.py* was created by Stuart Rackham and has received contributions from many individuals in the AsciiDoc.py community.
 
-*AsciiDoc* was written by Stuart Rackham and has received contributions from many other individuals.
+== Resources
 
-== RESOURCES
+*Project website:* https://asciidoctor.org
 
-*Project web site:* https://asciidoctor.org
+*Project documentation:* https://docs.asciidoctor.org
 
-*Git source repository on GitHub:* https://github.com/asciidoctor/asciidoctor
+*Source repository:* https://github.com/asciidoctor/asciidoctor
 
-*GitHub organization:* https://github.com/asciidoctor
+*Community chat:* https://asciidoctor.zulipchat.com
 
-*Discussion list / forum:* http://discuss.asciidoctor.org
+*Discussion list:* https://discuss.asciidoctor.org
 
-== COPYING
+== Copying
 
-Copyright \(C) 2012-2018 Dan Allen, Ryan Waldron and the Asciidoctor Project.
-Free use of this software is granted under the terms of the MIT License.
+Copyright \(C) 2012-present Dan Allen, Sarah White, Ryan Waldron, and the individual contributors to Asciidoctor.
+Use of this software is granted under the terms of the MIT License.