man/asciidoctor.adoc in asciidoctor-2.0.16 vs man/asciidoctor.adoc in asciidoctor-2.0.17

- old
+ new

@@ -1,28 +1,28 @@ = asciidoctor(1) -Dan Allen; Sarah White; Ryan Waldron +Dan Allen; Sarah White :doctype: manpage -:release-version: 2.0.16 +:release-version: 2.0.17 :man manual: Asciidoctor Manual :man source: Asciidoctor {release-version} -:page-layout: base +ifdef::backend-manpage[:!author:] -== NAME +== Name 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, 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_:: @@ -124,12 +124,12 @@ Matching templates found in subsequent directories override ones previously discovered. === 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 exit 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 application log messages and script warnings. *--trace*:: @@ -148,50 +148,55 @@ *-h, --help* [_TOPIC_]:: 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 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. *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* was written by Dan Allen, Ryan Waldron, Jason Porter, Nick Hengeveld, and other contributors. +*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. -*AsciiDoc* was written by Stuart Rackham and has received contributions from many other individuals. +*AsciiDoc.py* was created by Stuart Rackham and has received contributions from many individuals in the AsciiDoc.py community. -== RESOURCES +== Resources -*Project web site:* https://asciidoctor.org +*Project website:* https://asciidoctor.org -*Git source repository on GitHub:* https://github.com/asciidoctor/asciidoctor +*Project documentation:* https://docs.asciidoctor.org -*GitHub organization:* https://github.com/asciidoctor +*Source repository:* https://github.com/asciidoctor/asciidoctor -*Discussion list / forum:* http://discuss.asciidoctor.org +*Community chat:* https://asciidoctor.zulipchat.com -== COPYING +*Discussion list:* https://discuss.asciidoctor.org -Copyright \(C) 2012-present Dan Allen, Ryan Waldron, and the Asciidoctor Project. -Free use of this software is granted under the terms of the MIT License. +== Copying + +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.