asciidoctor.txt

asciidoctor(1)
==============
:doctype: manpage


NAME
----
asciidoctor - converts an AsciiDoc text file to HTML, DocBook and other formats


SYNOPSIS
--------
*asciidoctor* ['OPTION']... 'FILE'


DESCRIPTION
-----------
The asciidoctor(1) command translates the AsciiDoc text file 'FILE' to
DocBook, HTML and other formats. If 'FILE' is '-' then the standard
input is used.


OPTIONS
-------
*-a, --attribute*='ATTRIBUTE'::
    Define or delete document attribute. 'ATTRIBUTE' is formatted like
    'NAME=VALUE'. Command-line attributes take precedence over
    document and configuration file attributes.  Alternate acceptable
    forms are 'NAME' (the 'VALUE' defaults to an empty string);
    'NAME!' (delete the 'NAME' attribute); 'NAME=VALUE@' (do not override
    document or configuration file attributes).  Values containing
    spaces should be enclosed in double-quote characters. This option
    may be specified more than once.  A special attribute named
    'trace' controls the output of diagnostic information.

*-b, --backend*='BACKEND'::
    Backend output file format: 'docbook45' or 'html5'.  You can also
    use the backend alias names 'html' (aliased to 'html5') or
    'docbook' (aliased to 'docbook45'). Defaults to 'html5'.

*-C, --compact*::
    Compact the output by removing blank lines (default: false)

*-d, --doctype*='DOCTYPE'::
    Document type: 'article', 'manpage' or 'book'. The 'book' document
    type is only supported by the 'docbook' backend.  Default document
    type is 'article'.

*-D, --destination-dir*='DIR'::
    Destination output directory (default: directory of source file).

*-d, --help*::
    Show the help message.

*-s, --no-header-footer*::
    Suppress document header and footer output.

*--s*::
    Set safe mode to 'safe' (default: 'secure').
    Enables include macros, but restricts access to ancestor paths of 
    source file. Provided for compatibility with the asciidoc command

*-S, --safe--mode*='SAFE_MODE'::
    Set safe mode level explicity: 'unsafe', 'safe', 'secure' (default: 'secure').
    Disables potentially dangerous macros in source files, such as include[]

*-o, --out-file*='OUT_FILE'::
    Write output to file 'OUT_FILE'. Defaults to the base name of
    input file with 'backend' extension. If the input is stdin then
    the outfile defaults to stdout. If 'OUT_FILE' is '-' then the
    standard output is used.

*-n, --section-numbers*::
    Auto-number HTML article section titles.  Synonym for
    *--attribute numbered*.

*--trace*::
    Include backtrace information on errors (default: false).

*-T, --template-dir*='DIR'::
    Directory containing custom render templates that override the
    built-in set.

*-v, --verbose*::
    Verbosely print processing information and configuration file
    checks to stderr.

*-V, --version*::
    Print program version number.


EXIT STATUS
-----------
*0*::
    Success

*1*::
    Failure (syntax or usage error; configuration error; document
    processing failure; unexpected error).


BUGS
----
See the Asciidoctor issue tracker: <https://github.com/erebor/asciidoctor/issues?state=open>


AUTHORS
-------
Asciidoctor was written by Ryan Waldron, Dan Allen and other contributors.
AsciiDoc was written by Stuart Rackham and has received contributions from many
others.


RESOURCES
---------
Git repository on GitHub: <https://github.com/erebor/asciidoctor>

Main web site: <http://asciidoctor.org>


COPYING
-------
Copyright \(C) Ryan Waldron. Free use of this software is
granted under the terms of the MIT License.