summaryrefslogtreecommitdiff
path: root/doc/a2x.1.txt
diff options
context:
space:
mode:
authorStuart Rackham <srackham@methods.co.nz>2011-04-11 15:17:45 +1200
committerStuart Rackham <srackham@methods.co.nz>2011-04-11 15:17:45 +1200
commit55d8b1e1d6ac620e08843901998f2ad597cd2c5b (patch)
treee9d8ea66f7f842a393a5e19cf24378f72811b3c3 /doc/a2x.1.txt
parentcae899e2eee234fcc553a1146228188e296a4b05 (diff)
downloadasciidoc-git-55d8b1e1d6ac620e08843901998f2ad597cd2c5b.tar.gz
Documentation updates.
Diffstat (limited to 'doc/a2x.1.txt')
-rw-r--r--doc/a2x.1.txt19
1 files changed, 11 insertions, 8 deletions
diff --git a/doc/a2x.1.txt b/doc/a2x.1.txt
index 3c4d49e..6dcbaa4 100644
--- a/doc/a2x.1.txt
+++ b/doc/a2x.1.txt
@@ -124,17 +124,19 @@ OPTIONS
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. Options
-spanning multiple such comment lines will be concatenated. Zero or
-more white space characters can appear between the leading *//* and
-*a2x:*. Command-line options take precedence over options set in the
-source file. Example usage:
+the line will be treated as 'a2x' command-line options. For example:
// a2x default options.
// a2x: -dbook --epubcheck
// Suppress revision history in dblatex outputs.
// a2x: --dblatex-opts "-P latex.output.revhistory=0"
+- Options spanning multiple such comment lines will be concatenated.
+- Zero or more white space characters can appear between the leading
+ *//* and *a2x:*.
+- Command-line options take precedence over options set in the source
+ file.
+
[[X4]]
OUTPUT FILES
@@ -242,9 +244,10 @@ EXAMPLES
`a2x -f pdf doc/source-highlight-filter.txt`::
Generates `doc/source-highlight-filter.pdf` file.
-`a2x -f xhtml -D ../doc --icons -r ../images team.txt`::
- Creates HTML file `../doc/team.html`, uses admonition icons
- and searches `../images` for any missing resources.
+`a2x -f xhtml -D ../doc --icons -r ../images/ team.txt`::
+ Creates HTML file `../doc/team.html`, uses admonition icons and
+ recursively searches the `../images/` directory for any missing
+ resources.
`a2x -f manpage doc/asciidoc.1.txt`::
Generate `doc/asciidoc.1` manpage.