diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2021-07-18 23:57:40 -0600 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2021-07-19 01:08:29 -0600 |
| commit | fd826de062cdf02dd4a7f512efbb8891862a3cdf (patch) | |
| tree | f69a6fd888df99d0551b9aeb37afd81ebecd9d19 /docs/modules | |
| parent | 55c35890412ba8c944bf6548ff1be01e9e59597d (diff) | |
document on the CLI intro page how to generate the man page for the asciidoctor command [skip ci]
Diffstat (limited to 'docs/modules')
| -rw-r--r-- | docs/modules/cli/pages/index.adoc | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/modules/cli/pages/index.adoc b/docs/modules/cli/pages/index.adoc index 6451af8c..b8593fe1 100644 --- a/docs/modules/cli/pages/index.adoc +++ b/docs/modules/cli/pages/index.adoc @@ -1,5 +1,5 @@ = Process AsciiDoc Using the CLI -:url-manpage: https://github.com/asciidoctor/asciidoctor/blob/master/man/asciidoctor.adoc +:url-manpage: https://github.com/asciidoctor/asciidoctor/blob/v{release-version}/man/asciidoctor.adoc //// command-line-usage.adoc @@ -25,8 +25,12 @@ This will use the built-in defaults for options and create a new file in the sam The xref:options.adoc[] describes the available Asciidoctor CLI options and parameters. -Full help is provided in the {url-manpage}[Asciidoctor man page^] or via: +You can output the usage for the `asciidoctor` command by appending the `--help` option: $ asciidoctor --help -//There is also an `asciidoctor-safe` command, which turns on safe mode by default, preventing access to files outside the parent directory of the source file. +You can generate the full documentation (i.e., man page) for the `asciidoctor` command by passing the `manpage` argument to the `--help` option, which you can then pipe to the `man` pager for viewing: + + $ asciidoctor --help manpage | man -l - + +You can find the AsciiDoc source for the {url-manpage}[Asciidoctor man page^] online in the Asciidoctor repository, which you can preview in a browser. |