                             AsciiDoc Installation

   version 8.4.4, 26 April 2009

   Note
       The current version of AsciiDoc requires Python 2.4 or newer to run. If
       you don't already have an up-to-date version of Python installed it can
       be downloaded from the official Python website
       [1]http://www.python.org/.

   The latest AsciiDoc downloads can be found on the AsciiDoc website
   [2]http://www.methods.co.nz/asciidoc/downloads.html and at the
   SourceForge [3]http://sourceforge.net/projects/asciidoc/.
     __________________________________________________________________

1. Prepackaged AsciiDoc installation

   The AsciiDoc [4]downloads page lists AsciiDoc packages for various
   Linux distributions.
     __________________________________________________________________

2. Distribution tarball installation

   If your flavor or UNIX or Linux does not have a packaged AsciiDoc
   distribution or if you prefer to install the latest AsciiDoc version
   from source use the configure shell script in the tarball root
   directory.

   The autoconf(1) generated configure script creates a make file that is
   tailored for your system. To install:
  $ tar -xzf asciidoc-8.4.4.tar.gz
  $ cd asciidoc-8.4.4
  $ ./configure
  $ sudo make install

   To install the documentation:
  $ sudo make docs

   To uninstall AsciiDoc:
  $ sudo make uninstall

   If Vim is installed on your system the AsciiDoc Vim syntax highlighter
   and filetype detection scripts will be install in the global Vim
   configuration file directory (asciidoc.vim in the syntax directory and
   asciidoc_filetype.vim in the ftdetect directory).
     __________________________________________________________________

3. Installing from the Mercurial repository

   This is an easy way to install AsciiDoc if you don't have an up to date
   packaged version or want to get the latest version from the trunk:
     * Make sure you have [5]Mercurial installed, you can check with:
  $ hg --version
     * Go to the directory you want to install AsciiDoc into and download
       the repository. This example gets the 8.4.4 tagged release:
  $ cd ~/bin
  $ hg clone -r 8.4.4 http://hg.sharesource.org/asciidoc asciidoc-8.4.4
     * Create a symlink to the AsciiDoc script in a search PATH directory
       so it's easy to execute asciidoc from the command-line, for
       example:
  $ ln -s ~/bin/asciidoc-8.4.4/asciidoc.py ~/bin/asciidoc

   Use the Mercurial pull command to update your AsciiDoc repository.
     __________________________________________________________________

4. Microsoft Windows installation

   To install the zip formatted distribution just unzip the contents to a
   new folder:
  $ mkdir asciidoc
  $ cd asciidoc
  $ unzip ../asciidoc-8.4.4.zip
     __________________________________________________________________

5. Testing your installation

   Test out asciidoc by changing to the AsciiDoc application directory and
   convert the User Guide document (./doc/asciidoc.txt) to XHTML
   (./doc/asciidoc.html):
  $ python asciidoc.py doc/asciidoc.txt

   [6]testasciidoc offers a more extensive set of conformance tests.
     __________________________________________________________________

   Version 8.4.4
   Last updated 2009-04-13 09:18:34 NZDT

References

   1. http://www.python.org/
   2. http://www.methods.co.nz/asciidoc/downloads.html
   3. http://sourceforge.net/projects/asciidoc/
   4. http://www.methods.co.nz/asciidoc/downloads.html
   5. http://www.selenic.com/mercurial/
   6. file://localhost/tmp/lynxXXXXbrFxcI/testasciidoc.html
