ASCIIDOC(1)                                                        ASCIIDOC(1)



NAME
       asciidoc - converts an AsciiDoc text file to HTML or DocBook

SYNOPSIS
       asciidoc [OPTIONS] FILE

DESCRIPTION
       The asciidoc(1) command translates the AsciiDoc text file FILE to
       DocBook or HTML. 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, xhtml11, html4, wordpress or
           latex (the latex backend is experimental). You can also the backend
           alias names html (aliased to xhtml11) or docbook (aliased to
           docbook45). Defaults to html.

       -f, --conf-file=CONF_FILE
           Use configuration file CONF_FILE.Configuration files processed in
           command-line order (after implicit configuration files). This
           option may be specified more than once.

       --doctest
           Run Python doctests in asciidoc module.

       -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.

       -c, --dump-conf
           Dump configuration to stdout.

       --filter
           Manage asciidoc(1) filters (see FILTER COMMANDS).

       -h, --help [TOPIC]
           Print help TOPIC.  --help topics will print a list of help topics,
           --help syntax summarizes AsciiDoc syntax, --help manpage prints the
           AsciiDoc manpage.

       -e, --no-conf
           Exclude implicitly loaded configuration files except for those
           named like the input file (infile.conf and infile-backend.conf).

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

       -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 -a numbered.

       --safe
           Enable safe mode. Safe mode is disabled by default. AsciiDoc safe
           mode skips potentially dangerous scripted sections in AsciiDoc
           source files.

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

       --version
           Print program version number.

FILTER COMMANDS
       The --filter option is used to install, remove and list AsciiDoc filter
       plugins. Filter commands syntax:

           asciidoc --filter install ZIP_FILE [FILTERS_DIR]
           asciidoc --filter remove FILTER_NAME [FILTERS_DIR]
           asciidoc --filter list

       Where:

       FILTER_NAME
           A unique filter name containing only alphanumeric or underscore
           characters.

       ZIP_FILE
           A Zip file containing filter resources, the name must start with
           the filter name e.g.  my_filter-1.0.zip packages filter my_filter.

       FILTERS_DIR
           The directory containing installed filters. Each filter is
           contained in its own separate subdirectory which has the same name
           as the filter.  FILTERS_DIR defaults to the .asciidoc/filters
           directory in the user's home directory.

       The filter commands perform as follows:

       install
           Create a subdirectory in FILTERS_DIR with the same name as the
           filter then extract the ZIP_FILE into it.

       remove
           Delete the FILTER_NAME filter subdirectory and all its contents
           from the FILTERS_DIR.

       list
           List the names and locations of all installed filters (including
           standard filters installed in the global configuration directory).

EXIT STATUS
       0
           Success

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

BUGS
       See the AsciiDoc distribution BUGS file.

AUTHOR
       AsciiDoc was originally written by Stuart Rackham. Many people have
       contributed to it.

RESOURCES
       SourceForge: http://sourceforge.net/projects/asciidoc/

       Main web site: http://www.methods.co.nz/asciidoc/

COPYING
       Copyright (C) 2002-2011 Stuart Rackham. Free use of this software is
       granted under the terms of the GNU General Public License (GPL).



  8.6.5                           20 May 2011                      ASCIIDOC(1)
