summaryrefslogtreecommitdiff
path: root/doc/a2x.1.txt
diff options
context:
space:
mode:
authorStuart Rackham <srackham@methods.co.nz>2011-11-07 13:46:02 +1300
committerStuart Rackham <srackham@methods.co.nz>2011-11-07 13:46:02 +1300
commit8efcf2de228fe064e3d5bd78db2dc14f6be34dc6 (patch)
treef86d7e71685cb6f4a5108e70da29b22b2a9ab31d /doc/a2x.1.txt
parent1dfed16e590b19cc7e70352402ba0618d8639013 (diff)
downloadasciidoc-git-8efcf2de228fe064e3d5bd78db2dc14f6be34dc6.tar.gz
Added --backend and --backend-opts options to the a2x command so
process output formats with backend plugin code extensions. Patch submitted by Lex Trotman: http://groups.google.com/group/asciidoc/browse_thread/thread/b8e93740b7cd0e1d/b5e0b83fe37ae31a
Diffstat (limited to 'doc/a2x.1.txt')
-rw-r--r--doc/a2x.1.txt11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/a2x.1.txt b/doc/a2x.1.txt
index 17a9044..41bd56b 100644
--- a/doc/a2x.1.txt
+++ b/doc/a2x.1.txt
@@ -45,6 +45,13 @@ OPTIONS
document type is 'article' unless the format is 'manpage' (in which
case it defaults to 'manpage').
+*-b, --backend*='BACKEND'
+ 'BACKEND' is the name of an installed backend plugin. When this
+ option is specified 'a2x' attempts load a file name 'a2x-backend.py'
+ from the 'BACKEND' plugin directory It then converts the
+ 'SOURCE_FILE' to a 'BACKEND' formatted output file using a global
+ function defined in 'a2x-backend.py' called 'to_<BACKEND>'.
+
*-f, --format*='FORMAT'::
Output formats: 'chunked', 'docbook', 'dvi', 'epub', 'htmlhelp',
'manpage', 'pdf' (default), 'ps', 'tex', 'text', 'xhtml'.
@@ -124,6 +131,10 @@ OPTIONS
Additional 'dblatex(1)' options.
This option may be specified more than once.
+*--backend-opts*='BACKEND_OPTS'::
+ Options for the backend plugin specified by the '--backend' option.
+ This option may be specified more than once.
+
Options can also be set in the AsciiDoc source file. If 'SOURCE_FILE'
contains a comment line beginning with *// a2x:* then the remainder of
the line will be treated as 'a2x' command-line options. For example: