man/asciidoctor.adoc in asciidoctor-1.5.2 vs man/asciidoctor.adoc in asciidoctor-1.5.3

- old
+ new

@@ -1,10 +1,10 @@ = asciidoctor(1) Dan Allen; Sarah White; Ryan Waldron :doctype: manpage :man manual: Asciidoctor Manual -:man source: Asciidoctor 1.5.2 +:man source: Asciidoctor 1.5.3 :page-layout: base == NAME asciidoctor - converts AsciiDoc source files to HTML, DocBook and other formats @@ -13,11 +13,11 @@ *asciidoctor* [_OPTION_]... _FILE_... == DESCRIPTION -The asciidoctor(1) command converts the AsciiDoc source file(s) _FILE_ to HTML5, DocBook 4.5, DocBook 5.0 and other custom output formats. +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. If _FILE_ is _-_ then the AsciiDoc source is read from standard input. == OPTIONS @@ -50,11 +50,11 @@ Values containing spaces should be enclosed in quotes. + This option may be specified more than once. *-b, --backend*=_BACKEND_:: - Backend output file format: _html5_, _docbook45_ and _docbook5_ supported out of the box. + Backend output file format: _html5_, _docbook5_, _docbook45_ 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_). Defaults to _html5_. Other options can be passed, but if Asciidoctor cannot find the backend, it will fail during conversion. *-d, --doctype*=_DOCTYPE_:: @@ -85,10 +85,14 @@ *-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_. +*-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. + This option may be specified more than once. + *-n, --section-numbers*:: Auto-number section titles. Synonym for *--attribute numbered*. *-o, --out-file*=_OUT_FILE_:: @@ -96,10 +100,14 @@ Defaults to the base name of the input file suffixed with _backend_ extension. If the input is read from standard input, then the output file defaults to stdout. If _OUT_FILE_ is _-_ then the standard output is also used. If specified, the file is resolved relative to the working directory. +*-r, --require*=_LIBRARY_:: + Require the specified library before executing the processor, using the standard Ruby require. + This option may be specified more than once. + *-s, --no-header-footer*:: Suppress the document header and footer in the output. *-T, --template-dir*=_DIR_:: A directory containing custom converter templates that override one or more templates from the built-in set. @@ -131,10 +139,12 @@ *-h, --help*:: Show the help message. *-V, --version*:: Print program version number. ++ +`-v` can also be used if no other flags or arguments are present. == EXIT STATUS *0*:: Success. @@ -142,29 +152,27 @@ *1*:: Failure (syntax or usage error; configuration error; document processing failure; unexpected error). == BUGS -See the *Asciidoctor* issue tracker: <**https://github.com/asciidoctor/asciidoctor/issues?q=is%3Aopen**> +Refer to the *Asciidoctor* issue tracker at https://github.com/asciidoctor/asciidoctor/issues?q=is%3Aopen. == AUTHORS *Asciidoctor* was written by Dan Allen, Ryan Waldron, Jason Porter, Nick Hengeveld and other contributors. *AsciiDoc* was written by Stuart Rackham and has received contributions from many other individuals. == RESOURCES -Git source repository on GitHub: <**https://github.com/asciidoctor/asciidoctor**> +*Project web site:* http://asciidoctor.org -Project web site: <**http://asciidoctor.org**> +*Git source repository on GitHub:* https://github.com/asciidoctor/asciidoctor -GitHub organization: <**https://github.com/asciidoctor**> +*GitHub organization:* https://github.com/asciidoctor -Discussion list / forum: <**http://discuss.asciidoctor.org**> +*Discussion list / forum:* http://discuss.asciidoctor.org == COPYING -Copyright \(C) 2012-2014 Dan Allen, Ryan Waldron and the Asciidoctor Project. +Copyright \(C) 2012-2015 Dan Allen, Ryan Waldron and the Asciidoctor Project. Free use of this software is granted under the terms of the MIT License. - -// vim: tw=80