- Added a2x.py, a rewritten and much enhanced version of the old a2x bash

  script.
- Added epub format to a2x.py

1 files changed, 46 insertions, 49 deletions

diff --git a/doc/a2x.1.txt b/doc/a2x.1.txt
index 92da81d..f587423 100644
--- a/doc/a2x.1.txt
+++ b/doc/a2x.1.txt
@@ -4,8 +4,8 @@ A2X(1)
 
 NAME
 ----
-a2x - convert Asciidoc text file to PDF, XHTML, HTML Help, manpage or
-plain text
+a2x - convert Asciidoc text file to PDF, EPUB, XHTML, HTML Help,
+manpage or plain text
 
 
 SYNOPSIS
@@ -35,12 +35,6 @@ OPTIONS
   Additional asciidoc(1) options.  This option may be specified more
   than once.
 
-*--copy*::
-  Copy distributed docbook-xsl CSS stylesheet admonition and
-  navigation icons to their respective destinations. Applies to
-  'xhtml', 'chunked', 'htmlhelp' formats. The default behavior is to
-  suppress copying.
-
 *-D, --destination-dir*='PATH'::
   Output directory. Defaults to source 'FILE' directory.
 
@@ -50,8 +44,8 @@ OPTIONS
   case it defaults to 'manpage').
 
 *-f, --format*='FORMAT'::
-  Output format: 'chunked', 'dvi', 'htmlhelp', 'manpage', 'pdf', 'ps',
-  'tex', 'text' or 'xhtml'.
+  Output formats: 'chunked', 'docbook', 'dvi', 'epub', 'htmlhelp',
+  'manpage', 'pdf', 'ps', 'tex', 'text', 'xhtml'.
 
 *-h, --help*::
   Print command-line syntax and program options to stdout.
@@ -61,24 +55,37 @@ OPTIONS
   default behavior is to use text in place of icons.
 
 *--icons-dir*='PATH'::
-  A path (relative to destination HTML files) containing admonition
-  and navigation icons. Defaults to './images/icons/'.
-  Applies to 'xhtml', 'chunked', 'htmlhelp' formats.
+  A path (relative to output files) containing admonition
+  and navigation icons. Defaults to 'images/icons'.
+  The '--icons' option is implicit if this option is used.
+
+*--lynx*::
+  Use 'lynx(1)' to generate text formatted output. The default
+  behavior is to use 'w3m(1)'.
 
 *-L, --no-xmllint*::
-  Don't check asciidoc output with 'xmllint(1)'.
+  Do not check asciidoc output with 'xmllint'.
+
+*---epubcheck*::
+  Check EPUB output with 'epubcheck'.
 
 *-n, --dry-run*::
-  Don't do anything just print what would have been done.
+  Do not do anything just print what would have been done.
+
+*-r, --resource-dir*='PATH'::
+  If a relative image or CSS resource is not found relative to the
+  AsciiDoc source 'FILE' then search the 'PATH' recursively. This
+  option may be specified more than once.
 
 *-s, --skip-asciidoc*::
   Skip asciidoc execution. This is useful for converting DocBook XML
-  files not derived from AsciiDoc sources. Ignored if '--format=text'.
+  files not derived from AsciiDoc sources.
 
 *--stylesheet*='PATH'::
   A path (relative to destination HTML files) specifying the
-  docbook-xsl CSS stylesheet file. Defaults to './docbook-xsl.css'.
-  Applies to 'xhtml', 'chunked', 'htmlhelp' formats.
+  docbook-xsl CSS stylesheet file. Defaults to 'docbook-xsl.css'.
+  Applies to HTML formats: 'xhtml', 'epub', 'chunked', 'htmlhelp'
+  formats.
 
 *-v, --verbose*::
   Print operational details to stderr.
@@ -95,7 +102,8 @@ OPTIONS
   than once.
 
 *--fop*::
-  Use FOP to generate PDFs.
+  Use FOP to generate PDFs. The default behavior is to use
+  'dblatex(1)'.
 
 *--fop-opts*='FOP_OPTS'::
   Additional fop options.  This option may be specified more than
@@ -112,31 +120,21 @@ Output files are written to the directory specified by the
 output files are written to the source FILE directory.
 
 Output files have the same name as the source 'FILE' but with an
-appropriate file name extension: .html for 'xhtml'; .hhp for
-'htmlhelp'; .pdf for 'pdf'; .text for 'text'. By convention manpages
-have no .man extension (man page section number only). Chunked HTML
-directory names have a .chunked extension; chunked HTML Help directory
-names have a .htmlhelp extension.
+appropriate file name extension: .html for 'xhtml'; .epub for
+'epub'; .hhp for 'htmlhelp'; .pdf for 'pdf'; .text for 'text', .xml
+for 'docbook'. By convention manpages have no .man extension (man page
+section number only).  Chunked HTML directory names have a .chunked
+extension; chunked HTML Help directory names have a .htmlhelp
+extension.
 
 Same named existing files are overwritten.
 
-Intermediate output files are written to the source 'FILE' directory
-and are not automatically deleted.
-
-Intermediate DocBook XML files generated by AsciiDoc are only
-regenerated if out of date with respect to the AsciiDoc source 'FILE'.
-
-In addition to generating HTML files the 'xhtml', 'chunked' and
-'htmlhelp' formats copy the DocBook XSL stylesheet plus admonition and
-navigation icons distributed with AsciiDoc to their respective
-destination locations. Existing stylesheets and icons are only copied
-if they are newer than the destination files or if the destination
-files are missing.
-
-The 'xhtml' format generates a single XHTML output page.  The
-'chunked' format writes multiple per-section HTML pages to a chunked
-directory in the destination directory. The chunked directory has the
-same name as the source 'FILE' name plus a .chunked extension.
+In addition to generating HTML files the 'xhtml', 'epub', 'chunked'
+and 'htmlhelp' formats copy images and CSS stylesheet files referenced
+in the generated HTML outputs from locations relative to the asciidoc
+input 'FILE' to the correct relative destination directory locations
+generating sub-directories if neccessary. See also the
+'--resource-dir' option.
 
 
 EXAMPLES
@@ -144,12 +142,12 @@ EXAMPLES
 `a2x -f pdf doc/source-highlight-filter.txt`::
   Generates doc/source-highlight-filter.pdf file.
 
-`a2x -f chunked -D ../webpages guide.txt`::
-  Creates chunked directory `../webpages/guide.chunked` containing
-  chunked HTML files. Also copies `docbook-xsl.css` stylesheet to the
-  `../webpages/guide.chunked` directory plus admonition and navigation
-  icons to the `../webpages/guide.chunked/images/icons` directory.
+`a2x -f xhtml -D ../doc --icons -r ../images team.txt`::
+  Creates single HTML file `../doc/team.html`, uses admonition icons
+  and searches `../images` for any missing resources.
 
+`a2x -f manpage doc/asciidoc.1.txt`::
+  Generate `doc/asciidoc.1` manpage.
 
 REQUISITES
 ----------
@@ -183,8 +181,7 @@ See also the latest README file.
 
 BUGS
 ----
-- The odt output format is undocumented and experimental.
-- See also the AsciiDoc distribution BUGS file.
+See the AsciiDoc distribution BUGS file.
 
 
 AUTHOR
@@ -202,5 +199,5 @@ Main web site: http://www.methods.co.nz/asciidoc/
 COPYING
 -------
 Copyright \(C) 2002-2009 Stuart Rackham. Free use of this software is
-granted under the terms of the GNU General Public License (GPL).
+granted under the terms of the MIT license.