asciidoc / help.conf

# AsciiDoc help file.
# INI section format, each section contains a topic.
# Displayed with 'asciidoc --help sectionname' command.

# Default help topic.

Man page:     asciidoc --help manpage
Syntax:       asciidoc --help syntax



   asciidoc - converts an AsciiDoc text file to DocBook, HTML or LinuxDoc


   asciidoc [OPTIONS] FILE


   The asciidoc(1) command translates the AsciiDoc text file FILE to a
   DocBook, HTML or LinuxDoc file. If FILE is - then the standard input is


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

   -b, --backend=BACKEND
          Backend output file format: docbook, xhtml11 or html4. Defaults
          to xhtml11.

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

          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.

   -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

          Disable safe mode. Safe mode is enabled by default, disabling it
          is potentially dangerous.

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

          Print program version number.



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


   See the AsciiDoc distribution BUGS file.


   Written by Stuart Rackham, <>



   Main web site:


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


AsciiDoc Markup Syntax Summary

A summary of the most commonly used markup to jog the memory.
For a complete reference see the 'AsciiDoc User Guide'.

Text formatting
  *bold text*                 (boldface font)
  _emphasized text_           (normally italics)
  'emphasized text'
  +monospaced text+           (proportional font)
  `monospaced text`           (inline literal passthrough)

Document links
  [[id]]                      (define link target)
  <<id,caption>>              (link to target id)
  link:filename#id[caption]   (link to external HTML file)

  Use normal URL and email addess syntax or:

  http:address[caption]       (link to web page)
  mailto:address[caption]     (link to mail recipient)

  image:filename[caption]     (inline image)
  image::filename[caption]    (block image)

Document header

  The Document Title
  author <email>              (optional)
  revision, date              (optional)

Section title underlines

  Level 0                     (document title)
  Level 1
  Level 2
  Level 3
  Level 4                     (bottom level)

  Single line:

  = Level 0 =                 (document title) 
  == Level 1 ==
  === Level 2 ===
  ==== Level 3 ====
  ===== Level 4 =====         (bottom level)

A normal paragraph.           (styles: verse,NOTE,TIP,WARNING)
  An indented literal

Delimited blocks
Delimiters must begin at left margin.

  -------------------         (styles: source,music,graphviz)
  listing block

  ...................         (styles: listing)
  literal block

  *******************         (styles: abstract)
  sidebar block

  [style, author, cite]
  ___________________         (styles: quote,verse)
  quote block

  ===================         (styles: NOTE,TIP,WARNING,
  example block                        IMPORTANT,CAUTION)

  comment block

  +++++++++++++++++++         (styles: pass)
  passthrough block

More block elements
  [attributes list]
  .Block title
  // Comment line

  .An example table
  |Column 1 |Column 2
  |1        |Item 1
  |2        |Item 2
  |3        |Item 3
  |6        |Three items

  Common attributes:

  grid:    none,cols,rows,all
  frame:   none,sides,all
  options: header,footer
  format:  psv,csv,dsv
  valign:  top,bottom,middle
  width:   1%..100%
  cols:    colspec[,colspec,...]

  colspec:        [<multiplier>*][<align>][<width>][<style>]
  colspec align:  < (left), ^ (center), > (right)
  colspec width:  1... or 1%...100%
  colspec style:  d[efault], e[mphasis], m[onospaced], a[sciidoc],
                  s[trong], l[iteral], v[erse]

Bulleted lists
  - item text
  * item text
  ** item text
  *** item text
  **** item text
  ***** item text

  (styles: callout,bibliography)

Numbered lists
  1. arabic (decimal) numbering
  a. loweralpha numbering
  F. upperalpha numbering
  iii) lowerroman numbering
  IX) upperroman numbering

  . arabic (decimal) numbering
  .. loweralpha numbering
  ... lowerroman numbering
  .... upperalpha numbering
  ..... upperroman numbering

  (styles: arabic,loweralpha,upperalpha,lowerroman,upperroman)

Labeled lists
  label:: item text
  label;; item text
  label::: item text
  label:::: item text

  (styles: horizontal,vertical,glossary,qanda)

More inline elements
  footnote:[footnote text]    (document footnote)