diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2021-06-20 23:43:12 -0600 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2021-06-21 00:29:59 -0600 |
| commit | 5497605fb5c0e7129f3db0e7714eb762d469b573 (patch) | |
| tree | 38c83a83315b693dd84a28c1ed2788001d2032a3 /man | |
| parent | 3a43951cebf0dbbbbaa838963e94f53969a2b32d (diff) | |
update the documentation for the -e flag in the man page and CLI documentation (follow-up to #1444) [skip ci]
Diffstat (limited to 'man')
| -rw-r--r-- | man/asciidoctor.1 | 7 | ||||
| -rw-r--r-- | man/asciidoctor.adoc | 7 |
2 files changed, 6 insertions, 8 deletions
diff --git a/man/asciidoctor.1 b/man/asciidoctor.1 index 561cb150..31af6169 100644 --- a/man/asciidoctor.1 +++ b/man/asciidoctor.1 @@ -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 diff --git a/man/asciidoctor.adoc b/man/asciidoctor.adoc index cb392e76..59ee7486 100644 --- a/man/asciidoctor.adoc +++ b/man/asciidoctor.adoc @@ -79,10 +79,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. |